harmony-controller¶

Harmony controller information

harmony-controller Specification¶

Parameter Value

Type Intermediate Resource

Element Name harmony-controller

Element URI /axapi/v3/harmony-controller

Element Attributes harmony-controller_attributes

Partition Visibility shared

Schema harmony-controller schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/harmony-controller	harmony-controller_attributes

harmony-controller attributes¶

config-replace

Description: config-replace is a JSON Block. Please see below for config-replace

Type: Object

Reference Object: /axapi/v3/harmony-controller/config-replace

partition-tenant-info

Description: partition-tenant-info is a JSON Block. Please see below for partition-tenant-info

Type: Object

Reference Object: /axapi/v3/harmony-controller/partition-tenant-info

profile

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

Type: Object

Reference Object: /axapi/v3/harmony-controller/profile

telemetry

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

Type: Object

Reference Object: /axapi/v3/harmony-controller/telemetry

tunnel-stats

Description: tunnel-stats is a JSON Block. Please see below for tunnel-stats

Type: Object

Reference Object: /axapi/v3/harmony-controller/tunnel-stats

profile¶

Specification Value

Type object

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 profile_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 profile_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 profile_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

profile_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

profile_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

profile_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

tunnel-stats¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

config-replace¶

Specification Value

Type object

status

Description ‘enable’: enable config replace mode; ‘disable’: disable config replace mode;

Type: string

Supported Values: enable, disable

Default: disable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

telemetry¶

Specification Value

Type object

log-rate

Description Max number of session logs sent by the partition per second

Type: number

Range: 0-10000

Default: 10

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

partition-tenant-info¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters