call-home profile¶
Call home profile
profile Specification¶
Parameter Value Type Configuration Resource Element Name profile Element URI /axapi/v3/call-home/profile Element Attributes profile_attributes Partition Visibility shared Schema profile schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/call-home/profile | ||
Get Object | GET | /axapi/v3/call-home/profile | ||
Modify Object | POST | /axapi/v3/call-home/profile | ||
Replace Object | PUT | /axapi/v3/call-home/profile | ||
Delete Object | DELETE | /axapi/v3/call-home/profile |
profile attributes¶
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