List Virtual Machines

List Virtual Machines

Returns information about all virtual machines.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/fabric/virtual-machines
COPY
Query Parameters
string
included_fields
Optional

Comma separated list of fields that should be included to result of query

string
display_name
Optional

Display Name of the virtual machine

integer
page_size
Optional

Maximum number of results to return in this page (server may return fewer)

string
sort_by
Optional

Field by which records are sorted

string
cursor
Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean
sort_ascending
Optional

sort_ascending

string
host_id
Optional

Id of the host where this vif is located

string
external_id
Optional

External id of the virtual machine

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns VirtualMachineListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineVirtualMachineListResult1 
{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "display_name": "string",
            "description": "string",
            "_last_sync_time": 0,
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "resource_type": "string",
            "local_id_on_host": "string",
            "type": "string",
            "power_state": "string",
            "compute_ids": [
                "string"
            ],
            "host_id": "string",
            "external_id": "string"
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Fabric Operations
POST
Add Node
DELETE
Delete Node
GET
Get Fabric Node Modules
GET
Get Fabric Node State
GET
List Fabric Node Interfaces
GET
List Node Capabilities
GET
List Nodes
GET
List Vifs
GET
List Virtual Machines
POST
Perform Host Node Upgrade Action
POST
Perform Node Action
GET
Read Fabric Node Interface
GET
Read Fabric Node Interface Statistics
GET
Read Node
GET
Read Nodes Status
GET
Read Node Status
POST
Restart Inventory Sync
PUT
Update Node
POST
Update Virtual Machine Tags