Skip to content

Latest commit

 

History

History
588 lines (567 loc) · 24.6 KB

avi_ipamdnsproviderprofile.rst

File metadata and controls

588 lines (567 loc) · 24.6 KB

vmware.alb.avi_ipamdnsproviderprofile

Module for setup of IpamDnsProviderProfile Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
allocate_ip_in_vrf
bool
- If this flag is set, only allocate ip from networks in the virtual service vrf.
- Applicable for avi vantage ipam only.
- Field introduced in 17.2.4.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
aws_profile
dict
- Provider details if type is aws.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
azure_profile
dict
- Provider details if type is microsoft azure.
- Field introduced in 17.2.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
custom_profile
dict
- Provider details if type is custom.
- Field introduced in 17.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
gcp_profile
dict
- Provider details if type is google cloud.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
infoblox_profile
dict
- Provider details if type is infoblox.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
internal_profile
dict
- Provider details if type is avi.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
markers
list
- List of labels to be used for granular rbac.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
name
str
required: true
- Name for the ipam/dns provider profile.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
oci_profile
dict
- Provider details for oracle cloud.
- Field introduced in 18.2.1,18.1.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
openstack_profile
dict
- Provider details if type is openstack.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
proxy_configuration
dict
- Field introduced in 17.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tenant_ref
str
- It is a reference to an object of type tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tencent_profile
dict
- Provider details for tencent cloud.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
type
str
required: true
- 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_AZURE, IPAMDNS_TYPE_OCI, IPAMDNS_TYPE_TENCENT, IPAMDNS_TYPE_INTERNAL, IPAMDNS_TYPE_INTERNAL_DNS,
- IPAMDNS_TYPE_AWS_DNS, IPAMDNS_TYPE_AZURE_DNS.
- Allowed in enterprise edition with any value, essentials edition(allowed values- ipamdns_type_internal), basic edition(allowed values-
- ipamdns_type_internal), enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of the ipam/dns provider profile.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "{{ username }}"
      password: "{{ password }}"
      controller: "{{ controller }}"
      api_version: "{{ api_version }}"
  tasks:
    - name: Create IPAM DNS provider setting
      avi_ipamdnsproviderprofile:
        avi_credentials: "{{ avi_credentials }}"
        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: /api/tenant?name=Demo
        type: IPAMDNS_TYPE_INTERNAL

Authors