ansible / ansible.builtin / v2.9.3 / module / avi_stringgroup Module for setup of StringGroup Avi RESTful Object | "added in version" 2.4 of ansible.builtin" Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com> preview | supported by communityansible.builtin.avi_stringgroup (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
This module is used to configure StringGroup object
more examples at U(https://github.com/avinetworks/devops)
- name: Create a string group configuration avi_stringgroup: controller: '{{ controller }}' password: '{{ password }}' username: '{{ username }}' kv: - key: text/html - key: text/xml - key: text/plain - key: text/css - key: text/javascript - key: application/javascript - key: application/x-javascript - key: application/xml - key: application/pdf name: System-Compressible-Content-Types tenant_ref: admin type: SG_TYPE_STRING
kv: description: - Configure key value in the string group. url: description: - Avi controller URL of the object. name: description: - Name of the string group. required: true type: description: - Type of stringgroup. - Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. - Default value when not specified in API or module is interpreted by Avi Controller as SG_TYPE_STRING. required: true uuid: description: - Uuid of the string group. 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 tenant_ref: description: - It is a reference to an object of type 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: 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 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 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 avi_disable_session_cache_as_fact: default: false description: - It disables avi session information to be cached as a fact. type: bool
obj: description: StringGroup (api/stringgroup) object returned: success, changed type: dict