PUT /ipamdnsproviderprofile/{uuid}
/ipamdnsproviderprofile/{uuid}
UUID of the object to fetch
object name
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
IpamDnsProviderProfile object creation
Show optional properties
{
"name": "string",
"type": "string"
}{
"_last_modified": "string",
"allocate_ip_in_vrf": false,
"aws_profile": {
"access_key_id": "string",
"egress_service_subnets": [
"string"
],
"iam_assume_role": "string",
"publish_vip_to_public_zone": false,
"region": "string",
"secret_access_key": "string",
"ttl": 0,
"usable_domains": [
"string"
],
"usable_network_uuids": [
"string"
],
"use_iam_roles": false,
"vpc": "string",
"vpc_id": "string",
"zones": [
{
"availability_zone": "string",
"usable_network_uuids": [
"string"
]
}
]
},
"azure_profile": {
"azure_serviceprincipal": {
"application_id": "string",
"authentication_token": "string",
"tenant_id": "string"
},
"azure_userpass": {
"password": "string",
"tenant_name": "string",
"username": "string"
},
"egress_service_subnets": [
"string"
],
"resource_group": "string",
"subscription_id": "string",
"usable_domains": [
"string"
],
"usable_network_uuids": [
"string"
],
"use_enhanced_ha": false,
"use_standard_alb": false,
"virtual_network_ids": [
"string"
]
},
"configpb_attributes": {
"version": 0
},
"custom_profile": {
"custom_ipam_dns_profile_ref": "string",
"dynamic_params": [
{
"is_dynamic": false,
"is_sensitive": false,
"name": "string",
"value": "string"
}
],
"usable_alloc_subnets": [
{
"network_id": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
}
],
"usable_domains": [
"string"
]
},
"gcp_profile": {
"match_se_group_subnet": false,
"network_host_project_id": "string",
"region_name": "string",
"se_project_id": "string",
"usable_network_refs": [
"string"
],
"use_gcp_network": false,
"vpc_network_name": "string"
},
"infoblox_profile": {
"dns_view": "string",
"extensible_attributes": [
{
"is_dynamic": false,
"is_sensitive": false,
"name": "string",
"value": "string"
}
],
"ip6_address": {
"addr": "string",
"type": "string"
},
"ip_address": {
"addr": "string",
"type": "string"
},
"network_view": "string",
"password": "string",
"profile_url": "string",
"usable_alloc_subnets": [
{
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
}
],
"usable_domains": [
"string"
],
"username": "string",
"wapi_version": "string"
},
"internal_profile": {
"dns_service_domain": [
{
"domain_name": "string",
"pass_through": false,
"record_ttl": 0
}
],
"dns_virtualservice_ref": "string",
"ttl": 0,
"usable_networks": [
{
"labels": [
{
"key": "string",
"value": "string"
}
],
"nw_ref": "string"
}
]
},
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"name": "string",
"oci_profile": {
"cloud_credentials_ref": "string",
"region": "string",
"tenancy": "string",
"vcn_compartment_id": "string",
"vcn_id": "string"
},
"openstack_profile": {
"keystone_host": "string",
"password": "string",
"region": "string",
"tenant": "string",
"username": "string",
"vip_network_name": "string"
},
"proxy_configuration": {
"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"tenant_ref": "string",
"tencent_profile": {
"cloud_credentials_ref": "string",
"region": "string",
"usable_subnet_ids": [
"string"
],
"vpc_id": "string",
"zones": [
{
"availability_zone": "string",
"usable_subnet_id": "string"
}
]
},
"type": "string",
"url": "string",
"uuid": "string"
}OK
"IpamDnsProviderProfile Object"UNIX time since epoch in microseconds. Units(MICROSECONDS).
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.
aws_profile
azure_profile
configpb_attributes
custom_profile
gcp_profile
infoblox_profile
internal_profile
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 for the IPAM/DNS Provider profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
oci_profile
openstack_profile
proxy_configuration
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
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
UUID of the IPAM/DNS Provider profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","type:"string"}' https://{api_host}/api/ipamdnsproviderprofile/{uuid}