'; Configuring STUN | Incognito Help
    [0] => Array
            [version] => 4.3
            [language] => en

Rel: acs/tutorials/acs/dita/configuring_stun
URI: acs/tutorials/configuring_stun
=== Tags ===
    [993] => configuring stun

=== Related ===

Configuring STUN

This tutorial provides an example approach for enabling STUN on a device.

The sample parameters use the Device:1 data model.

To enable STUN for devices using the Device:2 data model, change InternetGatewayDevice to Device for the parameter name.

Configure a Device Model for STUN

Set the STUN parameters in the device model of the device for which you will activate STUN.

  1. From the ACS Hub, go to Device Models.

  2. Select the device model for the STUN device, and in the action bar, click View.
    A screen with the device model details appears.
  3. Under Options, click Supported Parameters.

  4. Select all of the following parameters at once.

  5. In the action bar, click Bulk Set.
    The Bulk Set Selected Parameters box appears.
  6. From the Monitoring Level dropdown, choose Relevant and click OK.

  7. In the action bar, click Confirm to save the device model.

About Service Classes

This tutorial requires you to create a service class and then configure values for a set of STUN parameters and configure notifications for a set of Notification parameters.

For this tutorial, use the information in the following tables to create the service class for STUN.

Table 1. STUN Parameters
Name Value Value
InternetGatewayDevice.ManagementServer.STUNEnable true true
InternetGatewayDevice.ManagementServer.STUNMaximum-KeepAlivePeriod Interval (in seconds) Maximum period that STUN Binding Requests MUST be sent by the CPE for maintaining the binding in the Gateway
InternetGatewayDevice.ManagementServer.STUNMinimumKeepAlivePeriod Interval (in seconds) Minimum period that STUN Binding Requests can be sent by the CPE for maintaining the binding in the Gateway
InternetGatewayDevice.ManagementServer.STUNServerAddress IP address of the STUN server If no STUNServerAddress is given, the address of the ACS, determined from the host portion of the ACS URL, MUST be used by the CPE as the STUN server address.
InternetGatewayDevice.ManagementServer.STUNServerPort Internet port on the STUN server  
Table 2. Notification Parameters
Name Notification Description
InternetGatewayDevice.ManagementServer.UDPConnectionRequestAddress Active CPE will set UDPConnectionRequestAddress parameter whenever the current public IP / port changes.
InternetGatewayDevice.ManagementServer.NATDetected Active When STUN is enabled, NATDetected parameter indicates whether or not the CPE has detected address and/or port mapping in use. When STUNEnable is false, this value MUST be false.

Create a Service Class for STUN

  1. From the ACS Hub, go to Service Classes.

  2. In the action bar, click Create.
  3. Type a name for the service class. Optionally, type a description and a unique priority number.
    Note: If you do not specify a priority, a default (unique) priority is automatically assigned to the service class.
  4. In the action bar, click Save.

    A screen with the service class details appears.

  5. Click Add Parameters.

    The Associated Parameters screen appears.

  6. In the action bar, click Add.
    The Select Parameters screen appears.
  7. Select the STUN parameters and Notification parameters specified for this tutorial.

    To filter attributes in the list, click the search symbol (), type part or all of an parameter string in the query field, and press Enter. For example, use the string “stun” to filter for STUN parameters.

  8. In the action bar, click Add.

    The Associated Parameters screen appears and displays the parameters you added.

  9. For each STUN parameter, type the parameter value specified for this tutorial. (Leave Notification and Access List at default).

    To enter parameter values, first choose “Not Set” from the Value dropdown, then erase “Not Set” and type a value.

  10. For each Notification parameter, choose Active from the Notification dropdown. (Leave Value and Access List at default).
  11. In the action bar, click Confirm to save the parameter settings.

When the above parameters are set, the device contacts the specified STUN server and updates UDPConnectionRequestAddress and NATDetected according to the standard. The device then notifies ACS that these parameters have been updated. ACS is now able to send a UDP connection request to the device using the value specified in the UDPConnectionRequestAddress (IP of modem and port number that has been negotiated for address translation).

The following parameters are cached in the service to minimize database access for connection requests when STUN is enabled on the device:
  • InternetGatewayDevice.ManagementServer.UDPConnectionRequestAddress
  • InternetGatewayDevice.ManagementServer.NATDetected
  • InternetGatewayDevice.ManagementServer.STUNEnable
Note: You can, optionally, configure the STUNUsername or STUNPassword that the CPE can use for message integrity or authenticating during STUN Binding Requests. For more information, refer to TR-111 and annex G in TR-069 standard, Amendment 2.