W3cubDocs

/Ansible

avi_ipamdnsproviderprofile - Module for setup of IpamDnsProviderProfile Avi RESTful Object

New in version 2.4.

Synopsis

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.
aws_profile
 no
Provider details if type is aws.
controller
 no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
custom_profile
 no
Provider details if type is custom.
Field introduced in 17.1.1.
gcp_profile
 no
Provider details if type is google cloud.
infoblox_profile
 no
Provider details if type is infoblox.
internal_profile
 no
Provider details if type is avi.
name
 yes
Name for the ipam/dns provider profile.
openstack_profile
 no
Provider details if type is openstack.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
proxy_configuration
 no
Field introduced in 17.1.1.
state
 no present
  • absent
  • 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.
tenant_uuid
 no
UUID of tenant used for all Avi API calls and context of object.
type
 yes
Provider type for the ipam/dns provider profile.
Enum options - IPAMDNS_TYPE_INFOBLOX, IPAMDNS_TYPE_AWS, IPAMDNS_TYPE_OPENSTACK, IPAMDNS_TYPE_GCP, IPAMDNS_TYPE_INFOBLOX_DNS, IPAMDNS_TYPE_CUSTOM,
IPAMDNS_TYPE_CUSTOM_DNS, IPAMDNS_TYPE_INTERNAL, IPAMDNS_TYPE_INTERNAL_DNS, IPAMDNS_TYPE_AWS_DNS.
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 ipam/dns provider profile.

Examples

- name: Create IPAM DNS provider setting
  avi_ipamdnsproviderprofile:
    controller: ''
    username: ''
    password: ''
    internal_profile:
      dns_service_domain:
      - domain_name: ashish.local
        num_dns_ip: 1
        pass_through: true
        record_ttl: 100
      - domain_name: guru.local
        num_dns_ip: 1
        pass_through: true
        record_ttl: 200
      ttl: 300
    name: Ashish-DNS
    tenant_ref: Demo
    type: IPAMDNS_TYPE_INTERNAL

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
IpamDnsProviderProfile (api/ipamdnsproviderprofile) 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–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/avi_ipamdnsproviderprofile_module.html