S
Serial Number
| Description | The unique MAC ID of the managed device. Similar to the WAN MAC Address but displayed without the colons. |
| Possible Values | MAC addresses are 6-byte (48-bits) in length expressed in a hexadecimal format. The first 3-bytes are ID number of the manufacturer, which is assigned by an Internet standards body (see OUI). The second 3-bytes are serial number assigned by the manufacturer of the managed device. |
Site Survey Json
| Description | A list of WiFi Access points within range of the subscriber’s gateway. NOTE: May not be available on your Device Manager Instance. |
| Possible Values | Access point names vary greatly so the JSON formatted list of SSID names reported here will be completely unique and completely variable. |
Speed Test
Upload Speed Test End Time History
| Description | A series of multiple timestamps documenting the previous instances where an upload speed test has been run against this device. These timestamps are captured when the speed test ended. |
| Possible Values | A string showing Day of week, Month, Date, Year time formatted as: Day Mon Date YYYY HH:MM:SS. The first listed in the comma separated series is the most recent. |
| Example | Thu Jun 4th 2016 14:25:32 |
Latest Upload Speed Test End Time
| Description | The end time of the most recently run upload Speed Test. |
| Possible Values | A string showing Day of week, Month, Date, Year time formatted as: Day Mon Date YYYY HH:MM:SS. |
| Example | Thu Jun 4th 2016 14:25:32 |
Upload Speed Test Start Time History
| Description | A series of multiple timestamps documenting the previous instances where an upload speed test has been run against this device. These timestamps are captured when the speed test began. |
| Possible Values | A string showing Day of week, Month, Date, Year time formatted as: Day Mon Date YYYY HH:MM:SS. |
| Example | Thu Jun 10th 2019 14:25:32 |
Latest Upload Speed Test Start Time
| Description | The start time of the most recently run upload Speed Test. |
| Possible Values | A string showing Day of week, Month, Date, Year time formatted as: Day Mon Date YYYY HH:MM:SS. |
| Example | Thu Aug 6th 2014 09:01:32 |
Upload Speed Test Status
| Description | The last-retrieved status of an upload speed test. The speed test has several possible states. |
Possible Values
| State of speed test | Description if speed test is FTP | Description if speed test is HTTP |
|---|---|---|
| None | Usually the case if a speed test has not yet been run on the device since boot. | Usually the case if a speed test has not yet been run on the device since boot. |
| Requested | When a speed test is requested on a device, it is set to this value. This state should transition to another state after the speed test is complete or has errored. | When a speed test is requested on a device, it is set to this value. This state should transition to another state after the speed test is complete or has errored. |
| Completed | When the last speed test completed successfully. | When the last speed test completed successfully. |
| Error_CannotResolveHostName | Indicates DNS path problems. | (Not supported for HTTP test) |
| Error_NoRouteToHost | Gateway unable to resolve route to the host URL. | (Not supported for HTTP test) |
| Error_InitConnectionFailed | Happens upon receiving a negative control connection response or a timeout has occurred. | A TCP socket could not be opened or a timeout has occurred. |
| Error_NoResponse | The TCP socket could not be opened or timeout has occurred. | An HTTP successful response code was not received from the server in response to the GET command or a timeout has occurred. |
| Error_PasswordRequestFailed | When the request for enter password times out. | (Not supported for HTTP test) |
| Error_LoginFailedError_LoginFailed | Download URL requires access credentials that were missing or incorrect or the request timed out. | (Not supported for HTTP test) |
| Error_NoTransferMode | If the set transfer mode response failed or timed out. | (Not supported for HTTP test) |
| Error_NoPASV | Setting the passive mode failed or timed out. | (Not supported for HTTP test) |
| Error_NoCWD | Setting the CWD failed or timed out. | (Not supported for HTTP test) |
| Error_NoSTOR | If a STOR command response is received and an error code is returned by the server and/or a timeout has occurred prior to receiving a "ready for transfer" notification. | (Not supported for HTTP test) |
| Error_NoTransferComplete | Upon completing the file upload, if an error code is returned by the server an/or a timeout has occurred prior to receiving a Transfer Complete notification. | (Not supported for HTTP test) |
| Error_Timeout | (Not supported for FTP test) | (Not supported for HTTP test) |
| Error_Internal | (Not supported for FTP test) | (Not supported for HTTP test) |
Upload Speed Test Test File Length History
| Description | A comma-delimited list of test file lengths used for previous upload speed tests. The test file length is the size of the file used in the upload speed test, in bytes. |
| Possible Values | A list of integers separated by commas. |
Latest Upload Speed Test Test File Length
| Description | The test file length is the size of the file used in the upload speed test. This value shows the most recent test file length used when initiating an upload speed test by this ACS. |
| Possible Values | Any unsigned integer value. |
Upload Speed Test Throughput(Kbps) History
| Description | A comma-delimited list of throughputs calculated from previously-ran upload speed tests. |
| Possible Values | A list of integers separated by commas. Values are expressed in Kb/S. |
Latest Upload Speed Test Throughput(Kbps)
| Description | The throughput, in Kb/s, calculated by the upload speed test results driver the last time it was ran. Throughput is calculated by dividing the number of bytes uploaded by the time it took to run the test, as determined by subtracting the upload start time (BOMTime) from the upload end time (EOMTime). |
| Possible Values | An integer value. |
Upload Speed Test Total Bytes History
| Description | A comma-delimited list of the total number of bytes sent over the interface between the beginning & end time of each upload speed test, as reported by the device. |
| Possible Values | A comma-delimited list of integer values. |
Latest Upload Speed Test Total Bytes
| Description | The total number of bytes sent over the interface between the beginning & end time of the last ran upload speed test, as reported by the device. |
| Possible Values | An integer value. |
Upload Speed Test URL History
| Description | A comma-delimited list of URLs used by the device during previous upload speed tests. |
Download Speed Test End Time History
| Description | A series of multiple timestamps documenting the previous instances where speed test has been run against this device. These timestamps are captured when the speed test ended. |
| Possible Values | A string showing Day of week, Month, Date, Year time formatted as: Day Mon Date YYYY HH:MM:SS. The first listed in the comma separated series is the most recent. |
| Example | Mon Nov 7th 2016 10:39:42, Mon Nov 7th 2016 10:44:52 |
Latest Download Speed Test End Time
| Description | The end time of the most recently run Speed Test. |
| Possible Values | A string showing Day of week, Month, Date, Year time formatted as: Day Mon Date YYYY HH:MM:SS. The first listed in the comma separated series is the most recent. |
| Example | Fri Jan 6th 2017 07:39:05 |
Download Speed Test Start Time History
| Description | A series of multiple timestamps documenting the previous instances where speed test has been run against this device. These timestamps are captured when the speed test started. |
| Possible Values | A series of multiple timestamps documenting the previous instances where speed test has been run against this device. These timestamps captured when the speed test started. |
| Example | Mon Nov 7th 2016 10:39:42, Mon Nov 7th 2016 10:44:52 |
Latest Download Speed Test Start Time
| Description | The start time of the most recently run Speed Test. |
| Possible Values | A string showing Day of week, Month, Date, Year time formatted as: Day Mon Date YYYY HH:MM:SS. The first listed in the comma separated series is the most recent. |
| Example | Fri Jan 6th 2017 07:39:05 |
Download Speed Test Status
| Description | The current status of a download speed test. The speed test has several possible states. |
Possible Values
| State of speed test | Description if speed test is FTP | Description if speed test is HTTP |
|---|---|---|
| None | Usually the case if a speed test has not yet been run on the device since boot. | Usually the case if a speed test has not yet been run on the device since boot. |
| Requested | When a speed test is requested on a device, it is set to this value. This state should transition to another state after the speed test is complete or has errored. | When a speed test is requested on a device, it is set to this value. This state should transition to another state after the speed test is complete or has errored. |
| Completed | When the last speed test completed successfully. | When the last speed test completed successfully. |
| Error_CannotResolveHostName | Indicates DNS path problems. | (Not supported for HTTP test) |
| Error_NoRouteToHost | Gateway unable to resolve route to the host URL. | (Not supported for HTTP test) |
| Error_InitConnectionFailed | Happens upon receiving a negative control connection response or a timeout has occurred. | A TCP socket could not be opened or a timeout has occurred. |
| Error_NoResponse | The TCP socket could not be opened or timeout has occurred. | An HTTP successful response code was not received from the server in response to the GET command or a timeout has occurred. |
| Error_PasswordRequestFailed | When the request for enter password times out. | (Not supported for HTTP test) |
| Error_LoginFailedError_LoginFailed | Download URL requires access credentials that were missing or incorrect or the request timed out. | (Not supported for HTTP test) |
| Error_NoTransferMode | If the set transfer mode response failed or timed out. | (Not supported for HTTP test) |
| Error_NoPASV | Setting the passive mode failed or timed out. | (Not supported for HTTP test) |
| Error_NoCWD | Setting the CWD failed or timed out. | (Not supported for HTTP test) |
| Error_NoSTOR | If a STOR command response is received and an error code is returned by the server and/or a timeout has occurred prior to receiving a "ready for transfer" notification. | (Not supported for HTTP test) |
| Error_NoTransferComplete | Upon completing the file upload, if an error code is returned by the server an/or a timeout has occurred prior to receiving a Transfer Complete notification. | (Not supported for HTTP test) |
| Error_Timeout | (Not supported for FTP test) | (Not supported for HTTP test) |
| Error_Internal | (Not supported for FTP test) | (Not supported for HTTP test) |
Download Speed Test Test Bytes History
| Description | A comma-delimited list of test bytes received as recorded from previous runs of the download speed test results driver. These values indicate how many bytes were retrieved specifically from the test file used by the download speed test in between the beginning and end times of each test. |
| Possible Values | A comma-delimited list of integers. |
Latest Download Speed Test Test Bytes
| Description | The test bytes received as recorded from the latest run of the download speed test results driver. This value indicates how many bytes were retrieved specifically from the test file used by the download speed test in between the beginning and end times of the latest test. |
| Possible Values | An integer value. |
Download Speed Test Throughput(Kbps) History
| Description | Throughput calculated from previously-run download speed tests. |
| Possible Values | A comma-delimited list of throughput data expressed in Kb/s. |
Latest Download Speed Test Throughput(Kbps)
| Description | The throughput, in Kb/s, calculated by the download speed test results driver the last time it was ran. Throughput is calculated by dividing the number of bytes downloaded by the time it took to run the test, as determined by subtracting the download start time (BOMTime) from the download end time (EOMTime). |
| Possible Values | An integer value. |
Download Speed Test Total Bytes History
| Description | A comma-delimited list of the total number of bytes sent over the interface between the beginning and end time of each download speed test, as reported by the device. Note that this is different from the download test bytes, which are specifically for the download test file. |
| Possible Values | An integer value. |
Latest Download Speed Test Total Bytes
| Description | The total number of bytes sent over the interface between the beginning and end time of the latest download speed test, as reported by the device. Note that this is different from the download test bytes, which are specifically for the download test file. |
| Possible Values | An integer value. |
Download Speed Test URL History
| Description | A comma-delimited list of URLs used by the device during previous download speed tests. |
| Possible Values | A comma-delimited list of URLs. Note: the ACS does not validate the URLs but merely lists what was retrieved from the device each time the download speed test results driver ran. |
Latest Download Speed Test URL
| Description | The URL used by the device during the previous download speed test. |
| Possible Values | A URL. The ACS does not do validation on this value, but merely lists what was gotten from the device the last time the download speed test results driver was ran. |
Static WAN
Static WAN Enabled
| Description | A means for establishing a static address for the WAN connection to the internet provider. IPOE connection type required. Static WAN not available for use with PPP based connections. |
| Possible Values | true - Static WAN is enabled in the Device Manager UI.
false - Static WAN is NOT enabled in the Device Manager UI. |
Static WAN IP Address
| Description | When Static WAN is enabled, this field contains the IP address associated with the WAN connection. |
| Possible Values | Values are delivered in standard IP address format... If IPv4 service connection - xxx.xxx.xxx.xxx If IPv6 service connection - fd4e:1d9f:72be:1e6a:xxxx:xxxx:xxxx:xxxx |
Static WAN Subnet Mask
| Description | When Static WAN is enabled, this field contains the subnet mask associated with the WAN connection. |
| Possible Values | xxx.xxx.xxx.xxx |
Subscriber
Subscriber Address
| Description | The street address of the subscriber. (Note that city and postal code are provided for in separate fields.) |
| Possible Values | Content possibilities are unlimited as this is a free-form text field. |
A note about subscriber Address and Phone information: The user interface of Device Manager allows for entry of multiple addresses associated with the same customer as needed (work, home, cottage, etc). If multiple addresses are present in a Subscriber record, they appear in a comma delimited list. The same is true if multiple Phone Numbers for a subscriber are present in the system.
Subscriber Associated
| Description | A true/false indicator of whether the Subscriber record has been associated with a Device record. |
| Possible Values | true: This Subscriber is provisioned to a Device.
false: This Subscriber is NOT provisioned to a Device. |
[Also see Device Associated.]
Subscriber Business Enabled
| Description | A true/false indicator of whether the subscriber has been flagged as a small/medium business (SMB) customer. See this article for more info. |
| Possible Values | true: This subscriber is flagged as an SMB customer. false: This subscriber is NOT flagged as an SMB customer. |
Subscriber Business Logo URL
| Description | A URL pointing to an image used to customize the look of the banner / title bar of their Control Panel view. Typically, the small/medium business’s (SMB) logo. All graphic file formats are supported (jpg, .png, etc.) See this article for more info. |
| Example | http://yourserver/files/images/companylogo.jpg |
Subscriber City
| Description | The name of the city where the subscriber resides. |
| Possible Values | Content possibilities are unlimited as this is a free-form text field. |
Subscriber Country
| Description | The country of residence associated with the address of the subscriber. |
| Possible Values | Content possibilities are unlimited as this is a free-form text field. |
Subscriber Code
| Description | A unique identifier defined by the ISP. Often a customer number generated by a 3rd party order entry or CRM system is used for this field. Alternatively, the subscriber’s phone number is also used as a subscriber code. Must be unique for each subscriber. |
| Possible Values | Content possibilities are unlimited as this is a free-form text field. |
Subscriber Creation Date
| Description | A complete date and time code stamp documenting when the subscriber was entered into Device Manger. |
| Possible Values | Day of week, Month, Date, Year time formatted as: Day Mon Date YYYY HH:MM:SS |
| Example | Thu Jul 13th 2017 04:55:41 |
Subscriber Device Count
| Description | One subscriber can have multiple locations/lines of service and thus multiple gateways associated with their service account. This field displays quantity of managed devices provisioned to the subscriber. |
| Possible Values | Integer |
Subscriber Domain
You can assign a device record to a specific domain. Domains can be used to restrict access of a group of devices to a group of specific CSRs. The Domain feature is rarely used and is likely turned off in the UI of your Device Manager instance.
| Description | When the Domain feature is available and a Domain has been assigned to a particular device, the name of the Domain is reported here. |
| Possible Values | Unlimited possibilities. Domain names are free-form text with no forbidden characters. |
Subscriber Labels
| Description | Shows a list of labels applied to the subscriber record. |
| Possible Values | Because labels contain free-form text that is conceived by Administrators of the system, the content potential for this field is not limited. |
Subscriber Name
| Description | The First and Last name of the subscriber. |
| Possible Values | Content possibilities are unlimited as this is a free-form text field. |
| Example | Paul Bunyan |
Subscriber Phone Number
| Description | The contact phone number associated with the subscriber. |
| Possible Values | Numerals 0-9, Space, Dash and open / close parenthesis are permissible but not required. |
Subscriber Postal Code
| Description | The postal code associated with the subscriber’s address. |
| Possible Values | Content possibilities are unlimited as this is a free-form text field. |
Subscriber State
| Description | The State or province associated with the subscriber’s address. |
| Possible Values | Content possibilities are unlimited as this is a free-form text field. |
Subscriber Street
| Description | Displays only the street address portion of the subscriber's address. Not to be confused with Subscriber Address. |
| Possible Values | Content possibilities are unlimited as this is a free-form text field. |