Avi VIMgrDCRuntime Object API

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

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

VIMgrDCRuntimeApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "pending_vcenter_reqs" : 123,
    "vcenter_uuid" : "aeiou",
    "interested_hosts" : [ {
      "interested_uuid" : "aeiou"
    } ],
    "interested_nws" : [ "" ],
    "vm_refs" : [ "aeiou" ],
    "host_refs" : [ "aeiou" ],
    "type" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "sevm_refs" : [ "aeiou" ],
    "inventory_state" : 123,
    "interested_vms" : [ "" ],
    "cluster_refs" : [ "aeiou" ],
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "nw_refs" : [ "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 VIMgrDCRuntimeApiResponse

401

log in failed

Up
post /vimgrdcruntime
(vimgrdcruntimePost)

Consumes

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

Request body

body (required)
Body Parameter — VIMgrDCRuntime object creation

Return type

VIMgrDCRuntime

Example data

Content-Type: application/json
{
  "pending_vcenter_reqs" : 123,
  "vcenter_uuid" : "aeiou",
  "interested_hosts" : [ {
    "interested_uuid" : "aeiou"
  } ],
  "interested_nws" : [ "" ],
  "vm_refs" : [ "aeiou" ],
  "host_refs" : [ "aeiou" ],
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "sevm_refs" : [ "aeiou" ],
  "inventory_state" : 123,
  "interested_vms" : [ "" ],
  "cluster_refs" : [ "aeiou" ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "nw_refs" : [ "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 VIMgrDCRuntime

401

log in failed

Up
delete /vimgrdcruntime/{uuid}
(vimgrdcruntimeUuidDelete)

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 /vimgrdcruntime/{uuid}
(vimgrdcruntimeUuidGet)

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

VIMgrDCRuntime

Example data

Content-Type: application/json
{
  "pending_vcenter_reqs" : 123,
  "vcenter_uuid" : "aeiou",
  "interested_hosts" : [ {
    "interested_uuid" : "aeiou"
  } ],
  "interested_nws" : [ "" ],
  "vm_refs" : [ "aeiou" ],
  "host_refs" : [ "aeiou" ],
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "sevm_refs" : [ "aeiou" ],
  "inventory_state" : 123,
  "interested_vms" : [ "" ],
  "cluster_refs" : [ "aeiou" ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "nw_refs" : [ "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 VIMgrDCRuntime

401

log in failed

Up
patch /vimgrdcruntime/{uuid}
(vimgrdcruntimeUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrDCRuntime

Example data

Content-Type: application/json
{
  "pending_vcenter_reqs" : 123,
  "vcenter_uuid" : "aeiou",
  "interested_hosts" : [ {
    "interested_uuid" : "aeiou"
  } ],
  "interested_nws" : [ "" ],
  "vm_refs" : [ "aeiou" ],
  "host_refs" : [ "aeiou" ],
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "sevm_refs" : [ "aeiou" ],
  "inventory_state" : 123,
  "interested_vms" : [ "" ],
  "cluster_refs" : [ "aeiou" ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "nw_refs" : [ "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 VIMgrDCRuntime

401

log in failed

Up
put /vimgrdcruntime/{uuid}
(vimgrdcruntimeUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrDCRuntime

Example data

Content-Type: application/json
{
  "pending_vcenter_reqs" : 123,
  "vcenter_uuid" : "aeiou",
  "interested_hosts" : [ {
    "interested_uuid" : "aeiou"
  } ],
  "interested_nws" : [ "" ],
  "vm_refs" : [ "aeiou" ],
  "host_refs" : [ "aeiou" ],
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "sevm_refs" : [ "aeiou" ],
  "inventory_state" : 123,
  "interested_vms" : [ "" ],
  "cluster_refs" : [ "aeiou" ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "nw_refs" : [ "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 VIMgrDCRuntime

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. VIMgrDCRuntime
  2. VIMgrDCRuntimeApiResponse
  3. VIMgrInterestedEntity

VIMgrDCRuntime Up

cloud_ref (optional)
String It is a reference to an object of type Cloud.
cluster_refs (optional)
array[String] It is a reference to an object of type VIMgrClusterRuntime.
host_refs (optional)
array[String] It is a reference to an object of type VIMgrHostRuntime.
interested_hosts (optional)
array[VIMgrInterestedEntity] Placeholder for description of property interested_hosts of obj type VIMgrDCRuntime field type str type object
interested_nws (optional)
array[VIMgrInterestedEntity] Placeholder for description of property interested_nws of obj type VIMgrDCRuntime field type str type object
interested_vms (optional)
array[VIMgrInterestedEntity] Placeholder for description of property interested_vms of obj type VIMgrDCRuntime field type str type object
inventory_state (optional)
Integer Number of inventory_state. format: int32
managed_object_id
String managed_object_id of VIMgrDCRuntime.
name
String Name of the object.
nw_refs (optional)
array[String] It is a reference to an object of type VIMgrNWRuntime.
pending_vcenter_reqs (optional)
Integer Number of pending_vcenter_reqs. format: int32
sevm_refs (optional)
array[String] It is a reference to an object of type VIMgrSEVMRuntime.
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.
vcenter_uuid (optional)
String Unique object identifier of vcenter.
vm_refs (optional)
array[String] It is a reference to an object of type VIMgrVMRuntime.

VIMgrDCRuntimeApiResponse Up

count
Integer format: int32
results

VIMgrInterestedEntity Up

interested_uuid
String Unique object identifier of interested.