'; Devices | Incognito Help
Array
(
    [0] => Array
        (
            [version] => 4.3
            [language] => en
        )

    [1] => Array
        (
            [version] => 4.2
            [language] => en
        )

    [2] => Array
        (
            [version] => 4.1
            [language] => en
        )

    [3] => Array
        (
            [version] => 4.0
            [language] => en
        )

    [4] => Array
        (
            [version] => 3.5
            [language] => en
        )

    [5] => Array
        (
            [version] => 3.4
            [language] => en
        )

    [6] => Array
        (
            [version] => 3.3
            [language] => en
        )

    [7] => Array
        (
            [version] => 3.2
            [language] => en
        )

    [8] => Array
        (
            [version] => 3.1
            [language] => en
        )

    [9] => Array
        (
            [version] => 4.2
            [language] => fr
        )

    [10] => Array
        (
            [version] => 4.2
            [language] => es
        )

)
Rel: acs/topics/acs/dita/devices
URI: acs/topics/devices
=== Tags ===
Array
(
    [363] => devices
    [921] => device states
    [810] => devices objects and parameters
    [811] => devices device session
    [812] => devices device actions
    [984] => devices device diagnostics
    [814] => devices associated device groups
    [985] => device search queries
    [847] => common query parameters device search keywords
)

=== Related ===
Array
(
    [0] => Array
        (
            [id] => 4964
            [title] => Discovery
            [slug] => discovery
            [product] => acs
            [component] => 
            [category] => key_concepts
            [version] => 4.3
            [common_tag_count] => 2
            [uri] => acs/key_concepts/discovery
        )

    [1] => Array
        (
            [id] => 4962
            [title] => Search
            [slug] => search
            [product] => acs
            [component] => 
            [category] => getting_started
            [version] => 4.3
            [common_tag_count] => 1
            [uri] => acs/getting_started/search
        )

)

Devices

Devices are discovered on the network through communication with the service. ACS supports the following device protocols: TR-069, MQTT, and SNMP. Use these settings to view and manage devices.

When integrated with SAC, devices are learned by the server. If a device does not exist in ACS, then SAC sends a request to create the device record in ACS. If the device already exists in ACS, then SAC sends a request to update the device record.

Note: The service uses the OUI, product class, and serial number to create a unique identifier for a device.
To do this: Follow these steps:
Select a device Click a record.
Select all devices In the action bar, click Select All. Exit select mode by clicking on any whitespace on the page.
View the device hub for a device Double-click a record, or click a record, and in the action bar, click View.
Edit details for an undiscovered device Double-click a record for an undiscovered device.
Create a device In the action bar, click Create.
Delete a device Select a device. Then, in the action bar, click Delete.
Filter devices by status From the dropdown menu, select ‘All Devices’, ‘Active’, ‘Undiscovered’, ‘All Problematic’, ‘Discovery Failure’, ‘Synchronized Failed’, or ‘Unknown’.
Filter devices by protocol From the dropdown menu, select ‘TR-069’, ‘MQTT’, or ‘SNMP’.
Search fields In table view, you can search column fields using either or both of the following methods:
  • In one or more of the available table heading fields, type search terms and press Enter.
  • From one or more of the available table heading dropdowns, select ‘Show all’, ‘Within the last hour’, ‘Within the last day’, ‘Within the last week’, ‘Within the last 4 weeks’.
Search for a device Click the search symbol (), type search terms, and press Enter.
Search for a device using the Form Search dropdown Click the search symbol (), click the down arrow that appears (), enter values in the available fields, and click Search.
Switch to table view/grid view Click the table symbol ()/grid symbol ().
Go back one screen Click the back symbol ().
Return to the main screen of the service Click the hub symbol ().
Note: The service searches for an exact match. If you need to search for a partial match, type a wildcard (*) for the character(s) you do not know.

Searching for Devices

You can search for devices either using single criteria or by creating advanced queries involving multiple criteria linked by operators. In table view, you can use the column heading fields to search for devices by the listed criteria.

When configuring an advanced query, you can either enter the query string directly in the search box or use the Form Search dropdown.

In the Form Search dropdown, you can select query terms by typing search terms in one or more available fields, and by selecting ‘Show all’, ‘Within the last hour’, ‘Within the last day’, ‘Within the last week’, ‘Within the last 4 weeks’ from one or more available dropdowns. As you select query terms, the corresponding query appears in the search box. The query is concatenated with all appropriate operators. After creating a query, you can further customize it by directly editing the string in the search box.

Note: The fields that display in the Search Form dropdown are configurable. For more information, refer to the ACS Installation Guide.

In table view, you can also search for (that is, filter) devices by typing search terms in any of the available column heading fields and pressing Enter, and by selecting ‘Show all’, ‘Within the last hour’, ‘Within the last day’, ‘Within the last week’, ‘Within the last 4 weeks’ from one or more available dropdowns. Each column represents a separate criterion: for example, device model or OUI. You can search for on one or more criteria at the same time. The active filter shows only subscribers, if any, matching all search criteria. If you enter criteria that do not match any subscriber, all subscribers are filtered out. For a selected subscriber, you can open the Device Hub for the subscriber’s device.

Note: The service automatically searches for partial matches to search criteria. You do not need to type a wildcard (*) for the character(s) you do not know.

Display of Devices Matching Search Criteria

The Devices view only lists the first 100 devices that match the search criteria.

The total number of devices that match the current search criteria are shown in the action bar.

Device Search Queries

In addition to the common query parameters, the following keywords are supported for devices.

Keyword Data Format Description
CENTRAL String Network hierarchy, where users connect to a central agent for all communications (server(s) or network objects).
CITY String Device city. For example, “BARCELONA”.
CREATED Time in ISO 8601 format Time when device record was created in the system.
DEVICEMODEL String Device model name.
DISTRICT String Device district.
FIRMWARE String Device firmware.
ID String Database identifier for device record.
IMEI String International Mobile Equipment Identity (IMEI) number.
IMSI String International Mobile Subscriber Identity (IMSI) number.
IP String Wide Area Network IP Address (IPv4 or IPv6).
LASTMODIFED Time in ISO 8601 format Time when device record was last modified in the system.
LASTSEEN Time in ISO 8601 format Time of last device inform.
LOCATION String Device location.
MAC 12 hex digits (any separator) Media Access Control address of device.
MANUFACTURER String Manufacturer string. For example, “THOMPSON”.
OUI 6 hex digits (any separator) Organizationally Unique Identifier.
PRODUCTCLASS String Product class string. For example, “Thomson TG789vn”.
SERIAL String Device serial number.
STATE String State (or other administrative division in a country) string. For example, “ARIZONA”.
SUBSCRIBERID String Subscriber Identifier.
SYNCSTATUS String Synchronization status. Possible values are: “NOT_SYNCHRONIZED”, “SYNCHRONIZED”, “SYNCHRONIZED_FAILED”, “UNDISCOVERED”, “DISCOVERY_FAILED”, “IN_DISCOVERY”
TAG List Variable device tag string.
Note: You can create and edit custom search terms using the CLI. Custom search terms are available for use in the GUI. For further information, refer to the ACS CLI reference.

Device Search Examples

Use Case Query String
Sync status is “NOT_SYNCHRONIZED SYNCSTATUS=*NOT*
Device serial number is “12AK08265115 SERIAL eq 12AK08265115
Product class starts with “B90 PRODUCTCLASS=B90*
Manufacturer contains “NET MANUFACTURER eq *NET*
MAC address starts with “BC MAC=BC*
IP address ends with “2 IP eq *2
State is Arizona (AZ) STATE eq AZ

Creating Devices

Use these settings to pre-provision devices before first contact with the service. To discover a device, the service requires the device serial number and either an OUI and product class or a device model.

When you manually create devices, the status is automatically set to Undiscovered. You can edit devices in this state by double-clicking on the device record in the Devices node.

While the device serial number is always required when creating a device, you may not always know the exact OUI or product class. As an alternative to specifying the OUI and product class, you can select a device model, which may have a list of possible values for both. The exact value for the device is assigned during discovery.

To do this: Follow these steps:
Save changes Click Save
Description Device description
Subscriber ID Identifier for the subscriber which allows a device record to be linked with subscriber data stored in a third-party product.
Serial* Device serial number.
Device Model Model of the device. This is required if you do not specify an OUI and product class. The service will attempt to automatically match OUI and product class.
OUI* Organizationally Unique Identifier for hardware manufacturer.
Product Class* Device product class. For example, “Thomson TG789vn”.

Undiscovered Devices

Use these settings to edit the device information for an undiscovered device.

Note: When a device is in an undiscovered state, only the available information about the device is displayed on the device summary bar.
To do this: Follow these steps:
Save changes Click Save
Identify Device Type By* Specify how the service should identify the device. Select from ‘Device model’ or ‘OUI and product class’.
Device Model* Model of the device. Visible when you select ‘Device model’ for the ‘Identify Device Type By*’ parameter.
OUI* Organizationally Unique Identifier for hardware manufacturer. Visible when you select ‘OUI and product class’ for the ‘Identify Device Type By*’ parameter.
Product Class* Device product class. For example, “Thomson TG789vn”. Visible when you select ‘OUI and product class’ for the ‘Identify Device Type By*’ parameter.
Serial* Device serial number.
Subscriber Id Identifier for the subscriber which allows a device record to be linked with subscriber data stored in a third-party product.
Device Groups Device group(s) to associate to the device.

Device Hub

ACS controls which parameters are exposed based on the device model, service class, and profile parameter values. Use these settings to view and manage the details associated with a device record.

Note: Access to these settings is determined by your security profile. The CSR dashboard is available to all security profiles.
To do this: Follow these steps:
View detailed device summary, including sync status Click Device Info.
View device session details, such as last inform time and connection requests Click Session Info.
Send a connection request to the device Click Initiate Session.
View and manage device management tools in the CSR Dashboard Click Switch to CSR View.
View and manage active, failed, and historical device operations Click Manage Operations.
View and manage device parameters Click Manage Object Structure and Parameters.
Schedule a device process, such as reboot Click Perform Action.
Initiate a ping, traceroute, or other type of device-supported diagnostic operation Click Perform Diagnostics.
View and manage the device group and service class associations for this device Click Manage Groupings.
For devices with no device model, change the discovery algorithm, or rediscover a device Click Device Workbench.

Summary Bar for TR-069 Devices

When working with a specific TR-069 device, the summary bar provides constant core information about the device. Use these settings to determine if the device is online and is currently responding, and the status of the device. You can also view the serial number, tags, IP address, MAC address, and any graphics associated with the device model.

View device model Displayed as first item in first column.
View serial number Displayed as second item in first column.
View device status Displayed as third item in first column. Possible states are: Undiscovered, Synchronized, Discovery Failed, Not Synchronized, and Synchronize Failed.
View device tags Displayed as fourth item in first column.
View device IP address Displayed in IP column.
View device summary Click Device Info.
View device MAC address Displayed in MAC column.
View connection status Displayed in Connection Status column. Possible states are: Online and Offline.
View connection status message Click the message link located below the connection status.
View session status Displayed in Session Status column. Possible states are: Active and Inactive.
View device session details Click Session Info.
View last contact with device Displayed in Last Seen column.
Send a connection request to initiate a session Click Initiate Session.
View graphics of the device If one or more images are attached to the device, click an image thumbnail in the Images column to expand it. If no images are attached to the device, the columns shows (0).


Summary Bar for MQTT Devices

When working with an individual MQTT device, the summary bar provides constant core information about the device. Use these settings to determine if the device is online, if the device is currently responding, and the status of the device. At a glance you can also view the serial number, tags, IP address, IMEI, and any graphics associated with the device model.

View device model Displayed as first item in first column.
View serial number Displayed as second item in first column.
View device status Displayed as third item in first column. Possible states are: Undiscovered, Synchronized, Discovery Failed, Not Synchronized, and Synchronize Failed.
View device tags Displayed as fourth item in first column.
View device IP address Displayed in IP column.
Note: This column does not display if either IMEI or ICCID have a value.
View device summary Click Device Info.
Note: This field in the IP column does not display if either IMEI or ICCID have a value.
View device MAC address Displayed in MAC column.
Note: This column does not display if either IMEI or ICCID have a value.
View device Integrated Circuit Card Identifier (ICCID) Displayed in ICCID column.
Note: This column only displays if either IMEI or ICCID have a value.
View device International Mobile Equipment Identity (IMEI) Displayed in IMEI column.
Note: This column only displays if either IMEI or ICCID have a value.
View connection status Displayed in Connection Status column. Possible states are: Online and Offline.
View connection status message Click the message link located below the connection status.
View session status Displayed in Session Status column. Possible states are: Active and Inactive.
View device session details Click Session Info.
View next time device contacted CWMP on the periodic inform interval Displayed in Next Periodic Inform column.
Send a connection request to initiate a session Click Initiate Session.
View graphics of the device If one or more images are attached to the device, click an image thumbnail in the Images column to expand it. If no images are attached to the device, the columns shows (0).


Manage Operations

Use the settings in the operations table to view and manage operations that have been applied to the device.

Active operations remain in the active operations table indefinitely until you retry the operation or terminate it, sending it to an archived state.

To do this: Follow these steps:
Filter operations by state From the dropdown menu, select Active Operations or Archived Operations.
Filter operations by creation date From the Created table heading field, select Show all, Within the last hour, Within the last day, Within the last week, or Within the last 4 weeks.
Filter operations by type. Available types differ between Active and Archived states. From the Type table heading field, select Get Parameter Value, Firmware Update, Script, Backup, or Discovery.
Filter operations by status From the Status table heading field, select All, Completed with error, Scheduled, Pending, or In Progress from the dropdown menu.
Select an operation Click an operation.
Select all operations Click Select All.
View an operation Select an operation and click View.
Terminate an operation Select an operation and click Terminate.
Retry an operation Select an operation and click Retry.

Device Operations Details

Use these settings to view details for the operation such as parameters, schedule, and log.

To do this: Follow these steps:
Terminate the operation Select an operation and click Terminate.

Manage Object Structure and Parameters

Use these settings to view and manage objects (root level parameters) and parameters available to the device.

The service controls which discovered parameters are exposed based on values set in the device model. Provisioned parameters are those which have been assigned values different from the default discovered parameter value.

To do this: Follow these steps:
Switch to the provisioned parameter list Click Provisioned.
Switch to the discovered parameter list Click Discovered.
View a parameter definition Click a parameter.
Expand or collapse an object tree Click expand (+) or collapse (-).
Select an object or parameter In the action bar, click Select.
Select the notification value Select a parameter. Then, in the action bar, click Provision.
Provision a parameter Select a parameter. Then, in the action bar, click Set.
Save changes In the action bar, click Save.
Delete an object or parameter In the action bar, click Delete.
Notification Parameter notification types can be inherited from service classes. Parameter notification types set on an individual device override the parameter notification types set in a service class.

When the notification type is set to Off, the device will never update the service with value changes.

When set to passive, and when the parameter value changes, the device will update the service with an inform request either on the next scheduled inform interval or on the next reboot that the device initiates.

When set to active, the device takes immediate action to inform the the service of the new parameter value.

Access List List of security profiles with permissions to modify device object and parameter settings. Displayed when supported by the device.
Value Parameter value.
Note: You can query an external data source to retrieve parameter values. The service supports queries to LDAP and SQL data sources. Before you can use these settings, you must configure a data source. For further information, refer to the ACS installation guide.

Schedule Options

When you create device operations, such as some actions and diagnostics, the service provides you with schedule options. Use these settings to set the operation schedule.

Table 1. Schedule
Immediate The service immediately sends the operation to the device.
Next Contact The service waits to send the operation until the next contact from the device.
Window Create a time window for the campaign to run. Window scheduling is useful for scheduling events that may disrupt service.

See the table below for parameters for time window scheduling.

Table 2. Window - Scheduling Options
Date Date the service can run the operation.
Start Time Start of a time window in which the service can run the operation.
End Time end of a time window in which the service can run the operation.
Note: Operations are only sent to the device within the active time window(s). Operations that are not completed at the end of this period move into a failed state.
Notify Device When the time window becomes active, the service notifies the device. Otherwise, the service waits to send the operation until the next contact from the device.
Repeat Enable to define a daily or weekly recurring schedule.
Repeats Daily or weekly.
Run Length of time to run the repeat schedule. Select one of:
  • Until completion
  • After ___ occurrence(s)
  • Until date ___

Perform Actions

Use these settings to perform actions against the device.

Actions are processed asynchronously in the background. When you select the immediate scheduling option, an operation may not be complete when the GUI returns the operation successfully submitted message.

Reboot Reboot the device.
Factory Reset Reset the device to the original firmware state.
CAUTION:
A factory reset will erase the current configuration on the device and set it back to default factory settings. This may change DHCP and WAN/LAN network interface settings, causing communication with the server to fail. Use this button with extreme care.
Resync Retrieves the current state from the devices and re-provisions if needed.
Reload Read parameter values from the device (those set to Relevant status in device model) and save them to the database. When you enable the Purge Parameters option, the CWMP service deletes all discovered parameters for the device from the database which were not included in the reload operation.
The last parameters reloaded from the device can be different than those in the database for the following reasons:
  • Some supported parameters may have been removed or set as “Requestonly” in the device model since the last reload or discovery operation. The service does not reload these from the device, but the previous values may still be in the database.
  • Some table instances may have been removed from the device by actions such as “delete object” or “factory reset” (which changes the device configuration). However, they may still be in the database from previous reload, discovery, or add object operations.
  • Some “Requestonly” parameters were saved to the database from “GetParameterValues” operations. The service enables you request individual parameters in “GetParameterValues” operations that are otherwise set to “Readonly” in device model. The service saves all parameters read by the “GetParameterValues” operation to the database, regardless if they are set to “Relevant” or “Requestonly” in device model. Therefore, a reload with Purge Parameters enabled removes all of those parameters from database.
Firmware Upgrade Upgrade firmware on a device.
Backup Store a backup of the current device configuration including provisioned parameters and, optionally, parameters discovered on the CPE.
Restore Restore device parameters from the last device backup.
Download Download new firmware, vendor configuration files, ringer or tone files, or web content from a HTTP server to the device.
Upload Upload log or configuration files from the device to an HTTP server.

Perform Diagnostics

Use these settings to perform diagnostic operations, such as ping, available to the device.

Important: Before you can execute diagnostic operations, you must first set up diagnostics for the device model in Device Models > Device Model Details > Diagnostics. The input fields and output elements for each diagnostic are defined in this location. The service displays a notification if there are no diagnostics configured for the device model of the device you are viewing.
Tip: You can set default input values in the device model.
To do this: Follow these steps:
Execute a diagnostic operation In the diagnostic menu, select a diagnostic operation. Then, input parameters and click Execute.
Cancel an active diagnostic operation In Returned Results, click Cancel.
View diagnostic operation details In Returned Results, click View diagnostics operation.
Note: For devices that support Download Diagnostics, ACS uses the value of TotalBytesReceived, not TestBytesReceived, to calculate download speed. The benefit is that TotalBytesReceived accounts for all applications that use bandwidth resources.

Manage Deployment Units

Deployment Units (DUs) are a type of software module, defined in TR-157 (Amendment 3), used to install and execute (start and stop scripts) configuration files, Execution Units (EUs), and other resources. EUs, comprised of entities such as scripts and libraries, initiate processes to perform tasks or to provide services. Primary firmware is a separate type of entity and is not considered a software module. If the SoftwareModules object is not supported by the device, then you will not see this option in the Device Hub. Use these settings to view and manage deployment units.

Note: The service will accept any file name, with or without an extension. If SNMP Genie is integrated with ACS, deployment units for SNMP devices require a JSON file. For further information, refer to the SNMP Genie user's guide.
To do this: Follow these steps:
Add a new Deployment Unit In the action bar, click Add.
Modify an existing Deployment Unit In the action bar, click Update.
Uninstall a Deployment Unit Click a deployment unit. Then, in the action bar, click Delete.
Note: When you uninstall a Deployment Unit, and you do not specify a version to remove, the service uninstalls all versions of the Deployment Unit with the same UUID.
Name Descriptive name for the Deployment Unit name.
UUID The Universally Unique Identifier (UUID) of the Deployment Unit.
DUID Read-only parameter. Deployment Unit Identifier (DUID), as defined in TR-157 (Amendment 3), assigned by the environment on which the Deployment Unit is deployed.
Status Deployment state. Possible states are: Installing, Installed, Updating, Uninstalling, and Uninstalled.
Vendor Read-only parameter. The author of the software module. The value of this parameter is used in the generation of the UUID.
Current Version Indicates the Deployment Unit version.

Updating Deployment Units

Use the following parameters, defined in TR-069 (Amendment 3), for updating a Deployment Unit.

URL Specify the location of the update to be applied to the Deployment Unit. If you do not provide a URL in the request, then the CPE uses the last specified URL.
UUID Universally Unique Identifier of the existing Deployment Unit to update. If empty, the CPE generates this ID.
Username If authentication is required by the file server, specify the username for the CPE to use.
Password If authentication is required by the file server, specify the password for the CPE to use.
Version Specify the version of the Deployment Unit to update when there are multiple versions available.
Schedule Specify a schedule. Options are ‘Immediate’, ‘Next Contact’, or ‘Window’.

Manage Groupings

View and manage device groups associated to the device.

To do this: Follow these steps:
View a device group Double click a device group name.
Associate the device to a new device group Click Add.
Remove the device from a device group association Click Remove.

View Device Information

Use these settings to view device summary details and to manage the associated device model.

To do this: Follow these steps:
Change the device model associated to the device From the dropdown menu, select a model.
Save Changes Click Save.
CAUTION:
Device models control which discovered parameters the service displays and which firmware versions are available to the device. Modifying the device model can prevent the device from running correctly and should be attempted by experienced users only.
Device Images Graphical image for the device. Images are defined in the device model.
OUI Organizationally Unique Identifier for hardware manufacturer.
Product Class Device product class. For example, “Thomson TG789vn”.
Serial Device serial number.
Sync Status The state of the device. Possible values are “SYNCHRONIZED”, “NOT_SYNCHRONIZED”, “SYNCHRONIZED_FAILED”, “UNDISCOVERED”, and “DISCOVERY_FAILED”.
Connection Status Reports whether the device is online or offline. If online, this status provides the total amount of time the device has been online in the format 'DD HH MM SS'.
Device Offline: The Connection Status reports a device ‘Offline’ when CWMP cannot establish a low level socket connection during a connection request. The types of messages you may see in the logs are: “connection refused”, “network is unreachable”, “no route to host”, “not accepting the connection”, or “connection timeout”.
Device Online: The Connection Status reports a device ‘Online’ when CWMP establishes a low level socket connection and the device accepts the connection request.

If CWMP is able to establish a low level socket connection and the connection request fails, the Connection Status will still report the device ‘Online’. The types of messages you may see in the logs are: “read timed out” (timeout waiting for response) or “authentication error”.

You can configure the timeouts for establishing a connection and for responses using the following service configuration parameters:

CONNECTION_REQUEST_CONNECT_TIMEOUT=5 (in seconds)

CONNECTION_REQUEST_RESPONSE_TIMEOUT=10 (in seconds)

Firmware Version Firmware version on the device.
Hardware Version Hardware version of the device.
Type Service type. For example, DSL.
Status Physical link status.
MAC Address Device MAC address.
IP Address Device IP address.
Mask Size Subnet mask size.
Default Gateway Default gateway IP address.
STUN Indicates if STUN is enabled, disabled, or unavailable.
XMPP Indicates if XMPP is enabled, disabled, or unavailable.
Subscriber Name Name of the subscriber. This name allows a device record to be linked with subscriber data stored in a third party product.
Subscriber ID Identifier of the subscriber. This ID allows a device record to be linked with subscriber data stored in a third party product.
DHCP Option 82.2 Remote ID (MAC address) of the client. (RFC 3046).

When present in the TR-069 device record, the service will contact discovered DHCP services in the same provisioning cluster, using multicast integration, to verify IP lease association to option 82.2 data.

Note: When integrated with Incognito DHCP service in a DOCSIS network, the cable modem MAC address must be specified using upper-case letters. For example, 00:AA:BB:CC:DD:EE.
Device Model Model of the device. For example, “DG1670A” (ARRIS).
Inform Interval Interval (in seconds) at which the CPE sends an Inform message.
Last Inform Time Time (in seconds) the CPE last sent an Inform message.
Next Expected Inform Time (in seconds) the CPE is expected to send an Inform message.
Cluster Id CWMP cluster ID to which the device belongs. Available when there are multiple CWMP services.
Discovered Date the service first discovered the device.
Last Modified Date the device record was last modified.
Last Modified By User that performed the last modification to the device record.

View Session Information

All communications and operations between the device and the service happen within a device session. Use these settings to view the most recent device session details, including when the last connection request was sent and when the response was received.

Session Status Displays whether there is an active or inactive device session.
IP Address Device IP address.
Last Inform Time Date and time the device last sent an inform message.
Last Session End Date and time of the last session between the device and service ended.
Next Periodic Inform Date and time for the next scheduled periodic inform.
Session Duration Duration for a currently active session.
Session Error Message Session error message. Field is blank if there are no errors.
Last Connection Request Sent Date and time the service last sent a connection request to the device.
Last Connection Request Response Received Date and time the device last responded to a connection request from the service.
Last Connection Request Response Code The response code can be any standard HTTP status code or a service code ('-1') service code. These codes are combined with the Last Connection Request Response Message parameter. Common response codes with messages are 200 OK, 401 Unauthorized, 410 Gone and -1 System Error.
Last Connection Request Response Message The response message can be any standard HTTP response message or a service message (system error). These messages are combined with the Last Connection Request Response Code parameter. Common response codes with messages are 200 OK, 401 Unauthorized, 410 Gone, and -1 System Error.

Device Workbench

The Device Workbench is a toolkit for the debugging of a device that has failed to discover. Use these settings to view logs, adjust discovery algorithms, and to rediscover devices.

The Device Workbench allows you to access ACS and device logs that can help you diagnose issues with device discovery. You can also set options for establishing device parameters, such as discovery method, connection request user name and password, CPE user name and password, and inform interval.
Note: These features are only intended for device discovery. Once a device model has been assigned, these settings are available in other locations.
To do this: Follow these steps:
Start a logging session Select the logs to show and click ACS Logs.
Retrieve internal log file from the device (must be TR-098-compliant) Click Device Log.
Export a log to a text file Click Export.
Suspend scrolling on the log screen Click Pause Auto-Scroll.
Resume scrolling on the log screen Click Resume Auto-Scroll.
Clear the log Click Clear Log.
Reload the device log Click Reload.
Change discovery settings Make changes and click Apply to trigger a connection request.
Go back one screen Click the back symbol ().
Return to the main screen of the service Click the hub symbol ().

When the device has completed a successful discovery cycle and is in a “Synchronized” state, the service displays the read-only settings used for discovery. When the device is in an “Undiscovered” state, you can modify these settings to reattempt discovery.

OUI The hardware manufacturer's Organizationally Unique Identifier(s) attached to the device model.
Product Class Product class label(s) attached to the device model.
Discovery Root Discovery root in use with the All at Once discovery algorithm. Format displayed is <root node>;<device manufacturer>. For example, InternetGatewayDevice.;Hitron Technologies.
Discovery Method The discovery algorithm for the device model.
Cookie Path Some devices require a path defined within the TR-069 session cookie. For example, "/". Refer to the documentation provided by the device manufacturer.
Ignore Error When enabled, devices complete the discovery process even if some errors occur. This is useful for devices that generate errors when reading some types of parameters.
Periodic Inform Interval The frequency, in seconds, that the device is set to contact the service.
Connection Request Username Username used to authenticate the device when performing a connection request. This is set by the service after a CPE contacts it for the first time.
Connection Request Password Password used to authenticate the device when performing a connection request. This is set by the service after a CPE contacts it for the first time.
CPE Username Username used by the CPE to authenticate against ACS when establishing a session.
XMPP When enabled, the device uses XMPP for connection requests.
STUN When enabled, the device uses STUN for connection requests.

CSR Dashboard

The CSR dashboard gives you a visual representation of the device and the white dashboard tiles display real-time information. Use these settings to view and manage the device.

To do this: Follow these steps:
Manage dashboards for this device model. Visible to administrator accounts In the action bar, click Manage Device Model Dashboards.
Return to the device hub In the action bar, click Switch To Admin View.
Reload the dashboard In the action bar, click Reboot.
View tile data Click a tile.

Network Quality Widget

The network quality widget displays quality indicator data collected from the device. This data can include information from ping, traceroute, upload, and download diagnostics as well as latency and packet loss measurements. Use these settings to create a new network quality widget.

Note: Diagnostics must be available to the device and defined in the device model for use in this widget. You can create and configure diagnostic definitions in the device model.
General Widget type* Network Quality widget type.
Name* Name for the widget
Description Description for the widget
Icon Select a widget icon.
IPPING CONFIGURATION Host* Name of the destination address to ping.
Number Of Repetitions Number of packets to send to the destination host.
Interface

The device parameter name for WAN or LAN-IP layer interface over which to perform the test, as defined in the TR-069 standard.

The following is a WAN interface example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1

The following is a LAN interface example: InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.1

DSCP Differentiated Services Code Point (DSCP) decimal value to specify the QoS priority of the packet, defined in RFC 2474. Possible values are 0 (lowest priority) - 63 (highest priority).
Data Block Size Packet size, in bytes. Valid range is 1-65535.
Timeout Time, in milliseconds, to wait for a response from the destination host before the request times out. Maximum value is 100000 (a 10-second timeout).
TRACEROUTE CONFIGURATION Hostname Name of destination host where you want to trace the route.
MaxHopCount Maximum number of hops before the packet is discarded and the destination is considered unreachable.
DOWNLOADSPEED/UPLOADSPEED CONFIGURATION DSCP Differentiated Services Code Point (DSCP) decimal value to specify the QoS priority of the packet, defined in RFC 2474. Possible values are 0 (lowest priority) - 63 (highest priority).
Timeout Time, in milliseconds, to wait for a response from the specified host before the request times out. Maximum value is 100000 (a 10-second timeout).
Max Hop Count Maximum number of hops before the packet is discarded.
Data Block Size Packet size, in bytes. Valid range is 1-65535.

Port Forwarding Widget

The port forwarding widget offers an interface with capabilities similar to a standard home router. It enables you to add, enable, and disable port rules and, if configured in the device model script, select from a set of predefined applications such as HTTP, SSH, and World of Warcraft. You can either enter the target machine, or select from the list of discovered devices.

Note: You can create a script for port forwarding Device Models > Device Model Details > CPE Service Configurations where you can add or modify script definitions.
Widget type* Port Forwarding widget type.
Name* Name for the widget.
Description Description for the widget.
Size In the Size dropdown menu, select Small (1x1). The Large (2x1) size is to display longer strings, such as for labels.
Icon Select a widget icon.
Service Name (Script) Select a script for the widget. Port forwarding scripts are configured in Device Models > Device Model Details > CPE Service Configurations.

Run Compliance Test Suite

Compliance test suites are collections of operator-defined certification tests for verifying that devices and device firmware pass your specific requirements before deployment to your network. Use these settings to execute and manage device compliance tests.

Important: This content refers to a separately licensed feature, available from ACS 3.4+, which may not be included in your deployment solution. For more information, contact Incognito.

Your user profile permissions determine if you have visibility to the compliance test suites. User types and permissions are defined in User Management Service (UMS).

Note: The device must be online and accepting connection requests for compliance tests to function. There must also be an existing device model record in the service that corresponds to the device. If you are testing STUN or XMPP, you must ensure these are configured on the device.

Compliance tests are carried out as live operations on the device. When tests are complete, the service includes them in the operations table at Devices > Device Hub > Manage Operations. The service retains these operations until you terminate (archive) them. To automatically clear failed operations, you can use the teardown script.

Tip: You can navigate between tests as they are executing. Tests continue to run in the background, and the CWMP service caches the results for 15 minutes after the test is complete. After a test is complete, you can select tests to re-run and export the results to a PDF report.

The possible status results from a test are “Passed”, “Error”, or “Failed”. An error status indicates that a REST call from IES to the ACS service failed. Errors are logged and provided in the PDF report. A failed status indicates that a test did not pass the conditions specified in the test case script.

Note: You can create and manage compliance test suites from the Device Compliance Test Suites node.
To do this: Follow these steps:
Select a test suite From the TEST SUITES list, click a test.
Execute a test suite against this device Click Run Test.
Customize tests in a test suite Use the check boxes to select and deselect tests. Then, click Run Test.
Modify settings for a test Select a test suite and click the settings symbol().
Go back to all device tests Click << Return to Device Tests.
Create a new test suite Click the add symbol ().
Import your own test suite Click the settings symbol() and click Import and select Local File.
Import a test suite from the Incognito repository Click the settings symbol() and click Import and select Remote File.
Export a test suite (XML format) to a zip file Click the settings symbol(), select a test, and click Export.
Add a test to a test suite In the Test Suite Details section, click the add symbol ().
Cancel an in progress test Click Cancel Test.
Re-run selected tests Use the check boxes to select and deselect tests. Then, click Re-Run Selected Tests.
Export test results to a PDF report Click Export Results (PDF).
Clear test results Click < Start Over.
Go back one screen Click the back symbol ().
Return to the main screen of the service Click the hub symbol ().
Test Suite Setup Logic that is executed, once, before the first test begins. Use it to initialize the test, or to provision necessary parameters on the device, such as the connection request username and password. The setup method does not pass or fail, but exceptions thrown at this stage prevent execution of the test suite.
Test Suite Teardown Logic that is executed after the last test finishes.

Configuring the Devices View

The Devices view displays by default in ACS. You can configure the columns that display in the view, and the available search fields in the Advanced Search box. For further information, refer to the ACS installation guide.

See also:
Top