community.network.avi_stringgroup – Module for setup of StringGroup Avi RESTful Object
Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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
Parameters
Parameter |
Comments |
---|---|
Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. |
|
Avi API version of to use for Avi API and objects. Default: “16.4.4” |
|
Patch operation to use when using avi_api_update_method as patch. Choices:
|
|
Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. Choices:
|
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. |
|
Avi controller version Default: “16.4.4” |
|
Avi controller IP or SQDN |
|
Avi controller API csrftoken to reuse existing session with session id |
|
Avi controller password |
|
Avi controller port |
|
Avi controller API session id to reuse existing session with csrftoken |
|
Avi controller tenant Default: “admin” |
|
Avi controller tenant UUID |
|
Avi controller request timeout Default: 300 |
|
Avi controller API token |
|
Avi controller username |
|
It disables avi session information to be cached as a fact. Choices:
|
|
IP address or hostname of the controller. The default value is the environment variable Default: “” |
|
User defined description for the object. |
|
Configure key value in the string group. |
|
Name of the string group. |
|
Password of Avi user in Avi controller. The default value is the environment variable Default: “” |
|
The state that should be applied on the entity. Choices:
|
|
Name of tenant used for all Avi API calls and context of object. Default: “admin” |
|
It is a reference to an object of type tenant. |
|
UUID of tenant used for all Avi API calls and context of object. Default: “” |
|
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. |
|
Avi controller URL of the object. |
|
Username used for accessing Avi controller. The default value is the environment variable Default: “” |
|
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 |
Description |
---|---|
StringGroup (api/stringgroup) object Returned: success, changed |
Authors
Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>