ansible / ansible.builtin / v2.9.3 / module / avi_controllerproperties Module for setup of ControllerProperties Avi RESTful Object | "added in version" 2.4 of ansible.builtin" Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com> preview | supported by communityansible.builtin.avi_controllerproperties (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
This module is used to configure ControllerProperties object
more examples at U(https://github.com/avinetworks/devops)
- name: Example to create ControllerProperties object avi_controllerproperties: controller: 10.10.25.42 username: admin password: something state: present name: sample_controllerproperties
url: description: - Avi controller URL of the object. uuid: description: - Unique object identifier of the object. dummy: description: - Number of dummy. state: choices: - absent - present default: present description: - The state that should be applied on the entity. tenant: default: admin description: - Name of tenant used for all Avi API calls and context of object. type: str password: default: '' description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). type: str username: default: '' description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). type: str controller: default: '' description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str api_context: description: - Avi API context that includes current session ID and CSRF Token. - This allows user to perform single login and re-use the session. type: dict api_version: default: 16.4.4 description: - Avi API version of to use for Avi API and objects. type: str tenant_uuid: default: '' description: - UUID of tenant used for all Avi API calls and context of object. type: str portal_token: description: - Token used for uploading tech-support to portal. - Field introduced in 16.4.6,17.1.2. version_added: '2.4' version_added_collection: ansible.builtin bm_use_ansible: description: - 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. type: bool version_added: '2.5' version_added_collection: ansible.builtin se_offline_del: description: - Number of se_offline_del. - Default value when not specified in API or module is interpreted by Avi Controller as 172000. avi_credentials: description: - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. suboptions: api_version: default: 16.4.4 description: - Avi controller version controller: description: - Avi controller IP or SQDN csrftoken: description: - Avi controller API csrftoken to reuse existing session with session id password: description: - Avi controller password port: description: - Avi controller port session_id: description: - Avi controller API session id to reuse existing session with csrftoken tenant: default: admin description: - Avi controller tenant tenant_uuid: description: - Avi controller tenant UUID timeout: default: 300 description: - Avi controller request timeout token: description: - Avi controller API token username: description: - Avi controller username type: dict cloud_reconcile: description: - Enable/disable periodic reconcile for all the clouds. - Field introduced in 17.2.14,18.1.5,18.2.1. - Default value when not specified in API or module is interpreted by Avi Controller as True. type: bool version_added: '2.9' version_added_collection: ansible.builtin query_host_fail: description: - Number of query_host_fail. - Default value when not specified in API or module is interpreted by Avi Controller as 180. upgrade_dns_ttl: description: - 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. vs_se_ping_fail: description: - 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: description: - Number of vs_se_vnic_fail. - Default value when not specified in API or module is interpreted by Avi Controller as 300. api_idle_timeout: description: - Allowed values are 0-1440. - Default value when not specified in API or module is interpreted by Avi Controller as 15. avi_api_patch_op: choices: - add - replace - delete description: - Patch operation to use when using avi_api_update_method as patch. version_added: '2.5' version_added_collection: ansible.builtin se_vnic_cooldown: description: - Number of se_vnic_cooldown. - Default value when not specified in API or module is interpreted by Avi Controller as 120. crashed_se_reboot: description: - Number of crashed_se_reboot. - Default value when not specified in API or module is interpreted by Avi Controller as 900. se_create_timeout: description: - Number of se_create_timeout. - Default value when not specified in API or module is interpreted by Avi Controller as 900. vnic_op_fail_time: description: - Number of vnic_op_fail_time. - Default value when not specified in API or module is interpreted by Avi Controller as 180. vs_se_bootup_fail: description: - Number of vs_se_bootup_fail. - Default value when not specified in API or module is interpreted by Avi Controller as 480. vs_se_create_fail: description: - Number of vs_se_create_fail. - Default value when not specified in API or module is interpreted by Avi Controller as 1500. dns_refresh_period: description: - Period for refresh pool and gslb dns job. - Default value when not specified in API or module is interpreted by Avi Controller as 60. max_dead_se_in_grp: description: - Number of max_dead_se_in_grp. - Default value when not specified in API or module is interpreted by Avi Controller as 1. upgrade_lease_time: description: - Number of upgrade_lease_time. - Default value when not specified in API or module is interpreted by Avi Controller as 360. vs_se_vnic_ip_fail: description: - Number of vs_se_vnic_ip_fail. - Default value when not specified in API or module is interpreted by Avi Controller as 120. allow_ip_forwarding: description: - Field introduced in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. type: bool enable_api_sharding: description: - This setting enables the controller leader to shard api requests to the followers (if any). - Field introduced in 18.1.5, 18.2.1. - Default value when not specified in API or module is interpreted by Avi Controller as True. type: bool version_added: '2.9' version_added_collection: ansible.builtin max_pcap_per_tenant: description: - Maximum number of pcap files stored per tenant. - Default value when not specified in API or module is interpreted by Avi Controller as 4. safenet_hsm_version: description: - Version of the safenet package installed on the controller. - Field introduced in 16.5.2,17.2.3. version_added: '2.5' version_added_collection: ansible.builtin se_from_marketplace: description: - This setting decides whether se is to be deployed from the cloud marketplace or to be created by the controller. - The setting is applicable only when byol license is selected. - Enum options - MARKETPLACE, IMAGE. - Field introduced in 18.1.4, 18.2.1. - Default value when not specified in API or module is interpreted by Avi Controller as IMAGE. version_added: '2.9' version_added_collection: ansible.builtin appviewx_compat_mode: description: - 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. type: bool vs_key_rotate_period: description: - Period for rotate vs keys job. - 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 360. vs_se_attach_ip_fail: description: - 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 600. version_added: '2.5' version_added_collection: ansible.builtin attach_ip_retry_limit: description: - Number of attach_ip_retry_limit. - Default value when not specified in API or module is interpreted by Avi Controller as 4. avi_api_update_method: choices: - put - patch default: put description: - Default method for object update is HTTP PUT. - Setting to patch will override that behavior to use HTTP PATCH. version_added: '2.5' version_added_collection: ansible.builtin max_seq_vnic_failures: description: - Number of max_seq_vnic_failures. - Default value when not specified in API or module is interpreted by Avi Controller as 3. enable_memory_balancer: description: - 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. type: bool version_added: '2.6' version_added_collection: ansible.builtin fatal_error_lease_time: description: - Number of fatal_error_lease_time. - Default value when not specified in API or module is interpreted by Avi Controller as 120. unresponsive_se_reboot: description: - Number of unresponsive_se_reboot. - Default value when not specified in API or module is interpreted by Avi Controller as 300. vs_awaiting_se_timeout: description: - Number of vs_awaiting_se_timeout. - Default value when not specified in API or module is interpreted by Avi Controller as 60. dead_se_detection_timer: description: - Number of dead_se_detection_timer. - Default value when not specified in API or module is interpreted by Avi Controller as 360. attach_ip_retry_interval: description: - Number of attach_ip_retry_interval. - Default value when not specified in API or module is interpreted by Avi Controller as 360. vs_apic_scaleout_timeout: description: - 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. allow_unauthenticated_apis: description: - Allow unauthenticated access for special apis. - Default value when not specified in API or module is interpreted by Avi Controller as False. type: bool api_perf_logging_threshold: description: - Threshold to log request timing in portal_performance.log and server-timing response header. - Any stage taking longer than 1% of the threshold will be included in the server-timing header. - Field introduced in 18.1.4, 18.2.1. - Default value when not specified in API or module is interpreted by Avi Controller as 10000. version_added: '2.9' version_added_collection: ansible.builtin max_seq_attach_ip_failures: description: - 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. version_added: '2.5' version_added_collection: ansible.builtin seupgrade_fabric_pool_size: description: - 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. allow_unauthenticated_nodes: description: - Boolean flag to set allow_unauthenticated_nodes. - Default value when not specified in API or module is interpreted by Avi Controller as False. type: bool se_failover_attempt_interval: description: - Interval between attempting failovers to an se. - Default value when not specified in API or module is interpreted by Avi Controller as 300. persistence_key_rotate_period: description: - Period for rotate app persistence keys job. - 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 0. warmstart_vs_resync_wait_time: description: - Timeout for warmstart vs resync. - Field introduced in 18.1.4, 18.2.1. - Default value when not specified in API or module is interpreted by Avi Controller as 300. version_added: '2.9' version_added_collection: ansible.builtin secure_channel_cleanup_timeout: description: - Period for secure channel cleanup job. - Default value when not specified in API or module is interpreted by Avi Controller as 60. cleanup_sessions_timeout_period: description: - Period for sessions cleanup job. - Field introduced in 18.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as 60. version_added: '2.9' version_added_collection: ansible.builtin secure_channel_se_token_timeout: description: - Number of secure_channel_se_token_timeout. - Default value when not specified in API or module is interpreted by Avi Controller as 60. cluster_ip_gratuitous_arp_period: description: - Period for cluster ip gratuitous arp job. - Default value when not specified in API or module is interpreted by Avi Controller as 60. consistency_check_timeout_period: description: - Period for consistency check job. - Field introduced in 18.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as 60. version_added: '2.9' version_added_collection: ansible.builtin vs_scaleout_ready_check_interval: description: - Interval for checking scaleout_ready status while controller is waiting for scaleoutready rpc from the service engine. - Field introduced in 18.2.2. - Default value when not specified in API or module is interpreted by Avi Controller as 60. version_added: '2.9' version_added_collection: ansible.builtin warmstart_se_reconnect_wait_time: description: - Number of warmstart_se_reconnect_wait_time. - Default value when not specified in API or module is interpreted by Avi Controller as 480. avi_disable_session_cache_as_fact: default: false description: - It disables avi session information to be cached as a fact. type: bool process_pki_profile_timeout_period: description: - Period for process pki profile job. - Field introduced in 18.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as 1440. version_added: '2.9' version_added_collection: ansible.builtin seupgrade_segroup_min_dead_timeout: description: - 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: description: - Number of days for ssl certificate expiry warning. secure_channel_controller_token_timeout: description: - Number of secure_channel_controller_token_timeout. - Default value when not specified in API or module is interpreted by Avi Controller as 60. cleanup_expired_authtoken_timeout_period: description: - Period for auth token cleanup job. - Field introduced in 18.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as 60. version_added: '2.9' version_added_collection: ansible.builtin process_locked_useraccounts_timeout_period: description: - Period for process locked user accounts job. - Field introduced in 18.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as 1. version_added: '2.9' version_added_collection: ansible.builtin
obj: description: ControllerProperties (api/controllerproperties) object returned: success, changed type: dict