Host pools

Description

Create a host pool or returns a list of host pools.

URL

Copy code
/Admin/rest/v1/pools

Remarks

The host pools data can be passed as XML containing the equivalent data.

To add a host pool to LAB_PROJECT, you need to send an HTTP request to create a Host Pool resource.

HTTP Method

POST: Creates the host pool.

GET: Returns a list of host pools.

Request

Headers:

Content-Type: application/xml

Accept: application/xml

Cookies:

Versions 2023 and later

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Versions 2022 - 2022 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

Versions 2021 - 2021 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

Versions 2020 - 2020 SP3

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Versions earlier than 2020

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

QCSession={QC_SESSION_COOKIE_VALUE};

Request Body:

GET: No request body.

POST: An XML describing the host.

The fields in the response are:

ElementDescription
IDThe host pool ID.
NameThe name of the host pool.
DescriptionDescription of the host pool (optional).
Hosts

Contains Host sub elements which list the host ID assigned to the pool.

Response

Headers:

Content-Type: application/xml

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes

Upon successful deletion, returns HTTP status 201 (Created).

HTML Body:

GET: Returns the data on the entity in the response. See Host pool response.

POST: Returns XML of the pool.

See Also

Return, update, or delete a host pool by ID
Get Host Pool List by Query