community / community.network / 5.0.2 / module / avi_tenant Module for setup of Tenant Avi RESTful Object Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>community.network.avi_tenant (5.0.2) — module
Install with ansible-galaxy collection install community.network:==5.0.2
collections: - name: community.network version: 5.0.2
This module is used to configure Tenant object
more examples at U(https://github.com/avinetworks/devops)
- name: Create Tenant using Service Engines in provider mode community.network.avi_tenant: controller: '{{ controller }}' password: '{{ password }}' username: '{{ username }}' config_settings: se_in_provider_context: false tenant_access_to_provider_se: true tenant_vrf: false description: VCenter, Open Stack, AWS Virtual services local: true name: Demo
url: description: - Avi controller URL of the object. name: description: - Name of the object. required: true uuid: description: - Unique object identifier of the object. local: description: - Boolean flag to set local. - Default value when not specified in API or module is interpreted by Avi Controller as True. type: bool 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: description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). type: str username: description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). type: str controller: description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str created_by: description: - Creator of this tenant. 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 description: description: - User defined description for the object. 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: default: '' description: - Avi controller API csrftoken to reuse existing session with session id password: description: - Avi controller password port: description: - Avi controller port session_id: default: '' description: - Avi controller API session id to reuse existing session with csrftoken tenant: default: admin description: - Avi controller tenant tenant_uuid: default: '' description: - Avi controller tenant UUID timeout: default: 300 description: - Avi controller request timeout token: default: '' description: - Avi controller API token username: description: - Avi controller username type: dict config_settings: description: - Tenantconfiguration settings for tenant. avi_api_patch_op: choices: - add - replace - delete description: - Patch operation to use when using avi_api_update_method as patch. 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. avi_disable_session_cache_as_fact: default: false description: - It disables avi session information to be cached as a fact. type: bool
obj: description: Tenant (api/tenant) object returned: success, changed type: dict