location_mgr_list
Back to SOAP Architecture Method Reference
Description
The location_mgr_list method lists Edge Servers (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 ID# of the Edge Server. | bstypes:ResourceId | R |
name | The name of the Edge Server. | string | R |
active | Indicates whether the resource is in an active or inactive state. | boolean | R |
container_id | The unique ID# of Edge Server folder that the Edge Server resides in. | bstypes:ResourceId | R |
domain_id | The unique ID# of your domain. | bstypes:ResourceId | R |
primary_mac_address | The primary MAC address of the Edge Server. | string | R |
secondary_mac_address | The secondary MAC address of the Edge Server. | string | R |
discovery_status | The Edge Server’s discovery status. (0 = Accepted, 2 = Retired) | bstypes:ResourceDiscoveryStatus | R |
licensed | If this Edge Server is licensed in the Broadsign Server cluster. | boolean | R |
license_end_date | The date that the Edge Server license expires. | bstypes:SimpleDate | R |
config_profile_bag_id | The unique ID# of the Edge Server’s Configuration Profile Bag. | bstypes:ResourceId | R |
db_pickup_tm_utc | The most recent UTC timestamp of a remote database pickup request for the Edge Server. | bstypes:SimpleDateTime | R |
public_key_fingerprint | The Edge Server’s Public Key Fingerprint. | 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 that the Edge Server gets its content from. | string | R |
base | The absolute path to the hot folder of the upstream FTP server that the Edge Server gets its content from. | string | R |
port | The port of the Broadsign Server to which the Edge Server will connect to get its content. | unsignedInt | R |
upstream_flag | If the Edge Server is using an upstream FTP server to get its content from. | boolean | R |
passwd | The password of the upstream FTP server that the Edge Server gets its content from. | string | R |
inter_domain_flag | If the Edge Server is to be used from more than one domain. | boolean | R |
upstream_url | The URL of the upstream FTP server that the Edge Server gets its content from. | string | R |
upstream_port | The port of the upstream FTP server that the Edge Server gets its content from. | unsignedInt | R |
hostname | The hostname of the Edge Server. | string | R |