Avi IpamDnsProviderProfile Object API
CLI ``` - configure ipamdnsproviderprofile - show ipamdnsproviderprofile ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /ipamdnsproviderprofilepost /ipamdnsproviderprofiledelete /ipamdnsproviderprofile/{uuid}get /ipamdnsproviderprofile/{uuid}patch /ipamdnsproviderprofile/{uuid}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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"aws_profile" : {
"access_key_id" : "aeiou",
"iam_assume_role" : "aeiou",
"vpc_id" : "aeiou",
"secret_access_key" : "aeiou",
"vpc" : "aeiou",
"publish_vip_to_public_zone" : true,
"zones" : [ {
"availability_zone" : "aeiou",
"usable_network_uuids" : [ "aeiou" ]
} ],
"ttl" : 123,
"egress_service_subnets" : [ "aeiou" ],
"usable_domains" : [ "aeiou" ],
"usable_network_uuids" : [ "aeiou" ],
"use_iam_roles" : true,
"region" : "aeiou"
},
"oci_profile" : {
"tenancy" : "aeiou",
"vcn_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"vcn_compartment_id" : "aeiou"
},
"gcp_profile" : {
"vpc_network_name" : "aeiou",
"match_se_group_subnet" : true,
"network_host_project_id" : "aeiou",
"use_gcp_network" : true,
"usable_network_refs" : [ "aeiou" ],
"region_name" : "aeiou",
"se_project_id" : "aeiou"
},
"allocate_ip_in_vrf" : true,
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"tencent_profile" : {
"usable_subnet_ids" : [ "aeiou" ],
"vpc_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"zones" : [ {
"availability_zone" : "aeiou",
"usable_subnet_id" : "aeiou"
} ]
},
"internal_profile" : {
"dns_service_domain" : [ {
"domain_name" : "aeiou",
"pass_through" : true,
"num_dns_ip" : 123,
"record_ttl" : 123
} ],
"dns_virtualservice_ref" : "aeiou",
"usable_networks" : [ {
"nw_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
} ],
"usable_network_refs" : [ "aeiou" ],
"ttl" : 123
},
"proxy_configuration" : {
"password" : "aeiou",
"port" : 123,
"host" : "aeiou",
"username" : "aeiou"
},
"infoblox_profile" : {
"extensible_attributes" : [ "" ],
"network_view" : "aeiou",
"usable_alloc_subnets" : [ {
"subnet" : "",
"subnet6" : ""
} ],
"password" : "aeiou",
"usable_subnets" : [ "" ],
"dns_view" : "aeiou",
"ip_address" : "",
"usable_domains" : [ "aeiou" ],
"username" : "aeiou",
"wapi_version" : "aeiou"
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"azure_profile" : {
"subscription_id" : "aeiou",
"use_enhanced_ha" : true,
"use_standard_alb" : 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"
},
"egress_service_subnets" : [ "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 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
Example data
Content-Type: application/json
{
"aws_profile" : {
"access_key_id" : "aeiou",
"iam_assume_role" : "aeiou",
"vpc_id" : "aeiou",
"secret_access_key" : "aeiou",
"vpc" : "aeiou",
"publish_vip_to_public_zone" : true,
"zones" : [ {
"availability_zone" : "aeiou",
"usable_network_uuids" : [ "aeiou" ]
} ],
"ttl" : 123,
"egress_service_subnets" : [ "aeiou" ],
"usable_domains" : [ "aeiou" ],
"usable_network_uuids" : [ "aeiou" ],
"use_iam_roles" : true,
"region" : "aeiou"
},
"oci_profile" : {
"tenancy" : "aeiou",
"vcn_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"vcn_compartment_id" : "aeiou"
},
"gcp_profile" : {
"vpc_network_name" : "aeiou",
"match_se_group_subnet" : true,
"network_host_project_id" : "aeiou",
"use_gcp_network" : true,
"usable_network_refs" : [ "aeiou" ],
"region_name" : "aeiou",
"se_project_id" : "aeiou"
},
"allocate_ip_in_vrf" : true,
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"tencent_profile" : {
"usable_subnet_ids" : [ "aeiou" ],
"vpc_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"zones" : [ {
"availability_zone" : "aeiou",
"usable_subnet_id" : "aeiou"
} ]
},
"internal_profile" : {
"dns_service_domain" : [ {
"domain_name" : "aeiou",
"pass_through" : true,
"num_dns_ip" : 123,
"record_ttl" : 123
} ],
"dns_virtualservice_ref" : "aeiou",
"usable_networks" : [ {
"nw_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
} ],
"usable_network_refs" : [ "aeiou" ],
"ttl" : 123
},
"proxy_configuration" : {
"password" : "aeiou",
"port" : 123,
"host" : "aeiou",
"username" : "aeiou"
},
"infoblox_profile" : {
"extensible_attributes" : [ "" ],
"network_view" : "aeiou",
"usable_alloc_subnets" : [ {
"subnet" : "",
"subnet6" : ""
} ],
"password" : "aeiou",
"usable_subnets" : [ "" ],
"dns_view" : "aeiou",
"ip_address" : "",
"usable_domains" : [ "aeiou" ],
"username" : "aeiou",
"wapi_version" : "aeiou"
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"azure_profile" : {
"subscription_id" : "aeiou",
"use_enhanced_ha" : true,
"use_standard_alb" : 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"
},
"egress_service_subnets" : [ "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 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 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"aws_profile" : {
"access_key_id" : "aeiou",
"iam_assume_role" : "aeiou",
"vpc_id" : "aeiou",
"secret_access_key" : "aeiou",
"vpc" : "aeiou",
"publish_vip_to_public_zone" : true,
"zones" : [ {
"availability_zone" : "aeiou",
"usable_network_uuids" : [ "aeiou" ]
} ],
"ttl" : 123,
"egress_service_subnets" : [ "aeiou" ],
"usable_domains" : [ "aeiou" ],
"usable_network_uuids" : [ "aeiou" ],
"use_iam_roles" : true,
"region" : "aeiou"
},
"oci_profile" : {
"tenancy" : "aeiou",
"vcn_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"vcn_compartment_id" : "aeiou"
},
"gcp_profile" : {
"vpc_network_name" : "aeiou",
"match_se_group_subnet" : true,
"network_host_project_id" : "aeiou",
"use_gcp_network" : true,
"usable_network_refs" : [ "aeiou" ],
"region_name" : "aeiou",
"se_project_id" : "aeiou"
},
"allocate_ip_in_vrf" : true,
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"tencent_profile" : {
"usable_subnet_ids" : [ "aeiou" ],
"vpc_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"zones" : [ {
"availability_zone" : "aeiou",
"usable_subnet_id" : "aeiou"
} ]
},
"internal_profile" : {
"dns_service_domain" : [ {
"domain_name" : "aeiou",
"pass_through" : true,
"num_dns_ip" : 123,
"record_ttl" : 123
} ],
"dns_virtualservice_ref" : "aeiou",
"usable_networks" : [ {
"nw_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
} ],
"usable_network_refs" : [ "aeiou" ],
"ttl" : 123
},
"proxy_configuration" : {
"password" : "aeiou",
"port" : 123,
"host" : "aeiou",
"username" : "aeiou"
},
"infoblox_profile" : {
"extensible_attributes" : [ "" ],
"network_view" : "aeiou",
"usable_alloc_subnets" : [ {
"subnet" : "",
"subnet6" : ""
} ],
"password" : "aeiou",
"usable_subnets" : [ "" ],
"dns_view" : "aeiou",
"ip_address" : "",
"usable_domains" : [ "aeiou" ],
"username" : "aeiou",
"wapi_version" : "aeiou"
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"azure_profile" : {
"subscription_id" : "aeiou",
"use_enhanced_ha" : true,
"use_standard_alb" : 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"
},
"egress_service_subnets" : [ "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 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
Example data
Content-Type: application/json
{
"aws_profile" : {
"access_key_id" : "aeiou",
"iam_assume_role" : "aeiou",
"vpc_id" : "aeiou",
"secret_access_key" : "aeiou",
"vpc" : "aeiou",
"publish_vip_to_public_zone" : true,
"zones" : [ {
"availability_zone" : "aeiou",
"usable_network_uuids" : [ "aeiou" ]
} ],
"ttl" : 123,
"egress_service_subnets" : [ "aeiou" ],
"usable_domains" : [ "aeiou" ],
"usable_network_uuids" : [ "aeiou" ],
"use_iam_roles" : true,
"region" : "aeiou"
},
"oci_profile" : {
"tenancy" : "aeiou",
"vcn_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"vcn_compartment_id" : "aeiou"
},
"gcp_profile" : {
"vpc_network_name" : "aeiou",
"match_se_group_subnet" : true,
"network_host_project_id" : "aeiou",
"use_gcp_network" : true,
"usable_network_refs" : [ "aeiou" ],
"region_name" : "aeiou",
"se_project_id" : "aeiou"
},
"allocate_ip_in_vrf" : true,
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"tencent_profile" : {
"usable_subnet_ids" : [ "aeiou" ],
"vpc_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"zones" : [ {
"availability_zone" : "aeiou",
"usable_subnet_id" : "aeiou"
} ]
},
"internal_profile" : {
"dns_service_domain" : [ {
"domain_name" : "aeiou",
"pass_through" : true,
"num_dns_ip" : 123,
"record_ttl" : 123
} ],
"dns_virtualservice_ref" : "aeiou",
"usable_networks" : [ {
"nw_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
} ],
"usable_network_refs" : [ "aeiou" ],
"ttl" : 123
},
"proxy_configuration" : {
"password" : "aeiou",
"port" : 123,
"host" : "aeiou",
"username" : "aeiou"
},
"infoblox_profile" : {
"extensible_attributes" : [ "" ],
"network_view" : "aeiou",
"usable_alloc_subnets" : [ {
"subnet" : "",
"subnet6" : ""
} ],
"password" : "aeiou",
"usable_subnets" : [ "" ],
"dns_view" : "aeiou",
"ip_address" : "",
"usable_domains" : [ "aeiou" ],
"username" : "aeiou",
"wapi_version" : "aeiou"
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"azure_profile" : {
"subscription_id" : "aeiou",
"use_enhanced_ha" : true,
"use_standard_alb" : 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"
},
"egress_service_subnets" : [ "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 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
Example data
Content-Type: application/json
{
"aws_profile" : {
"access_key_id" : "aeiou",
"iam_assume_role" : "aeiou",
"vpc_id" : "aeiou",
"secret_access_key" : "aeiou",
"vpc" : "aeiou",
"publish_vip_to_public_zone" : true,
"zones" : [ {
"availability_zone" : "aeiou",
"usable_network_uuids" : [ "aeiou" ]
} ],
"ttl" : 123,
"egress_service_subnets" : [ "aeiou" ],
"usable_domains" : [ "aeiou" ],
"usable_network_uuids" : [ "aeiou" ],
"use_iam_roles" : true,
"region" : "aeiou"
},
"oci_profile" : {
"tenancy" : "aeiou",
"vcn_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"vcn_compartment_id" : "aeiou"
},
"gcp_profile" : {
"vpc_network_name" : "aeiou",
"match_se_group_subnet" : true,
"network_host_project_id" : "aeiou",
"use_gcp_network" : true,
"usable_network_refs" : [ "aeiou" ],
"region_name" : "aeiou",
"se_project_id" : "aeiou"
},
"allocate_ip_in_vrf" : true,
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "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",
"tencent_profile" : {
"usable_subnet_ids" : [ "aeiou" ],
"vpc_id" : "aeiou",
"cloud_credentials_ref" : "aeiou",
"region" : "aeiou",
"zones" : [ {
"availability_zone" : "aeiou",
"usable_subnet_id" : "aeiou"
} ]
},
"internal_profile" : {
"dns_service_domain" : [ {
"domain_name" : "aeiou",
"pass_through" : true,
"num_dns_ip" : 123,
"record_ttl" : 123
} ],
"dns_virtualservice_ref" : "aeiou",
"usable_networks" : [ {
"nw_ref" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
} ],
"usable_network_refs" : [ "aeiou" ],
"ttl" : 123
},
"proxy_configuration" : {
"password" : "aeiou",
"port" : 123,
"host" : "aeiou",
"username" : "aeiou"
},
"infoblox_profile" : {
"extensible_attributes" : [ "" ],
"network_view" : "aeiou",
"usable_alloc_subnets" : [ {
"subnet" : "",
"subnet6" : ""
} ],
"password" : "aeiou",
"usable_subnets" : [ "" ],
"dns_view" : "aeiou",
"ip_address" : "",
"usable_domains" : [ "aeiou" ],
"username" : "aeiou",
"wapi_version" : "aeiou"
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"azure_profile" : {
"subscription_id" : "aeiou",
"use_enhanced_ha" : true,
"use_standard_alb" : 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"
},
"egress_service_subnets" : [ "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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
IpamDnsProviderProfile
401
log in failed
[ Jump to Methods ]
Table of Contents
AwsZoneNetworkAzureServicePrincipalCredentialsAzureUserPassCredentialsCustomParamsDnsServiceDomainInfobloxSubnetIpAddrIpAddrPrefixIpamDnsAwsProfileIpamDnsAzureProfileIpamDnsCustomProfileIpamDnsGCPProfileIpamDnsInfobloxProfileIpamDnsInternalProfileIpamDnsOCIProfileIpamDnsOpenstackProfileIpamDnsProviderProfileIpamDnsProviderProfileApiResponseIpamDnsTencentProfileIpamUsableNetworkKeyValueKeyValueTupleProxyConfigurationRoleFilterMatchLabelTencentZoneNetwork
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.
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.
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.
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
value (optional)
domain_name
String Service domain string used for FQDN.
num_dns_ip (optional)
Integer [DEPRECATED] Useless fieldPlease refer to DnsServiceApplicationProfile's num_dns_ip for default valuePlease refer to VsVip's dns_info num_records_in_response for user config valueSpecifies the number of A recordsreturned by Avi DNS Service. Field deprecated in 20.1.5. 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. Unit is SEC. format: int32
subnet (optional)
IpAddrPrefix IPv4 subnet to use for Infoblox allocation. Field introduced in 18.2.8, 20.1.1.
subnet6 (optional)
IpAddrPrefix IPv6 subnet to use for Infoblox allocation. Field introduced in 18.2.8, 20.1.1.
addr
type
String Enum options - V4, DNS, V6.
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
access_key_id (optional)
egress_service_subnets (optional)
array[String] A list of subnets used for source IP allocation for egress services in Openshift/k8s on Aws. Field introduced in 18.2.3. Maximum of 1 items allowed.
iam_assume_role (optional)
String IAM assume role for cross-account access. Field introduced in 17.1.1.
publish_vip_to_public_zone (optional)
Boolean If enabled and the virtual service is not floating ip capable, vip will be published to both private and public zones. This flag is applicable only for AWS DNS profile. Field introduced in 17.2.10.
region (optional)
secret_access_key (optional)
ttl (optional)
Integer Default TTL for all records. Allowed values are 1-172800. Field introduced in 17.1.3. Unit is SEC. 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)
vpc_id
zones (optional)
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.
egress_service_subnets (optional)
array[String] Used for allocating egress service source IPs. Field introduced in 17.2.8. Maximum of 1 items allowed.
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. Maximum of 128 items allowed.
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.
use_standard_alb (optional)
Boolean Use Standard SKU Azure Load Balancer. By default Basic SKU Load Balancer is used. Field introduced in 17.2.7.
virtual_network_ids (optional)
array[String] Virtual networks where Virtual IPs will belong. Field introduced in 17.2.1. Maximum of 1 items allowed.
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)
usable_subnets (optional)
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.
network_host_project_id (optional)
String Google Cloud Platform Network Host Project ID. This is the host project in which Google Cloud Platform Network resides. Field introduced in 18.1.2.
region_name (optional)
String Google Cloud Platform Region Name. Field introduced in 18.1.2.
se_project_id (optional)
String Google Cloud Platform Project ID. This is the project where service engines are hosted. This field is optional. By default it will use the value of the field network_host_project_id. Field introduced in 18.1.2.
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.
use_gcp_network (optional)
Boolean Use Google Cloud Platform Network for Private VIP allocation. By default Avi Vantage Network is used for Private VIP allocation. Field introduced in 18.1.2.
vpc_network_name (optional)
String Google Cloud Platform VPC Network Name. Field introduced in 18.1.2.
dns_view (optional)
extensible_attributes (optional)
array[CustomParams] Custom parameters that will passed to the Infoblox provider as extensible attributes. Field introduced in 18.2.7, 20.1.1.
ip_address
IpAddr Address of Infoblox appliance.
network_view (optional)
password
String Password for API access for Infoblox appliance.
usable_alloc_subnets (optional)
usable_domains (optional)
usable_subnets (optional)
array[IpAddrPrefix] This field is deprecated, use usable_alloc_subnets instead. Field deprecated in 18.2.8.
username
String Username for API access for Infoblox appliance.
wapi_version (optional)
dns_service_domain (optional)
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. Unit is SEC. Allowed in Basic(Allowed values- 30) edition, Essentials(Allowed values- 30) edition, Enterprise edition. format: int32
usable_network_refs (optional)
array[String] Use usable_networks. It is a reference to an object of type Network. Field deprecated in 20.1.3.
usable_networks (optional)
array[IpamUsableNetwork] 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 20.1.3. Allowed in Basic edition, Essentials edition, Enterprise edition.
cloud_credentials_ref (optional)
String Credentials to access oracle cloud. It is a reference to an object of type CloudConnectorUser. Field introduced in 18.2.1,18.1.3.
region (optional)
String Region in which Oracle cloud resource resides. Field introduced in 18.2.1,18.1.3.
tenancy (optional)
String Oracle Cloud Id for tenant aka root compartment. Field introduced in 18.2.1,18.1.3.
vcn_compartment_id (optional)
String Oracle cloud compartment id in which VCN resides. Field introduced in 18.2.1,18.1.3.
vcn_id (optional)
String Virtual Cloud network id where virtual ip will belong. Field introduced in 18.2.1,18.1.3.
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)
tenant (optional)
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.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
allocate_ip_in_vrf (optional)
Boolean 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.
aws_profile (optional)
azure_profile (optional)
custom_profile (optional)
gcp_profile (optional)
infoblox_profile (optional)
internal_profile (optional)
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
name
String Name for the IPAM/DNS Provider profile.
oci_profile (optional)
IpamDnsOCIProfile Provider details for Oracle Cloud. Field introduced in 18.2.1,18.1.3.
openstack_profile (optional)
proxy_configuration (optional)
tenant_ref (optional)
String It is a reference to an object of type Tenant.
tencent_profile (optional)
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_OCI, IPAMDNS_TYPE_TENCENT, IPAMDNS_TYPE_INTERNAL, IPAMDNS_TYPE_INTERNAL_DNS, IPAMDNS_TYPE_AWS_DNS, IPAMDNS_TYPE_AZURE_DNS. Allowed in Basic(Allowed values- IPAMDNS_TYPE_INTERNAL) edition, Essentials(Allowed values- IPAMDNS_TYPE_INTERNAL) edition, Enterprise edition.
url (optional)
uuid (optional)
String UUID of the IPAM/DNS Provider profile.
count
results
next (optional)
cloud_credentials_ref (optional)
String Credentials to access Tencent cloud. It is a reference to an object of type CloudConnectorUser. Field introduced in 18.2.3.
region
String VPC region. Field introduced in 18.2.3.
usable_subnet_ids (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 18.2.3.
vpc_id
String VPC ID. Field introduced in 18.2.3.
zones (optional)
labels (optional)
array[KeyValueTuple] Labels as key value pairs, used for selection of IPAM networks. Field introduced in 20.1.3. Maximum of 1 items allowed.
nw_ref
String Network. It is a reference to an object of type Network. Field introduced in 20.1.3.
key
String Key. Field introduced in 20.1.3.
value (optional)
String Value. Field introduced in 20.1.3.
host
String Proxy hostname or IP address.
password (optional)
port
username (optional)
key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.
availability_zone
String Availability zone. Field introduced in 18.2.3.
usable_subnet_id
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 18.2.3.