Avi ControllerProperties Object API

##CLI## ``` - configure controller properties - show controller properties ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /controllerproperties
  2. post /controllerproperties
  3. delete /controllerproperties/{uuid}
  4. get /controllerproperties/{uuid}
  5. patch /controllerproperties/{uuid}
  6. put /controllerproperties/{uuid}
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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ControllerPropertiesApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "attach_ip_retry_limit" : 123,
    "upgrade_lease_time" : 123,
    "vs_se_vnic_fail" : 123,
    "allow_unauthenticated_apis" : true,
    "se_create_timeout" : 123,
    "upgrade_dns_ttl" : 123,
    "allow_ip_forwarding" : true,
    "attach_ip_retry_interval" : 123,
    "query_host_fail" : 123,
    "unresponsive_se_reboot" : 123,
    "ssl_certificate_expiry_warning_days" : [ "" ],
    "se_offline_del" : 123,
    "uuid" : "aeiou",
    "warmstart_se_reconnect_wait_time" : 123,
    "fatal_error_lease_time" : 123,
    "vnic_op_fail_time" : 123,
    "dummy" : 123,
    "secure_channel_se_token_timeout" : 123,
    "vs_se_attach_ip_fail" : 123,
    "seupgrade_fabric_pool_size" : 123,
    "max_dead_se_in_grp" : 123,
    "vs_key_rotate_period" : 123,
    "portal_token" : "aeiou",
    "vs_se_create_fail" : 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,
    "crashed_se_reboot" : 123,
    "max_seq_vnic_failures" : 123,
    "bm_use_ansible" : true,
    "appviewx_compat_mode" : true,
    "url" : "aeiou",
    "cluster_ip_gratuitous_arp_period" : 123,
    "max_pcap_per_tenant" : 123,
    "max_seq_attach_ip_failures" : 123,
    "se_failover_attempt_interval" : 123,
    "vs_se_ping_fail" : 123,
    "dead_se_detection_timer" : 123,
    "vs_se_vnic_ip_fail" : 123,
    "persistence_key_rotate_period" : 123,
    "secure_channel_controller_token_timeout" : 123,
    "vs_awaiting_se_timeout" : 123,
    "api_idle_timeout" : 123,
    "allow_unauthenticated_nodes" : true,
    "dns_refresh_period" : 123,
    "vs_se_bootup_fail" : 123
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

ControllerProperties

Example data

Content-Type: application/json
{
  "attach_ip_retry_limit" : 123,
  "upgrade_lease_time" : 123,
  "vs_se_vnic_fail" : 123,
  "allow_unauthenticated_apis" : true,
  "se_create_timeout" : 123,
  "upgrade_dns_ttl" : 123,
  "allow_ip_forwarding" : true,
  "attach_ip_retry_interval" : 123,
  "query_host_fail" : 123,
  "unresponsive_se_reboot" : 123,
  "ssl_certificate_expiry_warning_days" : [ "" ],
  "se_offline_del" : 123,
  "uuid" : "aeiou",
  "warmstart_se_reconnect_wait_time" : 123,
  "fatal_error_lease_time" : 123,
  "vnic_op_fail_time" : 123,
  "dummy" : 123,
  "secure_channel_se_token_timeout" : 123,
  "vs_se_attach_ip_fail" : 123,
  "seupgrade_fabric_pool_size" : 123,
  "max_dead_se_in_grp" : 123,
  "vs_key_rotate_period" : 123,
  "portal_token" : "aeiou",
  "vs_se_create_fail" : 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,
  "crashed_se_reboot" : 123,
  "max_seq_vnic_failures" : 123,
  "bm_use_ansible" : true,
  "appviewx_compat_mode" : true,
  "url" : "aeiou",
  "cluster_ip_gratuitous_arp_period" : 123,
  "max_pcap_per_tenant" : 123,
  "max_seq_attach_ip_failures" : 123,
  "se_failover_attempt_interval" : 123,
  "vs_se_ping_fail" : 123,
  "dead_se_detection_timer" : 123,
  "vs_se_vnic_ip_fail" : 123,
  "persistence_key_rotate_period" : 123,
  "secure_channel_controller_token_timeout" : 123,
  "vs_awaiting_se_timeout" : 123,
  "api_idle_timeout" : 123,
  "allow_unauthenticated_nodes" : true,
  "dns_refresh_period" : 123,
  "vs_se_bootup_fail" : 123
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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.
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,
  "vs_se_vnic_fail" : 123,
  "allow_unauthenticated_apis" : true,
  "se_create_timeout" : 123,
  "upgrade_dns_ttl" : 123,
  "allow_ip_forwarding" : true,
  "attach_ip_retry_interval" : 123,
  "query_host_fail" : 123,
  "unresponsive_se_reboot" : 123,
  "ssl_certificate_expiry_warning_days" : [ "" ],
  "se_offline_del" : 123,
  "uuid" : "aeiou",
  "warmstart_se_reconnect_wait_time" : 123,
  "fatal_error_lease_time" : 123,
  "vnic_op_fail_time" : 123,
  "dummy" : 123,
  "secure_channel_se_token_timeout" : 123,
  "vs_se_attach_ip_fail" : 123,
  "seupgrade_fabric_pool_size" : 123,
  "max_dead_se_in_grp" : 123,
  "vs_key_rotate_period" : 123,
  "portal_token" : "aeiou",
  "vs_se_create_fail" : 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,
  "crashed_se_reboot" : 123,
  "max_seq_vnic_failures" : 123,
  "bm_use_ansible" : true,
  "appviewx_compat_mode" : true,
  "url" : "aeiou",
  "cluster_ip_gratuitous_arp_period" : 123,
  "max_pcap_per_tenant" : 123,
  "max_seq_attach_ip_failures" : 123,
  "se_failover_attempt_interval" : 123,
  "vs_se_ping_fail" : 123,
  "dead_se_detection_timer" : 123,
  "vs_se_vnic_ip_fail" : 123,
  "persistence_key_rotate_period" : 123,
  "secure_channel_controller_token_timeout" : 123,
  "vs_awaiting_se_timeout" : 123,
  "api_idle_timeout" : 123,
  "allow_unauthenticated_nodes" : true,
  "dns_refresh_period" : 123,
  "vs_se_bootup_fail" : 123
}

Produces

This API call produces the following media types according to the Accept 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

ControllerProperties

Example data

Content-Type: application/json
{
  "attach_ip_retry_limit" : 123,
  "upgrade_lease_time" : 123,
  "vs_se_vnic_fail" : 123,
  "allow_unauthenticated_apis" : true,
  "se_create_timeout" : 123,
  "upgrade_dns_ttl" : 123,
  "allow_ip_forwarding" : true,
  "attach_ip_retry_interval" : 123,
  "query_host_fail" : 123,
  "unresponsive_se_reboot" : 123,
  "ssl_certificate_expiry_warning_days" : [ "" ],
  "se_offline_del" : 123,
  "uuid" : "aeiou",
  "warmstart_se_reconnect_wait_time" : 123,
  "fatal_error_lease_time" : 123,
  "vnic_op_fail_time" : 123,
  "dummy" : 123,
  "secure_channel_se_token_timeout" : 123,
  "vs_se_attach_ip_fail" : 123,
  "seupgrade_fabric_pool_size" : 123,
  "max_dead_se_in_grp" : 123,
  "vs_key_rotate_period" : 123,
  "portal_token" : "aeiou",
  "vs_se_create_fail" : 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,
  "crashed_se_reboot" : 123,
  "max_seq_vnic_failures" : 123,
  "bm_use_ansible" : true,
  "appviewx_compat_mode" : true,
  "url" : "aeiou",
  "cluster_ip_gratuitous_arp_period" : 123,
  "max_pcap_per_tenant" : 123,
  "max_seq_attach_ip_failures" : 123,
  "se_failover_attempt_interval" : 123,
  "vs_se_ping_fail" : 123,
  "dead_se_detection_timer" : 123,
  "vs_se_vnic_ip_fail" : 123,
  "persistence_key_rotate_period" : 123,
  "secure_channel_controller_token_timeout" : 123,
  "vs_awaiting_se_timeout" : 123,
  "api_idle_timeout" : 123,
  "allow_unauthenticated_nodes" : true,
  "dns_refresh_period" : 123,
  "vs_se_bootup_fail" : 123
}

Produces

This API call produces the following media types according to the Accept 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

ControllerProperties

Example data

Content-Type: application/json
{
  "attach_ip_retry_limit" : 123,
  "upgrade_lease_time" : 123,
  "vs_se_vnic_fail" : 123,
  "allow_unauthenticated_apis" : true,
  "se_create_timeout" : 123,
  "upgrade_dns_ttl" : 123,
  "allow_ip_forwarding" : true,
  "attach_ip_retry_interval" : 123,
  "query_host_fail" : 123,
  "unresponsive_se_reboot" : 123,
  "ssl_certificate_expiry_warning_days" : [ "" ],
  "se_offline_del" : 123,
  "uuid" : "aeiou",
  "warmstart_se_reconnect_wait_time" : 123,
  "fatal_error_lease_time" : 123,
  "vnic_op_fail_time" : 123,
  "dummy" : 123,
  "secure_channel_se_token_timeout" : 123,
  "vs_se_attach_ip_fail" : 123,
  "seupgrade_fabric_pool_size" : 123,
  "max_dead_se_in_grp" : 123,
  "vs_key_rotate_period" : 123,
  "portal_token" : "aeiou",
  "vs_se_create_fail" : 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,
  "crashed_se_reboot" : 123,
  "max_seq_vnic_failures" : 123,
  "bm_use_ansible" : true,
  "appviewx_compat_mode" : true,
  "url" : "aeiou",
  "cluster_ip_gratuitous_arp_period" : 123,
  "max_pcap_per_tenant" : 123,
  "max_seq_attach_ip_failures" : 123,
  "se_failover_attempt_interval" : 123,
  "vs_se_ping_fail" : 123,
  "dead_se_detection_timer" : 123,
  "vs_se_vnic_ip_fail" : 123,
  "persistence_key_rotate_period" : 123,
  "secure_channel_controller_token_timeout" : 123,
  "vs_awaiting_se_timeout" : 123,
  "api_idle_timeout" : 123,
  "allow_unauthenticated_nodes" : true,
  "dns_refresh_period" : 123,
  "vs_se_bootup_fail" : 123
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ControllerProperties

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. ControllerProperties
  2. ControllerPropertiesApiResponse

ControllerProperties Up

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. format: int32
appviewx_compat_mode (optional)
Boolean Export configuration in appviewx compatibility mode. Field introduced in 17.1.1.
attach_ip_retry_interval (optional)
Integer Number of attach_ip_retry_interval. 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.
cluster_ip_gratuitous_arp_period (optional)
Integer Number of cluster_ip_gratuitous_arp_period. format: int32
crashed_se_reboot (optional)
Integer Number of crashed_se_reboot. format: int32
dead_se_detection_timer (optional)
Integer Number of dead_se_detection_timer. format: int32
dns_refresh_period (optional)
Integer Number of dns_refresh_period. format: int32
dummy (optional)
Integer Number of dummy. format: int32
fatal_error_lease_time (optional)
Integer Number of fatal_error_lease_time. 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_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
persistence_key_rotate_period (optional)
Integer Allowed values are 1-1051200. Special values are 0 - 'Disabled'. format: int32
portal_token (optional)
String Token used for uploading tech-support to portal. Field introduced in 16.4.6,17.1.2.
query_host_fail (optional)
Integer Number of query_host_fail. 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 Number of se_create_timeout. format: int32
se_failover_attempt_interval (optional)
Integer Interval between attempting failovers to an SE. format: int32
se_offline_del (optional)
Integer Number of se_offline_del. format: int32
se_vnic_cooldown (optional)
Integer Number of se_vnic_cooldown. format: int32
secure_channel_cleanup_timeout (optional)
Integer Number of secure_channel_cleanup_timeout. format: int32
secure_channel_controller_token_timeout (optional)
Integer Number of secure_channel_controller_token_timeout. format: int32
secure_channel_se_token_timeout (optional)
Integer Number of secure_channel_se_token_timeout. 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. format: int32
ssl_certificate_expiry_warning_days (optional)
array[Integer] Number of days for SSL Certificate expiry warning.
unresponsive_se_reboot (optional)
Integer Number of unresponsive_se_reboot. 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. format: int32
upgrade_lease_time (optional)
Integer Number of upgrade_lease_time. format: int32
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.
vnic_op_fail_time (optional)
Integer Number of vnic_op_fail_time. 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. format: int32
vs_awaiting_se_timeout (optional)
Integer Number of vs_awaiting_se_timeout. format: int32
vs_key_rotate_period (optional)
Integer Allowed values are 1-1051200. Special values are 0 - 'Disabled'. 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. format: int32
vs_se_bootup_fail (optional)
Integer Number of vs_se_bootup_fail. format: int32
vs_se_create_fail (optional)
Integer Number of vs_se_create_fail. format: int32
vs_se_ping_fail (optional)
Integer Number of vs_se_ping_fail. format: int32
vs_se_vnic_fail (optional)
Integer Number of vs_se_vnic_fail. format: int32
vs_se_vnic_ip_fail (optional)
Integer Number of vs_se_vnic_ip_fail. format: int32
warmstart_se_reconnect_wait_time (optional)
Integer Number of warmstart_se_reconnect_wait_time. format: int32

ControllerPropertiesApiResponse Up

count
Integer format: int32
results