location_mgr_list_many
Back to SOAP Architecture Method Reference
Description
The location_mgr_list_many method lists details of specific edge servers on your domain.
Note: Edge servers and players are unique resources in Broadsign Control in that they are both products (Broadsign Control Player and Broadsign Control Edge Server) and resources (player and edge server). As a convention, once you register one of these products, we no longer refer to it by product name, but by resource name.
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| ids | A comma-delimited list of the unique ID#s of edge servers you want to list. | string | R |
| domain_id | The unique ID# of the domain. | bstypes:ResourceId | O |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of the edge server. | bstypes:ResourceId | R |
| name | The name of this edge server. | string | R |
| active | Whether this edge server is active. | boolean | R |
| container_id | The unique ID# of the folder containing this edge server. | bstypes:ResourceId | R |
| domain_id | The unique ID# of the domain. | bstypes:ResourceId | R |
| primary_mac_address | The primary MAC address for this edge server. | string | R |
| secondary_mac_address | The secondary MAC address for this edge server. | string | R |
| discovery_status | The discovery status for this edge server:
|
bstypes:ResourceDiscoveryStatus | R |
| licensed | Indicates whether or not the edge server is licensed. | boolean | R |
| license_end_date | The date at which the license expires for this edge server. | bstypes:SimpleDate | R |
| config_profile_bag_id | The unique ID# of the configuration profile associated with this edge server. | bstypes:ResourceId | R |
| db_pickup_tm_utc | The most recent UTC timestamp of a remote database pickup request issued for the edge server. | bstypes:SimpleDateTime | R |
| public_key_fingerprint | The public key fingerprint for this edge server. | string | R |
| remote_reboot_tm_utc | The most recent UTC timestamp of a remote reboot request for the edge server. | bstypes:SimpleDateTime | R |
| remote_clear_db_tm_utc | The most recent UTC timestamp of a remote database clear request for the edge server. | bstypes:SimpleDateTime | R |
| username | The username of the upstream FTP server from which the edge server gets its content. | string | R |
| base | The absolute path to the hot folder of the upstream FTP server from which the edge server gets its content. | string | R |
| port | The Broadsign Server port to which the edge server will connect to get its content. | unsignedInt | R |
| upstream_flag | Indicates whether or not the edge server is using an upstream FTP server to get its content. | boolean | R |
| passwd | The password of the upstream FTP server from which the edge server gets its content. | string | R |
| inter_domain_flag | Indicates whether or not the edge server is to be used from more than one domain. | boolean | R |
| upstream_url | The URL of the upstream FTP server from which the edge server gets its content. | string | R |
| upstream_port | The port of the upstream FTP server from which the edge server gets its content. | unsignedInt | R |
| hostname | The hostname of the edge server. | string | R |