Avi ControllerProperties Object API

get /controllerproperties

(controllerpropertiesGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

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

ControllerProperties

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,
  "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,
  "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,
  "max_dead_se_in_grp" : 123,
  "vs_key_rotate_period" : 123,
  "shared_ssl_certificates" : true,
  "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,
  "bm_use_ansible" : true,
  "process_locked_useraccounts_timeout_period" : 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
}

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.

application/json

Responses

200

OK ControllerProperties

401

patch /controllerproperties

(controllerpropertiesPatch)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — ControllerProperties object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

ControllerProperties

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,
  "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,
  "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,
  "max_dead_se_in_grp" : 123,
  "vs_key_rotate_period" : 123,
  "shared_ssl_certificates" : true,
  "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,
  "bm_use_ansible" : true,
  "process_locked_useraccounts_timeout_period" : 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
}

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.

application/json

Responses

200

OK ControllerProperties

401

put /controllerproperties

(controllerpropertiesPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — ControllerProperties object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

ControllerProperties

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,
  "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,
  "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,
  "max_dead_se_in_grp" : 123,
  "vs_key_rotate_period" : 123,
  "shared_ssl_certificates" : true,
  "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,
  "bm_use_ansible" : true,
  "process_locked_useraccounts_timeout_period" : 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
}

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.

application/json

Responses

200

OK ControllerProperties

401

Models

ControllerProperties Up

_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.

allow_ip_forwarding (optional)

Boolean Field introduced in 17.1.1.

allow_unauthenticated_apis (optional)

Boolean Allow unauthenticated access for special APIs.

allow_unauthenticated_nodes (optional)

Boolean Placeholder for description of property allow_unauthenticated_nodes of obj type ControllerProperties field type str type boolean

api_idle_timeout (optional)

Integer Allowed values are 0-1440. Unit is MIN. 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. format: int32

appviewx_compat_mode (optional)

Boolean Export configuration in appviewx compatibility mode. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise 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. 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. format: int32

attach_ip_retry_interval (optional)

Integer Unit is SEC. format: int32

attach_ip_retry_limit (optional)

Integer Number of attach_ip_retry_limit. format: int32

bm_use_ansible (optional)

Boolean Use Ansible for SE creation in baremetal. Field introduced in 17.2.2.

check_vsvip_fqdn_syntax (optional)

Boolean Enforce VsVip FQDN syntax checks. Field introduced in 20.1.6. Allowed in Basic edition, Essentials edition, Enterprise edition.

cleanup_expired_authtoken_timeout_period (optional)

Integer Period for auth token cleanup job. Field introduced in 18.1.1. Unit is MIN. format: int32

cleanup_sessions_timeout_period (optional)

Integer Period for sessions cleanup job. Field introduced in 18.1.1. Unit is MIN. 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.

cluster_ip_gratuitous_arp_period (optional)

Integer Period for cluster ip gratuitous arp job. Unit is MIN. format: int32

consistency_check_timeout_period (optional)

Integer Period for consistency check job. Field introduced in 18.1.1. Unit is MIN. format: int32

controller_resource_info_collection_period (optional)

Integer Periodically collect stats. Field introduced in 20.1.3. Unit is MIN. format: int32

crashed_se_reboot (optional)

Integer Unit is SEC. format: int32

dead_se_detection_timer (optional)

Integer Unit is SEC. 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. 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. format: int32

dns_refresh_period (optional)

Integer Period for refresh pool and gslb DNS job. Unit is MIN. Allowed in Basic(Allowed values- 60) edition, Essentials(Allowed values- 60) edition, Enterprise edition. format: int32

dummy (optional)

Integer Number of dummy. 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.

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.

enable_memory_balancer (optional)

Boolean Enable/Disable Memory Balancer. Field introduced in 17.2.8.

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.

fatal_error_lease_time (optional)

Integer Unit is SEC. 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. format: int64

file_object_cleanup_period (optional)

Integer Period for file object cleanup job. Field introduced in 20.1.1. Unit is MIN. format: int32

max_dead_se_in_grp (optional)

Integer Number of max_dead_se_in_grp. format: int32

max_pcap_per_tenant (optional)

Integer Maximum number of pcap files stored per tenant. 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. 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. format: int32

max_seq_vnic_failures (optional)

Integer Number of max_seq_vnic_failures. 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. 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.

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 Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise 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. 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. format: int32

portal_token (optional)

String Token used for uploading tech-support to portal. Field introduced in 16.4.6,17.1.2.

process_locked_useraccounts_timeout_period (optional)

Integer Period for process locked user accounts job. Field introduced in 18.1.1. Unit is MIN. format: int32

process_pki_profile_timeout_period (optional)

Integer Period for process PKI profile job. Field introduced in 18.1.1. Unit is MIN. format: int32

query_host_fail (optional)

Integer Unit is SEC. 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. 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.

se_create_timeout (optional)

Integer Unit is SEC. format: int32

se_failover_attempt_interval (optional)

Integer Interval between attempting failovers to an SE. Unit is SEC. 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.

se_offline_del (optional)

Integer Unit is SEC. 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. format: int32

se_vnic_cooldown (optional)

Integer Unit is SEC. 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. format: int32

secure_channel_cleanup_timeout (optional)

Integer Period for secure channel cleanup job. Unit is MIN. format: int32

secure_channel_controller_token_timeout (optional)

Integer Unit is MIN. format: int32

secure_channel_se_token_timeout (optional)

Integer Unit is MIN. 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. format: int32

seupgrade_fabric_pool_size (optional)

Integer Pool size used for all fabric commands during se upgrade. format: int32

seupgrade_segroup_min_dead_timeout (optional)

Integer Time to wait before marking segroup upgrade as stuck. Unit is SEC. 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.

ssl_certificate_expiry_warning_days (optional)

array[Integer] Number of days for SSL Certificate expiry warning. Unit is DAYS.

unresponsive_se_reboot (optional)

Integer Unit is SEC. 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 Basic(Allowed values- 5) edition, Essentials(Allowed values- 5) edition, Enterprise 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. 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. 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. format: int32

url (optional)

String url

uuid (optional)

String Unique object identifier of the object.

vnic_op_fail_time (optional)

Integer Unit is SEC. 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. Unit is SEC. format: int32

vs_awaiting_se_timeout (optional)

Integer Unit is SEC. 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. 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. 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. format: int32

vs_se_bootup_fail (optional)

Integer Unit is SEC. format: int32

vs_se_create_fail (optional)

Integer Unit is SEC. format: int32

vs_se_ping_fail (optional)

Integer Unit is SEC. format: int32

vs_se_vnic_fail (optional)

Integer Unit is SEC. format: int32

vs_se_vnic_ip_fail (optional)

Integer Unit is SEC. 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. Unit is SEC. 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. Unit is SEC. 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. Unit is SEC. format: int32

warmstart_se_reconnect_wait_time (optional)

Integer Unit is SEC. 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. format: int32

Avi ControllerProperties Object API

Access

Methods

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Models

Table of Contents

ControllerProperties Up

ControllerPropertiesApiResponse Up