Documentation

avi_controllerproperties - Module for setup of ControllerProperties Avi RESTful Object

New in version 2.4.

Synopsis

Options

parameter required default choices comments
allow_ip_forwarding
no
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as False.
allow_unauthenticated_apis
no
Allow unauthenticated access for special apis.
Default value when not specified in API or module is interpreted by Avi Controller as False.
allow_unauthenticated_nodes
no
Boolean flag to set allow_unauthenticated_nodes.
Default value when not specified in API or module is interpreted by Avi Controller as False.
api_idle_timeout
no
Allowed values are 0-1440.
Default value when not specified in API or module is interpreted by Avi Controller as 15.
api_version
no
Avi API version of to use for Avi API and objects.
appviewx_compat_mode
no
Export configuration in appviewx compatibility mode.
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as False.
attach_ip_retry_interval
no
Number of attach_ip_retry_interval.
Default value when not specified in API or module is interpreted by Avi Controller as 360.
attach_ip_retry_limit
no
Number of attach_ip_retry_limit.
Default value when not specified in API or module is interpreted by Avi Controller as 4.
cluster_ip_gratuitous_arp_period
no
Number of cluster_ip_gratuitous_arp_period.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
crashed_se_reboot
no
Number of crashed_se_reboot.
Default value when not specified in API or module is interpreted by Avi Controller as 900.
dead_se_detection_timer
no
Number of dead_se_detection_timer.
Default value when not specified in API or module is interpreted by Avi Controller as 360.
dns_refresh_period
no
Number of dns_refresh_period.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
dummy
no
Number of dummy.
fatal_error_lease_time
no
Number of fatal_error_lease_time.
Default value when not specified in API or module is interpreted by Avi Controller as 120.
max_dead_se_in_grp
no
Number of max_dead_se_in_grp.
Default value when not specified in API or module is interpreted by Avi Controller as 1.
max_pcap_per_tenant
no
Maximum number of pcap files stored per tenant.
Default value when not specified in API or module is interpreted by Avi Controller as 4.
max_seq_vnic_failures
no
Number of max_seq_vnic_failures.
Default value when not specified in API or module is interpreted by Avi Controller as 3.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
persistence_key_rotate_period
no
Allowed values are 1-1051200.
Special values are 0 - 'disabled'.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
query_host_fail
no
Number of query_host_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 180.
se_create_timeout
no
Number of se_create_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 900.
se_failover_attempt_interval
no
Interval between attempting failovers to an se.
Default value when not specified in API or module is interpreted by Avi Controller as 300.
se_offline_del
no
Number of se_offline_del.
Default value when not specified in API or module is interpreted by Avi Controller as 172000.
se_vnic_cooldown
no
Number of se_vnic_cooldown.
Default value when not specified in API or module is interpreted by Avi Controller as 120.
secure_channel_cleanup_timeout
no
Number of secure_channel_cleanup_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
secure_channel_controller_token_timeout
no
Number of secure_channel_controller_token_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
secure_channel_se_token_timeout
no
Number of secure_channel_se_token_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
seupgrade_fabric_pool_size
no
Pool size used for all fabric commands during se upgrade.
Default value when not specified in API or module is interpreted by Avi Controller as 20.
seupgrade_segroup_min_dead_timeout
no
Time to wait before marking segroup upgrade as stuck.
Default value when not specified in API or module is interpreted by Avi Controller as 360.
ssl_certificate_expiry_warning_days
no
Number of days for ssl certificate expiry warning.
state
no present
  • absent
  • present
The state that should be applied on the entity.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
unresponsive_se_reboot
no
Number of unresponsive_se_reboot.
Default value when not specified in API or module is interpreted by Avi Controller as 300.
upgrade_dns_ttl
no
Time to account for dns ttl during upgrade.
This is in addition to vs_scalein_timeout_for_upgrade in se_group.
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as 5.
upgrade_lease_time
no
Number of upgrade_lease_time.
Default value when not specified in API or module is interpreted by Avi Controller as 360.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Unique object identifier of the object.
vnic_op_fail_time
no
Number of vnic_op_fail_time.
Default value when not specified in API or module is interpreted by Avi Controller as 180.
vs_apic_scaleout_timeout
no
Time to wait for the scaled out se to become ready before marking the scaleout done, applies to apic configuration only.
Default value when not specified in API or module is interpreted by Avi Controller as 360.
vs_awaiting_se_timeout
no
Number of vs_awaiting_se_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
vs_key_rotate_period
no
Allowed values are 1-1051200.
Special values are 0 - 'disabled'.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
vs_se_bootup_fail
no
Number of vs_se_bootup_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 300.
vs_se_create_fail
no
Number of vs_se_create_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 1500.
vs_se_ping_fail
no
Number of vs_se_ping_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
vs_se_vnic_fail
no
Number of vs_se_vnic_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 300.
vs_se_vnic_ip_fail
no
Number of vs_se_vnic_ip_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 120.
warmstart_se_reconnect_wait_time
no
Number of warmstart_se_reconnect_wait_time.
Default value when not specified in API or module is interpreted by Avi Controller as 300.

Examples

- name: Example to create ControllerProperties object
  avi_controllerproperties:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_controllerproperties

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj ControllerProperties (api/controllerproperties) object success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.