SupportDocumentation

Assignment

List

get

Retrieve a list of assigned hosts.

Query parameters
siteIdinteger · int32Optional

Site ID.

Responses
204
No Content
get
GET /api/Provider/VM/VDIHost/Assignment HTTP/1.1
Host: 
Accept: */*

No content

Update

put

Modify a host assignment.

Path parameters
providerIdinteger · int32Required

The ID of the Provider server on which the target Host resides.

vmIdstringRequired

The ID of the host VM.

Query parameters
siteIdinteger · int32Optional

Site ID.

Body

Update persistence configuration of the VDI Host

userstring | nullableOptional

The name of the user account to which to assign the Host.

devicestring | nullableOptional

The name of the device to which to assign the Host.

sidstring | nullableOptional

The SID of the user account to which to assign the Host.

Responses
204
No Content
put
PUT /api/Provider/{providerId}/VM/{vmId}/VDIHost/Assignment HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 44

{
  "user": "text",
  "device": "text",
  "sid": "text"
}
No content

Delete

delete

Remove a host assignment.

Path parameters
providerIdinteger · int32Required

The ID of the Provider server on which the target Host resides.

vmIdstringRequired

The ID of the host VM.

Query parameters
siteIdinteger · int32Optional

Site ID.

Responses
204
No Content
delete
DELETE /api/Provider/{providerId}/VM/{vmId}/VDIHost/Assignment HTTP/1.1
Host: 
Accept: */*

No content
PreviousVDI HostNextDisconnect

Was this helpful?