avi_vsvip - Module for setup of VsVip Avi RESTful Object¶

New in version 2.4.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

This module is used to configure VsVip 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 (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)	Choices: add replace delete	Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method (added in 2.5)	Choices: 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.
cloud_ref		It is a reference to an object of type cloud. Field introduced in 17.1.1.
controller	Default: ""	IP address or hostname of the controller. The default value is the environment variable `AVI_CONTROLLER`.
dns_info		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 bool	Choices: no yes	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 required		Name for the vsvip object. Field introduced in 17.1.1.
password	Default: ""	Password of Avi user in Avi controller. The default value is the environment variable `AVI_PASSWORD`.
state	Choices: 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. Field introduced in 17.1.1.
tenant_uuid	Default: ""	UUID of tenant used for all Avi API calls and context of object.
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 vsvip object. Field introduced in 17.1.1.
vip		List of virtual service ips and other shareable entities. Field introduced in 17.1.1.
vrf_context_ref		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.

Notes ¶

Note

For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.

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, the following are the fields unique to this module:

Key	Returned	Description
obj dict	success, changed	VsVip (api/vsvip) object

Status ¶

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

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Gaurav Rastogi (grastogi@avinetworks.com)

Hint

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