POST /cloudproperties
/cloudproperties
Request
URI
POST
https://{api_host}/api/cloudproperties
COPY
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
CloudProperties object creation
CloudProperties of type(s) application/json
Optional
{
"_last_modified": "string",
"cc_props": {
"rpc_poll_interval": 0,
"rpc_queue_size": 0
},
"cc_vtypes": [
"string"
],
"configpb_attributes": {
"version": 0
},
"hyp_props": [
{
"htype": "string",
"max_ips_per_nic": 0,
"max_nics": 0
}
],
"info": [
{
"cca_props": {
"async_retries": 0,
"async_retries_delay": 0,
"poll_duration_target": 0,
"poll_fast_target": 0,
"poll_slow_target": 0,
"vcenter_host_ping_interval": 0,
"vcenter_inventory_max_object_updates": 0,
"vcenter_max_datastore_go_routines": 0,
"vcenter_reconcile_interval": 0,
"vnic_retries": 0,
"vnic_retries_delay": 0
},
"controller_props": {
"_last_modified": "string",
"alert_manager_use_evms": false,
"allow_admin_network_updates": false,
"allow_ip_forwarding": false,
"allow_unauthenticated_apis": false,
"allow_unauthenticated_nodes": false,
"api_idle_timeout": 0,
"api_perf_logging_threshold": 0,
"appviewx_compat_mode": false,
"async_patch_merge_period": 0,
"async_patch_request_cleanup_duration": 0,
"attach_ip_retry_interval": 0,
"attach_ip_retry_limit": 0,
"bm_use_ansible": false,
"check_vsvip_fqdn_syntax": false,
"cleanup_expired_authtoken_timeout_period": 0,
"cleanup_sessions_timeout_period": 0,
"cloud_discovery_interval": 0,
"cloud_reconcile": false,
"cloud_reconcile_interval": 0,
"cluster_ip_gratuitous_arp_period": 0,
"configpb_attributes": {
"version": 0
},
"consistency_check_timeout_period": 0,
"controller_resource_info_collection_period": 0,
"crashed_se_reboot": 0,
"dead_se_detection_timer": 0,
"default_minimum_api_timeout": 0,
"del_offline_se_after_reboot_delay": 0,
"detach_ip_retry_interval": 0,
"detach_ip_retry_limit": 0,
"detach_ip_timeout": 0,
"dns_refresh_period": 0,
"dummy": 0,
"edit_system_limits": false,
"enable_api_sharding": false,
"enable_memory_balancer": false,
"enable_per_process_stop": false,
"enable_resmgr_log_cache_print": false,
"event_manager_max_goroutines": 0,
"event_manager_max_subscribers": 0,
"event_manager_processing_time_threshold": 0,
"false_positive_learning_config": {
"max_apps_supported": 0,
"min_monitor_time": 0,
"min_trans_per_application": 0,
"min_trans_per_uri": 0
},
"fatal_error_lease_time": 0,
"federated_datastore_cleanup_duration": 0,
"file_object_cleanup_period": 0,
"file_reference_mappings": [
{
"file_path": "string",
"reference": "string"
}
],
"fileobject_max_file_versions": 0,
"gslb_purge_batch_size": 0,
"gslb_purge_sleep_time_ms": 0,
"ignore_vrf_in_networksubnetlist": false,
"max_dead_se_in_grp": 0,
"max_pcap_per_tenant": 0,
"max_se_spawn_interval_delay": 0,
"max_seq_attach_ip_failures": 0,
"max_seq_vnic_failures": 0,
"max_threads_cc_vip_bg_worker": 0,
"permission_scoped_shared_admin_networks": false,
"persistence_key_rotate_period": 0,
"portal_request_burst_limit": 0,
"portal_request_rate_limit": 0,
"portal_token": "string",
"postgres_vacuum_period": 0,
"process_locked_useraccounts_timeout_period": 0,
"process_pki_profile_timeout_period": 0,
"query_host_fail": 0,
"resmgr_log_caching_period": 0,
"restrict_cloud_read_access": false,
"safenet_hsm_version": "string",
"se_create_timeout": 0,
"se_failover_attempt_interval": 0,
"se_from_marketplace": "string",
"se_offline_del": 0,
"se_spawn_retry_interval": 0,
"se_upgrade_flow_cleanup_timeout": 0,
"se_vnic_cooldown": 0,
"se_vnic_gc_wait_time": 0,
"secure_channel_cleanup_timeout": 0,
"secure_channel_controller_token_timeout": 0,
"secure_channel_se_token_timeout": 0,
"seupgrade_copy_buffer_size": 0,
"seupgrade_copy_pool_size": 0,
"seupgrade_fabric_pool_size": 0,
"seupgrade_segroup_min_dead_timeout": 0,
"shared_ssl_certificates": false,
"skopeo_retry_interval": 0,
"skopeo_retry_limit": 0,
"soft_min_mem_per_se_limit": 0,
"ssl_certificate_expiry_warning_days": [
0
],
"system_report_cleanup_interval": 0,
"system_report_limit": 0,
"unresponsive_se_reboot": 0,
"update_dns_entry_retry_limit": 0,
"update_dns_entry_timeout": 0,
"upgrade_dns_ttl": 0,
"upgrade_fat_se_lease_time": 0,
"upgrade_lease_time": 0,
"upgrade_se_per_vs_scale_ops_txn_time": 0,
"url": "string",
"user_agent_cache_config": {
"batch_size": 0,
"controller_cache_size": 0,
"max_age": 0,
"max_last_hit_time": 0,
"max_upstream_queries": 0,
"max_wait_time": 0,
"num_entries_upstream_update": 0,
"percent_reserved_for_bad_bots": 0,
"percent_reserved_for_browsers": 0,
"percent_reserved_for_good_bots": 0,
"percent_reserved_for_outstanding": 0,
"se_cache_size": 0,
"upstream_update_interval": 0
},
"uuid": "string",
"vnic_op_fail_time": 0,
"vs_awaiting_se_timeout": 0,
"vs_key_rotate_period": 0,
"vs_scaleout_ready_check_interval": 0,
"vs_se_attach_ip_fail": 0,
"vs_se_bootup_fail": 0,
"vs_se_bootup_fail_patch": 0,
"vs_se_create_fail": 0,
"vs_se_ping_fail": 0,
"vs_se_vnic_fail": 0,
"vs_se_vnic_ip_fail": 0,
"vsphere_ha_detection_timeout": 0,
"vsphere_ha_recovery_timeout": 0,
"vsphere_ha_timer_interval": 0,
"warmstart_se_reconnect_wait_time": 0,
"warmstart_vs_resync_wait_time": 0
},
"flavor_props": [
{
"cost": "string",
"disk_gb": 0,
"enhanced_nw": false,
"id": "string",
"is_recommended": false,
"max_ip6s_per_nic": 0,
"max_ips_per_nic": 0,
"max_nics": 0,
"meta": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"public": false,
"ram_mb": 0,
"vcpus": 0
}
],
"flavor_regex_filter": "string",
"htypes": [
"string"
],
"vtype": "string"
}
],
"url": "string",
"uuid": "string"
}
Responses
200
OK
Returns CloudProperties of type(s) application/json
"CloudProperties Object"string
_last_modified
Optional
UNIX time since epoch in microseconds. Units(MICROSECONDS).
object
cc_props
Optional
cc_props
array of string
cc_vtypes
Optional
Cloud types supported by CloudConnector. 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, Basic, Enterprise with Cloud Services edition.
object
configpb_attributes
Optional
configpb_attributes
array of object
hyp_props
Optional
Hypervisor properties. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
array of object
info
Optional
Properties specific to a cloud type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
string
url
Optional
url
string
uuid
Optional
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
401
log in failed
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/cloudproperties