PATCH /controllerproperties

PATCH /controllerproperties

/controllerproperties

Request
URI
PATCH
https://{api_host}/api/controllerproperties
COPY
Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Request Body

ControllerProperties object creation

ControllerProperties of type(s) application/json
Optional
{
    "_last_modified": "string",
    "alert_manager_use_evms": false,
    "allow_admin_network_updates": false,
    "allow_ip_forwarding": false,
    "allow_unauthenticated_apis": false,
    "allow_unauthenticated_nodes": false,
    "api_idle_timeout": 0,
    "api_perf_logging_threshold": 0,
    "appviewx_compat_mode": false,
    "async_patch_merge_period": 0,
    "async_patch_request_cleanup_duration": 0,
    "attach_ip_retry_interval": 0,
    "attach_ip_retry_limit": 0,
    "bm_use_ansible": false,
    "check_vsvip_fqdn_syntax": false,
    "cleanup_expired_authtoken_timeout_period": 0,
    "cleanup_sessions_timeout_period": 0,
    "cloud_discovery_interval": 0,
    "cloud_reconcile": false,
    "cloud_reconcile_interval": 0,
    "cluster_ip_gratuitous_arp_period": 0,
    "configpb_attributes": {
        "version": 0
    },
    "consistency_check_timeout_period": 0,
    "controller_resource_info_collection_period": 0,
    "crashed_se_reboot": 0,
    "dead_se_detection_timer": 0,
    "default_minimum_api_timeout": 0,
    "del_offline_se_after_reboot_delay": 0,
    "detach_ip_retry_interval": 0,
    "detach_ip_retry_limit": 0,
    "detach_ip_timeout": 0,
    "dns_refresh_period": 0,
    "dummy": 0,
    "edit_system_limits": false,
    "enable_api_sharding": false,
    "enable_memory_balancer": false,
    "enable_per_process_stop": false,
    "enable_resmgr_log_cache_print": false,
    "event_manager_max_goroutines": 0,
    "event_manager_max_subscribers": 0,
    "event_manager_processing_time_threshold": 0,
    "false_positive_learning_config": {
        "max_apps_supported": 0,
        "min_monitor_time": 0,
        "min_trans_per_application": 0,
        "min_trans_per_uri": 0
    },
    "fatal_error_lease_time": 0,
    "federated_datastore_cleanup_duration": 0,
    "file_object_cleanup_period": 0,
    "file_reference_mappings": [
        {
            "file_path": "string",
            "reference": "string"
        }
    ],
    "fileobject_max_file_versions": 0,
    "gslb_purge_batch_size": 0,
    "gslb_purge_sleep_time_ms": 0,
    "ignore_vrf_in_networksubnetlist": false,
    "max_dead_se_in_grp": 0,
    "max_pcap_per_tenant": 0,
    "max_se_spawn_interval_delay": 0,
    "max_seq_attach_ip_failures": 0,
    "max_seq_vnic_failures": 0,
    "max_threads_cc_vip_bg_worker": 0,
    "permission_scoped_shared_admin_networks": false,
    "persistence_key_rotate_period": 0,
    "portal_request_burst_limit": 0,
    "portal_request_rate_limit": 0,
    "portal_token": "string",
    "postgres_vacuum_period": 0,
    "process_locked_useraccounts_timeout_period": 0,
    "process_pki_profile_timeout_period": 0,
    "query_host_fail": 0,
    "resmgr_log_caching_period": 0,
    "restrict_cloud_read_access": false,
    "safenet_hsm_version": "string",
    "se_create_timeout": 0,
    "se_failover_attempt_interval": 0,
    "se_from_marketplace": "string",
    "se_offline_del": 0,
    "se_spawn_retry_interval": 0,
    "se_upgrade_flow_cleanup_timeout": 0,
    "se_vnic_cooldown": 0,
    "se_vnic_gc_wait_time": 0,
    "secure_channel_cleanup_timeout": 0,
    "secure_channel_controller_token_timeout": 0,
    "secure_channel_se_token_timeout": 0,
    "seupgrade_copy_buffer_size": 0,
    "seupgrade_copy_pool_size": 0,
    "seupgrade_fabric_pool_size": 0,
    "seupgrade_segroup_min_dead_timeout": 0,
    "shared_ssl_certificates": false,
    "skopeo_retry_interval": 0,
    "skopeo_retry_limit": 0,
    "soft_min_mem_per_se_limit": 0,
    "ssl_certificate_expiry_warning_days": [
        0
    ],
    "system_report_cleanup_interval": 0,
    "system_report_limit": 0,
    "unresponsive_se_reboot": 0,
    "update_dns_entry_retry_limit": 0,
    "update_dns_entry_timeout": 0,
    "upgrade_dns_ttl": 0,
    "upgrade_fat_se_lease_time": 0,
    "upgrade_lease_time": 0,
    "upgrade_se_per_vs_scale_ops_txn_time": 0,
    "url": "string",
    "user_agent_cache_config": {
        "batch_size": 0,
        "controller_cache_size": 0,
        "max_age": 0,
        "max_last_hit_time": 0,
        "max_upstream_queries": 0,
        "max_wait_time": 0,
        "num_entries_upstream_update": 0,
        "percent_reserved_for_bad_bots": 0,
        "percent_reserved_for_browsers": 0,
        "percent_reserved_for_good_bots": 0,
        "percent_reserved_for_outstanding": 0,
        "se_cache_size": 0,
        "upstream_update_interval": 0
    },
    "uuid": "string",
    "vnic_op_fail_time": 0,
    "vs_awaiting_se_timeout": 0,
    "vs_key_rotate_period": 0,
    "vs_scaleout_ready_check_interval": 0,
    "vs_se_attach_ip_fail": 0,
    "vs_se_bootup_fail": 0,
    "vs_se_bootup_fail_patch": 0,
    "vs_se_create_fail": 0,
    "vs_se_ping_fail": 0,
    "vs_se_vnic_fail": 0,
    "vs_se_vnic_ip_fail": 0,
    "vsphere_ha_detection_timeout": 0,
    "vsphere_ha_recovery_timeout": 0,
    "vsphere_ha_timer_interval": 0,
    "warmstart_se_reconnect_wait_time": 0,
    "warmstart_vs_resync_wait_time": 0
}
Responses
200

OK

Returns ControllerProperties of type(s) application/json
"ControllerProperties Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

boolean
alert_manager_use_evms
Optional
Constraints: default: true

Enable to use event manager as source of eventsDisable to use log manager as source of events. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
allow_admin_network_updates
Optional

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.

boolean
allow_ip_forwarding
Optional

Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
allow_unauthenticated_apis
Optional

Allow unauthenticated access for special APIs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
allow_unauthenticated_nodes
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
api_idle_timeout
Optional
Constraints: default: 15

Allowed values are 0-1440. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
api_perf_logging_threshold
Optional
Constraints: default: 10000

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.

boolean
appviewx_compat_mode
Optional

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.

integer As uint32 As uint32
async_patch_merge_period
Optional

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.

integer As uint32 As uint32
async_patch_request_cleanup_duration
Optional
Constraints: default: 60

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.

integer As uint32 As uint32
attach_ip_retry_interval
Optional
Constraints: default: 360

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
attach_ip_retry_limit
Optional
Constraints: default: 4

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
bm_use_ansible
Optional
Constraints: default: true

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.

boolean
check_vsvip_fqdn_syntax
Optional
Constraints: default: true

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.

integer As uint32 As uint32
cleanup_expired_authtoken_timeout_period
Optional
Constraints: default: 60

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.

integer As uint32 As uint32
cleanup_sessions_timeout_period
Optional
Constraints: default: 60

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.

integer As uint32 As uint32
cloud_discovery_interval
Optional
Constraints: default: 5

Time in minutes to wait between consecutive cloud discovery cycles. Allowed values are 1-1440. Field introduced in 22.1.5, 30.2.1. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
cloud_reconcile
Optional
Constraints: default: true

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.

integer As uint32 As uint32
cloud_reconcile_interval
Optional
Constraints: default: 5

Time in minutes to wait between consecutive cloud reconcile cycles. Allowed values are 1-1440. Field introduced in 22.1.5, 30.2.1. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
cluster_ip_gratuitous_arp_period
Optional
Constraints: default: 60

Period for cluster ip gratuitous arp job. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
configpb_attributes
Optional

configpb_attributes

integer As uint32 As uint32
consistency_check_timeout_period
Optional
Constraints: default: 60

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.

integer As uint32 As uint32
controller_resource_info_collection_period
Optional
Constraints: default: 525600

Periodically collect stats. Field introduced in 20.1.3. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
crashed_se_reboot
Optional
Constraints: default: 900

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
dead_se_detection_timer
Optional
Constraints: default: 360

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
default_minimum_api_timeout
Optional
Constraints: default: 60

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.

integer As uint32 As uint32
del_offline_se_after_reboot_delay
Optional
Constraints: default: 300

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.

integer As uint32 As uint32
detach_ip_retry_interval
Optional
Constraints: default: 60

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.

integer As uint32 As uint32
detach_ip_retry_limit
Optional
Constraints: default: 4

Maximum number of Detach IP retries. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
detach_ip_timeout
Optional
Constraints: default: 300

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.

integer As uint32 As uint32
dns_refresh_period
Optional
Constraints: default: 60

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.

integer As uint32 As uint32
dummy
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
edit_system_limits
Optional

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.

boolean
enable_api_sharding
Optional
Constraints: default: true

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.

boolean
enable_memory_balancer
Optional
Constraints: default: true

Enable/Disable Memory Balancer. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable_per_process_stop
Optional

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.

boolean
enable_resmgr_log_cache_print
Optional

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.

integer As uint32 As uint32
event_manager_max_goroutines
Optional
Constraints: default: 8

Maximum number of goroutines for event manager process. Allowed values are 1-64. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
event_manager_max_subscribers
Optional
Constraints: default: 5

Maximum number of subscribers for event manager process. Allowed values are 1-6. Special values are 0 - Disabled. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
event_manager_processing_time_threshold
Optional
Constraints: default: 4

Log instances for event manager processing delay; recorded whenever event processing delay exceeds configured interval specified in seconds. Allowed values are 1-5. Special values are 0 - Disabled. Field introduced in 30.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
false_positive_learning_config
Optional

false_positive_learning_config

integer As uint32 As uint32
fatal_error_lease_time
Optional
Constraints: default: 120

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64
federated_datastore_cleanup_duration
Optional
Constraints: default: 120

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.

integer As uint32 As uint32
file_object_cleanup_period
Optional
Constraints: default: 1440

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.

array of object
file_reference_mappings
Optional

List of mapping for file reference and their absolute path . Field deprecated in 30.2.1. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
fileobject_max_file_versions
Optional
Constraints: default: 3

This is the max number of file versions that will be retained for a file referenced by the local FileObject. Subsequent uploads of file will result in the file rotation of the older version and the latest version retained. Example When a file Upload is done for the first time, there will be a v1 version. Subsequent uploads will get mapped to v1, v2 and v3 versions. On the fourth upload of the file, the v1 will be file rotated and v2, v3 and v4 will be retained. Allowed values are 1-5. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
gslb_purge_batch_size
Optional
Constraints: default: 1000

Batch size for the vs_mgr to perform datastrorecleanup during a GSLB purge. Allowed values are 50-1200. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
gslb_purge_sleep_time_ms
Optional
Constraints: default: 50

Sleep time in the vs_mgr during a FederatedPurge RPC call. Allowed values are 50-100. Field introduced in 22.1.3. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
ignore_vrf_in_networksubnetlist
Optional

Ignore the vrf_context filter for /networksubnetlist API. Field introduced in 22.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_dead_se_in_grp
Optional
Constraints: default: 1

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_pcap_per_tenant
Optional
Constraints: default: 4

Maximum number of pcap files stored per tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_se_spawn_interval_delay
Optional
Constraints: default: 1800

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.

integer As uint32 As uint32
max_seq_attach_ip_failures
Optional
Constraints: default: 3

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.

integer As uint32 As uint32
max_seq_vnic_failures
Optional
Constraints: default: 3

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_threads_cc_vip_bg_worker
Optional
Constraints: default: 20

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.

boolean
permission_scoped_shared_admin_networks
Optional

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.

integer As uint32 As uint32
persistence_key_rotate_period
Optional

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.

integer As uint32 As uint32
portal_request_burst_limit
Optional

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.

integer As uint32 As uint32
portal_request_rate_limit
Optional

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.

string
portal_token
Optional

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.

integer As uint32 As uint32
postgres_vacuum_period
Optional
Constraints: default: 20160

Period for which postgres vacuum are executed. Allowed values are 30-40320. Special values are 0 - Deactivated. Field introduced in 22.1.3. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
process_locked_useraccounts_timeout_period
Optional
Constraints: default: 1

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.

integer As uint32 As uint32
process_pki_profile_timeout_period
Optional
Constraints: default: 1440

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.

integer As uint32 As uint32
query_host_fail
Optional
Constraints: default: 180

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
resmgr_log_caching_period
Optional
Constraints: default: 21600

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.

boolean
restrict_cloud_read_access
Optional

Restrict read access to cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
safenet_hsm_version
Optional

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.

integer As uint32 As uint32
se_create_timeout
Optional
Constraints: default: 900

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_failover_attempt_interval
Optional
Constraints: default: 300

Interval between attempting failovers to an SE. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
se_from_marketplace
Optional
Constraints: default: IMAGE_SE

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.

integer As uint32 As uint32
se_offline_del
Optional
Constraints: default: 172000

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_spawn_retry_interval
Optional
Constraints: default: 300

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.

integer As uint32 As uint32
se_upgrade_flow_cleanup_timeout
Optional
Constraints: default: 90

Timeout for flows cleanup by ServiceEngine during Upgrade.Internal knob to be exercised under the surveillance of VMware AVI support team. Field introduced in 22.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_vnic_cooldown
Optional
Constraints: default: 120

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
se_vnic_gc_wait_time
Optional
Constraints: default: 300

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.

integer As uint32 As uint32
secure_channel_cleanup_timeout
Optional
Constraints: default: 60

Period for secure channel cleanup job. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
secure_channel_controller_token_timeout
Optional
Constraints: default: 60

Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
secure_channel_se_token_timeout
Optional
Constraints: default: 60

Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
seupgrade_copy_buffer_size
Optional
Constraints: default: 512

This parameter defines the buffer size during SE image downloads in a SeGroup. It is used to pace the SE downloads so that controller network/CPU bandwidth is a bounded operation. Field introduced in 22.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
seupgrade_copy_pool_size
Optional
Constraints: default: 5

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.

integer As uint32 As uint32
seupgrade_fabric_pool_size
Optional
Constraints: default: 20

The pool size is used to control the number of concurrent segroup upgrades. This field value takes affect upon controller warm reboot. Allowed values are 2-20. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
seupgrade_segroup_min_dead_timeout
Optional
Constraints: default: 360

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.

boolean
shared_ssl_certificates
Optional

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.

integer As uint32 As uint32
skopeo_retry_interval
Optional
Constraints: default: 5

Time interval (in seconds) between retires for skopeo commands. Field introduced in 30.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
skopeo_retry_limit
Optional
Constraints: default: 3

Number of times to try skopeo commands for remote image registries. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
soft_min_mem_per_se_limit
Optional
Constraints: default: 1900

Soft Limit on the minimum SE Memory that an SE needs to have on SE Register. Field introduced in 30.1.1. Unit is MB. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of integer
ssl_certificate_expiry_warning_days
Optional

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.

integer As uint32 As uint32
system_report_cleanup_interval
Optional
Constraints: default: 60

Time in minutes to wait between cleanup of SystemReports. Allowed values are 15-300. Field introduced in 22.1.6, 30.2.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
system_report_limit
Optional
Constraints: default: 10

Number of SystemReports retained in the system. Once the number of system reports exceed this threshold, the oldest SystemReport will be removed and the latest one retained. i.e. the SystemReport will be rotated and the reports don't exceed the threshold. Allowed values are 5-50. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
unresponsive_se_reboot
Optional
Constraints: default: 300

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
update_dns_entry_retry_limit
Optional
Constraints: default: 3

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.

integer As uint32 As uint32
update_dns_entry_timeout
Optional
Constraints: default: 120

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.

integer As uint32 As uint32
upgrade_dns_ttl
Optional
Constraints: default: 5

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.

integer As uint32 As uint32
upgrade_fat_se_lease_time
Optional
Constraints: default: 1200

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.

integer As uint32 As uint32
upgrade_lease_time
Optional
Constraints: default: 600

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.

integer As uint32 As uint32
upgrade_se_per_vs_scale_ops_txn_time
Optional
Constraints: default: 3

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.

string
url
Optional

url

object
user_agent_cache_config
Optional

user_agent_cache_config

string
uuid
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vnic_op_fail_time
Optional
Constraints: default: 180

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vs_awaiting_se_timeout
Optional
Constraints: default: 60

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vs_key_rotate_period
Optional
Constraints: default: 360

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.

integer As int32 As int32
vs_scaleout_ready_check_interval
Optional
Constraints: default: 60

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.

integer As uint32 As uint32
vs_se_attach_ip_fail
Optional
Constraints: default: 600

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.

integer As uint32 As uint32
vs_se_bootup_fail
Optional
Constraints: default: 480

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vs_se_bootup_fail_patch
Optional
Constraints: default: 600

Wait for longer for patch SEs to boot up. Field introduced in 30.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vs_se_create_fail
Optional
Constraints: default: 1500

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vs_se_ping_fail
Optional
Constraints: default: 60

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vs_se_vnic_fail
Optional
Constraints: default: 300

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vs_se_vnic_ip_fail
Optional
Constraints: default: 120

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
vsphere_ha_detection_timeout
Optional
Constraints: default: 120

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.

integer As uint32 As uint32
vsphere_ha_recovery_timeout
Optional
Constraints: default: 480

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.

integer As uint32 As uint32
vsphere_ha_timer_interval
Optional
Constraints: default: 20

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.

integer As uint32 As uint32
warmstart_se_reconnect_wait_time
Optional
Constraints: default: 480

Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
warmstart_vs_resync_wait_time
Optional
Constraints: default: 300

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.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'