GET /vimgrhostruntime/{uuid}

GET /vimgrhostruntime/{uuid}

/vimgrhostruntime/{uuid}

Request
URI
GET
https://{api_host}/api/vimgrhostruntime/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

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.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Responses
200

OK

Returns VIMgrHostRuntime of type(s) application/json 
{
    "_last_modified": "string",
    "cloud_ref": "string",
    "cluster_name": "string",
    "cluster_uuid": "string",
    "cntlr_accessible": false,
    "connection_state": "string",
    "cpu_hz": 0,
    "maintenance_mode": false,
    "managed_object_id": "string",
    "mem": 0,
    "mgmt_portgroup": "string",
    "name": "string",
    "network_uuids": [
        "string"
    ],
    "num_cpu_cores": 0,
    "num_cpu_packages": 0,
    "num_cpu_threads": 0,
    "pnics": [
        {
            "chassis": "string",
            "device": "string",
            "mgmtaddr": "string",
            "port": "string",
            "switch_info_type": "string",
            "system_name": "string"
        }
    ],
    "powerstate": "string",
    "quarantine_start_ts": "string",
    "quarantined": false,
    "quarantined_periods": 0,
    "se_fail_cnt": 0,
    "se_success_cnt": 0,
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string",
    "vm_refs": [
        "string"
    ]
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
cloud_ref
Optional

It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
cluster_name
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
cluster_uuid
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
cntlr_accessible
Optional
Constraints: default: true

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
connection_state
Optional
Constraints: default: connected

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int64 As int64
cpu_hz
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
maintenance_mode
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
managed_object_id
Required

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int64 As int64
mem
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
mgmt_portgroup
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
network_uuids
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
num_cpu_cores
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
num_cpu_packages
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
num_cpu_threads
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
pnics
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
powerstate
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
quarantine_start_ts
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
quarantined
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
quarantined_periods
Optional
Constraints: default: 1

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
se_fail_cnt
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
se_success_cnt
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
type
Required

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.

string
url
Optional

url

string
uuid
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
vm_refs
Optional

It is a reference to an object of type VIMgrVMRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/api/vimgrhostruntime/{uuid}
On This Page
Vimgr Host Runtime Operations
GET
GET /vimgrhostruntime
POST
POST /vimgrhostruntime
GET
GET /vimgrhostruntime/{uuid}
PUT
PUT /vimgrhostruntime/{uuid}
PATCH
PATCH /vimgrhostruntime/{uuid}
DELETE
DELETE /vimgrhostruntime/{uuid}
POST
POST /vimgrhostruntime/{uuid}/accessible
POST
POST /vimgrhostruntime/getquarantinedhosts