Avi VIMgrControllerRuntime Object API

CLI ``` - show vinfra controller ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.9
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 /vimgrcontrollerruntime
  2. post /vimgrcontrollerruntime
  3. delete /vimgrcontrollerruntime/{uuid}
  4. get /vimgrcontrollerruntime/{uuid}
  5. patch /vimgrcontrollerruntime/{uuid}
  6. put /vimgrcontrollerruntime/{uuid}
Up
get /vimgrcontrollerruntime
(vimgrcontrollerruntimeGet)

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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VIMgrControllerRuntimeApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "vnics" : [ {
      "portgroup" : "aeiou",
      "vnic_ip" : [ {
        "ip_addr" : "aeiou",
        "mask" : 123
      } ]
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "type" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "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 VIMgrControllerRuntimeApiResponse

401

log in failed

Up
post /vimgrcontrollerruntime
(vimgrcontrollerruntimePost)

Consumes

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

Request body

body (required)
Body Parameter — VIMgrControllerRuntime object creation

Return type

VIMgrControllerRuntime

Example data

Content-Type: application/json
{
  "vnics" : [ {
    "portgroup" : "aeiou",
    "vnic_ip" : [ {
      "ip_addr" : "aeiou",
      "mask" : 123
    } ]
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 VIMgrControllerRuntime

401

log in failed

Up
delete /vimgrcontrollerruntime/{uuid}
(vimgrcontrollerruntimeUuidDelete)

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 /vimgrcontrollerruntime/{uuid}
(vimgrcontrollerruntimeUuidGet)

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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VIMgrControllerRuntime

Example data

Content-Type: application/json
{
  "vnics" : [ {
    "portgroup" : "aeiou",
    "vnic_ip" : [ {
      "ip_addr" : "aeiou",
      "mask" : 123
    } ]
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 VIMgrControllerRuntime

401

log in failed

Up
patch /vimgrcontrollerruntime/{uuid}
(vimgrcontrollerruntimeUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrControllerRuntime

Example data

Content-Type: application/json
{
  "vnics" : [ {
    "portgroup" : "aeiou",
    "vnic_ip" : [ {
      "ip_addr" : "aeiou",
      "mask" : 123
    } ]
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 VIMgrControllerRuntime

401

log in failed

Up
put /vimgrcontrollerruntime/{uuid}
(vimgrcontrollerruntimeUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrControllerRuntime

Example data

Content-Type: application/json
{
  "vnics" : [ {
    "portgroup" : "aeiou",
    "vnic_ip" : [ {
      "ip_addr" : "aeiou",
      "mask" : 123
    } ]
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 VIMgrControllerRuntime

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. VIControllerVnicInfo
  2. VIGuestvNicIPAddr
  3. VIMgrControllerRuntime
  4. VIMgrControllerRuntimeApiResponse

VIControllerVnicInfo Up

portgroup
String portgroup of VIControllerVnicInfo.
vnic_ip (optional)
array[VIGuestvNicIPAddr] Placeholder for description of property vnic_ip of obj type VIControllerVnicInfo field type str type object

VIGuestvNicIPAddr Up

ip_addr
String ip_addr of VIGuestvNicIPAddr.
mask
Integer Number of mask. format: int32

VIMgrControllerRuntime Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
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, CLOUD_GCP, CLOUD_NSXT.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.
vnics (optional)
array[VIControllerVnicInfo] Placeholder for description of property vnics of obj type VIMgrControllerRuntime field type str type object

VIMgrControllerRuntimeApiResponse Up

count
Integer format: int32
results
next (optional)