'; Service Classes | 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/service_classes
URI: acs/topics/service_classes
=== Tags ===
Array
(
    [823] => service_classes
)

=== Related ===
Array
(
)

Service Classes

Service classes are groupings of parameters, their values, and attributes (“Access List” and “Notification”). You can associate service classes with device groups, so every parameter configured within is provisioned to all the devices within the group. When a new device enters a device group, it is also provisioned with those values. You can associate multiple service classes with the same device group.

Service classes are assigned a unique priority to handle conflicts, such as when the same parameters configured in multiple service classes have different values. The service provisions parameters within service classes in order of priority.

Service classes simplify the provisioning of common parameters to a large number of devices. A common setup is to have base device provisioning, such as Connection Request Username and Password, done over a service class connected to the Walled Garden device group, and several vendor-specific configurations via individual device groups attached to respective service classes.

To do this: Follow these steps:
View details for a service class Double-click a record.
Search for a service class Click the search symbol (), type search terms, and press Enter.
Import a service class from a file In the action bar, click Import.
Create a service class In the action bar, click Create.
Select a service class Double-click a record. To select multiple records, press and hold CTRL and click the records you want to select.
Select all service classes In the action bar, click Select All. Exit select mode by clicking on any whitespace on the page.
Export a service class Click a service class, and in the action bar, click Export.
Clone a service class Click a service class and in the action bar, click Clone.
Delete a service class Click a service class. and in the action bar, click Delete.
Search fields In table view, type search terms in any of the available column heading fields and press Enter.
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.

Creating Service Classes

Use these settings to create a service class.

To do this: Follow these steps:
Save changes In the action bar, click Save
Name Name for the service class you are creating.
Description Description for the service class you are creating.
Priority Service classes are priority weighted. The lower the priority number, the higher the precedence of that service class. If no priority is specified, the next available priority is assigned. When a device group is a member of two or more service classes, the class with the highest priority is used to provision parameters to the group of devices.

Service Class Details

Use these settings to view and manage parameters and device groups associated to the service class.

To do this: Follow these steps:
Clone this service class In the action bar, click Clone.
Export this service class to a file on the local system In the action bar, click Export. The service class is downloaded to the local system in a file.
Delete this service class Click Delete.
View and manage parameters Click Add Parameters.
Note: After you have added parameters, this link changes to Parameters.
View and manage monitored parameters Click Add Monitored Parameters.
Note: After you have added parameters, this link changes to Monitored Parameters.
View and manage associated device groups Click Add Device Groups.
Note: After you have added parameters, this link changes to Device Groups.
Save changes Click Save.
Tip: You can export a service class to a file for import into another ACS interface or entity. For example, you can export a service class from a service used for testing in a lab environment to a file and then import it into a production environment service.

Associated Parameters

Use these settings to view and manage parameters associated to the service class.

To do this: Follow these steps:
Search for a parameter Click the search symbol (), type search terms, and press Enter.
View parameter details Click a parameter name.
Manage parameter values (for writable parameters) Select a parameter check box. Edit the values. In the action bar, click Confirm. From the Schedule Type dropdown, select a schedule. Click Confirm to save the changes.
Add parameters Click Add. Select one or more parameter check boxes. Click Add to save the changes.
Remove parameters Select a parameter check box and, in the action bar, click Remove.
Set parameters in bulk Select multiple parameter check boxes and, in the action bar, click Bulk Set.
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.
Value Service class parameter values can be expressed as static values or as query expressions (dynamic service class parameters) using the format $SYS(<datasource-name>;<default-value>;<query>).
Notification Select a notification type to control how the device will inform ACS of configuration changes for this parameter.

When no notification type is set, this service class will have no effect on the parameter attribute.

When the parameter notification type is set to Off, the CPE will never update ACS with value changes upon subsequent informs or during any reboot operation.

When the parameter notification type is set to Passive, the CPE device will update ACS with an inform request either on the next scheduled inform interval or on the next reboot that the device initiates.

When the notification type is set to Active, the CPE device takes immediate action to inform ACS of the new parameter value.

Note: Parameter notification types set on an individual device override the parameter notification types set in a service class. When a device belongs to more than one service class, and the notification type for the parameter attribute is set in another service class, the notification type from the service class with the highest priority is used.
Access List Defines an access list for modifying this parameter.

When set to ACS, the parameter may only be provisioned on ACS.

When set to Subscriber, the value may be provisioned by ACS or the subscriber. Use in conjunction with Active or Passive notification for ACS to be informed when the value changes.

Use Not Set for devices that do not support this feature.

Dynamic Service Class Parameters

Query expressions can be used in place of static service class parameter values to dynamically generate a parameter value.

You can define query expressions locally or by using an external lookup to an SQL database or LDAP source. Query expressions are evaluated at the time of provisioning. The format is: $SYS(expression).

Note: When you create a dynamic expression, do not insert characters before or after the expression container $SYS( ). All non-whitespace characters are permitted.
The following pre-defined variables are supported:
  • $SNUM. Substituted with the devices serial number.
  • $OUI. Substituted with the devices OUI (Organizationally Unique Identifier for hardware manufacturer).
  • $PRODUCTCLASS. Substituted with the devices product class.
  • $SERVICECLASS. Substituted with the service class ID provisioning the parameter.

For example, the following expression creates a single lookup for an InternetGateway- Device.Voice.i.Quality parameter in a service class:

$SYS(LDAP_1;60;cn=thompson,dc=devices,dc=incognito,dc=com/qos)
Tip: You can use custom strings in your query expression. For example:
  • $SYS(SECRETPASS+SERIAL)
  • $SYS(SERVERGROUP;SECRETPASS+$SNUM;CN=FOO)
Expression format examples:
  • $SYS(custom_string$predefinedvariablecustom_string)
  • $SYS(custom_string$OUI)
  • $SYS($PRODUCTCLASS;custom_string)
  • $SYS($SERVICECLASS)

External Data Source

You can query an external data source to return values for individual device parameters. The service supports queries to LDAP and SQL data sources.

You can configure your query by selecting an external source from the dropdown list or you can enter your query expression directly in the Value field.

Note: Before you can use these settings, you must configure a data source. For further information, refer to the Auto Configuration Server installation guide.

LDAP External Lookup

You can select an LDAP or SQL external lookup to create a query expression that returns a single value from an external datasource.

Source Select a source from a list of servers currently configured in the service.
Disable default value When enabled, if no entries are returned from the external source, then a default value is not used.
Default value Default parameter values are optional. If supplied, default values are used when an entry is not found in the datasource. When no default is provided and an entry is not found in the datasource, an empty string is used.
For LDAP datasources, ACS ignores this service class parameter and does not use it for provisioning when:
  • an entry is not found in the datasource and the default is set to “n/a”
  • an entry is found in the datasource but the value set in the datasource is “n/a”
Query Construct a query search string to return a single value from the external source using the format: $SYS(<data source name>;<default value>;<query string>).

Keywords can also be used in the query string, in the format ‘fieldname=data’ for example ‘HWAddress=$HW’, which are substituted with values from the device at runtime to uniquely match devices.

Valid keywords are $SNUM (hardware serial number), $PRODUCTCLASS, $SERVICECLASS (the name of the service class the expression is defined in), and $OUI (Organizationally Unique Identifier for hardware manufacturer).

LDAP attributes When you specify an LDAP attribute, the service searches for the corresponding entry in the LDAP record. When the service finds a match, the parameter value specified in the external record is used.
LDAP root The root domain name (dn) you have configured to bind to the LDAP server. If your LDAP directory allows anonymous binding, this field can be left blank.

Local Caching of LDAP Values

A service class can have thousands of devices associated to it. Due to the dynamic nature of the query language, this can result in potentially thousands of individual LDAP queries. For performance reasons, ACS contains a query optimized cache for service class-generated LDAP queries. This cache is refreshed periodically.

Associated Monitored Parameters

The service can write parameters (defined within a service class) to an SQL database for trend analysis over time or to the messaging bus for real-time monitoring.

For further information about real-time monitoring, refer to the ACS Real-Time Parameter Monitoring guide.

To view or utilize these monitored parameters, you can use or write any application you wish. For example, you can record device parameters related to packets sent and dropped to monitor the overall network health over a specified period of time.

To do this: Follow these steps:
View monitored parameter details Click a monitored parameter name.
Add a monitored parameter Click Add. Select one or more parameter check boxes. Click Add to save the changes.
Delete a monitored parameter Select a parameter check box and, in the action bar, click Remove.
Save changes Click Confirm.
Note: Before you can use these settings, you must configure the database location information. For further information, refer to the Auto Configuration Server installation guide.
CAUTION:

You can add monitored parameters using wildcards for table indexes. CWMP will replace all wildcards with indexes for the corresponding table. Do this with extreme caution, especially when used with a large number of devices. This can create a large number of parameters to read from a CPE device with every periodic inform and save to database.

For example:

InternetGatewayDevice.Services.VoiceService.*.VoiceProfile.*.Enable
InternetGatewayDevice.LANDevice.1.WLANConfiguration.*.WEPKey.*.WEPKey
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.WEPKey.1.WEPKey
InternetGatewayDevice.LANDevice.*.WLANConfiguration.*.Status
InternetGatewayDevice.LANDevice.1.WLANConfiguration.*.Status

For example for InternetGatewayDevice.Services.VoiceService.*.VoiceProfile.*.Enable, based on the configuration in CPE device, the parameters resulted could be:

InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.Enable
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.2.Enable
InternetGatewayDevice.Services.VoiceService.2.VoiceProfile.1.Enable
InternetGatewayDevice.Services.VoiceService.2.VoiceProfile.2.Enable

Monitored parameters that use wildcards will produce a number of CPE device parameters to read from CPE device. CWMP is optimized so that one parameter will be read only once, if it is referred by different monitor parameters.

Associated Device Groups

Use these settings to view and manage device group associations to the service class.

To do this: Follow these steps:
Add a device group Click Add. Select one or more device groups. In the action bar, click Add.
Delete a device group association Select a device group, and, in the action bar, click Remove.
Save changes Click Confirm.
Top