Host pools
Description
Create a host pool or returns a list of host pools.
URL
/Admin/rest/v1/pools
Remarks
The host pools data can be passed as XML or JSON 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:
One of the following:
Content-Type: application/xml
Content-Type: application/json
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: XML or JSON describing the host pool.
The fields in the response are:
Element | Description |
---|---|
ID | The host pool ID. |
Name | The name of the host pool. |
Description | Description of the host pool (optional). |
Hosts | Contains Host sub elements which list the host ID assigned to the pool. |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
GET http://<LRE_Server>/Admin/rest/v1/pools
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
JSON example:
GET http://<LRE_Server>/Admin/rest/v1/pools
Content-Type: application/json
Accept: application/json
Cookie: ADM_LWSSO={AdmLwssoCookie};
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
POST http://<LRE_Server>/Admin/rest/v1/pools
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
<HostPool>
<Name>Testing_Pool</Name>
<Description>System created testing</Description></HostPool>
POST http://<LRE_Server>/Admin/rest/v1/pools
Content-Type: application/json
Accept: application/json
Cookie: ADM_LWSSO={AdmLwssoCookie};
{
"Name": "Testing_Pool",
"Description": "System created testing"
}
Response
Headers:
One of:
Accept: application/xml
Accept: application/json
Cookies:
None
HTML Return Code:
One of the HTTP Return Codes
HTML Body:
The fields in the response are:
Element | Description |
---|---|
HostPools | The top-level element. Contains HostPool sub elements with the elements listed below. |
Name | The name of the host pool. |
Description | An optional description of the host pool. |
Hosts | Can contain HostID sub elements which lists the ID of the hosts assigned to the pool. |
ID | The ID of the host pool. |
GET: Returns the data on the host pool in the response.
POST: Returns XML or JSON of the host pool.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<HostPools>
<HostPool>
<Name>TestPool</Name>
<Description>Some description</Description>
<ID>1001</ID>
</HostPool>
<HostPool>
<Name>TestPool2</Name>
<Description>Some description</Description>
<Hosts>
<HostID>1026</HostID>
<HostID>1029</HostID>
</Hosts>
<ID>1002<ID>
</HostPool>
<HostPool>
<Name>TestPool4</Name>
<Description>Some description</Description>
<ID>1003</ID>
</HostPool>
</HostPools>
[
{
"ID": 1000,
"Name": "General",
"Description": "System created default pool",
"Hosts": [
1100,
1808
]
},
{
"ID": 1135,
"Name": "Pool_REST",
"Description": "Created with REST",
"Hosts": [
1100
]
}
]
See Also
Return, update, or delete a host pool by ID
Get Host Pool List by Query