GET /vimgrvmruntime/{uuid}

GET /vimgrvmruntime/{uuid}

/vimgrvmruntime/{uuid}

Request
URI
GET
https://{api_host}/api/vimgrvmruntime/{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 VIMgrVMRuntime of type(s) application/json 
{
    "_last_modified": "string",
    "availability_zone": "string",
    "cloud_ref": "string",
    "connection_state": "string",
    "controller_cluster_uuid": "string",
    "controller_ip_addr": "string",
    "controller_vm": false,
    "cpu_reservation": 0,
    "cpu_shares": 0,
    "creation_in_progress": false,
    "guest_nic": [
        {
            "avi_internal_network": false,
            "connected": false,
            "del_pending": false,
            "guest_ip": [
                {
                    "fip_available": false,
                    "fip_subnet_uuids": [
                        "string"
                    ],
                    "floatingip_subnets": [
                        {
                            "name": "string",
                            "prefix": {
                                "ip_addr": {
                                    "addr": "string",
                                    "type": "string"
                                },
                                "mask": 0
                            },
                            "uuid": "string"
                        }
                    ],
                    "ip_subnet": "string",
                    "name": "string",
                    "prefix": {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    },
                    "primary": false,
                    "ref_count": 0,
                    "se_ref_count": 0,
                    "uuid": "string"
                }
            ],
            "label": "string",
            "mac_addr": "string",
            "mgmt_vnic": false,
            "network_name": "string",
            "network_uuid": "string",
            "os_port_uuid": "string",
            "type": "string"
        }
    ],
    "host": "string",
    "init_vnics": 0,
    "managed_object_id": "string",
    "mem_shares": 0,
    "memory": 0,
    "memory_reservation": 0,
    "name": "string",
    "num_cpu": 0,
    "ovf_avisetype_field": "string",
    "powerstate": "string",
    "se_ver": 0,
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string",
    "vcenter_datacenter_uuid": "string",
    "vcenter_rm_cookie": "string",
    "vcenter_se_type": "string",
    "vcenter_template_vm": false,
    "vcenter_vAppName": "string",
    "vcenter_vAppVendor": "string",
    "vcenter_vm_type": "string",
    "vcenter_vnic_discovered": false,
    "vm_lb_weight": 0
}
string
_last_modified
Optional

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

string
availability_zone
Optional

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

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
connection_state
Optional

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

string
controller_cluster_uuid
Optional

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

string
controller_ip_addr
Optional

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

boolean
controller_vm
Optional

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

integer As int64 As int64
cpu_reservation
Optional

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

integer As int32 As int32
cpu_shares
Optional

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

boolean
creation_in_progress
Optional

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

array of object
guest_nic
Optional

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

string
host
Optional

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

integer As int32 As int32
init_vnics
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 int32 As int32
mem_shares
Optional

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

integer As int64 As int64
memory
Optional

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

integer As int64 As int64
memory_reservation
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.

integer As int32 As int32
num_cpu
Optional

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

string
ovf_avisetype_field
Optional

Field introduced in 17.1.1,17.1.3. 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.

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

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.

string
vcenter_datacenter_uuid
Optional

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

string
vcenter_rm_cookie
Optional

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

string
vcenter_se_type
Optional

Enum options - VIMGR_SE_NETWORK_ADMIN, VIMGR_SE_UNIFIED_ADMIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
vcenter_template_vm
Optional

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

string
vcenter_vAppName
Optional

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

string
vcenter_vAppVendor
Optional

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

string
vcenter_vm_type
Optional

Enum options - VMTYPE_SE_VM, VMTYPE_POOL_SRVR. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
vcenter_vnic_discovered
Optional

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

integer As int32 As int32
vm_lb_weight
Optional

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/vimgrvmruntime/{uuid}
On This Page
Vimgr Vmruntime Operations
GET
GET /vimgrvmruntime
POST
POST /vimgrvmruntime
GET
GET /vimgrvmruntime/{uuid}
PUT
PUT /vimgrvmruntime/{uuid}
PATCH
PATCH /vimgrvmruntime/{uuid}
DELETE
DELETE /vimgrvmruntime/{uuid}