Members

PreviousCreateHosts NextOptimization

Was this helpful?

List

get

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

Path parameters

vdiHostPoolIdinteger · int32required

The VDI Host Pool ID.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{vdiHostPoolId}/Members'

200

401

404

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

Success

Add

post

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

Path parameters

vdiHostPoolIdinteger · int32required

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

typestring · enumrequired

<para type="synopsis">VDI Host Pool Member Type</para> <para type="description"></para>

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

namestring | nullablerequired

<para type="description">The VDI Host Pool Member Name.</para>

providerIdinteger · int32 | nullable

<para type="description">The VDI Host Pool Member Provider ID.</para> <para type="description">This parameter is only accepted with Types: ALLGUESTSONPROVIDER, GUEST or NATIVEPOOL.</para>

vmIdstring | nullable

<para type="description">The VDI Host Pool Member Guest ID.</para> <para type="description">This parameter is only accepted with Type: GUEST.</para>

nativePoolIdstring | nullable

<para type="description">The VDI Host Pool Member Native Pool ID.</para> <para type="description">This parameter is only accepted with Type: NATIVEPOOL.</para>

noInstallboolean · default: false

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

vmIdsstring[] | nullable

<para type="description">The VDI Host Pool Member Desktops IDs.</para> <para type="description">This parameter is only accepted with Type: ALLDESKTOPSONPROVIDER.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{vdiHostPoolId}/Members' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "type": [
      "0 = AllHostsInProvider",
      "2 = Host",
      "3 = NativePool",
      "5 = Template",
      "7 = TemplateVersion"
    ],
    "name": "text",
    "providerId": 1,
    "vmId": "text",
    "nativePoolId": "text",
    "noInstall": false,
    "vmIds": [
      "text"
    ]
  }'

201

401

No body

Created

Get

get

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

Path parameters

vdiHostPoolIdinteger · int32required

The VDI Host Pool ID.

idinteger · int32required

The VDI Host Pool Member ID.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{vdiHostPoolId}/Members/{id}'

200

401

404

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

Success

Delete

delete

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

Path parameters

vdiHostPoolIdinteger · int32required

The VDI Host Pool ID.

idinteger · int32required

The VDI Host Pool Member ID.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{vdiHostPoolId}/Members/{id}'

204

401

404

No body

No Content