Avi VIMgrHostRuntime Object API

##CLI## ``` - show vinfra host - vinfra makehostaccessible ```
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 /vimgrhostruntime
  2. post /vimgrhostruntime
  3. delete /vimgrhostruntime/{uuid}
  4. get /vimgrhostruntime/{uuid}
  5. post /vimgrhostruntime/{uuid}/makeaccessible
  6. patch /vimgrhostruntime/{uuid}
  7. 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.
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
{
  "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",
    "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
( 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",
  "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
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.
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",
  "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}/makeaccessible
( vimgrhostruntimeUuidMakeaccessiblePost)

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
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",
  "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",
  "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

CdpLldpInfo Up

chassis (optional)
String chassis of CdpLldpInfo.
device (optional)
String device of CdpLldpInfo.
mgmtaddr (optional)
String mgmtaddr of CdpLldpInfo.
port (optional)
String port of CdpLldpInfo.
switch_info_type (optional)
String Enum options - CDP, LLDP, NOT_APPLICABLE.
system_name (optional)
String system_name of CdpLldpInfo.

VIMgrHostRuntime Up

cloud_ref (optional)
String It is a reference to an object of type Cloud.
cluster_name (optional)
String cluster_name of VIMgrHostRuntime.
cluster_uuid (optional)
String Unique object identifier of cluster.
cntlr_accessible (optional)
Boolean Placeholder for description of property cntlr_accessible of obj type VIMgrHostRuntime field type str type boolean
connection_state (optional)
String connection_state of VIMgrHostRuntime.
cpu_hz (optional)
Long Number of cpu_hz. format: int64
maintenance_mode (optional)
Boolean Placeholder for description of property maintenance_mode of obj type VIMgrHostRuntime field type str type boolean
managed_object_id
String managed_object_id of VIMgrHostRuntime.
mem (optional)
Long Number of mem. format: int64
mgmt_portgroup (optional)
String mgmt_portgroup of VIMgrHostRuntime.
name
String Name of the object.
network_uuids (optional)
array[String] Unique object identifiers of networks.
num_cpu_cores (optional)
Integer Number of num_cpu_cores. format: int32
num_cpu_packages (optional)
Integer Number of num_cpu_packages. format: int32
num_cpu_threads (optional)
Integer Number of num_cpu_threads. format: int32
pnics (optional)
array[CdpLldpInfo] Placeholder for description of property pnics of obj type VIMgrHostRuntime field type str type object
powerstate (optional)
String powerstate of VIMgrHostRuntime.
quarantine_start_ts (optional)
String quarantine_start_ts of VIMgrHostRuntime.
quarantined (optional)
Boolean Placeholder for description of property quarantined of obj type VIMgrHostRuntime field type str type boolean
quarantined_periods (optional)
Integer Number of quarantined_periods. format: int32
se_fail_cnt (optional)
Integer Number of se_fail_cnt. format: int32
se_success_cnt (optional)
Integer Number of se_success_cnt. format: int32
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.
vm_refs (optional)
array[String] It is a reference to an object of type VIMgrVMRuntime.

VIMgrHostRuntimeApiResponse Up

count
Integer format: int32
results