harmony-controller profile¶
Harmony controller profile
profile Specification¶
Parameter Value Type Configuration Resource Element Name profile Element URI /axapi/v3/harmony-controller/profile Element Attributes profile_attributes Partition Visibility shared Operational Data URI /axapi/v3/harmony-controller/profile/oper Schema profile schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/harmony-controller/profile | ||
Get Object | GET | /axapi/v3/harmony-controller/profile | ||
Modify Object | POST | /axapi/v3/harmony-controller/profile | ||
Replace Object | PUT | /axapi/v3/harmony-controller/profile | ||
Delete Object | DELETE | /axapi/v3/harmony-controller/profile | ||
profile attributes¶
action
Description ‘register’: Register the device to the controller; ‘deregister’: Deregister the device from controller;
Type: string
Supported Values: register, deregister
analytics
Description ‘all’: Export all the analytics information. This is the default value.; ‘system’: Export only system level policy for device management.; ‘disable’: Disable all the exports from the device.;
Type: string
Supported Values: all, system, disable
Default: all
auto-restart-action
Description ‘enable’: enable auto analytics bus restart, default behavior is enable; ‘disable’: disable auto analytics bus restart;
Type: string
Supported Values: enable, disable
Default: enable
availability-zone
Description availablity zone of the thunder-device
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
cluster-id
Description id for the cluster in harmony controller, typically an uuid
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
cluster-name
Description name of cluster in harmony controller that this device is a member of
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
host
Description Set harmony controller host address
Type: string
Format: host
Mutual Exclusion: host and host-ipv6 are mutually exclusive
host-ipv6
Description IPV6 address or FQDN for the host
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: host-ipv6 and host are mutually exclusive
interval
Description auto analytics bus restart time interval in mins, default is 3 mins
Type: number
Range: 1-15
Default: 3
password-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)port
Description Set port for remote Harmony Controller
Type: number
Range: 1-32767
provider
Description provider for the harmony-controller
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
re-sync
Description: re-sync is a JSON Block. Please see below for re-sync
Type: Object
Reference Object: /axapi/v3/harmony-controller/profile/re-sync
region
Description region of the thunder-device
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
secret-value
Description Specify the password for the user
Type: string
Format: password
Maximum Length: 128 characters
Maximum Length: 1 characters
thunder-mgmt-ip
Description: thunder-mgmt-ip is a JSON Block. Please see below for thunder-mgmt-ip
Type: Object
Reference Object: /axapi/v3/harmony-controller/profile/thunder-mgmt-ip
tunnel
Description: tunnel is a JSON Block. Please see below for tunnel
Type: Object
Reference Object: /axapi/v3/harmony-controller/profile/tunnel
use-mgmt-port
Description Use management port for connections
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-name
Description user-name for the tenant
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
re-sync¶
Specification Value Type object analytics-bus
Description re-sync analtyics bus connections
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
schema-registry
Description re-sync the schema registry
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tunnel¶
Specification Value Type object action
Description ‘enable’: Tunnel Enable; ‘disable’: Tunnel Disable;
Type: string
Supported Values: enable, disable
Default: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
thunder-mgmt-ip¶
Specification Value Type object ip-address
Description IP address (IPv4 address)
Type: string
Format: ipv4-address
Mutual Exclusion: ip-address and ipv6-addr are mutually exclusive
ipv6-addr
Description IPV6 address for the host
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6-addr and ip-address are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters