Hosts response

The fields in the response are:

ElementDescription
IDThe host ID.
LabHostsThe top-level element. Contains LabHost sub elements with the elements listed below.
NameThe host name.
InstallationThe installation type:
  • Unix
  • WindowsHost

  • WindowsStandaloneLG

HostPurposes

Can contain HostPurpose sub elements with any combination of the following:

  • Controller
  • LoadGenerator

  • DataProcessor

Note: To get hosts that have a specific purpose, but may have other purposes as well, you must surround the value with asterisks (*). For example:

{HostPurposes['*Controller*']}

StatusThe status can be:
  • Operational
  • NonOperational
  • Unavailable
Location(Optional) A valid location name defined in LAB_PPROJECT. If 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_PPROJECT.

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.
SslEnabled

One of:

  • true
  • false

Enable IPv6

(Available in versions: 24.3 and later)

One of:

  • true
  • false

Source

(Available in versions: 2021 R2 and later)

The host's source:

  • Local - A host that exists in your lab.

  • Cloud - A host from a cloud provider.

If this field is left blank, the default behavior is preserved and the host is added as Local.

IsPrivateThe privacy type of the host.
Pools

Can contain PoolID sub elements which lists the ID of the pools to which the host is assigned. If not specified, a host is added to the general pool with ID=1000.

Copy code
<LabHosts>
  <LabHost>
    <Name>testingHost</Name>
    <Installation>WindowsHost</Installation>
    <HostPurposes>
    <HostPurpose>LoadGenerator</HostPurpose>
    </HostPurposes>
    <Status>Operational</Status>
    <Location>Default</Location>
    <MIListener>None</MIListener>
    <Attributes>
    <Attribute>HostMemory:High</Attribute>
    <Attribute>HostStrength:Medium</Attribute>
    <Attribute>InstalledComponents:DotNetFramework</Attribute>
    <Attribute>InstalledComponents:CitrixClient</Attribute>
    <Attribute>InstalledComponents:JavaRuntime</Attribute>
    </Attributes>
    <Priority>5</Priority>
    <SslEnabled>false</SslEnabled> 
    <IPv6Enabled>true</IPv6Enabled>
    <IsPrivateHost>false</IsPrivateHost>   
    <Description />
    <Source>Local</Source>
    <Pools>
    <PoolID>1000</PoolID>
    <PoolID>1003</PoolID>
    <PoolID>1004</PoolID>
    </Pools>
    <ID>1048</ID>
  </LabHost> 
  <LabHost>
    <Name>MyHost</Name>
    <Installation>WindowsHost</Installation>
    <HostPurposes>
       <HostPurpose>Controller</HostPurpose>
       <HostPurpose>DataProcessor</HostPurpose>
       <HostPurpose>LoadGenerator</HostPurpose>
    </HostPurposes>
    <Status>Operational</Status>
    <Location>Default</Location>
    <MIListener>None</MIListener>
    <Attributes />
    <Priority>5</Priority>
    <SslEnabled>false</SslEnabled> 
    <IPv6Enabled>true</IPv6Enabled>
    <IsPrivateHost>false</IsPrivateHost>   
    <Description />
    <Source>Local</Source>
    <Pools>
    <PoolID>1000</PoolID>
    </Pools>
    <ID>1048</ID>
  </LabHost>
</LabHosts>

See Also

Add hosts and return list of hosts
Return, delete, reconfigure, or update a host by ID
Get Hosts List by Query