Add hosts and return list of hosts

Description

Adds a host and returns a list of hosts.

Tip: From OpenText Enterprise Performance Engineering 2021 R2, you can add a host created on the cloud using this API.

URL

Copy code
/Admin/rest/v1/hosts

Remarks

The host data can be passed as XML or JSON 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:

One of the following:

Content-Type: application/xml

Content-Type: application/json

Cookies:

Versions 2023, 24.1, 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 or JSON describing the host.

The fields in the request are:

ElementDescription
LabHostThe top-level element.
NameThe host name.
InstallationThe installation type:
  • Unix
  • WindowsHost

  • WindowsStandaloneLG

HostPurposesCan contain HostPurpose sub elements with any combination of the following:
  • Controller
  • LoadGenerator

  • DataProcessor

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:

  • true
  • false

Enable IPv6

(Available in versions: 24.3 and later)

One of:

  • true
  • false
StatusOne of:
  • Operational
  • NonOperational
  • Unavailable
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.

PriorityA numeric value between 1 and 9.
DescriptionDescription of the host.

Source

(Available in versions: 2021 R2 and later)

The host's source:

  • Local - A host that exists in your lab.

  • Cloud - A host from your cloud provider.

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.

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