ansible / ansible.builtin / v2.9.3 / module / avi_vsvip Module for setup of VsVip Avi RESTful Object | "added in version" 2.4 of ansible.builtin" Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com> preview | supported by communityansible.builtin.avi_vsvip (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
This module is used to configure VsVip object
more examples at U(https://github.com/avinetworks/devops)
- name: Example to create VsVip object avi_vsvip: controller: 10.10.25.42 username: admin password: something state: present name: sample_vsvip
url: description: - Avi controller URL of the object. vip: description: - List of virtual service ips and other shareable entities. - Field introduced in 17.1.1. name: description: - Name for the vsvip object. - Field introduced in 17.1.1. required: true uuid: description: - Uuid of the vsvip object. - Field introduced in 17.1.1. 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 dns_info: description: - Service discovery specific data including fully qualified domain name, type and time-to-live of the dns record. - Field introduced in 17.1.1. 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 cloud_ref: description: - It is a reference to an object of type cloud. - Field introduced in 17.1.1. controller: default: '' description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str tenant_ref: description: - It is a reference to an object of type tenant. - Field introduced in 17.1.1. 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 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 vrf_context_ref: description: - Virtual routing context that the virtual service is bound to. - This is used to provide the isolation of the set of networks the application is attached to. - It is a reference to an object of type vrfcontext. - Field introduced in 17.1.1. 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 use_standard_alb: description: - This overrides the cloud level default and needs to match the se group value in which it will be used if the se group use_standard_alb value is - set. - This is only used when fip is used for vs on azure cloud. - Field introduced in 18.2.3. type: bool version_added: '2.9' version_added_collection: ansible.builtin east_west_placement: description: - Force placement on all service engines in the service engine group (container clouds only). - Field introduced in 17.1.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. type: bool 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 vsvip_cloud_config_cksum: description: - Checksum of cloud configuration for vsvip. - Internally set by cloud connector. - Field introduced in 17.2.9, 18.1.2. version_added: '2.9' version_added_collection: ansible.builtin avi_disable_session_cache_as_fact: default: false description: - It disables avi session information to be cached as a fact. type: bool
obj: description: VsVip (api/vsvip) object returned: success, changed type: dict