a10_harmony_controller_profile

Synopsis

Harmony controller profile

Parameters

Parameters

Choices/Defaults

Comment

state

str/required

[‘noop’, ‘present’, ‘absent’]

State of the object to be created.

ansible_host

str/required

Host for AXAPI authentication

ansible_username

str/required

Username for AXAPI authentication

ansible_password

str/required

Password for AXAPI authentication

ansible_port

int/required

Port for AXAPI authentication

a10_device_context_id

int

[‘1-8’]

Device ID for aVCS configuration

a10_partition

str

Destination/target partition for object/command

host

str

Set harmony controller host address

host_ipv6

str

IPV6 address or FQDN for the host

port

int

Set port for remote Harmony Controller

use_mgmt_port

bool

Use management port for connections

provider

str

provider for the harmony-controller

user_name

str

user-name for the tenant

cluster_name

str

name of cluster in harmony controller that this device is a member of

cluster_id

str

id for the cluster in harmony controller, typically an uuid

secret_value

str

Specify the password for the user

password_encrypted

str

Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

region

str

region of the thunder-device

auto_restart_action

str

‘enable’= enable auto analytics bus restart, default behavior is enable; ‘disable’= disable auto analytics bus restart;

interval

int

auto analytics bus restart time interval in mins, default is 3 mins

availability_zone

str

availablity zone of the thunder-device

analytics

str

‘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.;

action

str

‘register’= Register the device to the controller; ‘deregister’= Deregister the device from controller;

uuid

str

uuid of the object

re_sync

dict

Field re_sync

schema_registry

bool

re-sync the schema registry

analytics_bus

bool

re-sync analtyics bus connections

force

dict

Field force

deregister

bool

forcefully deregister thunder from harmony controller

thunder_mgmt_ip

dict

Field thunder_mgmt_ip

ip_address

str

IP address (IPv4 address)

ipv6_addr

str

IPV6 address for the host

uuid

str

uuid of the object

tunnel

dict

Field tunnel

action

str

‘enable’= Tunnel Enable; ‘disable’= Tunnel Disable;

uuid

str

uuid of the object

oper

dict

Field oper

overall_status

str

Field overall_status

heartbeat_status

str

Field heartbeat_status

heartbeat_error_message

str

Field heartbeat_error_message

service_registry

str

Field service_registry

service_registry_error_message

str

Field service_registry_error_message

registration_status

str

Field registration_status

registration_status_code

int

Field registration_status_code

registration_error_message

str

Field registration_error_message

deregistration_status

str

Field deregistration_status

deregistration_status_code

int

Field deregistration_status_code

deregistration_error_message

str

Field deregistration_error_message

schema_registry_status

str

Field schema_registry_status

broker_info

str

Field broker_info

kafka_broker_state

str

Field kafka_broker_state

Number_of_tenant_mapped_partitions

int

Field Number_of_tenant_mapped_partitions

Number_of_tenant_unmapped_partitions

int

Field Number_of_tenant_unmapped_partitions

tunnel_status

str

Field tunnel_status

tunnel_error_message

str

Field tunnel_error_message

peer_device_info

str

Field peer_device_info

Examples


Return Values

modified_values (changed, dict, )

Values modified (or potential changes if using check_mode) as a result of task operation

axapi_calls (always, list, )

Sequential list of AXAPI calls made by the task

endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])

The AXAPI endpoint being accessed.

http_method (, str, [‘POST’, ‘GET’])

HTTP method being used by the primary task to interact with the AXAPI endpoint.

request_body (, complex, )

Params used to query the AXAPI

response_body (, complex, )

Response from the AXAPI

Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]

  • This module is maintained by community.

Authors

  • A10 Networks