Documentation

avi_controllerproperties - Module for setup of ControllerProperties Avi RESTful Object

New in version 2.4.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • avisdk

Parameters

Parameter Choices/Defaults Comments
allow_ip_forwarding
bool
    Choices:
  • no
  • yes
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
bool
    Choices:
  • no
  • yes
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
bool
    Choices:
  • no
  • yes
Boolean flag to set allow_unauthenticated_nodes.
Default value when not specified in API or module is interpreted by Avi Controller as False.
api_context
(added in 2.5)
Avi API context that includes current session ID and CSRF Token.
This allows user to perform single login and re-use the session.
api_idle_timeout
Allowed values are 0-1440.
Default value when not specified in API or module is interpreted by Avi Controller as 15.
Units(MIN).
api_version Default:
"16.4.4"
Avi API version of to use for Avi API and objects.
appviewx_compat_mode
bool
    Choices:
  • no
  • yes
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
Number of attach_ip_retry_interval.
Default value when not specified in API or module is interpreted by Avi Controller as 360.
Units(SEC).
attach_ip_retry_limit
Number of attach_ip_retry_limit.
Default value when not specified in API or module is interpreted by Avi Controller as 4.
avi_api_patch_op
(added in 2.5)
    Choices:
  • add
  • replace
  • delete
Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method
(added in 2.5)
    Choices:
  • put ←
  • patch
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials
(added in 2.5)
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
bm_use_ansible
bool

(added in 2.5)
    Choices:
  • no
  • yes
Use ansible for se creation in baremetal.
Field introduced in 17.2.2.
Default value when not specified in API or module is interpreted by Avi Controller as True.
cluster_ip_gratuitous_arp_period
Number of cluster_ip_gratuitous_arp_period.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
Units(MIN).
controller Default:
""
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
crashed_se_reboot
Number of crashed_se_reboot.
Default value when not specified in API or module is interpreted by Avi Controller as 900.
Units(SEC).
dead_se_detection_timer
Number of dead_se_detection_timer.
Default value when not specified in API or module is interpreted by Avi Controller as 360.
Units(SEC).
dns_refresh_period
Number of dns_refresh_period.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
Units(MIN).
dummy
Number of dummy.
enable_memory_balancer
bool

(added in 2.6)
    Choices:
  • no
  • yes
Enable/disable memory balancer.
Field introduced in 17.2.8.
Default value when not specified in API or module is interpreted by Avi Controller as True.
fatal_error_lease_time
Number of fatal_error_lease_time.
Default value when not specified in API or module is interpreted by Avi Controller as 120.
Units(SEC).
max_dead_se_in_grp
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
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_attach_ip_failures
(added in 2.5)
Maximum number of consecutive attach ip failures that halts vs placement.
Field introduced in 17.2.2.
Default value when not specified in API or module is interpreted by Avi Controller as 3.
max_seq_vnic_failures
Number of max_seq_vnic_failures.
Default value when not specified in API or module is interpreted by Avi Controller as 3.
password Default:
""
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
persistence_key_rotate_period
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.
Units(MIN).
portal_token
(added in 2.4)
Token used for uploading tech-support to portal.
Field introduced in 16.4.6,17.1.2.
query_host_fail
Number of query_host_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 180.
Units(SEC).
safenet_hsm_version
(added in 2.5)
Version of the safenet package installed on the controller.
Field introduced in 16.5.2,17.2.3.
se_create_timeout
Number of se_create_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 900.
Units(SEC).
se_failover_attempt_interval
Interval between attempting failovers to an se.
Default value when not specified in API or module is interpreted by Avi Controller as 300.
Units(SEC).
se_offline_del
Number of se_offline_del.
Default value when not specified in API or module is interpreted by Avi Controller as 172000.
Units(SEC).
se_vnic_cooldown
Number of se_vnic_cooldown.
Default value when not specified in API or module is interpreted by Avi Controller as 120.
Units(SEC).
secure_channel_cleanup_timeout
Number of secure_channel_cleanup_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
Units(MIN).
secure_channel_controller_token_timeout
Number of secure_channel_controller_token_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
Units(MIN).
secure_channel_se_token_timeout
Number of secure_channel_se_token_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
Units(MIN).
seupgrade_fabric_pool_size
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
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.
Units(SEC).
ssl_certificate_expiry_warning_days
Number of days for ssl certificate expiry warning.
Units(DAYS).
state
    Choices:
  • absent
  • present ←
The state that should be applied on the entity.
tenant Default:
"admin"
Name of tenant used for all Avi API calls and context of object.
tenant_uuid Default:
""
UUID of tenant used for all Avi API calls and context of object.
unresponsive_se_reboot
Number of unresponsive_se_reboot.
Default value when not specified in API or module is interpreted by Avi Controller as 300.
Units(SEC).
upgrade_dns_ttl
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.
Units(SEC).
upgrade_lease_time
Number of upgrade_lease_time.
Default value when not specified in API or module is interpreted by Avi Controller as 360.
Units(SEC).
url
Avi controller URL of the object.
username Default:
""
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
Unique object identifier of the object.
vnic_op_fail_time
Number of vnic_op_fail_time.
Default value when not specified in API or module is interpreted by Avi Controller as 180.
Units(SEC).
vs_apic_scaleout_timeout
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.
Units(SEC).
vs_awaiting_se_timeout
Number of vs_awaiting_se_timeout.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
Units(SEC).
vs_key_rotate_period
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.
Units(MIN).
vs_se_attach_ip_fail
(added in 2.5)
Time to wait before marking attach ip operation on an se as failed.
Field introduced in 17.2.2.
Default value when not specified in API or module is interpreted by Avi Controller as 3600.
Units(SEC).
vs_se_bootup_fail
Number of vs_se_bootup_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 480.
Units(SEC).
vs_se_create_fail
Number of vs_se_create_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 1500.
Units(SEC).
vs_se_ping_fail
Number of vs_se_ping_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 60.
Units(SEC).
vs_se_vnic_fail
Number of vs_se_vnic_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 300.
Units(SEC).
vs_se_vnic_ip_fail
Number of vs_se_vnic_ip_fail.
Default value when not specified in API or module is interpreted by Avi Controller as 120.
Units(SEC).
warmstart_se_reconnect_wait_time
Number of warmstart_se_reconnect_wait_time.
Default value when not specified in API or module is interpreted by Avi Controller as 300.
Units(SEC).

Notes

Note

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, the following are the fields unique to this module:

Key Returned Description
obj
dict
success, changed
ControllerProperties (api/controllerproperties) object



Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.