List Base V Ms V2

List Base V Ms V2

At least one of the listed privileges is required -

Privileges Description
GLOBAL_CONFIG_VIEW Caller should have permission to this privilege, to perform this operation.
VC_CONFIG_VIEW Caller should have permission to this privilege, to perform this operation.
Request
URI
GET
https://{api_host}/rest/external/v2/base-vms
COPY
Query Parameters
string
vcenter_id
Required

Virtual Center ID

string
datacenter_id
Optional

Datacenter ID

boolean
filter_incompatible_vms
Optional

Whether to filter out incompatible VMs

integer
page
Optional

page, if passed should be > 0.

page example
1
integer
size
Optional

size, if passed should be > 0.

size example
10
string
filter
Optional

filter expression built using fields with 'supported filters' as described in output model schema of this API.

filter example
[object Object]
string
sort_by
Optional

Field that would be used to sort the results.

sort_by example
<property-name>
string
order_by
Optional

Determines the ordering of results.

order_by example
ASC
Possible values are : ASC, DESC,

Authentication
This operation uses the following authentication methods.
Responses
200

OK

[
    {
        "datacenter_id": "datacenter-1",
        "id": "vm-416",
        "incompatible_reasons": [
            "string"
        ],
        "name": "Win10",
        "network_type": "STANDARD_NETWORK",
        "num_nics": 2,
        "operating_system": "WINDOWS_10",
        "operating_system_display_name": "Microsoft Windows 10 (64-bit)",
        "path": "/Datacenter/vm/VMs/Win10",
        "vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e"
    }
]

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure