harmony-controller¶
Harmony controller information
harmony-controller Specification¶
Type Intermediate Resource Element Name harmony-controller Element URI /axapi/v3/harmony-controller Element Attributes harmony-controller_attributes Schema harmony-controller schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/harmony-controller | harmony-controller_attributes |
harmony-controller attributes¶
profile
Description: profile is a JSON Block. Please see below for profile
Type: Object
Refernce Object: /axapi/v3/harmony-controller/profile
telemetry
Description: telemetry is a JSON Block. Please see below for telemetry
Type: Object
Refernce Object: /axapi/v3/harmony-controller/telemetry
profile¶
Specification Type object action
Description ‘enable’: Register the device to the controller; ‘disable’: Deregister the device from controller;
Type: string
Supported Values: register, deregister
availability-zone
Description availablity zone of the thunder-device
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
host
Description Set harmony controller host adddress
Type: string
Format: host
metrics-export-interval
Description metrics export interval in seconds, default is 60 (metrics export interval in seconds, default is 60 seconds)
Type: number
Range: 15-300
Default: 60
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, default is 8443
Type: number
Range: 1-32767
Default: 8443
provider
Description provider for the harmony-controller
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
region
Description region of the thunder-device
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
secret-value
Description The controller tenant password
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 profile_thunder-mgmt-ip
Type: Object
Refernce Object: /axapi/v3/harmony-controller/profile/thunder-mgmt-ip
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
profile_thunder-mgmt-ip¶
Specification Type object ip-address
Description IP address (IPv4 address)
Type: string
Format: ipv4-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
telemetry¶
Specification Type object log-rate
Description Max number of session logs sent by the partition per second
Type: number
Range: 0-10000
Default: 1
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters