avi_vsvip - Module for setup of VsVip Avi RESTful Object
New in version 2.4.
Synopsis
- This module is used to configure VsVip object
- more examples at https://github.com/avinetworks/devops
Requirements (on host that executes module)
- avisdk
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| api_version | no | Avi API version of to use for Avi API and objects. | ||
| cloud_ref | no | It is a reference to an object of type cloud. Field introduced in 17.1.1. | ||
| controller | no | IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER. | ||
| dns_info | no | Service discovery specific data including fully qualified domain name, type and time-to-live of the dns record. Field introduced in 17.1.1. | ||
| east_west_placement | no | Force placement on all service engines in the service engine group (container clouds only). Field introduced in 17.1.1. Default value when not specified in API or module is interpreted by Avi Controller as False. | ||
| name | yes | Name for the vsvip object. Field introduced in 17.1.1. | ||
| password | no | Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD. | ||
| state | no | present |
| The state that should be applied on the entity. |
| 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. Field introduced in 17.1.1. | ||
| 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 vsvip object. Field introduced in 17.1.1. | ||
| vip | no | List of virtual service ips and other shareable entities. Field introduced in 17.1.1. | ||
| vrf_context_ref | no | Virtual routing context that the virtual service is bound to. This is used to provide the isolation of the set of networks the application is attached to. It is a reference to an object of type vrfcontext. Field introduced in 17.1.1. |
Examples
- name: Example to create VsVip object
avi_vsvip:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_vsvip
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 | VsVip (api/vsvip) object | success, changed | dict |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_vsvip_module.html