On this page
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 (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 .
|
||
created_by |
no |
Creator name.
Field introduced in 17.1.1.
|
||
description |
no |
Field introduced in 17.1.1.
|
||
name |
no |
Name of the dns policy.
Field introduced in 17.1.1.
|
||
password |
no |
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD .
|
||
rule |
no |
Dns rules.
Field introduced in 17.1.1.
|
||
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 dns policy.
Field introduced in 17.1.1.
|
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 Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
obj |
DnsPolicy (api/dnspolicy) 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_dnspolicy_module.html