Avi VIMgrClusterRuntime Object API

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

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.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.

Return type

VIMgrClusterRuntimeApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "host_refs" : [ "aeiou" ],
    "datacenter_managed_object_id" : "aeiou",
    "datacenter_uuid" : "aeiou",
    "type" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "managed_object_id" : "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

200

OK VIMgrClusterRuntimeApiResponse

401

log in failed

Up
post /vimgrclusterruntime
(vimgrclusterruntimePost)

Consumes

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

Request body

body (required)
Body Parameter — VIMgrClusterRuntime object creation

Return type

VIMgrClusterRuntime

Example data

Content-Type: application/json
{
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "host_refs" : [ "aeiou" ],
  "datacenter_managed_object_id" : "aeiou",
  "datacenter_uuid" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "managed_object_id" : "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

200

OK VIMgrClusterRuntime

401

log in failed

Up
delete /vimgrclusterruntime/{uuid}
(vimgrclusterruntimeUuidDelete)

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 /vimgrclusterruntime/{uuid}
(vimgrclusterruntimeUuidGet)

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

VIMgrClusterRuntime

Example data

Content-Type: application/json
{
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "host_refs" : [ "aeiou" ],
  "datacenter_managed_object_id" : "aeiou",
  "datacenter_uuid" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "managed_object_id" : "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

200

OK VIMgrClusterRuntime

401

log in failed

Up
patch /vimgrclusterruntime/{uuid}
(vimgrclusterruntimeUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrClusterRuntime

Example data

Content-Type: application/json
{
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "host_refs" : [ "aeiou" ],
  "datacenter_managed_object_id" : "aeiou",
  "datacenter_uuid" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "managed_object_id" : "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

200

OK VIMgrClusterRuntime

401

log in failed

Up
put /vimgrclusterruntime/{uuid}
(vimgrclusterruntimeUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrClusterRuntime

Example data

Content-Type: application/json
{
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "host_refs" : [ "aeiou" ],
  "datacenter_managed_object_id" : "aeiou",
  "datacenter_uuid" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "managed_object_id" : "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

200

OK VIMgrClusterRuntime

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. VIMgrClusterRuntime
  2. VIMgrClusterRuntimeApiResponse

VIMgrClusterRuntime Up

cloud_ref (optional)
String It is a reference to an object of type Cloud.
datacenter_managed_object_id (optional)
String datacenter_managed_object_id of VIMgrClusterRuntime.
datacenter_uuid (optional)
String Unique object identifier of datacenter.
host_refs (optional)
array[String] It is a reference to an object of type VIMgrHostRuntime.
managed_object_id
String managed_object_id of VIMgrClusterRuntime.
name
String Name of the object.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
type
String 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.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

VIMgrClusterRuntimeApiResponse Up

count
Integer format: int32
results