IpamDnsProviderProfile

Description

API


    POST /api/ipamdnsproviderprofile
    PUT /api/ipamdnsproviderprofile/<key>
    DELETE /api/ipamdnsproviderprofile/<key>
    GET /api/ipamdnsproviderprofile
    GET /api/ipamdnsproviderprofile/<key>

CLI


    configure ipamdnsproviderprofile <key>
    show ipamdnsproviderprofile <key>

Data

IpamDnsProviderProfile

uuid

Type
string
Category
required
Description
UUID of the IPAM/DNS Provider profile

name

Type
string
Category
required
Description
Name for the IPAM/DNS Provider profile

type

Type
enum
Category
required
Description
Provider Type for the IPAM/DNS Provider profile
Choices
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

infoblox_profile

Type
IpamDnsInfobloxProfile
Category
optional
Description
Provider details if type is Infoblox

aws_profile

Type
IpamDnsAwsProfile
Category
optional
Description
Provider details if type is AWS

openstack_profile

Type
IpamDnsOpenstackProfile
Category
optional
Description
Provider details if type is OpenStack

internal_profile

Type
IpamDnsInternalProfile
Category
optional
Description
Provider details if type is Avi

gcp_profile

Type
IpamDnsGCPProfile
Category
optional
Description
Provider details if type is Google Cloud

custom_profile

Type
IpamDnsCustomProfile
Category
optional
Description
Provider details if type is Custom

proxy_configuration

Type
ProxyConfiguration
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
required
Description

IpamDnsInfobloxProfile

ip_address

Type
IpAddr
Category
required
Description
Address of Infoblox appliance

username

Type
string
Category
required
Description
Username for API access for Infoblox appliance

password

Type
string
Category
required
Description
Password for API access for Infoblox appliance

wapi_version

Type
string
Category
optional
Description
WAPI version
Default
2.0

dns_view

Type
string
Category
optional
Description
DNS view
Default
default

network_view

Type
string
Category
optional
Description
Network view
Default
default

usable_subnets

Type
IpAddrPrefix
Category
repeated
Description
Usable subnets to pick from Infoblox

usable_domains

Type
string
Category
repeated
Description
Usable domains to pick from Infoblox

IpAddr

addr

Type
string
Category
required
Description
IP address

type

Type
enum
Category
required
Description
Choices
V4, DNS

IpAddrPrefix

ip_addr

Type
IpAddr
Category
required
Description

mask

Type
int32
Category
required
Description

IpamDnsAwsProfile

region

Type
string
Category
optional
Description
AWS region

vpc

Type
string
Category
optional
Description
VPC name

vpc_id

Type
string
Category
required
Description
VPC ID

use_iam_roles

Type
bool
Category
optional
Description

access_key_id

Type
string
Category
optional
Description
AWS access key ID

secret_access_key

Type
string
Category
optional
Description
AWS secret access key

usable_network_uuids

Type
string
Category
repeated
Description
Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation.

usable_domains

Type
string
Category
repeated
Description
Usable domains to pick from Amazon Route 53

iam_assume_role

Type
string
Category
optional
Description
IAM assume role for cross-account access.

IpamDnsOpenstackProfile

username

Type
string
Category
optional
Description
The username Avi Vantage will use when authenticating to Keystone.

password

Type
string
Category
optional
Description
The password Avi Vantage will use when authenticating to Keystone.

tenant

Type
string
Category
optional
Description
OpenStack tenant name

keystone_host

Type
string
Category
optional
Description
Keystone's hostname or IP address.

vip_network_name

Type
string
Category
optional
Description
Network to be used for VIP allocation

region

Type
string
Category
optional
Description
Region name

IpamDnsInternalProfile

dns_service_domain

Type
DnsServiceDomain
Category
repeated
Description
List of service domains

ttl

Type
uint32
Category
optional
Description
Default TTL for all records, overridden by TTL value for each service domain configured in DnsServiceDomain.
Units
sec
Default
30

dns_virtualservice_uuid

Type
string
Category
optional
Description
Avi VirtualService to be used for serving DNS records.

usable_network_uuids

Type
string
Category
repeated
Description
Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation.

DnsServiceDomain

domain_name

Type
string
Category
required
Description
Service domain string used for FQDN

record_ttl

Type
uint32
Category
optional
Description
TTL value for DNS records
Units
sec

num_dns_ip

Type
uint32
Category
optional
Description
Specifies the number of A records returned by Avi DNS Service.
Default
1

pass_through

Type
bool
Category
optional
Description
Third-party Authoritative domain requests are delegated toDNS VirtualService's pool of nameservers.
Default
True

IpamDnsGCPProfile

usable_network_uuids

Type
string
Category
repeated
Description
Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation.

match_se_group_subnet

Type
bool
Category
optional
Description
Match SE group subnets for VIP placement. Default is to not match SE group subnets.
Default
False

IpamDnsCustomProfile

custom_ipam_dns_profile_ref

Type
Reference to CustomIpamDnsProfile
Category
optional
Description

custom_ipam_dns_params

Type
CustomParams
Category
repeated
Description
Custom parameters that will passed for the IPAM/DNS provider including but not limited to provider credentials and API version.

CustomParams

name

Type
string
Category
required
Description

value

Type
string
Category
optional
Description

is_sensitive

Type
bool
Category
optional
Description
Default
False

is_dynamic

Type
bool
Category
optional
Description
Default
False

ProxyConfiguration

host

Type
string
Category
required
Description
Proxy hostname or IP address

port

Type
uint32
Category
required
Description
Proxy port

username

Type
string
Category
optional
Description
Username for proxy

password

Type
string
Category
optional
Description
Password for proxy

References

CustomIpamDnsProfile Tenant

Sub Objects