'; Device Models | 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/device_models
URI: acs/topics/device_models
=== Tags ===
Array
(
    [816] => device_models
)

=== Related ===
Array
(
)
  1. Auto Configuration Server
  2. Topics

Device Models

Device models, in the service, act as containers for metadata about physical devices, and their associated firmware versions. This data lists supported parameters, describes features, such as how to configure WiFi services, details special parameters, such as those that hold log file and interface information, and defines service characteristics, such as how to discover the device and how to handle the device on factory reset.

Note: Access to these settings is determined by your security profile. The CSR dashboard is available to all security profiles.

Before you can manage a device, the service must contain a device model to store the parameters retrieved during discovery. During the device discovery process, the service matches devices to device models based on association logic which uses identifiers such as OUI, product class, and firmware version.

Adding a New Device Model

The service provides a set of device models out-of-the-box, support for cloning device models, and support for importing and exporting device models.

Most certified devices already have a pre-configured, out-of-the-box, device model listed in the repository. The fastest way to add a functional device model to the service is to import one from the repository.

Cloning device models can be useful in cases where you want a minor variation from an existing device model, such as when a new firmware brings behavioral changes or additional capabilities. You can use the GUI to clone the existing device model and make your edits. Then, when you are ready to import your file, navigate to Import > Local File.

Important: If you want to import an existing device model, you must set "Ignore Service Script Errors" flag to true. Otherwise, the service will return an error. When you import a .zip file that contains many device models, and at least one device model already exists in the service, then you must set the "Ignore Service Script Errors" flag to true. Otherwise, no device models are imported and the service will return an error.

In some cases, the service may discover a device without a matching device model. You can manually add a device model to a device using Device Info from the Device Summary Bar.

Tip: You can export a functioning device model from a lab environment to a file and import it onto a production ACS, making the production environment ready for devices that match the device model. Filenames can contain alphanumeric characters and the underscore character. Files must be located in a repository local to the service.
To do this: Follow these steps:
View details for a device model Double-click a record
Search for a device model Click the search symbol (), type search terms, and press Enter.
Import a device model In the action bar, click Import
Export a device model Select a device model. Then, in the action bar, click Export.
Select a device model Double-click a record. To select multiple records, press and hold CTRL and click the records you want to select.
Select all device models In the action bar, click Select All. Exit select mode by clicking on any whitespace on the page.
Review devices without a model and attempt to assign them to an existing model In the action bar, click Auto-Assign
Switch to table view/grid view Click the table symbol ()/grid 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.

Device Model Details

View the TR-069 data model associated to the device model and the supported device commands. Use these settings to view and manage the device model.

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:
Clone the device model In the action bar, click Clone
Delete the device model In the action bar, click Delete
Add an image to the device model In the action bar, click Add Device Images. Valid image formats are .jpg, .jpeg, .gif, or .png.
Supported Device Commands View and manage operations supported by the device model.
OUI View and manage the hardware manufacturer's Organizationally Unique Identifier(s) attached to the device model.
Firmware Versions View and manage firmware versions supported by the device model.
Product Class View and manage product class labels attached to the device model.
Options View and manage device discovery behaviour options for the device model.
Back to top

Device Model Options

Use these settings to view and manage notification and discovery options for the device model.

Dashboard Poll Time (Seconds) The interval, in seconds, in which the service sends requests for new data to the device for dashboard updates. Default value is 30 seconds.
Note: Short intervals provide a more real-time user experience but may cause denial of service protection to engage in some devices.
Reload Behavior

Defines the service behavior when the service receives a factory reset notification (BOOTSTRAP event) or factory reset operation (triggered by user). Possible values are: Never, Always, and ACS-triggered.

Never: Reload of device parameters is never executed on factory reset notification (BOOTSTRAP event) or factory reset operation (triggered by user).

Always: Reload of device parameters is always executed on factory reset notification (BOOTSTRAP event) or factory reset operation (triggered by user).

ACS-triggered: Reload of device parameters is executed only for factory reset operation (triggered by user).
Discovery Algorithm Device discovery behaviour options. Refer to the Discovery Algorithm topic for further details.
Batch Size Maximum number of parameters to retrieve at one time during batch discovery operations.
Send Connection Request Enable if this device model supports connection requests. Otherwise, no connection requests will be sent to devices of this model type.
Minimum Connection Request Interval Some devices engage into a denial of service protection behavior when connection requests are sent too frequently. This value sets the minimum interval required between sending connection requests to the device.
Collect Connected Devices Enables the collection of connected devices for every device with this device model. Updates the last time the connected device informed and any other details of the device as reported by the CPE.

Default: false (that is, off).

Back to top

Discovery Algorithm

During the device discovery process, the service uses a default discovery algorithm to request from devices a complete list of supported parameters. Using this all-at-once discovery method enables a majority of devices to complete a successful discovery cycle.

Default discovery can fail when devices are unable to transfer a complete list of parameters at once, which can occur with memory and CPU processor resource limitations on the device. The service offers several other discovery algorithms to accommodate these devices. By modifying the discovery algorithm, you can configure the service to request the device to limit the number of parameters it sends at once.

When there is an existing device model record in the service that corresponds to the device you are trying to discover, you can alter the discovery algorithm for the device model. When you are trying to discover devices that do not have a matching device model in the service, such as when you are introducing new devices to your network, and default discovery fails, you can use the ACS CLI to enforce an alternate discovery algorithm.

Note: Discovery algorithm types configured in the GUI take precedence over parameters configured in ACS CLI.
CAUTION:
Modifying the discovery algorithm can prevent the service from discovering devices associated with the device model.
All At Once Returns all parameters requested (RPC calls) at the same time. For example, if 200 parameters match, then 200 parameters are returned.
All At Once Multisession Returns all parameters requested at the same time, but each RPC call is executed in a separate session. The session is closed after each RPC call completes. For example, getParameterName will run as one session and getParameterValues will run as a new session after the first session closes.
Batch Discovery Retrieves parameters in numbered batches, specified in the Batch Size field. For example, if the batch size is 20, and there are 200 parameters, then the service retrieves the parameters in 10 batches of 20 parameters, making a separate request for each batch.
Batch Discovery Multisession Retrieves parameters in numbered batches, specified in the Batch Size field, and executes each RPC call in a separate session. For example, getParameterBatch discovery multisession runs as one session and getParameterValues runs as a new session after the first session closes.
Interface Discovery Default discovery algorithm for devices that implement the Device:2 (TR-181) device data model. The service gets parameters using the interface stack table as starting point. The algorithm discovers first the interfaces supported by the device, such as WiFi and IP, and then reads the parameters of those interfaces.
Interface Batch Discovery Retrieves parameters in numbered batches, specified in the Batch Size field, for devices that implement the Device:2 (TR-181) data model.
Interface Multisession Discovery Retrieves parameters for devices that implement the Device:2 (TR-181) device data model and executes each RPC call in a separate session.
Tip: When you use a batch discovery algorithm, begin by confirming that the device is discoverable by testing with a batch size of 1. If the device discovers, then increase the batch to a larger size, such as 50 or higher. Work your way down from that number until the device is discovered. Larger batch sizes are ideal since network activity increases with smaller batch sizes because each batch requires a separate request to the device.
Back to top

CPE Service Configurations

CPE service configuration scripts are attached to device models and communicate with a dedicated tile type in the device dashboard, Service Configuration. They are used to configure CPE functionality, such as WiFi, WAN, LAN, or DHCP. They generate the displayed fields and the default populated values in these tiles, and also control how the service writes values back to the device. They can return a list of parameters and values and allow you to change and save them. They can also define the level of detail exposed in the device dashboard tiles to different security profiles.

Note: Use Incognito Ecosystem Scripting to create script definitions that you can add to CPE service configurations.
To do this: Follow these steps:
View a service configuration script Click a configuration name
Add a service configuration script In the action bar, click Add
Remove a service configuration script Select a configuration and click Remove
Accept changes Click Confirm

Port Forwarding

There are sample port forwarding scripts in the ACS Scripting Guide in the CPE Service Configurations section.

Back to top

Device-Log Parameters

Device log parameters describe the parameters that contain log file information. Use these settings to view and manage device log parameters.

To do this: Follow these steps:
Add a parameter In the action bar, click Add
Delete a parameter Select one or more records. Then, in the action bar, click Remove
Set the friendly name on a parameter Select a parameter. Then, in the action bar, click Set
Accept changes In the action bar, click Confirm
Back to top

Perform Actions

Device action scripts are attached to device models and can be executed against an individual device or as a campaign against a group of devices. The individual CPE details are available within the script for further analysis. Use these settings to manage device actions for the device model.

To do this: Follow these steps:
Add a device action In the action bar, click Add
Delete a device action In the action bar, click Delete
View device action details Click a device action
Manage action script From device action details, click the Script Accessible bar on the top of a device action
Accept changes Click Confirm
Back to top

Supported Parameters

List of discovered objects and parameters supported by the device model.

Sometimes, objects can be empty during discovery, such as the hosts table, and the discovered parameters underneath are not listed. When this happens you can add parameters manually. When you add a parameter, you must use a properly formed value. For example, InternetGatewayDevice.LanDevice{i}.HostsNumberOfEntries. Do not include a trailing dot (.).

To do this: Follow these steps:
Manage a supported parameter Select a parameter check box. Then, in the action bar, click Set.
Filter parameter list In the dropdown menu select All, Relevant, Request-Only, Writable, or Non-Writable
Search for a parameter Click the search symbol (), type search terms, and press Enter.
Add a supported parameter In the action bar, click Add
Remove a supported parameter Select a parameter check box. Then, in the action bar, click Remove.
Select all parameters In the action bar, click Select All. Exit select mode by clicking on any whitespace on the page.
Save changes In the action bar, click Confirm
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.
Monitoring Level All parameters marked relevant are displayed in the Object Structure and Parameters list for a device. Request-only parameters are display only if a request is issued for the parameter.
Writable Parameters are writable or non-writable (read-only). Values for writeable parameters can be changed by ACS. The device does not allow ACS to change values for non-writeable parameters, however ACS can use non-writeable parameters to collect statistics and to determine the state of the CPE.
Data Type Data type the parameter supports. For example, string or datetime.
Back to top

Diagnostics

List of diagnostic parameters supported by the device model. When a device is created in the service, diagnostics available to the device are auto-detected and populated here. Use these settings to view and manage parameters and values for diagnostic operations.

To do this: Follow these steps:
View diagnostic details Select a diagnostic. Then, in the action bar, click View.
Select all diagnostics In the action bar, click Select All. Exit select mode by clicking on any whitespace on the page.
Create a new diagnostic definition In the action bar, click Create
Delete a diagnostic Select a diagnostic. Then, in the action bar, click Delete.
Accept changes In the action bar, click Confirm
Back to top

Creating Diagnostics

Use these settings to create a new diagnostic definition for the device model.

To do this: Follow these steps:
Save changes Click Confirm
Name* Diagnostic name.
Description Diagnostic description.
Type* Dropdown menu of diagnostics available to the device model.
Add Trigger Parameter* Select a parameter(s) to trigger the diagnostic.
Add Input Parameters* Define the input fields required for a diagnostic. For example, to define input parameters for a ping diagnostic, you might include a timeout, host for the device to ping, and number of repetitions. You can also set default values for input parameters.
Add Return Parameters* Define the output elements that are returned to the user when the diagnostic is complete. For example, to define output elements for a ping diagnostic, you might include a minimum and maximum response time, a success count, and a failure count.
Back to top

Custom Value Generators

Custom value generators can access data from devices and external systems and then calculate values to display in the device dashboard. They can be represented as a single numeric value or as a graph, which enables more complex calculations. For example: (number of outgoing failed calls + number of incoming failed calls) / (total number of outgoing calls + total number of incoming calls). You can also use the graph feature to calculate per-device key performance indicators. Use these settings to add custom value generators to the device model.

To do this: Follow these steps:
View custom data generator details Click a record
Add a custom data generator In the action bar, click Add
Delete a custom data generator Select one or more records, and click Remove
Select a record Double-click a record. To select multiple records, press and hold CTRL and click the records you want to select.
Manage action script From custom data generator details, click the Script Accessible bar on the top of a generator
Accept changes Click Confirm
Back to top

Network Interfaces

Network interfaces defined for the device model provide the subscriber network view. Use these settings to manage network interfaces associated with the device model.

To do this: Follow these steps:
View details for a network interface Double-click a record
Create a network interface In the action bar, click Create
Delete a network interface Select one or more records. Then, in the action bar, click Remove
Select a network interface Double-click a record. To select multiple records, press and hold CTRL and click the records you want to select.
Select all network interfaces In the action bar, click Select All. Exit select mode by clicking on any whitespace on the page.
Accept changes In the action bar, click Confirm
Back to top
Versions
Top