host_mgr_list
Back to SOAP Architecture Method Reference
Description
The host_mgr_list method list the details of the designated Players (Resource).
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| domain_id |
The unique ID# of your domain. |
bstypes:ResourceId | O |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of the host. | bstypes:ResourceId | R |
| name | The name of this host. | string | R |
| active | Whether this host is active. | boolean | R |
| container_id | The ID# of the folder containing this host. | bstypes:ResourceId | R |
| domain_id |
The unique ID# of your domain. |
bstypes:ResourceId | R |
| primary_mac_address | The primary MAC address of this host. | string | R |
| secondary_mac_address | The secondary MAC address of this host. | string | R |
| discovery_status | The discovery status for this host (0 = Accepted, 2 = Retired) | bstypes:ResourceDiscoveryStatus | R |
| licensed | Whether this host is licensed. | boolean | R |
| license_end_date | The date at which the license expires for this host. | bstypes:SimpleDate | R |
| config_profile_bag_id | The unique ID# of the configuration profile associated with this host. | bstypes:ResourceId | R |
| db_pickup_tm_utc | The date time in UTC at which the local db for this host was sent to the Broadsign Server. | bstypes:SimpleDateTime | R |
| public_key_fingerprint | The Public Key Fingerprint for this host. | string | R |
| remote_reboot_tm_utc | The most recent date time in UTC at which this host was remotely rebooted. | bstypes:SimpleDateTime | R |
| remote_clear_db_tm_utc | The most recent date time in UTC at which this host local db was cleared. | bstypes:SimpleDateTime | R |
| display_unit_id | The unique ID# of the Display Unit associated to this host. | bstypes:ResourceId | R |
| nscreens | The number of screens attached to this host. | int | R |
| volume | The sound volume level for this host. | int | R |
| geolocation | The geographic location in latitude and longitude for this host. | bstypes:SimplePoint | R |