avi_stringgroup – Module for setup of StringGroup Avi RESTful Object

From Get docs
Ansible/docs/2.7/modules/avi stringgroup module


avi_stringgroup – Module for setup of StringGroup Avi RESTful Object

New in version 2.4.


Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • avisdk

Parameters

Parameter Choices/Defaults Comments

api_context

-

added in 2.5

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

-

Default:

"16.4.4"

Avi API version of to use for Avi API and objects.

avi_api_patch_op

-

added in 2.5

  • add
  • replace
  • delete

Patch operation to use when using avi_api_update_method as patch.

avi_api_update_method

-

added in 2.5

  • put

  • patch

Default method for object update is HTTP PUT.

Setting to patch will override that behavior to use HTTP PATCH.

avi_credentials

-

added in 2.5

Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.

controller

-

Default:

""

IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.

description

-

User defined description for the object.

kv

-

Configure key value in the string group.

name

- / required

Name of the string group.

password

-

Default:

""

Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.

state

-

  • absent
  • present

The state that should be applied on the entity.

tenant

-

Default:

"admin"

Name of tenant used for all Avi API calls and context of object.

tenant_ref

-

It is a reference to an object of type tenant.

tenant_uuid

-

Default:

""

UUID of tenant used for all Avi API calls and context of object.

type

- / 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

-

Avi controller URL of the object.

username

-

Default:

""

Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.

uuid

-

Uuid of the string group.



Notes

Note


Examples

- 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

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





Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/avi_stringgroup_module.html