[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

List VMS With User Deprecated

Description

excludeAssignedVms - If true - return only unassigned VMs. If false - return all VMs

Request

Request

URL

URL


get
https://cloud.vmwarehorizon.com/portal/v1/entitlements/{id}/template/{dTemplateId}/vms
Copy

Path Parameters

Path Parameters

string
dTemplateId Required

dTemplateId


string
id Required

id


Query Parameters

Query Parameters

boolean
excludeAssignedVms Optional

excludeAssignedVms


string
org_id Optional

org_id


ref
page Optional

Page number to retrieve.


ref
size Optional

Size of each page.


array of string
sort Optional

Ascending/Descending. Format is property,{asc|desc} and default is ascending.

Parameter Serialization Style: form Explode:true

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PageInvVmWithUser of type */*
{
	"content": [
		{
			"agentStatus": "AVAILABLE",
			"agentVersion": "string",
			"cloudId": "string",
			"createdAt": "string",
			"error": "string",
			"id": "string",
			"image": "string",
			"lifecycleStatus": "CUSTOMIZING",
			"maxSessions": 0,
			"powerState": "PoweredOff",
			"privateIp": "string",
			"publicKey": "string",
			"sessionPlacementStatus": "AVAILABLE",
			"snapshotId": "string",
			"statusCode": 0,
			"timestamp": 0,
			"updatedAt": "string",
			"users": [
				{
					"active": true,
					"avatar": "url",
					"azureAdDomain": "string",
					"department": "Finance",
					"displayName": "John Smith",
					"distinguishedName": "CN=JSMITH,DC=vmware,DC=com",
					"domain": "horizonv2.local",
					"familyName": "Smith",
					"givenName": "John",
					"id": "1223234",
					"ipaddr": "0.0.0.0",
					"onPremisesUserPrincipalName": "john.smith@horizonv2.local",
					"orgIds": [
						"string"
					],
					"tid": "1223234",
					"userDomain": "string",
					"userGroups": [
						"string"
					],
					"userName": "john.smith",
					"userPrincipalName": "john.smith@horizonv2.onmicrosof.com",
					"userSid": "S-1-5-21-2502306595"
				}
			],
			"vmFreeSessions": 0
		}
	],
	"empty": false,
	"first": false,
	"last": false,
	"number": 0,
	"numberOfElements": 0,
	"pageable": {
		"offset": 0,
		"pageNumber": 0,
		"pageSize": 0,
		"paged": false,
		"sort": {
			"empty": false,
			"sorted": false,
			"unsorted": false
		},
		"unpaged": false
	},
	"size": 0,
	"sort": {
		"empty": false,
		"sorted": false,
		"unsorted": false
	},
	"totalElements": 0,
	"totalPages": 0
}
array of InvVmWithUser
content Optional

boolean
empty Optional

boolean
first Optional

boolean
last Optional

integer as int32
number Optional

integer as int32
numberOfElements Optional

pageable Optional

integer as int32
size Optional

sort Optional

integer as int64
totalElements Optional

integer as int32
totalPages Optional
Errors

Errors

401

Unauthorized


403

Forbidden


404

Not found

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/portal/v1/entitlements/{id}/template/{dTemplateId}/vms


[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Feedback

Was this page helpful?