Avi Cluster Object API

##CLI## ``` - configure cluster - show cluster ```
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 /cluster
  2. post /cluster
  3. delete /cluster/{uuid}
  4. get /cluster/{uuid}
  5. patch /cluster/{uuid}
  6. put /cluster/{uuid}
Up
get /cluster
( clusterGet)

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

ClusterApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "nodes" : [ {
      "vm_mor" : "aeiou",
      "public_ip_or_name" : "",
      "vm_uuid" : "aeiou",
      "ip" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "name" : "aeiou",
      "vm_hostname" : "aeiou",
      "vm_name" : "aeiou"
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "rejoin_nodes_automatically" : true,
    "uuid" : "aeiou",
    "url" : "aeiou",
    "virtual_ip" : ""
  } ]
}

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 ClusterApiResponse

401

log in failed

Up
post /cluster
( clusterPost)

Consumes

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

Request body

body (required)
Body Parameter — Cluster object creation

Return type

Cluster

Example data

Content-Type: application/json
{
  "nodes" : [ {
    "vm_mor" : "aeiou",
    "public_ip_or_name" : "",
    "vm_uuid" : "aeiou",
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "name" : "aeiou",
    "vm_hostname" : "aeiou",
    "vm_name" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "rejoin_nodes_automatically" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "virtual_ip" : ""
}

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 Cluster

401

log in failed

Up
delete /cluster/{uuid}
( clusterUuidDelete)

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 /cluster/{uuid}
( clusterUuidGet)

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

Cluster

Example data

Content-Type: application/json
{
  "nodes" : [ {
    "vm_mor" : "aeiou",
    "public_ip_or_name" : "",
    "vm_uuid" : "aeiou",
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "name" : "aeiou",
    "vm_hostname" : "aeiou",
    "vm_name" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "rejoin_nodes_automatically" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "virtual_ip" : ""
}

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 Cluster

401

log in failed

Up
patch /cluster/{uuid}
( clusterUuidPatch)

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 — Cluster object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

Cluster

Example data

Content-Type: application/json
{
  "nodes" : [ {
    "vm_mor" : "aeiou",
    "public_ip_or_name" : "",
    "vm_uuid" : "aeiou",
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "name" : "aeiou",
    "vm_hostname" : "aeiou",
    "vm_name" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "rejoin_nodes_automatically" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "virtual_ip" : ""
}

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 Cluster

401

log in failed

Up
put /cluster/{uuid}
( clusterUuidPut)

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 — Cluster object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

Cluster

Example data

Content-Type: application/json
{
  "nodes" : [ {
    "vm_mor" : "aeiou",
    "public_ip_or_name" : "",
    "vm_uuid" : "aeiou",
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "name" : "aeiou",
    "vm_hostname" : "aeiou",
    "vm_name" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "rejoin_nodes_automatically" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "virtual_ip" : ""
}

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 Cluster

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. Cluster
  2. ClusterApiResponse
  3. ClusterNode
  4. IpAddr

Cluster Up

name
String Name of the object.
nodes (optional)
array[ClusterNode] Placeholder for description of property nodes of obj type Cluster field type str type object
rejoin_nodes_automatically (optional)
Boolean Re-join cluster nodes automatically in the event one of the node is reset to factory.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.
virtual_ip (optional)
IpAddr A virtual IP address. This IP address will be dynamically reconfigured so that it always is the IP of the cluster leader.

ClusterApiResponse Up

count
Integer format: int32
results

ClusterNode Up

ip
IpAddr IP address of controller VM.
name (optional)
String Name of the object.
public_ip_or_name (optional)
IpAddr Public IP address or hostname of the controller VM. Field introduced in 17.2.3.
vm_hostname (optional)
String Hostname assigned to this controller VM.
vm_mor (optional)
String Managed object reference of this controller VM.
vm_name (optional)
String Name of the controller VM.
vm_uuid (optional)
String UUID on the controller VM.

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS.