Add hosts and return list of hosts
Description
Adds a host and returns a list of hosts.
Tip: From LoadRunner Enterprise 2021 R2, you can add a host created on the cloud using this API.
URL
/Admin/rest/v1/hosts
Remarks
The host data can be passed as XML containing the equivalent data.
To add a host to LAB_PROJECT, you need to send an HTTP request to create a Host resource.
HTTP Method
POST: Creates the host.
GET: Returns a list of hosts.
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 request are:
Element | Description |
---|---|
LabHost | The top-level element. |
Name | The host name. |
Installation | The installation type:
|
HostPurposes | Can contain HostPurpose sub elements with any combination of the following:
|
Location | (Optional) Specify a value that is a valid location name defined in LAB_PROJECT. Otherwise when this field is not provided, the default location is used. |
MIListener | Optional when the location is not defined as over a firewall (OFW). When the location is an OFW location, the value should be the name of a valid MIListener that is defined in LAB_PROJECT. |
SslEnabled | One of:
|
Status | One of:
|
Attributes | Can contain Attribute sub elements in order to set Host properties values. |
Attribute | Attribute value should contain Host Properties values as defined in LAB_PROJECT under Project Customization > Project Lists > Host Properties. You can specify multiple Attribute elements using either the default host attributes (as in the example below) or any custom attribute defined by the user. |
Priority | A numeric value between 1 and 9. |
Description | Description of the host. |
Source (Available in versions: 2021 R2 and later) | The host's source:
If this field is left blank, the default behavior is preserved and the host is added as Local. |
Pools | Contains PoolID sub elements which list the ID of the pools to which the host is assigned. |
POST http://<LRE_Server>/Admin/rest/v1/hosts
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
<LabHost>
<Name>testingHost</Name>
<Installation>WindowsHost</Installation>
<HostPurposes>
<HostPurpose>LoadGenerator</HostPurpose>
</HostPurposes>
<Location>Default</Location>
<MIListener>None</MIListener>
<Priority>5</Priority>
<SslEnabled>false</SslEnabled>
<Status>Operational</Status>
<Attributes>
<Attribute>Host memory:High</Attribute>
<Attribute>Host strength:Medium</Attribute>
</Attributes>
<Description />
<Source>Local</Source>
<Pools>
<PoolID>1000</PoolID>
</Pools>
</LabHost>
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:
The data on the entity in the response. See Hosts response.
The Location contains the link to the newly created entity.
See Also
Return, delete, reconfigure, or update a host by ID
Get Hosts List by Query