avi_dnspolicy – Module for setup of DnsPolicy Avi RESTful Object
New in version 2.4.
Synopsis
- This module is used to configure DnsPolicy 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 dictionary 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 string | Default: "16.4.4" | Avi API version of to use for Avi API and objects. |
| avi_api_patch_op - added in 2.5 |
| Patch operation to use when using avi_api_update_method as patch. |
| avi_api_update_method - added in 2.5 |
| Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. |
| avi_credentials dictionary added in 2.5 | Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
| controller string | Default: "" | IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER. |
| created_by - | Creator name. Field introduced in 17.1.1. | |
| description - | Field introduced in 17.1.1. | |
| name - / required | Name of the dns policy. Field introduced in 17.1.1. | |
| password string | Default: "" | Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD. |
| rule - | Dns rules. Field introduced in 17.1.1. | |
| state - |
| The state that should be applied on the entity. |
| tenant string | 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 string | Default: "" | UUID of tenant used for all Avi API calls and context of object. |
| url - | Avi controller URL of the object. | |
| username string | Default: "" | Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME. |
| uuid - | Uuid of the dns policy. 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 DnsPolicy object
avi_dnspolicy:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_dnspolicy
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| obj dictionary | success, changed | DnsPolicy (api/dnspolicy) object |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
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.8/modules/avi_dnspolicy_module.html