avi_gslbgeodbprofile - Module for setup of GslbGeoDbProfile Avi RESTful Object
New in version 2.4.
Synopsis
- This module is used to configure GslbGeoDbProfile 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. | ||
| controller | no | IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER. | ||
| description | no | Field introduced in 17.1.1. | ||
| entries | no | List of geodb entries. An entry can either be a geodb file or an ip address group with geo properties. Field introduced in 17.1.1. | ||
| is_federated | no | This field indicates that this object is replicated across gslb federation. Field introduced in 17.1.3. Default value when not specified in API or module is interpreted by Avi Controller as True. | ||
| name | yes | A user-friendly name for the geodb profile. 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 geodb profile. Field introduced in 17.1.1. |
Examples
- name: Example to create GslbGeoDbProfile object
avi_gslbgeodbprofile:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_gslbgeodbprofile
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 | GslbGeoDbProfile (api/gslbgeodbprofile) 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_gslbgeodbprofile_module.html