Members

List

Retrieve the list of VDI Host Pool Members from a VDI Host Pool.

GET/api/VDI/HostPool/{vdiHostPoolId}/Members

Path parameters

vdiHostPoolId*integer (int32)

The VDI Host Pool ID.

Response

Success

Body

idinteger (int32)

ID of the VDI Host Pool member

namenullable string

Name of the VDI Host Pool member

typeVDIHostPoolMemberType (enum)

VDI Host Pool Member Type

0 = AllHostsInProvider,2 = Host,3 = NativePool,5 = Template,7 = TemplateVersion

providerIdinteger (int32)

ID of the Provider

Request

Response

Add

Add one VDI Host Pool Member to an existing VDI Host Pool.

POST/api/VDI/HostPool/{vdiHostPoolId}/Members

Path parameters

vdiHostPoolId*integer (int32)

The VDI Host Pool ID.

Query parameters

noInstallboolean

If passed agent will not be installed on VM

usernamestring

An administrator account for push installing the RAS Guest Agent in the VM.

passwordstring

The password of the account specified in the Username parameter.

Body

VDI host pool member configuration

type*VDIHostPoolMemberType (enum)

VDI Host Pool Member Type

0 = AllHostsInProvider,2 = Host,3 = NativePool,5 = Template,7 = TemplateVersion

name*nullable string

The VDI Host Pool Member Name.

providerIdnullable integer (int32)

The VDI Host Pool Member Provider ID. This parameter is only accepted with Types: ALLGUESTSONPROVIDER, GUEST or NATIVEPOOL.

vmIdnullable string

The VDI Host Pool Member Guest ID. This parameter is only accepted with Type: GUEST.

nativePoolIdnullable string

The VDI Host Pool Member Native Pool ID. This parameter is only accepted with Type: NATIVEPOOL.

noInstallboolean

Specifies not to install the RAS Guest Agent on the server. If this parameter is omitted, the agent will be push installed in the VM using your RAS admin credentials. To specify different credentials for push installation, use the Username and Password parameters. This parameter can be used in situations when the RAS Guest Agent is already installed in a VM, but the VM is powered down. By including this parameter, you will simply power up the VM and make it available for Parallels RAS operations.

vmIdsnullable array of string

The VDI Host Pool Member Desktops IDs. This parameter is only accepted with Type: ALLDESKTOPSONPROVIDER.

itemsstring

Response

Created

Request

Response

Get

Retrieve a VDI Host Pool Member from a VDI Host Pool.

GET/api/VDI/HostPool/{vdiHostPoolId}/Members/{id}

Path parameters

vdiHostPoolId*integer (int32)

The VDI Host Pool ID.

id*integer (int32)

The VDI Host Pool Member ID.

Response

Success

Body

idinteger (int32)

ID of the VDI Host Pool member

namenullable string

Name of the VDI Host Pool member

typeVDIHostPoolMemberType (enum)

VDI Host Pool Member Type

0 = AllHostsInProvider,2 = Host,3 = NativePool,5 = Template,7 = TemplateVersion

providerIdinteger (int32)

ID of the Provider

Request

Response

Delete

Remove a VDI Host Pool Member from a VDI Host Pool.

DELETE/api/VDI/HostPool/{vdiHostPoolId}/Members/{id}

Path parameters

vdiHostPoolId*integer (int32)

The VDI Host Pool ID.

id*integer (int32)

The VDI Host Pool Member ID.

Response

No Content

Request

Response

Delete

Remove a VDI Host Pool Member from a VDI Host Pool.

DELETE/api/VDI/HostPool/{vdiHostPoolId}/Members/{id}

Path parameters

vdiHostPoolId*integer (int32)

The VDI Host Pool ID.

id*integer (int32)

The VDI Host Pool Member ID.

Response

No Content

Request

Response

Get

Retrieve a VDI Host Pool Member from a VDI Host Pool.

GET/api/VDI/HostPool/{vdiHostPoolId}/Members/{id}

Path parameters

vdiHostPoolId*integer (int32)

The VDI Host Pool ID.

id*integer (int32)

The VDI Host Pool Member ID.

Response

Success

Body

idinteger (int32)

ID of the VDI Host Pool member

namenullable string

Name of the VDI Host Pool member

typeVDIHostPoolMemberType (enum)

VDI Host Pool Member Type

0 = AllHostsInProvider,2 = Host,3 = NativePool,5 = Template,7 = TemplateVersion

providerIdinteger (int32)

ID of the Provider

Request

Response

List

Retrieve the list of VDI Host Pool Members from a VDI Host Pool.

GET/api/VDI/HostPool/{vdiHostPoolId}/Members

Path parameters

vdiHostPoolId*integer (int32)

The VDI Host Pool ID.

Response

Success

Body

idinteger (int32)

ID of the VDI Host Pool member

namenullable string

Name of the VDI Host Pool member

typeVDIHostPoolMemberType (enum)

VDI Host Pool Member Type

0 = AllHostsInProvider,2 = Host,3 = NativePool,5 = Template,7 = TemplateVersion

providerIdinteger (int32)

ID of the Provider

Request

Response

Add

Add one VDI Host Pool Member to an existing VDI Host Pool.

POST/api/VDI/HostPool/{vdiHostPoolId}/Members

Path parameters

vdiHostPoolId*integer (int32)

The VDI Host Pool ID.

Query parameters

noInstallboolean

If passed agent will not be installed on VM

usernamestring

An administrator account for push installing the RAS Guest Agent in the VM.

passwordstring

The password of the account specified in the Username parameter.

Body

VDI host pool member configuration

type*VDIHostPoolMemberType (enum)

VDI Host Pool Member Type

0 = AllHostsInProvider,2 = Host,3 = NativePool,5 = Template,7 = TemplateVersion

name*nullable string

The VDI Host Pool Member Name.

providerIdnullable integer (int32)

The VDI Host Pool Member Provider ID. This parameter is only accepted with Types: ALLGUESTSONPROVIDER, GUEST or NATIVEPOOL.

vmIdnullable string

The VDI Host Pool Member Guest ID. This parameter is only accepted with Type: GUEST.

nativePoolIdnullable string

The VDI Host Pool Member Native Pool ID. This parameter is only accepted with Type: NATIVEPOOL.

noInstallboolean

vmIdsnullable array of string

The VDI Host Pool Member Desktops IDs. This parameter is only accepted with Type: ALLDESKTOPSONPROVIDER.

itemsstring

Response

Created

Request

Response

const response = await fetch('/api/VDI/HostPool/{vdiHostPoolId}/Members/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/VDI/HostPool/{vdiHostPoolId}/Members/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "name": "text",
  "type": [
    "0 = AllHostsInProvider",
    "2 = Host",
    "3 = NativePool",
    "5 = Template",
    "7 = TemplateVersion"
  ]
}

const response = await fetch('/api/VDI/HostPool/{vdiHostPoolId}/Members', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "name": "text",
    "type": [
      "0 = AllHostsInProvider",
      "2 = Host",
      "3 = NativePool",
      "5 = Template",
      "7 = TemplateVersion"
    ]
  }
]

const response = await fetch('/api/VDI/HostPool/{vdiHostPoolId}/Members', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text",
      "type": [
        "0 = AllHostsInProvider",
        "2 = Host",
        "3 = NativePool",
        "5 = Template",
        "7 = TemplateVersion"
      ]
    }),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}