Documentation

avi_vsdatascriptset - Module for setup of VSDataScriptSet Avi RESTful Object

New in version 2.4.

Synopsis

Options

parameter required default choices comments
api_version
no
Avi API version of to use for Avi API and objects.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
datascript
no
Datascripts to execute.
description
no
User defined description for the object.
ipgroup_refs
no
Uuid of ip groups that could be referred by vsdatascriptset objects.
It is a reference to an object of type ipaddrgroup.
name
yes
Name for the virtual service datascript collection.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
pool_group_refs
no
Uuid of pool groups that could be referred by vsdatascriptset objects.
It is a reference to an object of type poolgroup.
pool_refs
no
Uuid of pools that could be referred by vsdatascriptset objects.
It is a reference to an object of type pool.
state
no present
  • absent
  • present
The state that should be applied on the entity.
string_group_refs
no
Uuid of string groups that could be referred by vsdatascriptset objects.
It is a reference to an object of type stringgroup.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
no
It is a reference to an object of type tenant.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Uuid of the virtual service datascript collection.

Examples

- name: Example to create VSDataScriptSet object
  avi_vsdatascriptset:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_vsdatascriptset

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj VSDataScriptSet (api/vsdatascriptset) object success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.