Avi CloudProperties Object API

##CLI## ``` - configure cloudproperties - show cloudproperties ```
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 /cloudproperties
  2. post /cloudproperties
  3. delete /cloudproperties/{uuid}
  4. get /cloudproperties/{uuid}
  5. patch /cloudproperties/{uuid}
  6. put /cloudproperties/{uuid}
  7. get /controllerproperties
  8. post /controllerproperties
  9. delete /controllerproperties/{uuid}
  10. get /controllerproperties/{uuid}
  11. patch /controllerproperties/{uuid}
  12. put /controllerproperties/{uuid}
Up
get /cloudproperties
( 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

CloudPropertiesApiResponse

Example data

Content-Type: application/json
{
  "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
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "info" : [ {
      "cca_props" : {
        "poll_duration_target" : 123,
        "vnic_retries_delay" : 123,
        "poll_fast_target" : 123,
        "poll_slow_target" : 123,
        "async_retries_delay" : 123,
        "async_retries" : 123,
        "vnic_retries" : 123
      },
      "htypes" : [ "aeiou" ],
      "vtype" : "aeiou",
      "flavor_regex_filter" : "aeiou",
      "flavor_props" : [ {
        "enhanced_nw" : true,
        "cost" : "aeiou",
        "public" : true,
        "ram_mb" : 123,
        "max_nics" : 123,
        "meta" : [ {
          "value" : "aeiou",
          "key" : "aeiou"
        } ],
        "max_ips_per_nic" : 123,
        "name" : "aeiou",
        "id" : "aeiou",
        "vcpus" : 123,
        "disk_gb" : 123
      } ],
      "controller_props" : {
        "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 CloudPropertiesApiResponse

401

log in failed

Up
post /cloudproperties
( 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

CloudProperties

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
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "info" : [ {
    "cca_props" : {
      "poll_duration_target" : 123,
      "vnic_retries_delay" : 123,
      "poll_fast_target" : 123,
      "poll_slow_target" : 123,
      "async_retries_delay" : 123,
      "async_retries" : 123,
      "vnic_retries" : 123
    },
    "htypes" : [ "aeiou" ],
    "vtype" : "aeiou",
    "flavor_regex_filter" : "aeiou",
    "flavor_props" : [ {
      "enhanced_nw" : true,
      "cost" : "aeiou",
      "public" : true,
      "ram_mb" : 123,
      "max_nics" : 123,
      "meta" : [ {
        "value" : "aeiou",
        "key" : "aeiou"
      } ],
      "max_ips_per_nic" : 123,
      "name" : "aeiou",
      "id" : "aeiou",
      "vcpus" : 123,
      "disk_gb" : 123
    } ],
    "controller_props" : {
      "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 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 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 /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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

CloudProperties

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
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "info" : [ {
    "cca_props" : {
      "poll_duration_target" : 123,
      "vnic_retries_delay" : 123,
      "poll_fast_target" : 123,
      "poll_slow_target" : 123,
      "async_retries_delay" : 123,
      "async_retries" : 123,
      "vnic_retries" : 123
    },
    "htypes" : [ "aeiou" ],
    "vtype" : "aeiou",
    "flavor_regex_filter" : "aeiou",
    "flavor_props" : [ {
      "enhanced_nw" : true,
      "cost" : "aeiou",
      "public" : true,
      "ram_mb" : 123,
      "max_nics" : 123,
      "meta" : [ {
        "value" : "aeiou",
        "key" : "aeiou"
      } ],
      "max_ips_per_nic" : 123,
      "name" : "aeiou",
      "id" : "aeiou",
      "vcpus" : 123,
      "disk_gb" : 123
    } ],
    "controller_props" : {
      "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 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

CloudProperties

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
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "info" : [ {
    "cca_props" : {
      "poll_duration_target" : 123,
      "vnic_retries_delay" : 123,
      "poll_fast_target" : 123,
      "poll_slow_target" : 123,
      "async_retries_delay" : 123,
      "async_retries" : 123,
      "vnic_retries" : 123
    },
    "htypes" : [ "aeiou" ],
    "vtype" : "aeiou",
    "flavor_regex_filter" : "aeiou",
    "flavor_props" : [ {
      "enhanced_nw" : true,
      "cost" : "aeiou",
      "public" : true,
      "ram_mb" : 123,
      "max_nics" : 123,
      "meta" : [ {
        "value" : "aeiou",
        "key" : "aeiou"
      } ],
      "max_ips_per_nic" : 123,
      "name" : "aeiou",
      "id" : "aeiou",
      "vcpus" : 123,
      "disk_gb" : 123
    } ],
    "controller_props" : {
      "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 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

CloudProperties

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
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "info" : [ {
    "cca_props" : {
      "poll_duration_target" : 123,
      "vnic_retries_delay" : 123,
      "poll_fast_target" : 123,
      "poll_slow_target" : 123,
      "async_retries_delay" : 123,
      "async_retries" : 123,
      "vnic_retries" : 123
    },
    "htypes" : [ "aeiou" ],
    "vtype" : "aeiou",
    "flavor_regex_filter" : "aeiou",
    "flavor_props" : [ {
      "enhanced_nw" : true,
      "cost" : "aeiou",
      "public" : true,
      "ram_mb" : 123,
      "max_nics" : 123,
      "meta" : [ {
        "value" : "aeiou",
        "key" : "aeiou"
      } ],
      "max_ips_per_nic" : 123,
      "name" : "aeiou",
      "id" : "aeiou",
      "vcpus" : 123,
      "disk_gb" : 123
    } ],
    "controller_props" : {
      "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 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.
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. CC_AgentProperties
  2. CC_Properties
  3. CloudFlavor
  4. CloudInfo
  5. CloudMeta
  6. CloudProperties
  7. CloudPropertiesApiResponse
  8. ControllerProperties
  9. ControllerPropertiesApiResponse
  10. Hypervisor_Properties

CC_AgentProperties Up

async_retries (optional)
Integer Maximum polls to check for async jobs to finish. format: int32
async_retries_delay (optional)
Integer Delay between each async job status poll check. 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. format: int32
poll_fast_target (optional)
Integer Fast poll interval. format: int32
poll_slow_target (optional)
Integer Slow poll interval. format: int32
vnic_retries (optional)
Integer Maximum polls to check for vnics to be attached to VM. format: int32
vnic_retries_delay (optional)
Integer Delay between each vnic status poll check. format: int32

CC_Properties Up

rpc_poll_interval (optional)
Integer Number of rpc_poll_interval. format: int32
rpc_queue_size (optional)
Integer Number of rpc_queue_size. format: int32

CloudFlavor Up

cost (optional)
String cost of CloudFlavor.
disk_gb (optional)
Integer Number of disk_gb. format: int32
enhanced_nw (optional)
Boolean Placeholder for description of property enhanced_nw of obj type CloudFlavor field type str type boolean
id
String id of CloudFlavor.
max_ips_per_nic (optional)
Integer Number of max_ips_per_nic. format: int32
max_nics (optional)
Integer Number of max_nics. format: int32
meta (optional)
array[CloudMeta] Placeholder for description of property meta of obj type CloudFlavor field type str type object
name
String Name of the object.
public (optional)
Boolean Placeholder for description of property public of obj type CloudFlavor field type str type boolean
ram_mb (optional)
Integer Number of ram_mb. format: int32
vcpus (optional)
Integer Number of vcpus. format: int32

CloudInfo Up

cca_props (optional)
CC_AgentProperties CloudConnectorAgent properties specific to this cloud type.
controller_props (optional)
ControllerProperties Controller properties specific to this cloud type.
flavor_props (optional)
array[CloudFlavor] Flavor properties specific to this cloud type.
flavor_regex_filter (optional)
String flavor_regex_filter of CloudInfo.
htypes (optional)
array[String] Supported hypervisors. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN.
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.

CloudMeta Up

key
String key of CloudMeta.
value
String value of CloudMeta.

CloudProperties Up

cc_props (optional)
CC_Properties CloudConnector properties.
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.
hyp_props (optional)
array[Hypervisor_Properties] Hypervisor properties.
info (optional)
array[CloudInfo] Properties specific to a cloud type.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

CloudPropertiesApiResponse Up

count
Integer format: int32
results

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

Hypervisor_Properties Up

htype
String Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN.
max_ips_per_nic (optional)
Integer Number of max_ips_per_nic. format: int32
max_nics (optional)
Integer Number of max_nics. format: int32