PATCH /cloud-inventory/{uuid}
/cloud-inventory/{uuid}
Request
URI
PATCH
https://{api_host}/api/cloud-inventory/{uuid}
COPY
Path Parameters
string
uuid
Required
UUID of the object to fetch
Query Parameters
string
name
Optional
object name
Header Parameters
string
X-Avi-Tenant
Optional
Avi Tenant Header
string
X-Avi-Tenant-UUID
Optional
Avi Tenant Header UUID
string
X-Avi-Version
Required
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.
string
X-CSRFToken
Optional
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.
Request Body
CloudInventory object creation
CloudInventory
of type(s)
application/json
Optional
{
"_last_modified": "string",
"config": {
"_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",
"verify_certificate": false,
"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",
"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",
"verify_certificate": false
},
"vmc_deployment": false,
"vtype": "string"
},
"mvrf": {
"cloud_ref": "string",
"lldp_enable": false,
"name": "string",
"system_default": false,
"tenant_ref": "string",
"url": "string",
"uuid": "string"
},
"status": {
"cc_id": "string",
"nsxt_streaming_server_status": {
"cursor": {
"epoch": 0,
"sequence": 0
},
"last_update_err": "string",
"last_update_time": "string",
"nsxt_manager_url": "string",
"state": "string",
"uuid": "string"
},
"reason": "string",
"se_image_state": [
{
"reason": "string",
"state": "string",
"version": "string"
}
],
"state": "string"
},
"url": "string",
"uuid": "string"
}Responses
200
OK
Returns
CloudInventory
of type(s)
application/json
"CloudInventory Object"
string
_last_modified
Optional
UNIX time since epoch in microseconds. Units(MICROSECONDS).
object
config
Optional
config
object
mvrf
Optional
mvrf
object
status
Optional
status
string
url
Optional
url
string
uuid
Optional
UUID of the cloud. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.
401
log in failed
Operation doesn't return any data structure
Code Samples
COPY
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'