Avi VIMgrHostRuntime Object API

CLI ``` - show vinfra host - vinfra makehostaccessible - show vinfra quarantinedhost ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 22.1.6
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 /vimgrhostruntime
  2. post /vimgrhostruntime/getquarantinedhosts
  3. post /vimgrhostruntime
  4. post /vimgrhostruntime/{uuid}/accessible
  5. delete /vimgrhostruntime/{uuid}
  6. get /vimgrhostruntime/{uuid}
  7. patch /vimgrhostruntime/{uuid}
  8. put /vimgrhostruntime/{uuid}
Up
get /vimgrhostruntime
(vimgrhostruntimeGet)

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.
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

VIMgrHostRuntimeApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "maintenance_mode" : true,
    "num_cpu_packages" : 123,
    "pnics" : [ {
      "mgmtaddr" : "aeiou",
      "switch_info_type" : "aeiou",
      "port" : "aeiou",
      "system_name" : "aeiou",
      "chassis" : "aeiou",
      "device" : "aeiou"
    } ],
    "vm_refs" : [ "aeiou" ],
    "quarantined" : true,
    "connection_state" : "aeiou",
    "type" : "aeiou",
    "uuid" : "aeiou",
    "powerstate" : "aeiou",
    "_last_modified" : "aeiou",
    "se_fail_cnt" : 123,
    "quarantine_start_ts" : "aeiou",
    "mem" : 123456789,
    "cloud_ref" : "aeiou",
    "cpu_hz" : 123456789,
    "num_cpu_threads" : 123,
    "network_uuids" : [ "aeiou" ],
    "cluster_name" : "aeiou",
    "se_success_cnt" : 123,
    "cntlr_accessible" : true,
    "url" : "aeiou",
    "num_cpu_cores" : 123,
    "cluster_uuid" : "aeiou",
    "tenant_ref" : "aeiou",
    "mgmt_portgroup" : "aeiou",
    "name" : "aeiou",
    "quarantined_periods" : 123,
    "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 VIMgrHostRuntimeApiResponse

401

log in failed

Up
post /vimgrhostruntime/getquarantinedhosts
(vimgrhostruntimeGetquarantinedhostsPost)

Consumes

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

Request body

body (required)
Body Parameter — VcenterQuarantinedHostParams

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

200

OK String

401

log in failed

Up
post /vimgrhostruntime
(vimgrhostruntimePost)

Consumes

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

Request body

body (required)
Body Parameter — VIMgrHostRuntime object creation

Return type

VIMgrHostRuntime

Example data

Content-Type: application/json
{
  "maintenance_mode" : true,
  "num_cpu_packages" : 123,
  "pnics" : [ {
    "mgmtaddr" : "aeiou",
    "switch_info_type" : "aeiou",
    "port" : "aeiou",
    "system_name" : "aeiou",
    "chassis" : "aeiou",
    "device" : "aeiou"
  } ],
  "vm_refs" : [ "aeiou" ],
  "quarantined" : true,
  "connection_state" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "powerstate" : "aeiou",
  "_last_modified" : "aeiou",
  "se_fail_cnt" : 123,
  "quarantine_start_ts" : "aeiou",
  "mem" : 123456789,
  "cloud_ref" : "aeiou",
  "cpu_hz" : 123456789,
  "num_cpu_threads" : 123,
  "network_uuids" : [ "aeiou" ],
  "cluster_name" : "aeiou",
  "se_success_cnt" : 123,
  "cntlr_accessible" : true,
  "url" : "aeiou",
  "num_cpu_cores" : 123,
  "cluster_uuid" : "aeiou",
  "tenant_ref" : "aeiou",
  "mgmt_portgroup" : "aeiou",
  "name" : "aeiou",
  "quarantined_periods" : 123,
  "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 VIMgrHostRuntime

401

log in failed

Up
post /vimgrhostruntime/{uuid}/accessible
(vimgrhostruntimeUuidAccessiblePost)

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 — empty

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

200

OK String

401

log in failed

Up
delete /vimgrhostruntime/{uuid}
(vimgrhostruntimeUuidDelete)

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 /vimgrhostruntime/{uuid}
(vimgrhostruntimeUuidGet)

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

VIMgrHostRuntime

Example data

Content-Type: application/json
{
  "maintenance_mode" : true,
  "num_cpu_packages" : 123,
  "pnics" : [ {
    "mgmtaddr" : "aeiou",
    "switch_info_type" : "aeiou",
    "port" : "aeiou",
    "system_name" : "aeiou",
    "chassis" : "aeiou",
    "device" : "aeiou"
  } ],
  "vm_refs" : [ "aeiou" ],
  "quarantined" : true,
  "connection_state" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "powerstate" : "aeiou",
  "_last_modified" : "aeiou",
  "se_fail_cnt" : 123,
  "quarantine_start_ts" : "aeiou",
  "mem" : 123456789,
  "cloud_ref" : "aeiou",
  "cpu_hz" : 123456789,
  "num_cpu_threads" : 123,
  "network_uuids" : [ "aeiou" ],
  "cluster_name" : "aeiou",
  "se_success_cnt" : 123,
  "cntlr_accessible" : true,
  "url" : "aeiou",
  "num_cpu_cores" : 123,
  "cluster_uuid" : "aeiou",
  "tenant_ref" : "aeiou",
  "mgmt_portgroup" : "aeiou",
  "name" : "aeiou",
  "quarantined_periods" : 123,
  "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 VIMgrHostRuntime

401

log in failed

Up
patch /vimgrhostruntime/{uuid}
(vimgrhostruntimeUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrHostRuntime

Example data

Content-Type: application/json
{
  "maintenance_mode" : true,
  "num_cpu_packages" : 123,
  "pnics" : [ {
    "mgmtaddr" : "aeiou",
    "switch_info_type" : "aeiou",
    "port" : "aeiou",
    "system_name" : "aeiou",
    "chassis" : "aeiou",
    "device" : "aeiou"
  } ],
  "vm_refs" : [ "aeiou" ],
  "quarantined" : true,
  "connection_state" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "powerstate" : "aeiou",
  "_last_modified" : "aeiou",
  "se_fail_cnt" : 123,
  "quarantine_start_ts" : "aeiou",
  "mem" : 123456789,
  "cloud_ref" : "aeiou",
  "cpu_hz" : 123456789,
  "num_cpu_threads" : 123,
  "network_uuids" : [ "aeiou" ],
  "cluster_name" : "aeiou",
  "se_success_cnt" : 123,
  "cntlr_accessible" : true,
  "url" : "aeiou",
  "num_cpu_cores" : 123,
  "cluster_uuid" : "aeiou",
  "tenant_ref" : "aeiou",
  "mgmt_portgroup" : "aeiou",
  "name" : "aeiou",
  "quarantined_periods" : 123,
  "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 VIMgrHostRuntime

401

log in failed

Up
put /vimgrhostruntime/{uuid}
(vimgrhostruntimeUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrHostRuntime

Example data

Content-Type: application/json
{
  "maintenance_mode" : true,
  "num_cpu_packages" : 123,
  "pnics" : [ {
    "mgmtaddr" : "aeiou",
    "switch_info_type" : "aeiou",
    "port" : "aeiou",
    "system_name" : "aeiou",
    "chassis" : "aeiou",
    "device" : "aeiou"
  } ],
  "vm_refs" : [ "aeiou" ],
  "quarantined" : true,
  "connection_state" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "powerstate" : "aeiou",
  "_last_modified" : "aeiou",
  "se_fail_cnt" : 123,
  "quarantine_start_ts" : "aeiou",
  "mem" : 123456789,
  "cloud_ref" : "aeiou",
  "cpu_hz" : 123456789,
  "num_cpu_threads" : 123,
  "network_uuids" : [ "aeiou" ],
  "cluster_name" : "aeiou",
  "se_success_cnt" : 123,
  "cntlr_accessible" : true,
  "url" : "aeiou",
  "num_cpu_cores" : 123,
  "cluster_uuid" : "aeiou",
  "tenant_ref" : "aeiou",
  "mgmt_portgroup" : "aeiou",
  "name" : "aeiou",
  "quarantined_periods" : 123,
  "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 VIMgrHostRuntime

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. CdpLldpInfo
  2. VIMgrHostRuntime
  3. VIMgrHostRuntimeApiResponse
  4. VcenterQuarantinedHostParams

CdpLldpInfo Up

chassis (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
device (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mgmtaddr (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
switch_info_type (optional)
String Enum options - CDP, LLDP, NOT_APPLICABLE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
system_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VIMgrHostRuntime Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
cloud_ref (optional)
String It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cluster_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cluster_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cntlr_accessible (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
connection_state (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cpu_hz (optional)
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
maintenance_mode (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
managed_object_id
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mem (optional)
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
mgmt_portgroup (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
network_uuids (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_cpu_cores (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_cpu_packages (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_cpu_threads (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
pnics (optional)
array[CdpLldpInfo] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
powerstate (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
quarantine_start_ts (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
quarantined (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
quarantined_periods (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_fail_cnt (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_success_cnt (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vm_refs (optional)
array[String] It is a reference to an object of type VIMgrVMRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VIMgrHostRuntimeApiResponse Up

count
Integer format: int32
results
next (optional)

VcenterQuarantinedHostParams Up

cloud_uuid (optional)
String Vcenter cloud id. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.