Get Base V Ms V2 | VMware Horizon Server API

Get 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/{id}

COPY

Path Parameters

string

Required

Query Parameters

string

vcenter_id

Required

Virtual Center ID

string

datacenter_id

Optional

Datacenter ID

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns BaseVMInfoV2 of type(s) */*

{
    "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"
}

string

datacenter_id

Optional

Datacenter id for this VM. Supported Filters : 'Equals'.

string

Optional

Unique ID representing a VM. Supported Filters : 'Equals'.

array of string

incompatible_reasons

Optional

Reasons that may preclude this BaseVM from having its snapshots used in linked or instant clone desktop or farm creation. Supported Filters : 'Equals'.

Possible values are : IN_USE_BY_DESKTOP_POOL, IN_USE_BY_LINKED_CLONE_DESKTOP_POOL, VIEW_COMPOSER_REPLICA, UNSUPPORTED_OS_FOR_FARM, UNSUPPORTED_OS, NO_SNAPSHOTS, INSTANT_INTERNAL, IN_USE_BY_INSTANT_CLONE_DESKTOP_POOL,

string

name

Optional

VM name. Supported Filters : 'Equals','StartsWith','Contains'.

string

network_type

Optional

Type of network base VM belongs to. Supported Filters : 'Equals'.

STANDARD_NETWORK: Standard network.
OPAQUE_NETWORK: Opaque network.
DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS port group.

Possible values are : STANDARD_NETWORK, OPAQUE_NETWORK, DISTRUBUTED_VIRTUAL_PORT_GROUP,

integer As int32 As int32

num_nics

Optional

Number of network interface cards in a VM. Supported Filters : 'Equals'.

string

operating_system

Optional

Operating system. Supported Filters : 'Equals'.

LINUX_CENTOS: Linux (CentOS)
LINUX_OTHER: Linux (other)
LINUX_RHEL: Linux (Red Hat Enterprise)
LINUX_SERVER_OTHER: Linux server (other)
LINUX_SUSE: Linux (Suse)
LINUX_UBUNTU: Linux (Ubuntu)
UNKNOWN: Unknown
WINDOWS_10: Windows 10
WINDOWS_11: Windows 11
WINDOWS_7: Windows 7
WINDOWS_8: Windows 8
WINDOWS_SERVER_2003: Windows Server 2003
WINDOWS_SERVER_2008: Windows Server 2008
WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
WINDOWS_SERVER_2012: Windows Server 2012
WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
WINDOWS_VISTA: Windows Vista
WINDOWS_XP: Windows XP

Possible values are : LINUX_CENTOS, LINUX_OTHER, LINUX_RHEL, LINUX_SERVER_OTHER, LINUX_SUSE, LINUX_UBUNTU, UNKNOWN, WINDOWS_10, WINDOWS_11, WINDOWS_7, WINDOWS_8, WINDOWS_SERVER_2003, WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016_OR_ABOVE, WINDOWS_VISTA, WINDOWS_XP,

string

operating_system_display_name

Optional

Operating system display name from Virtual Center. Supported Filters : 'Equals','StartsWith','Contains'.

string

path

Optional

VM path. Supported Filters : 'Equals','StartsWith','Contains'.

string

vcenter_id

Optional

Virtual Center id for this VM. Supported Filters : 'Equals'.