Avi IpamDnsProviderProfile Object API

##CLI## ``` - configure ipamdnsproviderprofile - show ipamdnsproviderprofile ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /ipamdnsproviderprofile
  2. post /ipamdnsproviderprofile
  3. delete /ipamdnsproviderprofile/{uuid}
  4. get /ipamdnsproviderprofile/{uuid}
  5. patch /ipamdnsproviderprofile/{uuid}
  6. put /ipamdnsproviderprofile/{uuid}
Up
get /ipamdnsproviderprofile
( ipamdnsproviderprofileGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

IpamDnsProviderProfileApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "aws_profile" : {
      "access_key_id" : "aeiou",
      "iam_assume_role" : "aeiou",
      "vpc_id" : "aeiou",
      "use_iam_roles" : true,
      "secret_access_key" : "aeiou",
      "vpc" : "aeiou",
      "region" : "aeiou",
      "zones" : [ {
        "availability_zone" : "aeiou",
        "usable_network_uuids" : [ "aeiou" ]
      } ],
      "ttl" : 123,
      "usable_domains" : [ "aeiou" ],
      "usable_network_uuids" : [ "aeiou" ]
    },
    "gcp_profile" : {
      "match_se_group_subnet" : true,
      "usable_network_refs" : [ "aeiou" ]
    },
    "allocate_ip_in_vrf" : true,
    "type" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "custom_profile" : {
      "usable_subnets" : [ {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      } ],
      "dynamic_params" : [ {
        "is_sensitive" : true,
        "is_dynamic" : true,
        "name" : "aeiou",
        "value" : "aeiou"
      } ],
      "custom_ipam_dns_profile_ref" : "aeiou",
      "usable_domains" : [ "aeiou" ]
    },
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "internal_profile" : {
      "dns_service_domain" : [ {
        "domain_name" : "aeiou",
        "pass_through" : true,
        "num_dns_ip" : 123,
        "record_ttl" : 123
      } ],
      "dns_virtualservice_ref" : "aeiou",
      "usable_network_refs" : [ "aeiou" ],
      "ttl" : 123
    },
    "proxy_configuration" : {
      "password" : "aeiou",
      "port" : 123,
      "host" : "aeiou",
      "username" : "aeiou"
    },
    "infoblox_profile" : {
      "network_view" : "aeiou",
      "password" : "aeiou",
      "usable_subnets" : [ "" ],
      "dns_view" : "aeiou",
      "ip_address" : "",
      "usable_domains" : [ "aeiou" ],
      "username" : "aeiou",
      "wapi_version" : "aeiou"
    },
    "azure_profile" : {
      "subscription_id" : "aeiou",
      "use_enhanced_ha" : true,
      "resource_group" : "aeiou",
      "azure_userpass" : {
        "password" : "aeiou",
        "tenant_name" : "aeiou",
        "username" : "aeiou"
      },
      "virtual_network_ids" : [ "aeiou" ],
      "azure_serviceprincipal" : {
        "tenant_id" : "aeiou",
        "authentication_token" : "aeiou",
        "application_id" : "aeiou"
      },
      "usable_domains" : [ "aeiou" ],
      "usable_network_uuids" : [ "aeiou" ]
    },
    "openstack_profile" : {
      "password" : "aeiou",
      "keystone_host" : "aeiou",
      "vip_network_name" : "aeiou",
      "region" : "aeiou",
      "tenant" : "aeiou",
      "username" : "aeiou"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK IpamDnsProviderProfileApiResponse

401

log in failed

Up
post /ipamdnsproviderprofile
( ipamdnsproviderprofilePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — IpamDnsProviderProfile object creation

Return type

IpamDnsProviderProfile

Example data

Content-Type: application/json
{
  "aws_profile" : {
    "access_key_id" : "aeiou",
    "iam_assume_role" : "aeiou",
    "vpc_id" : "aeiou",
    "use_iam_roles" : true,
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "region" : "aeiou",
    "zones" : [ {
      "availability_zone" : "aeiou",
      "usable_network_uuids" : [ "aeiou" ]
    } ],
    "ttl" : 123,
    "usable_domains" : [ "aeiou" ],
    "usable_network_uuids" : [ "aeiou" ]
  },
  "gcp_profile" : {
    "match_se_group_subnet" : true,
    "usable_network_refs" : [ "aeiou" ]
  },
  "allocate_ip_in_vrf" : true,
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "custom_profile" : {
    "usable_subnets" : [ {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    } ],
    "dynamic_params" : [ {
      "is_sensitive" : true,
      "is_dynamic" : true,
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "custom_ipam_dns_profile_ref" : "aeiou",
    "usable_domains" : [ "aeiou" ]
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "internal_profile" : {
    "dns_service_domain" : [ {
      "domain_name" : "aeiou",
      "pass_through" : true,
      "num_dns_ip" : 123,
      "record_ttl" : 123
    } ],
    "dns_virtualservice_ref" : "aeiou",
    "usable_network_refs" : [ "aeiou" ],
    "ttl" : 123
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "infoblox_profile" : {
    "network_view" : "aeiou",
    "password" : "aeiou",
    "usable_subnets" : [ "" ],
    "dns_view" : "aeiou",
    "ip_address" : "",
    "usable_domains" : [ "aeiou" ],
    "username" : "aeiou",
    "wapi_version" : "aeiou"
  },
  "azure_profile" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "resource_group" : "aeiou",
    "azure_userpass" : {
      "password" : "aeiou",
      "tenant_name" : "aeiou",
      "username" : "aeiou"
    },
    "virtual_network_ids" : [ "aeiou" ],
    "azure_serviceprincipal" : {
      "tenant_id" : "aeiou",
      "authentication_token" : "aeiou",
      "application_id" : "aeiou"
    },
    "usable_domains" : [ "aeiou" ],
    "usable_network_uuids" : [ "aeiou" ]
  },
  "openstack_profile" : {
    "password" : "aeiou",
    "keystone_host" : "aeiou",
    "vip_network_name" : "aeiou",
    "region" : "aeiou",
    "tenant" : "aeiou",
    "username" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK IpamDnsProviderProfile

401

log in failed

Up
delete /ipamdnsproviderprofile/{uuid}
( ipamdnsproviderprofileUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /ipamdnsproviderprofile/{uuid}
( ipamdnsproviderprofileUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

IpamDnsProviderProfile

Example data

Content-Type: application/json
{
  "aws_profile" : {
    "access_key_id" : "aeiou",
    "iam_assume_role" : "aeiou",
    "vpc_id" : "aeiou",
    "use_iam_roles" : true,
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "region" : "aeiou",
    "zones" : [ {
      "availability_zone" : "aeiou",
      "usable_network_uuids" : [ "aeiou" ]
    } ],
    "ttl" : 123,
    "usable_domains" : [ "aeiou" ],
    "usable_network_uuids" : [ "aeiou" ]
  },
  "gcp_profile" : {
    "match_se_group_subnet" : true,
    "usable_network_refs" : [ "aeiou" ]
  },
  "allocate_ip_in_vrf" : true,
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "custom_profile" : {
    "usable_subnets" : [ {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    } ],
    "dynamic_params" : [ {
      "is_sensitive" : true,
      "is_dynamic" : true,
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "custom_ipam_dns_profile_ref" : "aeiou",
    "usable_domains" : [ "aeiou" ]
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "internal_profile" : {
    "dns_service_domain" : [ {
      "domain_name" : "aeiou",
      "pass_through" : true,
      "num_dns_ip" : 123,
      "record_ttl" : 123
    } ],
    "dns_virtualservice_ref" : "aeiou",
    "usable_network_refs" : [ "aeiou" ],
    "ttl" : 123
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "infoblox_profile" : {
    "network_view" : "aeiou",
    "password" : "aeiou",
    "usable_subnets" : [ "" ],
    "dns_view" : "aeiou",
    "ip_address" : "",
    "usable_domains" : [ "aeiou" ],
    "username" : "aeiou",
    "wapi_version" : "aeiou"
  },
  "azure_profile" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "resource_group" : "aeiou",
    "azure_userpass" : {
      "password" : "aeiou",
      "tenant_name" : "aeiou",
      "username" : "aeiou"
    },
    "virtual_network_ids" : [ "aeiou" ],
    "azure_serviceprincipal" : {
      "tenant_id" : "aeiou",
      "authentication_token" : "aeiou",
      "application_id" : "aeiou"
    },
    "usable_domains" : [ "aeiou" ],
    "usable_network_uuids" : [ "aeiou" ]
  },
  "openstack_profile" : {
    "password" : "aeiou",
    "keystone_host" : "aeiou",
    "vip_network_name" : "aeiou",
    "region" : "aeiou",
    "tenant" : "aeiou",
    "username" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK IpamDnsProviderProfile

401

log in failed

Up
patch /ipamdnsproviderprofile/{uuid}
( ipamdnsproviderprofileUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — IpamDnsProviderProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

IpamDnsProviderProfile

Example data

Content-Type: application/json
{
  "aws_profile" : {
    "access_key_id" : "aeiou",
    "iam_assume_role" : "aeiou",
    "vpc_id" : "aeiou",
    "use_iam_roles" : true,
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "region" : "aeiou",
    "zones" : [ {
      "availability_zone" : "aeiou",
      "usable_network_uuids" : [ "aeiou" ]
    } ],
    "ttl" : 123,
    "usable_domains" : [ "aeiou" ],
    "usable_network_uuids" : [ "aeiou" ]
  },
  "gcp_profile" : {
    "match_se_group_subnet" : true,
    "usable_network_refs" : [ "aeiou" ]
  },
  "allocate_ip_in_vrf" : true,
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "custom_profile" : {
    "usable_subnets" : [ {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    } ],
    "dynamic_params" : [ {
      "is_sensitive" : true,
      "is_dynamic" : true,
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "custom_ipam_dns_profile_ref" : "aeiou",
    "usable_domains" : [ "aeiou" ]
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "internal_profile" : {
    "dns_service_domain" : [ {
      "domain_name" : "aeiou",
      "pass_through" : true,
      "num_dns_ip" : 123,
      "record_ttl" : 123
    } ],
    "dns_virtualservice_ref" : "aeiou",
    "usable_network_refs" : [ "aeiou" ],
    "ttl" : 123
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "infoblox_profile" : {
    "network_view" : "aeiou",
    "password" : "aeiou",
    "usable_subnets" : [ "" ],
    "dns_view" : "aeiou",
    "ip_address" : "",
    "usable_domains" : [ "aeiou" ],
    "username" : "aeiou",
    "wapi_version" : "aeiou"
  },
  "azure_profile" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "resource_group" : "aeiou",
    "azure_userpass" : {
      "password" : "aeiou",
      "tenant_name" : "aeiou",
      "username" : "aeiou"
    },
    "virtual_network_ids" : [ "aeiou" ],
    "azure_serviceprincipal" : {
      "tenant_id" : "aeiou",
      "authentication_token" : "aeiou",
      "application_id" : "aeiou"
    },
    "usable_domains" : [ "aeiou" ],
    "usable_network_uuids" : [ "aeiou" ]
  },
  "openstack_profile" : {
    "password" : "aeiou",
    "keystone_host" : "aeiou",
    "vip_network_name" : "aeiou",
    "region" : "aeiou",
    "tenant" : "aeiou",
    "username" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK IpamDnsProviderProfile

401

log in failed

Up
put /ipamdnsproviderprofile/{uuid}
( ipamdnsproviderprofileUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — IpamDnsProviderProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

IpamDnsProviderProfile

Example data

Content-Type: application/json
{
  "aws_profile" : {
    "access_key_id" : "aeiou",
    "iam_assume_role" : "aeiou",
    "vpc_id" : "aeiou",
    "use_iam_roles" : true,
    "secret_access_key" : "aeiou",
    "vpc" : "aeiou",
    "region" : "aeiou",
    "zones" : [ {
      "availability_zone" : "aeiou",
      "usable_network_uuids" : [ "aeiou" ]
    } ],
    "ttl" : 123,
    "usable_domains" : [ "aeiou" ],
    "usable_network_uuids" : [ "aeiou" ]
  },
  "gcp_profile" : {
    "match_se_group_subnet" : true,
    "usable_network_refs" : [ "aeiou" ]
  },
  "allocate_ip_in_vrf" : true,
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "custom_profile" : {
    "usable_subnets" : [ {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    } ],
    "dynamic_params" : [ {
      "is_sensitive" : true,
      "is_dynamic" : true,
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "custom_ipam_dns_profile_ref" : "aeiou",
    "usable_domains" : [ "aeiou" ]
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "internal_profile" : {
    "dns_service_domain" : [ {
      "domain_name" : "aeiou",
      "pass_through" : true,
      "num_dns_ip" : 123,
      "record_ttl" : 123
    } ],
    "dns_virtualservice_ref" : "aeiou",
    "usable_network_refs" : [ "aeiou" ],
    "ttl" : 123
  },
  "proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "infoblox_profile" : {
    "network_view" : "aeiou",
    "password" : "aeiou",
    "usable_subnets" : [ "" ],
    "dns_view" : "aeiou",
    "ip_address" : "",
    "usable_domains" : [ "aeiou" ],
    "username" : "aeiou",
    "wapi_version" : "aeiou"
  },
  "azure_profile" : {
    "subscription_id" : "aeiou",
    "use_enhanced_ha" : true,
    "resource_group" : "aeiou",
    "azure_userpass" : {
      "password" : "aeiou",
      "tenant_name" : "aeiou",
      "username" : "aeiou"
    },
    "virtual_network_ids" : [ "aeiou" ],
    "azure_serviceprincipal" : {
      "tenant_id" : "aeiou",
      "authentication_token" : "aeiou",
      "application_id" : "aeiou"
    },
    "usable_domains" : [ "aeiou" ],
    "usable_network_uuids" : [ "aeiou" ]
  },
  "openstack_profile" : {
    "password" : "aeiou",
    "keystone_host" : "aeiou",
    "vip_network_name" : "aeiou",
    "region" : "aeiou",
    "tenant" : "aeiou",
    "username" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK IpamDnsProviderProfile

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AwsZoneNetwork
  2. AzureServicePrincipalCredentials
  3. AzureUserPassCredentials
  4. CustomParams
  5. DnsServiceDomain
  6. IpAddr
  7. IpAddrPrefix
  8. IpamDnsAwsProfile
  9. IpamDnsAzureProfile
  10. IpamDnsCustomProfile
  11. IpamDnsGCPProfile
  12. IpamDnsInfobloxProfile
  13. IpamDnsInternalProfile
  14. IpamDnsOpenstackProfile
  15. IpamDnsProviderProfile
  16. IpamDnsProviderProfileApiResponse
  17. ProxyConfiguration

AwsZoneNetwork Up

availability_zone
String Availability zone. Field introduced in 17.1.3.
usable_network_uuids (optional)
array[String] 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. Field introduced in 17.1.3.

AzureServicePrincipalCredentials Up

application_id (optional)
String Application Id created for Avi Controller. Required for application id based authentication only. Field introduced in 17.2.1.
authentication_token (optional)
String Authentication token created for the Avi Controller application. Required for application id based authentication only. Field introduced in 17.2.1.
tenant_id (optional)
String Tenant ID for the subscription. Required for application id based authentication only. Field introduced in 17.2.1.

AzureUserPassCredentials Up

password (optional)
String Password for Azure subscription. Required only if username is provided. Field introduced in 17.2.1.
tenant_name (optional)
String Tenant or the active directory associated with the subscription. Required for user name password authentication. Field introduced in 17.2.1.
username (optional)
String Username for Azure subscription. Required only for username password based authentication. Field introduced in 17.2.1.

CustomParams Up

is_dynamic (optional)
Boolean Placeholder for description of property is_dynamic of obj type CustomParams field type str type boolean
is_sensitive (optional)
Boolean Placeholder for description of property is_sensitive of obj type CustomParams field type str type boolean
name
String Name of the object.
value (optional)
String value of CustomParams.

DnsServiceDomain Up

domain_name
String Service domain string used for FQDN.
num_dns_ip (optional)
Integer Specifies the number of A records returned by Avi DNS Service. Allowed values are 0-20. Special values are 0- 'Return all IP addresses'. format: int32
pass_through (optional)
Boolean Third-party Authoritative domain requests are delegated toDNS VirtualService's pool of nameservers.
record_ttl (optional)
Integer TTL value for DNS records. Allowed values are 1-604800. format: int32

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS.

IpAddrPrefix Up

ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32

IpamDnsAwsProfile Up

access_key_id (optional)
String AWS access key ID.
iam_assume_role (optional)
String IAM assume role for cross-account access. Field introduced in 17.1.1.
region (optional)
String AWS region.
secret_access_key (optional)
String AWS secret access key.
ttl (optional)
Integer Default TTL for all records. Allowed values are 1-172800. Field introduced in 17.1.3. format: int32
usable_domains (optional)
array[String] Usable domains to pick from Amazon Route 53. Field introduced in 17.1.1.
usable_network_uuids (optional)
array[String] 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. Field introduced in 17.1.1.
use_iam_roles (optional)
Boolean Use IAM roles instead of access and secret key.
vpc (optional)
String VPC name.
vpc_id
String VPC ID.
zones (optional)
array[AwsZoneNetwork] Network configuration for Virtual IP per AZ. Field introduced in 17.1.3.

IpamDnsAzureProfile Up

azure_serviceprincipal (optional)
AzureServicePrincipalCredentials Service principal based credentials for azure. Only one of azure_userpass or azure_serviceprincipal is allowed. Field introduced in 17.2.1.
azure_userpass (optional)
AzureUserPassCredentials User name password based credentials for azure. Only one of azure_userpass or azure_serviceprincipal is allowed. Field introduced in 17.2.1.
resource_group (optional)
String Azure resource group dedicated for Avi Controller. Avi Controller will create all its resources in this resource group. Field introduced in 17.2.1.
subscription_id (optional)
String Subscription Id for the Azure subscription. Field introduced in 17.2.1.
usable_domains (optional)
array[String] Usable domains to pick from Azure DNS. Field introduced in 17.2.1.
usable_network_uuids (optional)
array[String] 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. Field introduced in 17.2.1.
use_enhanced_ha (optional)
Boolean Use Azure's enhanced HA features. This needs a public IP to be associated with the VIP. Field introduced in 17.2.1.
virtual_network_ids (optional)
array[String] Virtual networks where Virtual IPs will belong. Field introduced in 17.2.1.

IpamDnsCustomProfile Up

custom_ipam_dns_profile_ref (optional)
String It is a reference to an object of type CustomIpamDnsProfile. Field introduced in 17.1.1.
dynamic_params (optional)
array[CustomParams] Custom parameters that will passed to the IPAM/DNS provider including but not limited to provider credentials and API version. Field introduced in 17.1.1.
usable_domains (optional)
array[String] Usable domains. Field introduced in 17.2.2.
usable_subnets (optional)
array[IpAddrPrefix] Usable subnets. Field introduced in 17.2.2.

IpamDnsGCPProfile Up

match_se_group_subnet (optional)
Boolean Match SE group subnets for VIP placement. Default is to not match SE group subnets. Field introduced in 17.1.1.
usable_network_refs (optional)
array[String] 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. It is a reference to an object of type Network.

IpamDnsInfobloxProfile Up

dns_view (optional)
String DNS view.
ip_address
IpAddr Address of Infoblox appliance.
network_view (optional)
String Network view.
password
String Password for API access for Infoblox appliance.
usable_domains (optional)
array[String] Usable domains to pick from Infoblox.
usable_subnets (optional)
array[IpAddrPrefix] Usable subnets to pick from Infoblox.
username
String Username for API access for Infoblox appliance.
wapi_version (optional)
String WAPI version.

IpamDnsInternalProfile Up

dns_service_domain (optional)
array[DnsServiceDomain] List of service domains.
dns_virtualservice_ref (optional)
String Avi VirtualService to be used for serving DNS records. It is a reference to an object of type VirtualService.
ttl (optional)
Integer Default TTL for all records, overridden by TTL value for each service domain configured in DnsServiceDomain. Allowed values are 1-604800. format: int32
usable_network_refs (optional)
array[String] 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. It is a reference to an object of type Network.

IpamDnsOpenstackProfile Up

keystone_host (optional)
String Keystone's hostname or IP address.
password (optional)
String The password Avi Vantage will use when authenticating to Keystone.
region (optional)
String Region name.
tenant (optional)
String OpenStack tenant name.
username (optional)
String The username Avi Vantage will use when authenticating to Keystone.
vip_network_name (optional)
String Network to be used for VIP allocation.

IpamDnsProviderProfile Up

allocate_ip_in_vrf (optional)
Boolean If this flag is set, only allocate IP from networks in the Virtual Service VRF. Field introduced in 17.2.4.
aws_profile (optional)
IpamDnsAwsProfile Provider details if type is AWS.
azure_profile (optional)
IpamDnsAzureProfile Provider details if type is Microsoft Azure. Field introduced in 17.2.1.
custom_profile (optional)
IpamDnsCustomProfile Provider details if type is Custom. Field introduced in 17.1.1.
gcp_profile (optional)
IpamDnsGCPProfile Provider details if type is Google Cloud.
infoblox_profile (optional)
IpamDnsInfobloxProfile Provider details if type is Infoblox.
internal_profile (optional)
IpamDnsInternalProfile Provider details if type is Avi.
name
String Name for the IPAM/DNS Provider profile.
openstack_profile (optional)
IpamDnsOpenstackProfile Provider details if type is OpenStack.
proxy_configuration (optional)
ProxyConfiguration Field introduced in 17.1.1.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
type
String 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_INTERNAL, IPAMDNS_TYPE_INTERNAL_DNS, IPAMDNS_TYPE_AWS_DNS, IPAMDNS_TYPE_AZURE_DNS.
url (optional)
String url
uuid (optional)
String UUID of the IPAM/DNS Provider profile.

IpamDnsProviderProfileApiResponse Up

count
Integer format: int32
results

ProxyConfiguration Up

host
String Proxy hostname or IP address.
password (optional)
String Password for proxy.
port
Integer Proxy port. format: int32
username (optional)
String Username for proxy.