GET /cloud/{uuid}
/cloud/{uuid}
UUID of the object to fetch
object name
List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
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.
Default values are not set.
It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
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.
OK
{
"_last_modified": "string",
"autoscale_polling_interval": 0,
"aws_configuration": {
"access_key_id": "string",
"asg_poll_interval": 0,
"ebs_encryption": {
"master_key": "string",
"mode": "string"
},
"free_elasticips": false,
"iam_assume_role": "string",
"publish_vip_to_public_zone": false,
"region": "string",
"route53_integration": false,
"s3_encryption": {
"master_key": "string",
"mode": "string"
},
"secret_access_key": "string",
"sqs_encryption": {
"master_key": "string",
"mode": "string"
},
"ttl": 0,
"use_iam_roles": false,
"use_sns_sqs": false,
"vpc": "string",
"vpc_id": "string",
"zones": [
{
"availability_zone": "string",
"mgmt_network_name": "string",
"mgmt_network_uuid": "string"
}
]
},
"azure_configuration": {
"availability_zones": [
"string"
],
"cloud_credentials_ref": "string",
"des_id": "string",
"location": "string",
"network_info": [
{
"management_network_id": "string",
"se_network_id": "string",
"virtual_network_id": "string"
}
],
"resource_group": "string",
"se_storage_account": "string",
"subscription_id": "string",
"use_azure_dns": false,
"use_enhanced_ha": false,
"use_managed_disks": false,
"use_standard_alb": false
},
"cloudstack_configuration": {
"access_key_id": "string",
"api_url": "string",
"cntr_public_ip": "string",
"hypervisor": "string",
"mgmt_network_name": "string",
"mgmt_network_uuid": "string",
"secret_access_key": "string"
},
"configpb_attributes": {
"version": 0
},
"custom_tags": [
{
"tag_key": "string",
"tag_val": "string"
}
],
"dhcp_enabled": false,
"dns_provider_ref": "string",
"dns_resolution_on_se": false,
"dns_resolvers": [
{
"fixed_ttl": 0,
"min_ttl": 0,
"nameserver_ips": [
{
"addr": "string",
"type": "string"
}
],
"resolver_name": "string",
"use_mgmt": false
}
],
"docker_configuration": {
"app_sync_frequency": 0,
"ca_tls_key_and_certificate_ref": "string",
"client_tls_key_and_certificate_ref": "string",
"container_port_match_http_service": false,
"coredump_directory": "string",
"disable_auto_backend_service_sync": false,
"disable_auto_frontend_service_sync": false,
"disable_auto_se_creation": false,
"docker_registry_se": {
"oshift_registry": {
"registry_namespace": "string",
"registry_service": "string",
"registry_vip": {
"addr": "string",
"type": "string"
}
},
"password": "string",
"private": false,
"registry": "string",
"username": "string"
},
"east_west_placement_subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"enable_event_subscription": false,
"feproxy_container_port_as_service": false,
"feproxy_vips_enable_proxy_arp": false,
"fleet_endpoint": "string",
"http_container_ports": [
0
],
"se_deployment_method": "string",
"se_exclude_attributes": [
{
"attribute": "string",
"value": "string"
}
],
"se_include_attributes": [
{
"attribute": "string",
"value": "string"
}
],
"se_spawn_rate": 0,
"se_volume": "string",
"services_accessible_all_interfaces": false,
"ssh_user_ref": "string",
"ucp_nodes": [
"string"
],
"use_container_ip_port": false,
"use_controller_image": false
},
"east_west_dns_provider_ref": "string",
"east_west_ipam_provider_ref": "string",
"enable_vip_on_all_interfaces": false,
"enable_vip_static_routes": false,
"gcp_configuration": {
"cloud_credentials_ref": "string",
"encryption_keys": {
"gcs_bucket_kms_key_id": "string",
"gcs_objects_kms_key_id": "string",
"se_disk_kms_key_id": "string",
"se_image_kms_key_id": "string"
},
"firewall_target_tags": [
"string"
],
"gcp_service_account_email": "string",
"gcs_bucket_name": "string",
"gcs_project_id": "string",
"network_config": {
"config": "string",
"inband": {
"vpc_network_name": "string",
"vpc_project_id": "string",
"vpc_subnet_name": "string"
},
"one_arm": {
"data_vpc_network_name": "string",
"data_vpc_project_id": "string",
"data_vpc_subnet_name": "string",
"management_vpc_network_name": "string",
"management_vpc_project_id": "string",
"management_vpc_subnet_name": "string"
},
"two_arm": {
"backend_data_vpc_network_name": "string",
"backend_data_vpc_project_id": "string",
"backend_data_vpc_subnet_name": "string",
"frontend_data_vpc_network_name": "string",
"frontend_data_vpc_project_id": "string",
"frontend_data_vpc_subnet_name": "string",
"management_vpc_network_name": "string",
"management_vpc_project_id": "string",
"management_vpc_subnet_name": "string"
}
},
"region_name": "string",
"se_project_id": "string",
"vip_allocation_strategy": {
"ilb": {
"cloud_router_names": [
"string"
]
},
"mode": "string",
"routes": {
"match_se_group_subnet": false,
"route_priority": 0
}
},
"zones": [
"string"
]
},
"ip6_autocfg_enabled": false,
"ipam_provider_ref": "string",
"license_tier": "string",
"license_type": "string",
"linuxserver_configuration": {
"hosts": [
{
"host_attr": [
{
"attr_key": "string",
"attr_val": "string"
}
],
"host_ip": {
"addr": "string",
"type": "string"
},
"node_availability_zone": "string",
"se_group_ref": "string"
}
],
"se_inband_mgmt": false,
"se_log_disk_path": "string",
"se_log_disk_size_GB": 0,
"se_sys_disk_path": "string",
"se_sys_disk_size_GB": 0,
"ssh_user_ref": "string"
},
"maintenance_mode": false,
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"metrics_polling_interval": 0,
"mgmt_ip_v4_enabled": false,
"mgmt_ip_v6_enabled": false,
"mtu": 0,
"name": "string",
"nsxt_configuration": {
"automate_dfw_objects": false,
"automate_dfw_rules": false,
"data_network_config": {
"tier1_segment_config": {
"automatic": {
"nsxt_segment_subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"num_se_per_segment": 0,
"tier1_lr_ids": [
"string"
]
},
"manual": {
"tier1_lrs": [
{
"locale_service": "string",
"segment_id": "string",
"tier1_lr_id": "string"
}
]
},
"segment_config_mode": "string"
},
"transport_zone": "string",
"tz_type": "string",
"vlan_segments": [
"string"
]
},
"domain_id": "string",
"enforcementpoint_id": "string",
"management_network_config": {
"overlay_segment": {
"locale_service": "string",
"segment_id": "string",
"tier1_lr_id": "string"
},
"transport_zone": "string",
"tz_type": "string",
"vlan_segment": "string"
},
"nsxt_credentials_ref": "string",
"nsxt_url": "string",
"site_id": "string",
"vmc_mode": false,
"vpc_mode": false
},
"ntp_configuration": {
"ntp_authentication_keys": [
{
"algorithm": "string",
"key": "string",
"key_number": 0
}
],
"ntp_server_list": [
{
"addr": "string",
"type": "string"
}
],
"ntp_servers": [
{
"key_number": 0,
"server": {
"addr": "string",
"type": "string"
}
}
]
},
"obj_name_prefix": "string",
"openstack_configuration": {
"admin_tenant": "string",
"admin_tenant_uuid": "string",
"allowed_address_pairs": false,
"anti_affinity": false,
"auth_url": "string",
"config_drive": false,
"contrail_disable_policy": false,
"contrail_endpoint": "string",
"contrail_plugin": false,
"custom_se_image_properties": [
{
"name": "string",
"value": "string"
}
],
"enable_os_object_caching": false,
"enable_tagging": false,
"external_networks": false,
"free_floatingips": false,
"hypervisor": "string",
"hypervisor_properties": [
{
"hypervisor": "string",
"image_properties": [
{
"name": "string",
"value": "string"
}
]
}
],
"img_format": "string",
"import_keystone_tenants": false,
"insecure": false,
"keystone_host": "string",
"map_admin_to_cloudadmin": false,
"mgmt_network_name": "string",
"mgmt_network_uuid": "string",
"name_owner": false,
"neutron_rbac": false,
"password": "string",
"privilege": "string",
"prov_name": [
"string"
],
"provider_vip_networks": [
{
"os_network_uuid": "string",
"os_tenant_uuids": [
"string"
]
}
],
"region": "string",
"role_mapping": [
{
"avi_role": "string",
"os_role": "string"
}
],
"security_groups": false,
"tenant_se": false,
"use_admin_url": false,
"use_internal_endpoints": false,
"use_keystone_auth": false,
"username": "string",
"vip_port_in_admin_tenant": false
},
"prefer_static_routes": false,
"proxy_configuration": {
"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"rancher_configuration": {
"access_key": "string",
"app_sync_frequency": 0,
"container_port_match_http_service": false,
"coredump_directory": "string",
"disable_auto_backend_service_sync": false,
"disable_auto_frontend_service_sync": false,
"disable_auto_se_creation": false,
"docker_registry_se": {
"oshift_registry": {
"registry_namespace": "string",
"registry_service": "string",
"registry_vip": {
"addr": "string",
"type": "string"
}
},
"password": "string",
"private": false,
"registry": "string",
"username": "string"
},
"east_west_placement_subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"enable_event_subscription": false,
"feproxy_container_port_as_service": false,
"feproxy_vips_enable_proxy_arp": false,
"fleet_endpoint": "string",
"http_container_ports": [
0
],
"nuage_controller": {
"nuage_organization": "string",
"nuage_password": "string",
"nuage_port": 0,
"nuage_username": "string",
"nuage_vsd_host": "string",
"se_domain": "string",
"se_enterprise": "string",
"se_network": "string",
"se_policy_group": "string",
"se_user": "string",
"se_zone": "string"
},
"rancher_servers": [
"string"
],
"se_deployment_method": "string",
"se_exclude_attributes": [
{
"attribute": "string",
"value": "string"
}
],
"se_include_attributes": [
{
"attribute": "string",
"value": "string"
}
],
"se_spawn_rate": 0,
"se_volume": "string",
"secret_key": "string",
"services_accessible_all_interfaces": false,
"ssh_user_ref": "string",
"use_container_ip_port": false,
"use_controller_image": false
},
"resolve_fqdn_to_ipv6": false,
"se_group_template_ref": "string",
"state_based_dns_registration": false,
"tenant_ref": "string",
"url": "string",
"uuid": "string",
"vca_configuration": {
"privilege": "string",
"vca_host": "string",
"vca_instance": "string",
"vca_mgmt_network": "string",
"vca_orgnization": "string",
"vca_password": "string",
"vca_username": "string",
"vca_vdc": "string"
},
"vcenter_configuration": {
"content_lib": {
"id": "string",
"name": "string"
},
"datacenter": "string",
"datacenter_managed_object_id": "string",
"deactivate_vm_discovery": false,
"is_nsx_environment": false,
"management_ip_subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"management_network": "string",
"password": "string",
"privilege": "string",
"use_content_lib": false,
"username": "string",
"vcenter_template_se_location": "string",
"vcenter_url": "string"
},
"vmc_deployment": false,
"vtype": "string"
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
CloudConnector polling interval in seconds for external autoscale groups, minimum 60 seconds. Allowed values are 60-3600. Field introduced in 18.2.2. Unit is SECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 60), Basic edition(Allowed values- 60), Enterprise with Cloud Services edition.
aws_configuration
azure_configuration
cloudstack_configuration
configpb_attributes
Custom tags for all Avi created resources in the cloud infrastructure. Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Select the IP address management scheme. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
DNS Profile for the cloud. It is a reference to an object of type IpamDnsProviderProfile. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
By default, pool member FQDNs are resolved on the Controller. When this is set, pool member FQDNs are instead resolved on Service Engines in this cloud. This is useful in scenarios where pool member FQDNs can only be resolved from Service Engines and not from the Controller. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
DNS resolver for the cloud. Field introduced in 20.1.5. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
docker_configuration
DNS Profile for East-West services. It is a reference to an object of type IpamDnsProviderProfile. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Ipam Profile for East-West services. Warning - Please use virtual subnets in this IPAM profile that do not conflict with the underlay networks or any overlay networks in the cluster. For example in AWS and GCP, 169.254.0.0/16 is used for storing instance metadata. Hence, it should not be used in this profile. It is a reference to an object of type IpamDnsProviderProfile. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Enable VIP on all data interfaces for the Cloud. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Use static routes for VIP side network resolution during VirtualService placement. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
gcp_configuration
Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Ipam Profile for the cloud. It is a reference to an object of type IpamDnsProviderProfile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Specifies the default license tier which would be used by new SE Groups. This field by default inherits the value from system configuration. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS, ENTERPRISE_WITH_CLOUD_SERVICES. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
If no license type is specified then default license enforcement for the cloud type is chosen. The default mappings are Container Cloud is Max Ses, OpenStack and VMware is cores and linux it is Sockets. Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
linuxserver_configuration
Cloud is in maintenance mode. Field introduced in 20.1.7,21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
List of labels to be used for granular RBAC. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
Cloud metrics collector polling interval in seconds. Field introduced in 22.1.1. Unit is SECONDS. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
Enable IPv4 on the Management interface of the ServiceEngine. Defaults to dhcp if no static config on Network present. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Enable IPv6 on the Management interface of the ServiceEngine. Defaults to autocfg if no static config on Network present. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
MTU setting for the cloud. Unit is BYTES. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nsxt_configuration
ntp_configuration
Default prefix for all automatically created objects in this cloud. This prefix can be overridden by the SE-Group template. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
openstack_configuration
Prefer static routes over interface routes during VirtualService placement. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
proxy_configuration
rancher_configuration
Resolve IPv6 address for pool member FQDNs. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
The Service Engine Group to use as template. It is a reference to an object of type ServiceEngineGroup. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
DNS records for VIPs are added/deleted based on the operational state of the VIPs. Field introduced in 17.1.12. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.
It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vca_configuration
vcenter_configuration
This deployment is VMware on AWS cloud. Field introduced in 20.1.5, 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Cloud type. Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- CLOUD_NONE,CLOUD_VCENTER), Basic edition(Allowed values- CLOUD_NONE,CLOUD_NSXT), Enterprise with Cloud Services edition.
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/cloud/{uuid}