community.network.avi_stringgroup – Module for setup of StringGroup Avi RESTful Object
Note
This plugin is part of the community.network collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.avi_stringgroup.
Synopsis
- This module is used to configure StringGroup object
- more examples at https://github.com/avinetworks/devops
Requirements
The below requirements are needed on the host that executes this module.
- avisdk
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| api_context
dictionary
|
Avi API context that includes current session ID and CSRF Token.
This allows user to perform single login and re-use the session.
|
||
| api_version
string
|
Default:
"16.4.4"
|
Avi API version of to use for Avi API and objects.
|
|
| avi_api_patch_op
string
|
|
Patch operation to use when using avi_api_update_method as patch.
|
|
| avi_api_update_method
string
|
|
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
|
|
| avi_credentials
dictionary
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
||
| api_version
string
|
Default:
"16.4.4"
|
Avi controller version
|
|
| controller
string
|
Avi controller IP or SQDN
|
||
| csrftoken
string
|
Avi controller API csrftoken to reuse existing session with session id
|
||
| password
string
|
Avi controller password
|
||
| port
string
|
Avi controller port
|
||
| session_id
string
|
Avi controller API session id to reuse existing session with csrftoken
|
||
| tenant
string
|
Default:
"admin"
|
Avi controller tenant
|
|
| tenant_uuid
string
|
Avi controller tenant UUID
|
||
| timeout
string
|
Default:
300
|
Avi controller request timeout
|
|
| token
string
|
Avi controller API token
|
||
| username
string
|
Avi controller username
|
||
| avi_disable_session_cache_as_fact
boolean
|
|
It disables avi session information to be cached as a fact.
|
|
| controller
string
|
Default:
""
|
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
|
|
| description
string
|
User defined description for the object.
|
||
| kv
string
|
Configure key value in the string group.
|
||
| name
string / required
|
Name of the string group.
|
||
| password
string
|
Default:
""
|
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
|
|
| state
string
|
|
The state that should be applied on the entity.
|
|
| tenant
string
|
Default:
"admin"
|
Name of tenant used for all Avi API calls and context of object.
|
|
| tenant_ref
string
|
It is a reference to an object of type tenant.
|
||
| tenant_uuid
string
|
Default:
""
|
UUID of tenant used for all Avi API calls and context of object.
|
|
| type
string / required
|
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.
|
||
| url
string
|
Avi controller URL of the object.
|
||
| username
string
|
Default:
""
|
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
|
|
| uuid
string
|
Uuid of the string group.
|
||
Notes
Note
- For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.
Examples
- name: Create a string group configuration
community.network.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
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| obj
dictionary
|
success, changed |
StringGroup (api/stringgroup) object
|
Authors
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/avi_stringgroup_module.html