Avi CloudProperties Object API
CLI ``` - configure cloudproperties - show cloudproperties ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /cloudpropertiespost /cloudpropertiesdelete /cloudproperties/{uuid}get /cloudproperties/{uuid}patch /cloudproperties/{uuid}put /cloudproperties/{uuid}get /controllerpropertiespost /controllerpropertiesdelete /controllerproperties/{uuid}get /controllerproperties/{uuid}patch /controllerproperties/{uuid}put /controllerproperties/{uuid}
(cloudpropertiesGet)
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" : [ {
"cc_vtypes" : [ "aeiou" ],
"hyp_props" : [ {
"htype" : "aeiou",
"max_nics" : 123,
"max_ips_per_nic" : 123
} ],
"cc_props" : {
"rpc_poll_interval" : 123,
"rpc_queue_size" : 123
},
"configpb_attributes" : {
"version" : 123
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"info" : [ {
"cca_props" : {
"poll_duration_target" : 123,
"vcenter_reconcile_interval" : 123,
"vnic_retries_delay" : 123,
"poll_fast_target" : 123,
"vcenter_inventory_max_object_updates" : 123,
"poll_slow_target" : 123,
"vcenter_host_ping_interval" : 123,
"async_retries_delay" : 123,
"async_retries" : 123,
"vcenter_max_datastore_go_routines" : 123,
"vnic_retries" : 123
},
"htypes" : [ "aeiou" ],
"vtype" : "aeiou",
"flavor_regex_filter" : "aeiou",
"flavor_props" : [ {
"cost" : "aeiou",
"ram_mb" : 123,
"max_ips_per_nic" : 123,
"vcpus" : 123,
"enhanced_nw" : true,
"is_recommended" : true,
"public" : true,
"max_nics" : 123,
"meta" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"max_ip6s_per_nic" : 123,
"name" : "aeiou",
"id" : "aeiou",
"disk_gb" : 123
} ],
"controller_props" : {
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : "",
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
}
} ]
} ]
}
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
CloudPropertiesApiResponse
401
log in failed
(cloudpropertiesPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — CloudProperties object creation
Return type
Example data
Content-Type: application/json
{
"cc_vtypes" : [ "aeiou" ],
"hyp_props" : [ {
"htype" : "aeiou",
"max_nics" : 123,
"max_ips_per_nic" : 123
} ],
"cc_props" : {
"rpc_poll_interval" : 123,
"rpc_queue_size" : 123
},
"configpb_attributes" : {
"version" : 123
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"info" : [ {
"cca_props" : {
"poll_duration_target" : 123,
"vcenter_reconcile_interval" : 123,
"vnic_retries_delay" : 123,
"poll_fast_target" : 123,
"vcenter_inventory_max_object_updates" : 123,
"poll_slow_target" : 123,
"vcenter_host_ping_interval" : 123,
"async_retries_delay" : 123,
"async_retries" : 123,
"vcenter_max_datastore_go_routines" : 123,
"vnic_retries" : 123
},
"htypes" : [ "aeiou" ],
"vtype" : "aeiou",
"flavor_regex_filter" : "aeiou",
"flavor_props" : [ {
"cost" : "aeiou",
"ram_mb" : 123,
"max_ips_per_nic" : 123,
"vcpus" : 123,
"enhanced_nw" : true,
"is_recommended" : true,
"public" : true,
"max_nics" : 123,
"meta" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"max_ip6s_per_nic" : 123,
"name" : "aeiou",
"id" : "aeiou",
"disk_gb" : 123
} ],
"controller_props" : {
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : "",
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
}
} ]
}
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
CloudProperties
401
log in failed
Up
delete /cloudproperties/{uuid}
(cloudpropertiesUuidDelete)
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 /cloudproperties/{uuid}
(cloudpropertiesUuidGet)
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
{
"cc_vtypes" : [ "aeiou" ],
"hyp_props" : [ {
"htype" : "aeiou",
"max_nics" : 123,
"max_ips_per_nic" : 123
} ],
"cc_props" : {
"rpc_poll_interval" : 123,
"rpc_queue_size" : 123
},
"configpb_attributes" : {
"version" : 123
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"info" : [ {
"cca_props" : {
"poll_duration_target" : 123,
"vcenter_reconcile_interval" : 123,
"vnic_retries_delay" : 123,
"poll_fast_target" : 123,
"vcenter_inventory_max_object_updates" : 123,
"poll_slow_target" : 123,
"vcenter_host_ping_interval" : 123,
"async_retries_delay" : 123,
"async_retries" : 123,
"vcenter_max_datastore_go_routines" : 123,
"vnic_retries" : 123
},
"htypes" : [ "aeiou" ],
"vtype" : "aeiou",
"flavor_regex_filter" : "aeiou",
"flavor_props" : [ {
"cost" : "aeiou",
"ram_mb" : 123,
"max_ips_per_nic" : 123,
"vcpus" : 123,
"enhanced_nw" : true,
"is_recommended" : true,
"public" : true,
"max_nics" : 123,
"meta" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"max_ip6s_per_nic" : 123,
"name" : "aeiou",
"id" : "aeiou",
"disk_gb" : 123
} ],
"controller_props" : {
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : "",
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
}
} ]
}
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
CloudProperties
401
log in failed
Up
patch /cloudproperties/{uuid}
(cloudpropertiesUuidPatch)
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 — CloudProperties object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"cc_vtypes" : [ "aeiou" ],
"hyp_props" : [ {
"htype" : "aeiou",
"max_nics" : 123,
"max_ips_per_nic" : 123
} ],
"cc_props" : {
"rpc_poll_interval" : 123,
"rpc_queue_size" : 123
},
"configpb_attributes" : {
"version" : 123
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"info" : [ {
"cca_props" : {
"poll_duration_target" : 123,
"vcenter_reconcile_interval" : 123,
"vnic_retries_delay" : 123,
"poll_fast_target" : 123,
"vcenter_inventory_max_object_updates" : 123,
"poll_slow_target" : 123,
"vcenter_host_ping_interval" : 123,
"async_retries_delay" : 123,
"async_retries" : 123,
"vcenter_max_datastore_go_routines" : 123,
"vnic_retries" : 123
},
"htypes" : [ "aeiou" ],
"vtype" : "aeiou",
"flavor_regex_filter" : "aeiou",
"flavor_props" : [ {
"cost" : "aeiou",
"ram_mb" : 123,
"max_ips_per_nic" : 123,
"vcpus" : 123,
"enhanced_nw" : true,
"is_recommended" : true,
"public" : true,
"max_nics" : 123,
"meta" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"max_ip6s_per_nic" : 123,
"name" : "aeiou",
"id" : "aeiou",
"disk_gb" : 123
} ],
"controller_props" : {
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : "",
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
}
} ]
}
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
CloudProperties
401
log in failed
Up
put /cloudproperties/{uuid}
(cloudpropertiesUuidPut)
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 — CloudProperties object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"cc_vtypes" : [ "aeiou" ],
"hyp_props" : [ {
"htype" : "aeiou",
"max_nics" : 123,
"max_ips_per_nic" : 123
} ],
"cc_props" : {
"rpc_poll_interval" : 123,
"rpc_queue_size" : 123
},
"configpb_attributes" : {
"version" : 123
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"info" : [ {
"cca_props" : {
"poll_duration_target" : 123,
"vcenter_reconcile_interval" : 123,
"vnic_retries_delay" : 123,
"poll_fast_target" : 123,
"vcenter_inventory_max_object_updates" : 123,
"poll_slow_target" : 123,
"vcenter_host_ping_interval" : 123,
"async_retries_delay" : 123,
"async_retries" : 123,
"vcenter_max_datastore_go_routines" : 123,
"vnic_retries" : 123
},
"htypes" : [ "aeiou" ],
"vtype" : "aeiou",
"flavor_regex_filter" : "aeiou",
"flavor_props" : [ {
"cost" : "aeiou",
"ram_mb" : 123,
"max_ips_per_nic" : 123,
"vcpus" : 123,
"enhanced_nw" : true,
"is_recommended" : true,
"public" : true,
"max_nics" : 123,
"meta" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"max_ip6s_per_nic" : 123,
"name" : "aeiou",
"id" : "aeiou",
"disk_gb" : 123
} ],
"controller_props" : {
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : "",
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
}
} ]
}
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
CloudProperties
401
log in failed
Up
get /controllerproperties
(controllerpropertiesGet)
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" : [ {
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : {
"version" : 123
},
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
} ]
}
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
ControllerPropertiesApiResponse
401
log in failed
Up
post /controllerproperties
(controllerpropertiesPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ControllerProperties object creation
Return type
Example data
Content-Type: application/json
{
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : {
"version" : 123
},
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
}
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
ControllerProperties
401
log in failed
Up
delete /controllerproperties/{uuid}
(controllerpropertiesUuidDelete)
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 /controllerproperties/{uuid}
(controllerpropertiesUuidGet)
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
{
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : {
"version" : 123
},
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
}
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
ControllerProperties
401
log in failed
Up
patch /controllerproperties/{uuid}
(controllerpropertiesUuidPatch)
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 — ControllerProperties object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : {
"version" : 123
},
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
}
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
ControllerProperties
401
log in failed
Up
put /controllerproperties/{uuid}
(controllerpropertiesUuidPut)
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 — ControllerProperties object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"attach_ip_retry_limit" : 123,
"upgrade_lease_time" : 123,
"se_create_timeout" : 123,
"enable_resmgr_log_cache_print" : true,
"upgrade_dns_ttl" : 123,
"user_agent_cache_config" : {
"se_cache_size" : 123,
"controller_cache_size" : 123,
"batch_size" : 123,
"percent_reserved_for_good_bots" : 123,
"percent_reserved_for_bad_bots" : 123,
"percent_reserved_for_browsers" : 123,
"max_upstream_queries" : 123,
"upstream_update_interval" : 123,
"num_entries_upstream_update" : 123,
"max_wait_time" : 123,
"percent_reserved_for_outstanding" : 123
},
"query_host_fail" : 123,
"unresponsive_se_reboot" : 123,
"portal_request_burst_limit" : 123,
"ssl_certificate_expiry_warning_days" : [ "" ],
"se_offline_del" : 123,
"uuid" : "aeiou",
"consistency_check_timeout_period" : 123,
"fatal_error_lease_time" : 123,
"enable_per_process_stop" : true,
"dummy" : 123,
"secure_channel_se_token_timeout" : 123,
"vs_se_attach_ip_fail" : 123,
"seupgrade_fabric_pool_size" : 123,
"async_patch_request_cleanup_duration" : 123,
"vsphere_ha_recovery_timeout" : 123,
"detach_ip_retry_interval" : 123,
"detach_ip_timeout" : 123,
"max_dead_se_in_grp" : 123,
"vs_key_rotate_period" : 123,
"shared_ssl_certificates" : true,
"configpb_attributes" : {
"version" : 123
},
"seupgrade_segroup_min_dead_timeout" : 123,
"se_vnic_cooldown" : 123,
"safenet_hsm_version" : "aeiou",
"secure_channel_cleanup_timeout" : 123,
"vs_apic_scaleout_timeout" : 123,
"vsphere_ha_timer_interval" : 123,
"crashed_se_reboot" : 123,
"se_upgrade_flow_cleanup_timeout" : 123,
"bm_use_ansible" : true,
"process_locked_useraccounts_timeout_period" : 123,
"detach_ip_retry_limit" : 123,
"update_dns_entry_timeout" : 123,
"appviewx_compat_mode" : true,
"cluster_ip_gratuitous_arp_period" : 123,
"controller_resource_info_collection_period" : 123,
"max_pcap_per_tenant" : 123,
"vsphere_ha_detection_timeout" : 123,
"del_offline_se_after_reboot_delay" : 123,
"dead_se_detection_timer" : 123,
"resmgr_log_caching_period" : 123,
"cleanup_expired_authtoken_timeout_period" : 123,
"cleanup_sessions_timeout_period" : 123,
"vs_se_vnic_ip_fail" : 123,
"persistence_key_rotate_period" : 123,
"secure_channel_controller_token_timeout" : 123,
"api_idle_timeout" : 123,
"max_threads_cc_vip_bg_worker" : 123,
"vs_se_bootup_fail" : 123,
"upgrade_se_per_vs_scale_ops_txn_time" : 123,
"vs_se_vnic_fail" : 123,
"allow_unauthenticated_apis" : true,
"se_spawn_retry_interval" : 123,
"allow_ip_forwarding" : true,
"attach_ip_retry_interval" : 123,
"cloud_reconcile" : true,
"se_from_marketplace" : "aeiou",
"permission_scoped_shared_admin_networks" : true,
"allow_admin_network_updates" : true,
"max_se_spawn_interval_delay" : 123,
"warmstart_se_reconnect_wait_time" : 123,
"vnic_op_fail_time" : 123,
"_last_modified" : "aeiou",
"edit_system_limits" : true,
"federated_datastore_cleanup_duration" : 123456789,
"portal_token" : "aeiou",
"upgrade_fat_se_lease_time" : 123,
"vs_se_create_fail" : 123,
"async_patch_merge_period" : 123,
"enable_api_sharding" : true,
"se_vnic_gc_wait_time" : 123,
"check_vsvip_fqdn_syntax" : true,
"seupgrade_copy_pool_size" : 123,
"process_pki_profile_timeout_period" : 123,
"warmstart_vs_resync_wait_time" : 123,
"api_perf_logging_threshold" : 123,
"max_seq_vnic_failures" : 123,
"portal_request_rate_limit" : 123,
"url" : "aeiou",
"default_minimum_api_timeout" : 123,
"max_seq_attach_ip_failures" : 123,
"se_failover_attempt_interval" : 123,
"vs_se_ping_fail" : 123,
"file_object_cleanup_period" : 123,
"enable_memory_balancer" : true,
"vs_awaiting_se_timeout" : 123,
"vs_scaleout_ready_check_interval" : 123,
"allow_unauthenticated_nodes" : true,
"dns_refresh_period" : 123,
"update_dns_entry_retry_limit" : 123
}
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
ControllerProperties
401
log in failed
[ Jump to Methods ]
Table of Contents
CC_AgentPropertiesCC_PropertiesCloudFlavorCloudInfoCloudMetaCloudPropertiesCloudPropertiesApiResponseConfigPbAttributesControllerPropertiesControllerPropertiesApiResponseHypervisor_PropertiesUserAgentCacheConfig
async_retries (optional)
Integer Maximum polls to check for async jobs to finish. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
async_retries_delay (optional)
Integer Delay between each async job status poll check. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
poll_duration_target (optional)
Integer Discovery poll target duration; a scale factor of 1+ is computed with the actual discovery (actual/target) and used to tweak slow and fast poll intervals. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
poll_fast_target (optional)
Integer Fast poll interval. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
poll_slow_target (optional)
Integer Slow poll interval. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vcenter_host_ping_interval (optional)
Integer Vcenter host reachability check interval. Allowed values are 60-3600. Field introduced in 21.1.6. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
vcenter_inventory_max_object_updates (optional)
Integer Batch size of vcenter inventory updates. Allowed values are 1-500. Field introduced in 21.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
vcenter_max_datastore_go_routines (optional)
Integer Max datastore processing go routines for vcenter datastore updates. Allowed values are 1-40. Field introduced in 21.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
vcenter_reconcile_interval (optional)
Integer Reconcile interval for vcenter inventory. Allowed values are 60-3600. Field introduced in 21.1.6. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
vnic_retries (optional)
Integer Maximum polls to check for vnics to be attached to VM. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vnic_retries_delay (optional)
Integer Delay between each vnic status poll check. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
rpc_poll_interval (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
rpc_queue_size (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
cost (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disk_gb (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
enhanced_nw (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_recommended (optional)
Boolean If a vm flavor is recommended for requested se_usage_type.Set to True if the chosen VM flavor is recommended for requested se_usage_type.Else set to False. Field introduced in 18.1.4, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
max_ip6s_per_nic (optional)
Integer Maximum number of IPv6 addresses that can be configured per NIC. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_ips_per_nic (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_nics (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
meta (optional)
array[CloudMeta] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
public (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ram_mb (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vcpus (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
cca_props (optional)
CC_AgentProperties CloudConnectorAgent properties specific to this cloud type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
controller_props (optional)
ControllerProperties Controller properties specific to this cloud type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flavor_props (optional)
array[CloudFlavor] Flavor properties specific to this cloud type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flavor_regex_filter (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
htypes (optional)
array[String] Supported hypervisors. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vtype
String 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, Basic, Enterprise with Cloud Services edition.
key
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
cc_props (optional)
CC_Properties CloudConnector properties. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cc_vtypes (optional)
array[String] 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.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
hyp_props (optional)
array[Hypervisor_Properties] Hypervisor properties. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
info (optional)
array[CloudInfo] Properties specific to a cloud type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
allow_admin_network_updates (optional)
Boolean Allow non-admin tenants to update admin VrfContext and Network objects. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
allow_ip_forwarding (optional)
Boolean Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
allow_unauthenticated_apis (optional)
Boolean Allow unauthenticated access for special APIs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
allow_unauthenticated_nodes (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
api_idle_timeout (optional)
Integer Allowed values are 0-1440. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
api_perf_logging_threshold (optional)
Integer Threshold to log request timing in portal_performance.log and Server-Timing response header. Any stage taking longer than 1% of the threshold will be included in the Server-Timing header. Field introduced in 18.1.4, 18.2.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
appviewx_compat_mode (optional)
Boolean Export configuration in appviewx compatibility mode. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
async_patch_merge_period (optional)
Integer Period for which asynchronous patch requests are queued. Allowed values are 30-120. Special values are 0 - Deactivated. Field introduced in 18.2.11, 20.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
async_patch_request_cleanup_duration (optional)
Integer Duration for which asynchronous patch requests should be kept, after being marked as SUCCESS or FAIL. Allowed values are 5-120. Field introduced in 18.2.11, 20.1.3. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
attach_ip_retry_interval (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
attach_ip_retry_limit (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
bm_use_ansible (optional)
Boolean Use Ansible for SE creation in baremetal. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
check_vsvip_fqdn_syntax (optional)
Boolean Enforce VsVip FQDN syntax checks. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
cleanup_expired_authtoken_timeout_period (optional)
Integer Period for auth token cleanup job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
cleanup_sessions_timeout_period (optional)
Integer Period for sessions cleanup job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
cloud_reconcile (optional)
Boolean Enable/Disable periodic reconcile for all the clouds. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cluster_ip_gratuitous_arp_period (optional)
Integer Period for cluster ip gratuitous arp job. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
consistency_check_timeout_period (optional)
Integer Period for consistency check job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
controller_resource_info_collection_period (optional)
Integer Periodically collect stats. Field introduced in 20.1.3. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
crashed_se_reboot (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
dead_se_detection_timer (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
default_minimum_api_timeout (optional)
Integer Minimum api timeout value.If this value is not 60, it will be the default timeout for all APIs that do not have a specific timeout.If an API has a specific timeout but is less than this value, this value will become the new timeout. Allowed values are 60-3600. Field introduced in 18.2.6. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
del_offline_se_after_reboot_delay (optional)
Integer The amount of time the controller will wait before deleting an offline SE after it has been rebooted. For unresponsive SEs, the total time will be unresponsive_se_reboot + del_offline_se_after_reboot_delay. For crashed SEs, the total time will be crashed_se_reboot + del_offline_se_after_reboot_delay. Field introduced in 20.1.5. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
detach_ip_retry_interval (optional)
Integer Amount of time to wait after last Detach IP failure before attempting next Detach IP retry. Field introduced in 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
detach_ip_retry_limit (optional)
Integer Maximum number of Detach IP retries. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
detach_ip_timeout (optional)
Integer Time to wait before marking Detach IP as failed. Field introduced in 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
dns_refresh_period (optional)
Integer Period for refresh pool and gslb DNS job. Unit is MIN. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 60), Basic edition(Allowed values- 60), Enterprise with Cloud Services edition. format: int32
dummy (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
edit_system_limits (optional)
Boolean Allow editing of system limits. Keep in mind that these system limits have been carefully selected based on rigorous testing in our testig environments. Modifying these limits could destabilize your cluster. Do this at your own risk!. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_api_sharding (optional)
Boolean This setting enables the controller leader to shard API requests to the followers (if any). Field introduced in 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_memory_balancer (optional)
Boolean Enable/Disable Memory Balancer. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_per_process_stop (optional)
Boolean Enable stopping of individual processes if process cross the given threshold limit, even when the total controller memory usage is belowits threshold limit. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enable_resmgr_log_cache_print (optional)
Boolean Enable printing of cached logs inside Resource Manager. Used for debugging purposes only. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
fatal_error_lease_time (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
federated_datastore_cleanup_duration (optional)
Long Federated datastore will not cleanup diffs unless they are at least this duration in the past. Field introduced in 20.1.1. Unit is HOURS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
file_object_cleanup_period (optional)
Integer Period for file object cleanup job. Field introduced in 20.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_dead_se_in_grp (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_pcap_per_tenant (optional)
Integer Maximum number of pcap files stored per tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_se_spawn_interval_delay (optional)
Integer Maximum delay possible to add to se_spawn_retry_interval after successive SE spawn failure. Field introduced in 20.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_seq_attach_ip_failures (optional)
Integer Maximum number of consecutive attach IP failures that halts VS placement. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_seq_vnic_failures (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_threads_cc_vip_bg_worker (optional)
Integer Maximum number of threads in threadpool used by cloud connector CCVIPBGWorker. Allowed values are 1-100. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
permission_scoped_shared_admin_networks (optional)
Boolean Network and VrfContext objects from the admin tenant will not be shared to non-admin tenants unless admin permissions are granted. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
persistence_key_rotate_period (optional)
Integer Period for rotate app persistence keys job. Allowed values are 1-1051200. Special values are 0 - Disabled. Unit is MIN. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition. format: int32
portal_request_burst_limit (optional)
Integer Burst limit on number of incoming requests. 0 to disable. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
portal_request_rate_limit (optional)
Integer Maximum average number of requests allowed per second. 0 to disable. Field introduced in 20.1.1. Unit is PER_SECOND. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
portal_token (optional)
String Token used for uploading tech-support to portal. Field introduced in 16.4.6,17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
process_locked_useraccounts_timeout_period (optional)
Integer Period for process locked user accounts job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
process_pki_profile_timeout_period (optional)
Integer Period for process PKI profile job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
query_host_fail (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
resmgr_log_caching_period (optional)
Integer Period for each cycle of log caching in Resource Manager. At the end of each cycle, the in memory cached log history will be cleared. Field introduced in 20.1.5. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
safenet_hsm_version (optional)
String Version of the safenet package installed on the controller. Field introduced in 16.5.2,17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_create_timeout (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_failover_attempt_interval (optional)
Integer Interval between attempting failovers to an SE. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_from_marketplace (optional)
String This setting decides whether SE is to be deployed from the cloud marketplace or to be created by the controller. The setting is applicable only when BYOL license is selected. Enum options - MARKETPLACE, IMAGE_SE. Field introduced in 18.1.4, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_offline_del (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_spawn_retry_interval (optional)
Integer Default retry period before attempting another Service Engine spawn in SE Group. Field introduced in 20.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_upgrade_flow_cleanup_timeout (optional)
Integer Timeout for flows cleanup by ServiceEngine during Upgrade.Internal knob to be exercised under the surveillance of VMware AVI support team. Field introduced in 21.1.5. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
se_vnic_cooldown (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_vnic_gc_wait_time (optional)
Integer Duration to wait after last vNIC addition before proceeding with vNIC garbage collection. Used for testing purposes. Field introduced in 20.1.4. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
secure_channel_cleanup_timeout (optional)
Integer Period for secure channel cleanup job. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
secure_channel_controller_token_timeout (optional)
Integer Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
secure_channel_se_token_timeout (optional)
Integer Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
seupgrade_copy_pool_size (optional)
Integer This parameter defines the number of simultaneous SE image downloads in a SeGroup. It is used to pace the SE downloads so that controller network/CPU bandwidth is a bounded operation. A value of 0 will disable the pacing scheme and all the SE(s) in the SeGroup will attempt to download the image. . Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
seupgrade_fabric_pool_size (optional)
Integer Pool size used for all fabric commands during se upgrade. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
seupgrade_segroup_min_dead_timeout (optional)
Integer Time to wait before marking segroup upgrade as stuck. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
shared_ssl_certificates (optional)
Boolean SSL Certificates in the admin tenant can be used in non-admin tenants. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssl_certificate_expiry_warning_days (optional)
array[Integer] Number of days for SSL Certificate expiry warning. Unit is DAYS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
unresponsive_se_reboot (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
update_dns_entry_retry_limit (optional)
Integer Number of times to retry a DNS entry update/delete operation. Field introduced in 21.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
update_dns_entry_timeout (optional)
Integer Timeout period for a DNS entry update/delete operation. Field introduced in 21.1.4. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
upgrade_dns_ttl (optional)
Integer Time to account for DNS TTL during upgrade. This is in addition to vs_scalein_timeout_for_upgrade in se_group. Field introduced in 17.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5), Basic edition(Allowed values- 5), Enterprise with Cloud Services edition. format: int32
upgrade_fat_se_lease_time (optional)
Integer Amount of time Controller waits for a large-sized SE (>=128GB memory) to reconnect after it is rebooted during upgrade. Field introduced in 18.2.10, 20.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
upgrade_lease_time (optional)
Integer Amount of time Controller waits for a regular-sized SE (<128GB memory) to reconnect after it is rebooted during upgrade. Starting 18.2.10/20.1.1, the default time has increased from 360 seconds to 600 seconds. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
upgrade_se_per_vs_scale_ops_txn_time (optional)
Integer This parameter defines the upper-bound value of the VS scale-in or VS scale-out operation executed in the SeScaleIn and SeScale context. User can tweak this parameter to a higher value if the Segroup gets suspended due to SeScalein or SeScaleOut timeout failure typically associated with high number of VS(es) scaled out. . Field introduced in 18.2.10, 20.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
url (optional)
user_agent_cache_config (optional)
UserAgentCacheConfig Configuration for User-Agent Cache used in Bot Management. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vnic_op_fail_time (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_apic_scaleout_timeout (optional)
Integer Time to wait for the scaled out SE to become ready before marking the scaleout done, applies to APIC configuration only. Field deprecated in 21.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_awaiting_se_timeout (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_key_rotate_period (optional)
Integer Period for rotate VS keys job. Allowed values are 1-1051200. Special values are 0 - Disabled. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_scaleout_ready_check_interval (optional)
Integer Interval for checking scaleout_ready status while controller is waiting for ScaleOutReady RPC from the Service Engine. Field introduced in 18.2.2. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_se_attach_ip_fail (optional)
Integer Time to wait before marking attach IP operation on an SE as failed. Field introduced in 17.2.2. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_se_bootup_fail (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_se_create_fail (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_se_ping_fail (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_se_vnic_fail (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vs_se_vnic_ip_fail (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vsphere_ha_detection_timeout (optional)
Integer vSphere HA monitor detection timeout. If vsphere_ha_enabled is true and the controller is not able to reach the SE, placement will wait for this duration for vsphere_ha_inprogress to be marked true before taking corrective action. Field introduced in 20.1.7, 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
vsphere_ha_recovery_timeout (optional)
Integer vSphere HA monitor recovery timeout. Once vsphere_ha_inprogress is set to true (meaning host failure detected and vSphere HA will recover the Service Engine), placement will wait for at least this duration for the SE to reconnect to the controller before taking corrective action. Field introduced in 20.1.7, 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
vsphere_ha_timer_interval (optional)
Integer vSphere HA monitor timer interval for sending cc_check_se_status to Cloud Connector. Field introduced in 20.1.7, 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
warmstart_se_reconnect_wait_time (optional)
Integer Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
warmstart_vs_resync_wait_time (optional)
Integer Timeout for warmstart VS resync. Field introduced in 18.1.4, 18.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
count
results
next (optional)
htype
String Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
max_ips_per_nic (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_nics (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
batch_size (optional)
Integer How many unknown User-Agents to batch up before querying Controller - unless max_wait_time is reached first. Allowed values are 1-500. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
controller_cache_size (optional)
Integer The number of User-Agent entries to cache on the Controller. Allowed values are 500-10000000. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
max_upstream_queries (optional)
Integer How often at most to query controller for a given User-Agent. Allowed values are 2-100. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
max_wait_time (optional)
Integer The time interval in seconds after which to make a request to the Controller, even if the 'batch_size' hasn't been reached yet. Allowed values are 20-100000. Field introduced in 21.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
num_entries_upstream_update (optional)
Integer How many BotUACacheResult elements to include in an upstream update message. Allowed values are 1-10000. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
percent_reserved_for_bad_bots (optional)
Integer How much space to reserve in percent for known bad bots. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
percent_reserved_for_browsers (optional)
Integer How much space to reserve in percent for browsers. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
percent_reserved_for_good_bots (optional)
Integer How much space to reserve in percent for known good bots. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
percent_reserved_for_outstanding (optional)
Integer How much space to reserve in percent for outstanding upstream requests. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
se_cache_size (optional)
Integer The number of User-Agent entries to cache on each Service Engine. Allowed values are 500-10000000. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
upstream_update_interval (optional)
Integer How often in seconds to send updates about User-Agent cache entries to the next upstream cache. Field introduced in 21.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32