Open topic with navigation

# hosts response

The fields in the response are:

Element | Description
--- | ---
ID | The host ID.
LabHosts | The top-level element. Contains LabHost sub elements with the elements listed below.
Name | The host name.
Installation | The 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*']}`
Status | The 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.
Priority | A numeric value between 1 and 9.
SslEnabled | One of: true false
IsPrivate | The 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.

Example

    <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>
        <IsPrivateHost>false</IsPrivateHost>
        <Description />
        <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>
        <IsPrivateHost>false</IsPrivateHost>
        <Description />
        <Pools>
    	<PoolID>1000</PoolID>
        </Pools>
        <ID>1048</ID>
      </LabHost>
    </LabHosts>

## See Also

hosts
hosts/{hostID}
Get Hosts List by Query