Cloud Virtual Machine Info

Returns information about the particular virtual machine

Request

URI

GET

https://nsxmanager.your.domain/api/v1/csm/virtual-machines/{virtual-machine-id}

COPY

Path Parameters

string

virtual-machine-id

Required

ID of the virtual machine

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns CloudVirtualMachine of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineCloudVirtualMachine1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_create_time": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_last_modified_time": 0,
    "_create_user": "string",
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "gateway_ha_index": 0,
    "gateway_status": "string",
    "nsx_ip": "string",
    "is_gateway": false,
    "is_gateway_active": false,
    "error_messages": [
        {
            "error_id": 0,
            "detailed_message": "string"
        }
    ],
    "agent_status": "string",
    "logical_switch_id": "string",
    "logical_switch_display_name": "string",
    "private_ip": "string",
    "public_ip": "string",
    "os_details": "string",
    "managed_by_nsx": false,
    "quarantine_state": "string",
    "cloud_tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "os_type": "string",
    "agent_version": "string"
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure