call-home¶

Call home information

call-home Specification¶

Parameter Value

Type Intermediate Resource

Element Name call-home

Element URI /axapi/v3/call-home

Element Attributes call-home_attributes

Partition Visibility shared

Schema call-home schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/call-home	call-home_attributes

call-home attributes¶

profile

Description: profile is a JSON Block. Please see below for profile

Type: Object

Reference Object: /axapi/v3/call-home/profile

profile¶

Specification Value

Type object

action

Description ‘register’: Register the device to the portal; ‘deregister’: Deregister the device from the portal;

Type: string

Supported Values: register, deregister

Default: register

export-policy

Description ‘restrictive’: Export minimal information about system and config, default policy; ‘permissive’: Export as much as possible information about system, config and solution data;

Type: string

Supported Values: restrictive, permissive

Default: restrictive

ipv4

Description set IPV4 address for the host

Type: string

Format: ipv4-address

Mutual Exclusion: ipv4, name, and ipv6 are mutually exclusive

ipv6

Description set IPV6 address for the host

Type: string

Format: ipv6-address

Mutual Exclusion: ipv6, name, and ipv4 are mutually exclusive

name

Description set hostname url for the host

Type: string

Format: host

Mutual Exclusion: name, ipv4, and ipv6 are mutually exclusive

port

Description Set port for the call home portal

Type: number

Range: 1-32767

time

Description Set export time of the data. default 0 (12 AM), default 0

Type: number

Range: 0-59

Default: 0

use-mgmt-port

Description Use management port for connections

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters