harmony-controller profile

Harmony controller profile

profile Specification

Type	Configuration Resource
Element Name	profile
Element URI	/axapi/v3/harmony-controller/profile
Element Attributes	profile_attributes
Operational Data URI	/axapi/v3/harmony-controller/profile/oper
Schema	profile schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/harmony-controller/profile	profile attributes
Get Object	GET	/axapi/v3/harmony-controller/profile	profile attributes
Modify Object	POST	/axapi/v3/harmony-controller/profile	profile attributes
Replace Object	PUT	/axapi/v3/harmony-controller/profile	profile attributes
Delete Object	DELETE	/axapi/v3/harmony-controller/profile	profile attributes

profile attributes

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

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

operational data

	Counter	Size	Description
	deregistration-error-message	string	deregistration-error-message
	service-registry	string	service-registry
	overall-status	string	overall-status
	heartbeat-error-message	string	heartbeat-error-message
	registration-status	string	registration-status
	heartbeat-status	string	heartbeat-status
	broker_info	string	broker_info
	kafka-broker-state	enum	Output contains one of the following values: - Up, Down
	deregistration-status	string	deregistration-status
	deregistration-status-code	number	deregistration-status-code
	registration-status-code	number	registration-status-code
	service-registry-error-message	string	service-registry-error-message
	registration-error-message	string	registration-error-message