User Guide for Cisco Access Registrar 5.1
Chapter 3 Using the Graphical User Interface
Downloads: This chapterpdf (PDF - 0.98MB) The complete bookPDF (PDF - 7.58MB) | Feedback

Using the Graphical User Interface

Table Of Contents

Using the Graphical User Interface

Launching the GUI

Disabling HTTP

Disabling HTTPS

Login Page

Logging In

Logging Out

Common Methodologies

Filtering Records

Deleting Records

Setting Record Limits per Page

Common Navigations

Relocating Records

Dashboard

Sessions

Configuring Cisco Access Registrar

RADIUS

Profiles

Adding Profile Details

Editing Profile Details

UserGroups

Adding UserGroup Details

Editing UserGroup Details

UserList

Adding UserList Details

Editing UserList Details

Users

Adding User Details

Editing User Details

Scripts

Adding Script Details

Editing Script Details

Policies

Adding Policy Details

Editing Policy Details

Services

Simple Services

ServiceWithRS

PEAP Service

EAP Service

Diameter Service

Adding Diameter Service Details

Editing Diameter Service Details

Replication

Adding Replication Details

Editing Replication Member Details

RADIUS Dictionary

Adding Radius Dictionary Details

Editing Radius Dictionary Details

Vendor Dictionary

Adding Vendor Dictionary Details

Editing Vendor Dictionary Details

Vendor Attributes

Adding Vendor Attributes

Editing Vendor Attributes

Vendors

Adding Vendor Details

Editing Vendor Details

Translations

Adding Translation Details

Editing Translation Details

Translation Groups

Adding Translation Group Details

Editing Translation Group Details

DIAMETER

General

SessionManagement

Applications

Commands

Advanced

Default

BackingStore/ServerParam

RemoteSessionServer

SNMP

DDNS

ODBCDataSources

Log

Ports

Interfaces

Attribute Groups

Rules

Setting Rules

Editing Rules

Session Managers

Adding Session Manager Details

Editing Session Manager Details

Resource Manager

Adding Resource Manager Details

Editing Resource Manager Details

Network Resources

Clients

Adding Client Details

Editing Client Details

Remote Servers

LDAP

LDAP Accounting

Domain Authentication

ODBC/OCI

ODBC/OCI-Accounting

Others

Administration

Administrators

Adding Administrator Details

Editing Administrator Details

Statistics

Diameter Statistics

Backup and Restore

License Upload

Read-Only GUI


Using the Graphical User Interface


Revised: August 11, 2011, OL-25652-01

Cisco Access Registrar (Cisco AR) is a Remote Authentication Dial-In User Service (RADIUS) server that enables multiple dial-in Network Access Server (NAS) devices to share a common authentication, authorization, and accounting database.

This chapter describes how to use the standalone graphical user interface (GUI) of Cisco AR to:

Configure Cisco Access Registrar

Manage Network Resources managed by Cisco AR

Administer Cisco AR related activities

The following topics help you to work with and understand the Cisco AR GUI:

Launching the GUI

Common Methodologies

Dashboard

Configuring Cisco Access Registrar

Network Resources

Administration

Read-Only GUI

Launching the GUI

Cisco AR requires you to use Microsoft Internet Explorer 6.0 SP1 (Windows 2000 and Windows XP). You start the GUI by pointing your browser to the Cisco AR server and port 8080, as in the following:

http://ar_server_name:8080

To start a secure socket layer (SSL) connection, use https to connect to the Cisco AR server and port 8443, as in the following:

https://ar_servr_name:8443

By default, both HTTP and HTTPS are enabled. The following sections describe how to disable HTTP and HTTPS:

Disabling HTTP

Disabling HTTPS


Note For proper function of AR 5.1 GUI, the DNS name resolution for the server's hostname should be defined precisely.


Disabling HTTP

To disable HTTP access, you must edit the server.xml file in the /cisco-ar/apache-tomcat-5.5.27/conf directory. You must have root privileges to edit this file.

Use a text editor such as vi to open the server.xml file, and comment out lines 96-99. Use the <!-- character sequence to begin a comment. Use the --> character sequence to end a comment.

The following are lines 93-99 of the server.xml file:

<!-- Define a non-SSL HTTP/1.1 Connector on port 8080 -->
    <!-- CHANGE MADE: Note: to disable HTTP, comment out this Connector -->
<Connector port="8080" maxHttpHeaderSize="8192"
               maxThreads="150 minSpare/Threads="25" maxSpareThreads="75"
               enableLookups="false" redirectPort="8443" acceptCount="100"
               connectionTimeout="20000" disableUploadTimeout="true" />
 
   

The following example shows these lines with beginning and ending comment sequences to disable HTTP:

<!-- Define a non-SSL HTTP/1.1 Connector on port 8080 -->
    <!-- CHANGE MADE: Note: to disable HTTP, comment out this Connector -->
<!-- 
<Connector className="org.apache.catalina.connector.http.HttpConnector"
               port="8080" minProcessors="5" maxProcessors="75"
               enableLookups="true" redirectPort="8443"
               acceptCount="10" debug="0" connectionTimeout="60000"/>
-->
 
   

After you modify the server.xml file, you must restart the Cisco AR server for the changes to take effect. Use the following command line to restart the server:

/opt/CSCOar/bin/arserver  restart

Disabling HTTPS

To disable HTTPS access, you must edit the server.xml file in the /cisco-ar/apache-tomcat-5.5.27/conf directory. You must have root privileges to edit this file.

Use a text editor such as vi to open the server.xml file, and comment out lines 116-121. Use the <!-- character sequence to begin a comment. Use the --> character sequence to end a comment.

The following are lines 111-121 of the server.xml file:

<!-- Define an SSL HTTP/1.1 Connector on port 8443 -->
    <!-- CHANGE MADE: enabled HTTPS.
        Note: to disable HTTPS, comment out this Connector -->
    <Connector port="8443" maxHttpHeaderSize="8192"
               maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
               enableLookups="true" disableUploadTimeout="true"
               acceptCount="100" scheme="https" secure="true"
               clientAuth="false"
               keystoreFile="/cisco-ar/certs/tomcat/server-cert.p12"
               keystorePass="cisco" keystoreType="PKCS12" sslProtocol="TLS" />
    </Connector>
 
   

The following example shows these lines with beginning and ending comment sequences to disable HTTPS.

<!-- Define an SSL HTTP/1.1 Connector on port 8443 -->
    <!-- CHANGE MADE: enabled HTTPS.
        Note: to disable HTTPS, comment out this Connector -->
<!-- 
<Connector className="org.apache.catalina.connector.http.HttpConnector"
               port="8443" minProcessors="5" maxProcessors="75"
               enableLookups="true"
               acceptCount="10" debug="0" scheme="https" secure="true">
      <Factory className="org.apache.catalina.net.SSLServerSocketFactory"
               keystoreFile="/cisco-ar/certs/tomcat/server-cert.p12"
               keystorePass="cisco" keystoreType="PKCS12"
               clientAuth="false" protocol="TLS"/>
    </Connector>
-->
 
   

After you modify the server.xml file, you must restart the Cisco AR server for the changes to take effect. Use the following command line to restart the server:

/opt/CSCOar/bin/arserver  restart

Login Page

The login page has fields for a username and password. This page displays when you first attempt to log in to the system, if a session times out, or after you log out of the system.

Logging In

Only users who are configured as administrators can log into the Cisco AR server. To log into the Cisco AR GUI, enter a username and password for a configured administrator in the fields provided, then click Login.


Note After installation of Cisco AR server, when you log into the application for the first time, the application redirects to the change password page.


Refreshing using the GUI Interface

To stop the server (when it is running), and then immediately start the server, click the reload link.

Restarting the GUI Interface

To restart the Cisco AR server using GUI, click the Restart link.


Note If aregcmd interface is active, then it needs to be closed for restarting the Cisco AR server.


Logging Out

To log out of the Cisco AR GUI, click the Logout in the upper right portion of the Cisco AR GUI window.

Common Methodologies

This section explains the operations that are common across the GUI interface of Cisco AR. The functions explained in this section are referred throughout to this help system.

This section describes the following:

Filtering Records

Deleting Records

Setting Record Limits per Page

Common Navigations

Relocating Records

Filtering Records

To locate a record, enter the known details of the record in the text area preceding the Go button. Click the Go button; the records matching the search criteria will be displayed below in the predefined column format. To clear the performed filter, click the Clear Filter button.

Deleting Records

Select the record to be deleted from the list displayed by checking the check box relevant to it. Click the Delete button; a success message is displayed on deletion of the selected record. A record can be located using the filter option. See Filtering Records for more details.

Setting Record Limits per Page

To set the numbers of records to be displayed per page, select the record limit from the list available and click the Go button. The available denominations are 10, 25, 50, 100, and All.

Common Navigations

On existence of more records that cannot be accommodated in a page, the records are displayed in multiple pages. Table 3-1 describes the icons used for page navigation.

.

Table 3-1 Page Navigation Icons 

Icons
Description

To view the next page

To return back to previous page

To view the last page

To return to the first page


Relocating Records

Table 3-2 describes the icons used for relocating records.

Table 3-2 Icons for Relocating Records 

Icons
Description

To move a record from the Available List to the Selected List

To move a record from the Selected List to the Available List

To move all the records from the Available List to the Selected List

To move all the records from the Selected List to the Available List

To move the selected record one step above

To move the selected record one step below

To move the selected record to the first position

To move the selected record to the last position


Dashboard

The dashboard of the Cisco AR GUI shows you the overview on the status on the server and user session details. It consists of the three tabs: Server Status, User Sessions, and System Information.

The Server Status tab provides details with respect to AAA Server status, the Health status of the AAA Server, and product. In AAA Server status, the AAA Process, Process ID and status are displayed. In health status, the status of the AAA Server with respect to the performance condition is displayed. The Product Details section displays version, build information and license of the Cisco AR.

The User Sessions tab consists of three graphs.

Number of Sessions versus Duration in Weeks

Number of Sessions versus Duration in Days

Time(mins) versus Username

The Number of Sessions vs Duration in Weeks report provides the session details with respect to the number of weeks for which it is queried. The Number of Sessions vs Duration in Days report provides the session details with respect to the number of days for which it is queried. The Time(mins) vs Username report provides the accumulated time with respect to the selected username. This report can also be viewed in the form of chart and grid. Click the relevant icons below the graph to view the details in the respective formats.

The System Information tab consists of two graphs:

Disk Availability for AR Directory

CPU Utilisation

The Disk Availability for AR Directory report provides the details of the available disk space and used disk space in the AR directory. When you hover the mouse on the pie chart, the details of the disk space are displayed. The CPU Utilisation report provides the utilization of the CPU for a specific time. The CPU usage is represented in kilobits per seconds.

Sessions

The Sessions feature of the dashboard helps you in viewing the records based on session id.

To view sessions details, choose Dashboard > Sessions. The Sessions page appears. The session id can be located using the filter option. See Filtering Records for more details. Select the required session id to view the details. To release the selected session details, click the Release button. Click the Release All button to release all the records from the list. To send the CoA packet to the client device, click the Send CoA packet. Click the Send PoD button to send the disconnect packet to the NAS to clear sessions and an Accounting-Stop notification to the client listed in the session record. To query all the sessions in the server, click the Query All Sessions button.

Configuring Cisco Access Registrar

Cisco AR's operation and configuration are based on a set of objects. On configuring the Cisco AR major components, the server objects can be created. These objects include the following:

RADIUS— the root of the configuration hierarchy

Profiles—contains individual Profiles

UserGroups—contains individual UserGroups

UserList—contains individual UserLists which in turn contain users

Users—contains individual authentication or authorization details of a user

Scripts—contains individual Scripts

Clients—contains individual Clients

Policies—contains a set of rules applied to an Access-Request

Services—contains individual Services

Replication—maintains identical configurations on multiple machines simultaneously

RADIUS Dictionary—passes information between a script and the RADIUS server, or between scripts running on a single packet

Vendor Dictionary—allows to maintain the attributes of the vendor with respect to vendor id, vendor type and the attributes required to support the major NAS

Vendor Attributes—communicates prepaid user balance information from the Cisco AR server to the AAA client, and actual usage, either interim or total, between the NAS and the Cisco AR server

Vendors—contains individual Vendors

Translations—adds new attributes to a packet or change an existing attribute from one value to another.

Translation Groups—add translation groups for different user groups

Session Managers—contains individual Session Managers

Resource Manager—contains individual Resource Managers

Remote Servers—contains individual Remote Servers

DIAMETER—contains SessionManagement, Applications, and Commands

Advanced—contains Ports, Interfaces, Reply Messages, and the Attribute dictionary

Rules—allows to set rules for service selection

RADIUS

The Radius object is the root of the hierarchy. For each installation of the Cisco AR server, there is one instance of the Radius object. You reach all other objects in the hierarchy from the Radius.

To set or change the Radius properties, choose Configuration > Radius. The Radius Properties page appears.

Table 3-3 lists and describes the fields in the Radius Properties page.


Note Fields which are represented with the term "required" in the windows of the Cisco AR GUI, denote mandatory input.


Table 3-3 Radius Properties 

Fields
Description

Name

Required; must be unique in the list of servers in the cluster.

Version

Required; the currently installed version of Cisco AR.

Description

Optional; description of the server.

DefaultSessionManager

Optional; Cisco AR uses this property if none of the incoming scripts sets the environment dictionary variable Session-Manager.

IncomingScript

Optional; if there is a script, it is the first script Cisco AR runs when it receives a request from any client and/or for any service.

OutgoingScript

Optional; if there is a script, it is the last script Cisco AR runs before it sends a response to any client.

DefaultAuthenticationService

Optional; Cisco AR uses this property when none of the incoming scripts sets the environment dictionary variable Authentication-Service.

DefaultAuthorizationService

Optional; Cisco AR uses this property when none of the incoming scripts sets the environment dictionary variable Authorization-Service.

DefaultAccountingService

Optional; Cisco AR uses this property when none of the incoming scripts sets the environment dictionary variable Accounting-Service.

DefaultSessionService

Optional; Cisco AR uses this property when none of the incoming scripts sets the environment dictionary variable Session-Service.


Click the Save button to save the changes made to the Radius properties.

Profiles

You use Profiles to group RADIUS attributes that belong together, such as attributes that are appropriate for a particular class of PPP or Telnet user. You can reference profiles by name from either the UserGroup or the User properties. Thus, if the specifications of a particular profile change, you can make the change in a single place and have it propagated throughout your user community.

Although you can use UserGroups or Profiles in a similar manner, choosing whether to use one rather than the other depends on your site. When you require some choice in determining how to authorize or authenticate a user session, then creating specific profiles, and creating a group that uses a script to choose among them is more flexible.

In such a situation, you might create a default group, and then write a script that selects the appropriate profile based on the specific request. The benefit to this technique is each user can have a single entry, and use the appropriate profile depending on the way they log in.

Use the Profiles page for the following:

Filtering Records

Adding Profile Details

Editing Profile Details

Deleting Records

Adding Profile Details

To add new profile details, choose Configuration > Profiles. The Profiles page appears.

Click the Add button to add new profile details. The Add Profiles page appears.

Table 3-4 lists and describes the fields in the Add Profiles page.

Table 3-4 Profile Properties 

Fields
Description

Name

Required; must be unique in the Profiles list.

Description

Optional; description of the profile.

RADIUS

Optional; set Radius, if the attribute and value needs to be defined for Radius.

VENDOR

Optional; set Vendor, if the attribute and value needs to be defined for Vendor.

Attribute Name

Optional; based on the Attribute Type selected, the attribute name is automated. Set the relevant name for the attribute type selected.

Value Attribute

Optional; set the value for the selected attribute. Click the Add button to save the details and list it in Radius and Value list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Click the Submit button to save the specified details in the Add Profiles page. To return to the Profiles page without saving the details, click the Cancel button. On successful creation of the profiles, the Profiles page is displayed else a respective error message is displayed.

Editing Profile Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit a profile, check the appropriate check box and click the Edit button. The Edit Profiles page appears. To modify the profile's attributes, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Profiles page. If the modification is not successful, Cisco AR displays an error message.

UserGroups

The UserGroups objects allow you to maintain common authentication and authorization attributes in one location, and then have many users reference them. By having a central location for attributes, you can make modifications in one place instead of having to make individual changes throughout your user community.

For example, you can use several UserGroups to separate users by the services they use, such as a group specifying PPP and another for Telnet.

Use the User Groups page for the following:

Filtering Records

Adding UserGroup Details

Editing UserGroup Details

Deleting Records

Adding UserGroup Details

To add new user group details, choose Configuration > UserGroups. The User Groups page appears.

Click the Add button to add new user group details. The Add User Groups page appears.

Table 3-5 lists and describes the fields in the Add User Groups page.

Table 3-5 UserGroups Properties 

Fields
Description

General Properties tab

Name

Required; must be unique in the UserGroup list.

Description

Optional; description of the group.

BaseProfile

Optional; when you set this to the name of a profile, Cisco AR adds the properties in the Profile to the response dictionary as part of the authorization.

AuthenticationScript

Optional; when you set this property to the name of a script, you can use the Script to perform additional authentication checks to determine whether to accept or reject the user.

AuthorizationScript

Optional; when you set this property to the name of a script, you can use the script to add, delete, or modify the attributes of the Response dictionary.

Attribute List tab

RADIUS

Optional; set Radius, if the attribute and value needs to be defined for Radius.

VENDOR

Optional; set Vendor, if the attribute and value needs to be defined for Vendor.

Attribute Name

Optional; based on the Attribute Type selected, the attribute name is automated. Set the relevant name for the attribute type selected.

Attribute Value

Optional; set the value for the selected attribute. Click the Add button to save the details and list it in Name and Value list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

CheckItems List tab

RADIUS

Optional; set Radius, if the attribute and value needs to be defined for Radius.

VENDOR

Optional; set Vendor, if the attribute and value needs to be defined for Vendor.

Attribute Name

Optional; based on the Attribute Type selected, the attribute name is automated. Set the relevant name for the attribute type selected.

Attribute Value

Optional; set the value for the selected attribute. Click the Add button to save the details and list it in Check Name and Check Value list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Click the Submit button to save the specified details in the Add User Groups page. To return to the User Groups page without saving the details, click the Cancel button. On successful creation of the user groups, the User Groups page is displayed else a respective error message is displayed.

Editing UserGroup Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the user group details, check the appropriate check box and click the Edit button. The Edit UserGroups page appears. To modify the attributes of user group, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the UserGroups page. If the modification is not successful, Cisco AR displays an error message.

UserList

The UserLists object contains all of the individual UserLists, which in turn, contain the specific users stored within Cisco AR. Cisco AR references each specific UserList by name from a Service whose type is set to local. When Cisco AR receives a request, it directs it to a Service. When the Service has its type property set to local, the Service looks up the user's entry in the specific UserList and authenticates and/or authorizes the user against that entry.

You can have more than one UserList in the UserLists object. Therefore, use the UserLists object to divide your user community by organization. For example, you might have separate UserLists objects for Company A and B, or you might have separate UserLists objects for different departments within a company.

Using separate UserLists objects allows you to have the same name in different lists. For example, if your company has three people named Bob and they work in different departments, you could create a UserList for each department, and each Bob could use his own name. Using UserLists lets you avoid the problem of Bob1, Bob2, and so on.

If you have more than one UserList, Cisco AR can run a script in response to requests. The script chooses the Service, and the Service specifies the actual UserList which contains the user. The alternative is dynamic properties.

Use the User List page for the following:

Filtering Records

Adding UserList Details

Editing UserList Details

Deleting Records

Adding UserList Details

To add new user list details, choose Configuration > UserList. The User List page appears.

Click the Add button to add new user list details. The Add User List page appears. Table 3-6 lists and describes the fields in the Add User List page.

Table 3-6 User List Properties 

Fields
Description

Name

Required; must be unique.

Description

Optional; description of the user.


Click the Submit button to save the specified details in the Add User List page. After adding a new user list, you can add users to the user list. See Adding User Details for details. To return to the User List page without saving the details, click the Cancel button. On successful creation of the user list, the User List page is displayed else a respective error message is displayed.

Editing UserList Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit a user list, check the appropriate check box and click the Edit button. The Edit User List page appears. To modify user attributes, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the User List page. If the modification is not successful, Cisco AR displays an error message.

Users

The user objects are created to hold the necessary details to authenticate or authorize a user. These users form the component of User Lists, where their details are stored with in Cisco AR. The users in local Userlist can have multiple profiles.


Note Usernames might not include the forward slash (/) character. If the Cisco AR server receives an access request packet with a Username attribute containing a forward slash character and the Cisco AR server uses an internal UserList to look up users, the server produces an error (AX_EINVAL) and might fail. If usernames require a forward slash, use a script to translate the slash to an acceptable, unused character.


Use the Users page for the following:

Filtering Records

Adding User Details

Editing User Details

Deleting Records

Adding User Details

To add new user details, choose Configuration > UserList. The User List page appears. Click the user list name link. The Users page appears. Click the Add button to add new user details. The Add Users page appears. Table 3-7 lists and describes the fields in the Add Users page.

Table 3-7 Users Properties 

Fields
Description

General Properties tab

Name

Required; must be unique.

Enabled

Required; must be checked to allow user access. If Enabled is not checked, user is denied access.

Allow Null Pwd

During authentication, if the Allow NULL Password environment variable is set to TRUE, user authentication is bypassed. By default, the Allow NULL Password environment variable is not set.

UserGroup

Use the drop-down list to select a UserGroup and use the properties specified in the UserGroup to authenticate and/or authorize the user. The default is none.

Password

Required; length must be between 0-253 characters.

Base Profile

Use the drop-down list to select a Profile. If the service-type is not equal to Authenticate Only, Cisco AR adds the properties in the Profile to the Response dictionary as part of the authorization. This field is optional for the CLI, but required for the GUI. Use the menu to select a profile other than the default None.

Confirm Password

Required; must match password.

User Defined

Optional; you can use this property to store notational information which you can then use to filter the UserList. This property also sets the environment variable for UserDefined.

AuthenticationScript

Use the drop-down list to select the name of a script to perform additional authentication checks to determine whether to accept or reject the user. This field is optional for the CLI, but required for the GUI. Use the menu to select an AuthenticationScript other than the default None.

AuthorizationScript

Use the drop-down list to select the name of a script to add, delete, or modify the attributes of the Response dictionary. This field is optional for the CLI, but required for the GUI. Use the menu to select an AuthorizationScript other than the default None.

Description

Optional; description of the user.

Attribute List tab

RADIUS

Optional; set Radius, if the attribute and value needs to be defined for Radius.

VENDOR

Optional; set Vendor, if the attribute and value needs to be defined for Vendor.

Attribute Name

Optional; based on the Attribute Type selected, the attribute name is automated. Set the relevant name for the attribute type selected.

Attribute Value

Optional; set the value for the selected attribute. Click the Add button to save the details and list it in Name and Value list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

CheckItems List tab

RADIUS

Optional; set Radius, if the attribute and value needs to be defined for Radius.

VENDOR

Optional; set Vendor, if the attribute and value needs to be defined for Vendor.

Attribute Name

Optional; based on the Attribute Type selected, the attribute name is automated. Set the relevant name for the attribute type selected.

Attribute Value

Optional; set the value for the selected attribute. Click the Add button to save the details and list it in Check Name and Check Value list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Click the Submit button to save the specified details in the Add Users page. To return to the Users page without saving the details, click the Cancel button. On successful creation of the user details, the Users page is displayed else a respective error message is displayed.

Editing User Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit a user list, check the appropriate check box and click the Edit button. The Edit Users page appears. To modify an attributes of user, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Users page. If the modification is not successful, Cisco AR displays an error message.

Scripts

The Script objects define the function Cisco AR invokes whenever the Script is referenced by name from other objects in the configuration.

You can write three types of scripts:

REX (RADIUS EXtension) scripts are written in C or C++, and thus are compiled functions that reside in shared libraries

Tcl scripts are written in Tcl, and are interpreted functions defined in source files.

Java scripts

For more information about scripts, see Chapter 10, "Using Extension Points." of the User Guide for Cisco Access Registrar, 5.1.

Use the Scripts page for the following:

Filtering Records

Adding Script Details

Editing Script Details

Deleting Records

Adding Script Details

To add new script details, choose Configuration > Scripts. The Scripts page appears.

Click the Add button to add new script details. The Add Scripts page appears. Table 3-8 lists and describes the fields in the Add Scripts page.

Table 3-8 Script Object Properties 

Fields
Description

Script Name

Required; must be unique in the Scripts list.

Language

Required; specify either REX, Tcl, or Java.

Description

Optional; description of the script.

File/Class Name

Required; specifies either a relative or absolute path. When you specify a relative path, the path must be relative to the $INSTALL/scripts/radius/$Language directory. When you specify an absolute path, the server must be able to reach it.

For Java language scripts, the name of the class that implements the extension interface; the .class file should be placed in /cisco-ar/scripts/radius/java

EntryPoint

Required; when not set, Cisco AR uses the value specified in the Name property.

InitEntryPoint

Optional; if set, it must be the name of the global symbol Cisco AR should call when it initializes the shared library at system start up, and just before it unloads the shared library.

InitEntryPointArg

Optional; when set, it provides the arguments to be passed to the InitEntryPoint in the environmental variable Arguments.


The InitEntryPoint properties allow you to perform initialization before processing and then cleanup before stopping the server. For example, when Cisco AR unloads the script (when it stops the RADIUS server) it calls the InitEntryPoint again to allow it to perform any clean-up operations as a result of its initialization. One use of the function might be to allow the script to close an open Accounting log file before stopping the RADIUS server.


Note When you use a Cisco AR file service, Cisco AR automatically closes any opened files. However, if you write scripts that manipulate files, you are responsible for closing them.



Note If you have more than one extension point script (defined under /Radius/Scripts) using the same Java class, only one instance of the class is created and used for all the extension point scripts.


Click the Submit button to save the specified details in the Add Scripts page. To return to the Scripts page without saving the details, click the Cancel button. On successful creation of the scripts, the Scripts page is displayed else a respective error message is displayed.

Editing Script Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit script details, check the appropriate check box and click the Edit button. The Edit Scripts page appears. To modify the attributes of script, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Scripts page. If the modification is not successful, Cisco AR displays an error message.

Policies

A Policy is a set of rules applied to an Access-Request.

Use the Policies page for the following:

Filtering Records

Adding Policy Details

Editing Profile Details

Deleting Records

Adding Policy Details

To add new policy details, choose Configuration > Policies. The Policies page appears.

Click the Add button to add new policy details. The Add Policies page appears. Table 3-9 lists and describes the fields in the Add Policies page.

Table 3-9 Policies Properties 

Fields
Description

Name

Required; must be unique in the Policies list

Description

Optional; description of the Policy

Rules/Policies

Required; set the rules/polices to be grouped.

Operators

Required; set the operators to be grouped along with selected rules/policies. The selected rules and operators will be grouped and listed in the Grouping Box. To delete the available groups, select the relevant group from the Grouping list and click the Delete button below.


Click the Submit button to save the specified details in the Add Policies page. To return to the Policies page without saving the details, click the Cancel button. On successful creation of the policies, the Policies page is displayed else a respective error message is displayed.

Editing Policy Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit a policy, check the appropriate check box and click the Edit button. The Edit Policies page appears. To modify the attributes of policy, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Policies page. If the modification is not successful, Cisco AR displays an error message.

Services

Cisco AR supports authentication, authorization, and accounting (AAA) services. In addition to the variety of built-in AAA services (specified in the Type property), Cisco AR also enables you to add new AAA services through custom shared libraries.

This section lists the types of services available in Cisco AR with their required and optional properties. The service you specify determines what additional information you must provide. The various types of services are:

Simple Services

ServiceWithRS

PEAP Service

EAP Service

Diameter Service

Simple Services

Cisco AR provides the following simple services:

Rex

File

Group

Local

Java

WiMAX

Radius Query

Rex

Select rex service when a custom service needs to be created and a script for authentication, authorization, or accounting has to be used.

File

Select File type when local accounting is to be performed using a specific file. The files under the configuration will be saved in the configured name when the server is invoked even if the service is not being invoked by any request packets.

Cisco AR flushes the accounting record to disk before it acknowledges the request packets. Based on the specified maximum file size and age, it closes the accounting file, moves it to a new name, and reopens the file as a new file. The file names are based on its creation and modification dates.

Group

A group service contains a list of references to other services and specifies whether the responses from each of the services should be handled as a logical AND or OR function, which is specified in the Result-Rule attribute of Group Services. The default value is AND.

When the Result-Rule attribute is set to AND or OR, each referenced service is accessed sequentially, and the Group Service waits for a response from the first referenced service before moving on to the next service (if necessary).

The ResultRule settings parallel-and and parallel-or are similar to the AND and OR settings except that they ask each referenced service to process the request simultaneously instead of asking each referenced server sequentially, thereby saving processing time.

Local

Select local services when authentication and authorization needs to be performed by Cisco AR server using a specific UserList.

Java

Select Java service type when a custom service needs to be created and to use an extension point script to provide the service's functionality and handle both RADIUS and TACACS requests for authentication, authorization, or accounting.

WiMAX

Cisco AR uses the Extensible Authentication Protocol (EAP) to enable the WiMAX feature. It captures the IP attributes and Mobility Keys that are generated during network access authentication.

Radius Query

Select this service type to query cached data through Radius Packets. It contains the list of session managers to be queried from and a list of (cached) attributes to be returned in the Access-Accept packet in response to a Radius Query request. It is initiated through an extension point script or through the Rule and Policy Engine by setting it to a new environment variable named Query-Service.

Use the Simple Services List page for the following:

Filtering Records

Adding Simple Service Details

Editing Simple Service Details

Deleting Records

Adding Simple Service Details

To add new simple service details, choose Configuration > Services > Simple. The Simple Services List page appears.

Click the Add button to add new simple service details. The Add Simple Services List page appears. Table 3-10 lists and describes the fields in the Add Simple Services List page. The fields listed below are the entire list of all the available types. The fields are displayed based on the type selected.

Table 3-10 Simple Service Properties 

Fields
Description

Service Name

Required; must be unique in the Services list.

Incoming Script

Name of script to run when the service starts.

Type

Required, must set it to a valid Cisco AR service.

Outgoing Script

Name of script to run when the service ends.

Description

Optional; description of the service.

OutageScript

Optional; if you set this property to the name of a script, Cisco AR runs it when an outage occurs. This property allows you to create a script that notifies you when the RADIUS server detects a failure.

OutagePolicy

Required; the default is RejectAll. This property defines how Cisco AR handles requests if all servers listed in the RemoteServers properties are unavailable (that is, all remote RADIUS servers are not available). You must set it to one of the following: AcceptAll, DropPacket, or RejectAll.

FileName

Required; must be either a relative or an absolute path to the shared library containing the Service. When the pathname is relative, it must be relative to $INSTALL/Scripts/Radius/rex.

EntryPoint

Required; must be set to the function's global symbol.

InitEntryPoint

Required; must be the name of the global symbol Cisco AR should call when it initializes the shared library and just before it unloads the shared library.

A rex service must have an InitEntryPoint even if the service only returns REX_OK.

InitEntryPointArgs

Optional; when set, it provides the arguments to be passed to the InitEntryPoint in the environmental variable Arguments.

FilenamePrefix

Required; a string that specifies where Cisco AR writes the account records. It must be either a relative or absolute path. When you specify a relative path, it must be relative to the $INSTALL/logs directory. When you specify an absolute path, the server must be able to reach it. The default is Accounting.

MaxFileAge

Optional; stored as a string, but is composed of two parts, a number and a units indicator (<n> <units>) in which the unit is one of: H, Hour, Hours, D, Day, Days, W, Week, Weeks. The default is one day.

RolloverSchedule

Indicates the exact time including the day of the month or day of the week, hour and minute to roll over the accounting log file.

MaxFileSize

Optional; stored as a string, but is composed of two parts, a number and a units indicator (<n> <units>) in which the unit is one of: K, kilobyte, or kilobytes, M, megabyte, or megabytes, or G, gigabyte, or gigabytes. The default is ten megabytes.

UseLocalTimeZone

When set to TRUE, indicates the accounting records' TimeStamp is in local time. When set to FALSE, the default, accounting records' TimeStamp is in GMT.

UserService

Required; name of service that can be used to authenticate

SessionManager

Select the required session manager from the available list.

Result Rule

When set to AND (the default), the response from the GroupService is positive if each of the services referenced return a positive result. The response is negative if any of the services reference return a negative result.

When set to OR, the response from the GroupService is positive if any of the services referenced return a positive result. The response is negative if all the referenced services return a negative result.

The settings parallel-AND or parallel-OR are similar to AND and OR settings, except that each referenced service processes requests simultaneously instead of asking each reference service sequentially to save processing time.

InitEntryPoint

Required; must be the name of the global symbol Cisco AR should call when it initializes the shared library and just before it unloads the shared library.

A rex service must have an InitEntryPoint even if the service only returns REX_OK.

GroupServices 

Use the GroupServices subdirectory to specify the subservices in an indexed list to provide specific ordering control of which services to apply first. Each subservice listed must be defined in the Services section of the Radius configuration and cannot be a of type group, eap-leap, or eap-md5.

To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.

UserList

Required; this object contains all of the individual UserLists, which in turn, contain the specific users stored within Cisco AR. Cisco AR references each specific UserList by name from a Service whose type is set to local.

When Cisco AR receives a request, it directs it to a Service. When the Service has its type property set to local, the Service looks up the user's entry in the specific UserList and authenticates and/or authorizes the user against that entry.

Class name

Set to the name of a class that implements the Extension interface.

InitializeArg

Optional; set to a string to be passed to the Initialize method if the class implements the optional ExtensionWithInitialization interface.

HARKKey

Used as the base key to generate random HARKKey for all the HAs that are configured in Cisco AR.

By default, the value is cisco123.You can change this value.

WimaxAuthenticationService

A valid EAP service which can be used for WiMAX authentication. By default, this value is none.

HARKLifeTime

Used as time (in minutes) to regenerate the HARKKeys based on its lifetime.

WimaxSessionManager

Set a valid session manager which has HA and HA Cache as resource managers. By default, this value is none.

WimaxQueryService

Set a valid RADIUS query service which is configured with WiMAX session manager. By default, this value is none.

WimaxPrepaidService

Set a valid prepaid service to carry out the prepaid functionality of WiMAX. Otherwise this value is set to none.

Attribute List tab

Attribute type

Select either RADIUS or VENDOR. If Vendor is selected, specify the vendor type from the drop-down list. Select the attributes from the available list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.

Session Manager tab

Session Manager

Select the required session manager from the available list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.


Click the Submit button to save the specified details in the Add Simple Services List page. To return to the Simple Services List page without saving the details, click the Cancel button. On successful creation of the simple service properties, the Simple Services List page is displayed else a respective error message is displayed.

Editing Simple Service Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the simple service properties, check the appropriate check box and click the Edit button. The Edit Simple Services List page appears. To modify the properties of simple service, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Simple Services List page. If the modification is not successful, Cisco AR displays an error message.

ServiceWithRS

The RemoteServers directory lists one or more remote servers to process access requests. The servers must also be listed in order under /Radius/RemoteServers. The order of the RemoteServers list determines the sequence for directing access requests when MultipleServersPolicy is set to RoundRobin mode. The first server in the list receives all access requests when MultipleServersPolicy is set to Failover mode.

The RemoteServers object can be used to specify the properties of the remote servers to which Services proxy requests. RemoteServers are referenced by name from the RemoteServers list in either the RADIUS, LDAP or TACACS-UDP Services.

Use the ServiceWithRS List page for the following:

Filtering Records

Adding Remote Server Service Details

Editing Remote Server Service Details

Deleting Records

Adding Remote Server Service Details

To add new remote server service details, choose Configuration > Services > ServiceWithRS. The ServiceWithRS List page appears.

Click the Add button to add new remote server service details. The Add ServiceWithRS List page appears. Table 3-11 lists and describes the fields in the Add ServiceWithRS List page.

Table 3-11 Remote Server Service Properties 

Fields
Description

Service Name

Required; name of the remote server service

Incoming Script

Name of script to run when the service starts

Type

Required; Remote service Type must be set to one of the following: domain-auth, ldap, ldap-accounting, odbc-accounting, odbc, oci-accounting, oci, prepaid, radius, or radius-session.

Outgoing Script

Name of script to run when the service ends

Outage Script

Optional; if you set this property to the name of a script, Cisco AR runs it when an outage occurs. This property allows you to create a script that notifies you when the RADIUS server detects a failure.

Outage Policy

Required; the default is RejectAll. This property defines how Cisco AR handles requests if all servers listed in the RemoteServers properties are unavailable (that is, all remote RADIUS servers are not available). You must set it to one of the following: AcceptAll, DropPacket, or RejectAll.

Description (optional)

Optional; description of the remote server service

MultipleServersPolicy

Required; must be set to either Failover or RoundRobin.

When you set it to Failover, Cisco AR directs requests to the first server in the list until it determines the server is offline. At which time, Cisco AR redirects all requests to the next server in the list until it finds a server that is online.

When you set it to RoundRobin, Cisco AR directs each request to the next server in the RemoteServers list to share the resource load across all of the servers listed in the RemoteServers list.

RemoteServers

Select the required remote server from the available list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.


Click the Submit button to save the specified details in the Add ServiceWithRS List page. To return to the ServiceWithRS List page without saving the details, click the Cancel button. On successful creation of the properties, the ServiceWithRS List page is displayed else a respective error message is displayed.

Editing Remote Server Service Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit properties of ServiceWithRS, check the appropriate check box and click the Edit button. The Edit ServiceWithRS List page appears. To modify the properties of ServiceWithRS properties, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the ServiceWithRS List page. If the modification is not successful, Cisco AR displays an error message.

PEAP Service

Protected EAP (PEAP) is an authentication method designed to mitigate several weaknesses of EAP. PEAP leverages Industry standard authentication of the server using certificates TLS (RFC 2246) and creation of a secure session that can then be used to authenticate the client.

The PEAP protocol consists of two phases, an authentication handshake phase and a tunnel phase where another complete EAP authentication exchange takes place protected by the session keys negotiated by phase one. Cisco AR supports the tunneling of other EAP methods within the PEAP phase two exchange.

Cisco AR supports the two major existing variants of PEAP,

PEAP Version 0 (Microsoft PEAP)

PEAP Version 1 (Cisco PEAP)

PEAP Version 0

PEAP Version 0 also called as Microsoft PEAP is described in IETF drafts (draft-kamath-pppext-peapv0-00.txt and draft-josefsson-pppext-eap-tls-eap-02.txt). This version of PEAP uses either EAP-MSChapV2 or EAP-SIM as an authentication method. The testing method used for this version of PEAP is radclient.

PEAP Version 1

PEAP Version 1 also called as Cisco PEAP is described by IETF draft (draft-zhou-pppext-peapv1-00.txt). This version can use either EAP-GTC or EAP-SIM as an authentication method. The testing method used for this version of PEAP is radclient.

Use the PEAP Services List page for the following:

Filtering Records

Adding PEAP Service Details

Editing PEAP Service Details

Deleting Records

Adding PEAP Service Details

To add new PEAP service details, choose Configuration > Services > PEAP. The PEAP Services List page appears.

Click the Add button to add new PEAP service details. The Add PEAP Services List page appears. Table 3-12 lists and describes the fields in the Add PEAP Services List page. The fields listed below are the entire list of all the available types. The fields are displayed based on the type selected.

Table 3-12 PEAP Service Properties 

Fields
Description

Service Name

Required; service name

Incoming Script

Optional; script Cisco AR server runs when it receives a request from a client.

Type

Required; must set it to a valid Cisco AR service.

Outgoing Script

Optional; script Cisco AR server runs before it sends a response to a client.

Maximum Message Size

Indicates the maximum length in bytes that a PEAP or EAP-TLS message can have before it is fragmented.

Server Certificate File

Required; the full pathname of the file containing the server's certificate or certificate chain used during the TLS exchange. The pathname can be optionally prefixed with a special string that indicates the type of encoding used for the certificate. The two valid encoding prefixes are PEM and DER. If an encoding prefix is not present, the file is assumed to be in PEM format.

The following example assumes that the subdirectory pki under /cisco-ar contains the server's certificate file. The file server-cert.pem is assumed to be in PEM format; note that the file extension .pem is not significant.

set ServerCertificateFile PEM:/cisco-ar/pki/server-cert.pem

Private Key Password

The password used to protect the server's private key.

Server RSA Key File

Required; the full pathname of the file containing the server's RSA private key.

CRL Distribution URL

Optional; The URL that Cisco AR should use to retrieve the CRL.You can specify a URL that uses HTTP or LDAP.

The following is an example for an HTTP URL: <http://crl.verisign.com/pca1.1.1.crl>.

The following is an example for an LDAP URL: ldap://209.165.200.225:388/CN=development-CA,CN=acs-westcoast2,CN=CDP,CN=Public Key Services,CN=Services,CN=Configuration,DC=cisco,DC=com

CA Certificate File

The full pathname of the file containing trusted CA certificates used for client verification. The file can contain more than one certificate, but all certificates must be in PEM format. DER encoding is not allowed.

Certificate Verification Mode

Specifies the type of verification used for client certificates. Must be set to one of RequireCertificate, None, or Optional.

RequireCertificate causes the server to request a client certificate and authentication fails if the client refuses to provide one.

None will not request a client certificate.

Optional causes the server to request a client certificate but the client is allowed to refuse to provide one.

CA Certificate Path

The name of a directory containing trusted CA certificates (in PEM format) used for client verification. This parameter is optional, and if it is used there are some special preparations required for the directory it references.

Each certificate file in this directory must contain exactly one certificate in PEM format. The server looks up the certificate files using the MD5 hash value of the certificate's subject name as a key. The directory must therefore also contain a set of symbolic links each of which points to an actual certificate file. The name of each symbolic link is the hash of the subject name of the certificate.

For example, if a certificate file name ca-cert.pem is located in the CACertificatePath directory, and the MD5 hash of the subject name contained in ca-cert.path.pem is 1b96dd93, then a symbolic link named 1b96dd93 must point to the ca-cert.pem file.

If there are subject name collisions such as multiple certificates with the same subject name, each link name must be indexed with a numeric extension as in 1b96dd93.0 and 1b96dd93.1.

Verification Depth

Specifies the maximum length of the certificate chain used for client verification.

Enable Session Cache

Specifies whether TLS session caching (fast reconnect) is enabled or not. Set to True to enable session caching; otherwise set to False.

Tunnel Service

Mandatory; must be the name of an existing EAP-MSCHAPv2 or EAP-SIM service.

Authentication Timeout

Mandatory; specifies time (in seconds) to wait before an authentication request times out; defaults to 120.

Description (optional)

Optional; description of the PEAP service.

Session Timeout

If TLS session caching (fast reconnect) is enabled, SessionTimeout specifies the maximum lifetime of a TLS session. Expired sessions are removed from the cache and will require a subsequent full authentication.

SessionTimeout is specified as a string consisting of pairs of numbers and units, where units might be one of the following: M, Minute, Minutes, H, Hour, Hours, D, Day, Days, W, Week, Weeks, as in the following:

Set SessionTimeout "1 Hour 45 Minutes"

Enable WPS

When set to TRUE, enables Windows Provisioning Service (WPS) and provides two other properties, MasterURL and WPSGuestUserProfile. The default value is FALSE.

Master URL

When using WPS, specifies the URL of the provisioning server which is modified with the appropriate fragment and sent to the client.

WPS Guest User Profile

When using WPS, specifies a profile to be used as a guest user profile; must be a valid profile under /Radius/Profiles.

This profile is used for guests and users whose account has expired. This profile normally contains attributes denoting the VLAN-id of the guest network (which has the provisioning server alone) and might contain IP-Filters that would restrict the access of the guest (to only the provisioning server).


Click the Submit button to save the specified details in the Add PEAP Services List page. To return to the PEAP Services List page without saving the details, click the Cancel button. On successful creation of the PEAP service properties, the PEAP Services List page is displayed else a respective error message is displayed.

Editing PEAP Service Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit properties of PEAP service, check the appropriate check box and click the Edit button. The Edit PEAP Services List page appears. To modify the service properties, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the PEAP Services List page. If the modification is not successful, Cisco AR displays an error message.

EAP Service

Cisco Access Registrar (Cisco AR) supports the Extensible Authentication Protocol (EAP) to provide a common protocol for differing authentication mechanisms. It provides dynamic selection of the authentication mechanism at the time of authentication based on information transmitted in the Access-Request.

Cisco AR 5.1 supports the following EAP authentication methods:

EAP-AKA

EAP-FAST

EAP-GTC

EAP-LEAP

EAP-MD5

EAP-Negotiate

EAP-MSChapV2

EAP-SIM

EAP-Transport Level Security (TLS)

EAP-TTLS

EAP-AKA

Authentication and Key Agreement (AKA) is an EAP mechanism for authentication and session key distribution. It is used in the 3rd generation mobile networks Universal Mobile Telecommunications System (UMTS) and CDMA2000. AKA is based on symmetric keys, and typically runs in a UMTS Subscriber Identity Module (USIM), or a (Removable) User Identity Module ((R) UIM), similar to a smart card. EAP-AKA (Extensible Authentication Protocol Method for UMTS Authentication and Key Agreement) includes optional identity privacy support, optional result indications, and an optional fast reauthentication procedure. The EAP-AKA authentication service is extended to generate a Diameter message Multimedia-Authentication-Request (MAR), with the subscriber identity(IMSI), to the Home Subscriber Server (HSS) when it requires the authentication vectors. The HSS sends a Diameter Mutlimedia-Authentication-Answer (MAA) back containing the number of quintuplets.

EAP-FAST

EAP-FAST is an authentication method which uses the EAP-MSChapV2 method for credential provisioning and EAP-GTC for authentication. Credential provisioning typically occurs only during the client's initial EAP-FAST authentication. Subsequent authentications rely on the provisioned credential and will usually omit the provisioning step.

This authentication protocol is designed to address the performance shortcomings of prior TLS-based EAP methods while retaining features such as identity privacy and support for password-based protocols. The EAP-FAST protocol is described by the IETF draft (draft-cam-winget-eap-fast-00.txt).

EAP-GTC

This method defined in RFC 2284, is used for transmitting a username and password to an authentication server.


Note It should not be used except as an authentication method for PEAP Version 1 because the password is not protected.


EAP-LEAP

The new AAA Cisco-proprietary protocol called Light Extensible Authentication Protocol (LEAP) supported by Cisco AR, is a proprietary Cisco authentication protocol designed for use in IEEE 802.11 wireless local area network (WLAN) environments. Important features of LEAP include:

Mutual authentication between the network infrastructure and the user

Secure derivation of random, user-specific cryptographic session keys

Compatibility with existing and widespread network authentication mechanisms (e.g., RADIUS)


Note Cisco AR supports a subset of EAP to support LEAP. This is not a general implementation of EAP for Cisco AR.


The Cisco-Wireless or LEAP is an EAP authentication mechanism where the user password is hashed based on an MD4 algorithm.

EAP-MD5

This is another EAP authentication exchange. In EAP-MD5 there is a CHAP-like exchange and the password is hashed by a challenge from both client and server to verify the password. On successful verification, the connection proceeds, although the connection is periodically rechallenged (per RFC 1994).

EAP-Negotiate

This is a special service used to select at runtime the EAP service to be used to authenticate the client. It is configured with a list of candidate EAP services that represent the allowable authentication methods in preference order.

EAP-Negotiate is useful when the client population has deployed a mix of different EAP methods that must be simultaneously supported by Cisco AR. EAP-Negotiate solves the problem of distinguishing client requirement by using the method negotiation feature of the EAP protocol.

EAP-MSChapV2

EAP-MSChapv2 encapsulates the MSChapV2 protocol (specified by RFC 2759) and can be used either as an independent authentication mechanism or as an inner method for PEAP Version 0 (recommended). This is based on draft-kamath-pppext-eap-mschapv2-00.txt, an informational IETF draft document.

EAP-SIM

An access point uses the Cisco AR RADIUS server to perform EAP-SIM authentication of mobile clients. Cisco AR must obtain authentication information from the HLR. Cisco AR contacts the MAP gateway that performs the MAP protocol over SS7 to the HLR. The EAP-SIM authentication service is extended to generate a Diameter message Multimedia-Authentication-Request (MAR), with the subscriber identity(IMSI), to the HSS when it requires the authentication vectors. The HSS sends a Diameter Mutlimedia-Authentication-Answer (MAA) back containing the number of triplets.

EAP-Transport Level Security (EAP-TLS)

This is an authentication method (described in RFC 2716) which leverages TLS, described in RFC 2246, to achieve certificate-based authentication of the server and the client (optionally). It provides many of the same benefits as PEAP but differs in the lack of support for legacy authentication methods.

EAP-Transport Level Security (TLS)

This is an authentication method (described in RFC 2716) which leverages TLS, described in RFC 2246, to achieve certificate-based authentication of the server and the client (optionally). It provides many of the same benefits as PEAP but differs in the lack of support for legacy authentication methods.

EAP-TTLS

The Extensible Authentication Protocol Tunneled TLS (EAP-TTLS) is an EAP protocol that extends EAP-TLS. EAP- TTLS extends the authentication negotiation EAP-TLS by using the secure connection established by the TLS handshake to exchange additional information between client and server. It leverages TLS (RFC 2246) to achieve certificate-based authentication of the server (and optionally the client) and creation of a secure session that can then be used to authenticate the client using a legacy mechanism.

EAP-TTLS is a two-phase protocol. Phase 1 conducts a complete TLS session and derives the session keys used in Phase 2 to securely tunnel attributes between the server and the client. The attributes tunneled during Phase 2 can be used to perform additional authentication(s) via a number of different mechanisms.

The authentication mechanisms used during Phase 2 include PAP, CHAP, MS-CHAP, MS-CHAPv2, and EAP. If the mechanism is EAP, then several different EAP methods are possible.

Use the EAP Services List page for the following:

Filtering Records

Adding EAP Service Details

Editing EAP Service Details

Deleting Records

Adding EAP Service Details

To add new EAP service details, choose Configuration > Services > EAP. The EAP Services List page appears.

Click the Add button to add new EAP service details. The Add EAP Services List page appears. Table 3-13 lists and describes the fields in the Add EAP Services List page. The fields listed below are the entire list of all the available types. The fields are displayed based on the type selected.

Table 3-13 EAP Service Properties 

Fields
Description

Service Name

Required; service name

Incoming Script

Optional script Cisco AR server runs when it receives a request from a client.

Type

Required; must set it to a valid Cisco AR service

Outgoing Script

Optional script Cisco AR server runs before it sends a response to a client

Description (optional)

Optional; description of the PEAP service.

Authentication Timeout

Mandatory; specifies time (in seconds) to wait before an authentication request times out; defaults to 120.

UserService

Required; name of service that can be used to authenticate using cleartext passwords.

Service List

List of preconfigured EAP authentication services. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.

Maximum Message Size

Indicates the maximum length in bytes that a PEAP message can have before it is fragmented.

Server Certificate File

The full pathname of the file containing the server's certificate or certificate chain used during the TLS exchange. The pathname can be optionally prefixed with a special string that indicates the type of encoding used for the certificate. The two valid encoding prefixes are PEM and DER. If an encoding prefix is not present, the file is assumed to be in PEM format.

Private Key Password

The password used to protect the server's private key.

Server RSA Key File

The full pathname of the file containing the server's RSA private key. The pathname can be optionally prefixed with a special string that indicates the type of encoding used for the certificate. The two valid encoding prefixes are "PEM" and "DER". If an encoding prefix is not present, the file is assumed to be in PEM format.

The following example assumes that the subdirectory pki under /cisco-ar contains the server's certificate file. The file server-key.pem is assumed to be in PEM format. The file extension .pem is not significant.

set ServerRSAKeyFile PEM:/cisco-ar/pki/server-key.pem

CRL Distribution URL

Optional. Enter the URL that Cisco AR should use to retrieve the CRL.You can specify a URL that uses HTTP or LDAP.

The following is an example for an HTTP URL: <http://crl.verisign.com/pca1.1.1.crl>.

The following is an example for an LDAP URL: ldap://209.165.200.225:388/CN=development-CA,CN=acs-westcoast2,CN=CDP,CN=Public Key Services,CN=Services,CN=Configuration,DC=cisco,DC=com

CA Certificate File

The full pathname of the file containing trusted CA certificates used for client verification. The file can contain more than one certificate, but all certificates must be in PEM format. DER encoding is not allowed.

Certificate Verification Mode

The value is set to optional by default. If set to RequireCertificate, the client certificate will always be verified. If set to optional, client certificate verification happens optionally.

CA Certificate Path

The name of a directory containing trusted CA certificates (in PEM format) used for client verification. This parameter is optional and if it is used there are some special preparations required for the directory it references.

Each certificate file in this directory must contain exactly one certificate in PEM format. The server looks up the certificate files using the MD5 hash value of the certificate's subject name as a key. The directory must therefore also contain a set of symbolic links each of which points to an actual certificate file. The name of each symbolic link is the hash of the subject name of the certificate.

For example, if a certificate file named ca-cert.pem is located in the CACertificatePath directory, and the MD5 hash of the subject name contained in ca-cert.path.pem is 1b96dd93, then a symbolic link named 1b96dd93 must point to ca-cert.pem.

If there are subject name collisions such as multiple certificates with the same subject name, each link name must be indexed with a numeric extension as in 1b96dd93.0 and 1b96dd93.1.

Verification Depth

Specifies the maximum length of the certificate chain used for client verification.

Enable Session Cache

Specifies whether TLS session caching (fast reconnect) is enabled or not. Set to True to enable session caching; otherwise set to False.

Session Timeout

If TLS session caching (fast reconnect) is enabled, SessionTimeout specifies the maximum lifetime of a TLS session. Expired sessions are removed from the cache and will require a subsequent full authentication.

SessionTimeout is specified as a string consisting of pairs of numbers and units, where units might be one of the following: M, Minute, Minutes, H, Hour, Hours, D, Day, Days, W, Week, Weeks, as in the following:

Set SessionTimeout "1 Hour 45 Minutes"

Authentication Service

Specifies the name of the EAP-GTC service used for authentication. The named service must have the UseLabels parameter set to True.

User Prompt

Optional string the client might display to the user; default is Enter password:" Use the set command to change the prompt, as in the following:

set UserPrompt "Admin Password:"

User Labels

Required; must be set to TRUE for EAP-FAST authentication and set to FALSE for PEAP authentication. Set to FALSE by default.

SystemID

Optional; string that identifies the sender of the MSChapV2 challenge message.

IsWindows7Client

Optional; must be set to TRUE for EAP-MSChapV2 authentication. Set to FALSE by default.

Authority Identifier

A string that uniquely identifies the credential (PAC) issuer. The client uses this value to select the correct PAC to use with a particular server from the set of PACs it might have stored locally.

Authority Information

A string that provides a descriptive text for this credential issuer. The value can be displayed to the client for identification purposes and might contain the enterprise or server names.

Credential Life Time

Specifies the maximum lifetime of a Protected Access Credential (PAC). Clients that successfully authenticate with an expired PAC will be reprovisioned with a new PAC.

CredentialLifetime is specified as a string consisting of pairs of numbers and units, where units might be one of the following: M, Minute, Minutes, H, Hour, Hours, D, Day, Days, W, Week, Weeks. Credentials that never expire should be specified as Forever.

Provision Service

Specifies the name of the EAP-MSChapV2 service used for provisioning.

Provision Mode

Specifies the TLS mode used for provisioning. Clients only support the default Anonymous mode.

Always Authenticate

Indicates whether provisioning should always automatically rollover into authentication without relying on a separate session. Most environments, particularly wireless, will perform better when this parameter is set to True, the default value.

HSSLookup

Specifies the type of communication with the HLR/HSS server.

Based on the type selected, the communication happens with the HLR/HSS server using the diameter Wx interface, MAP protocol, or SIGTRAN protocol.

DestinationRealm

Required. Need to configure the Diameter Remote Server for the Realm. The role of the remote server should be Relay.

PreRequestTranslationScript

Optional. Cisco AR server runs before sending the request to the Diameter remote server. The script can modify the Radius packet dictionaries.

PostRequestTranslationScript

Optional. Cisco AR server runs before sending the request to the Diameter remote server. The script can modify the Diameter packet dictionaries.

PreResponseTranslationScript

Optional. Cisco AR server runs after receiving the response from the Diameter remote server. The script can modify the Diameter packet dictionaries.

PostResponseTranslationScript

Optional. Cisco AR server runs after receiving the response from the Diameter remote server. The script can modify the Radius packet dictionaries.

General tab
The details in the tab is displayed based on the eap-sim or eap-aka option you select in the Type field.

MultipleServersPolicy

Required. Must be set to either Failover or RoundRobin.

When set to Failover, Cisco AR directs requests to the first server in the list until it determines the server is offline. At that time, Cisco AR redirects all requests to the next server in the list until it finds a server that is online.

When set to RoundRobin, Cisco AR directs each request to the next server in the RemoteServers list to share the resource load across all of the servers listed in the RemoteServers list.

NumberOfTriplets

Number of triplets (1, 2, or 3) to use for authentication; default is 2.

PseudonymSecret

The secret string that is used as the basis for protecting identities when identity privacy is enabled. This should be at least 16 characters long and have a value that is impossible for an outsider to guess. The default value is secret.

Note It is very important to change PseudonymSecret from its default value to a more secure value when identity privacy is enabled for the first time.

PseudonymRenewtime

Specifies the maximum age a pseudonym can have before it is renewed. When the server receives a valid pseudonym that is older than this, it generates a new pseudonym for that subscriber. The value is specified as a string consisting of pairs of numbers and units, where the units might be of the following: M, Minute, Minutes, H, Hour, Hours, D, Day, Days, W, Week, Weeks. The default value is "24 Hours".

Examples are: "8 Hours", "10 Hours 30 Minutes", "5 D 6 H 10 M"

PseudonymLifetime

Specifies the maximum age a pseudonym can have before it is rejected by the server, forcing the subscriber to authenticate using it's permanent identity. The value is specified as a string consisting of pairs of numbers and units, where the units might be one of the following: M, Minute, Minutes, H, Hour, Hours, D, Day, Days, W, Week, Weeks. It can also be Forever, in which case, pseudonyms do not have a maximum age. The default value is "Forever".

Examples are: "Forever", "3 Days 12 Hours 15 Minutes", "52 Weeks"

ReauthenticationTimeout

Specifies the time in seconds that reauthentication identities are cached by the server. Subscribers that attempt to reauthenticate using identities that are older than this value will be forced to use full authentication instead. The default value is 3600 (one hour).

EnableReauthentication

When True, the fast reauthentication option is enabled. The default value is False.

UseProtectedResults

Enables or disables the use of protected results messages. Results messages indicate the state of the authentication but are cryptographically protected.

ReauthenticationRealm

This information will be supplied later.

MaximumReauthentications

Specifies the maximum number of times a reauthentication identity might be reused before it must be renewed. The default value is 16.

TripletCacheTimeout

Time in seconds an entry remains in the triplet cache. A zero (0) indicates that triplets are not cached. The maximum is 28 days; the default is 0 (no caching).

Authentication Timeout

Time in seconds to wait for authentication to complete. The default is 2 minutes; range is 10 seconds to 10 minutes.

UseSimDemoTriplets

Set to TRUE to enable the use of demo triplets. This must be disabled for release builds.

AlwaysRequestIdentity

When True, enables the server to obtain the subscriber's identity via EAP/SIM messages instead of relying on the EAP messages alone. This might be useful in cases where intermediate software layers can modify the identity field of the EAP-Response/Identity message. The default value is False.

EnableIdentityPrivacy

When True, the identity privacy feature is enabled. The default value is False.

Generate3GPPCompliantPseudonym

The value is set to False by default. If set to TRUE then Cisco AR generates a 23 octet 3GPP compliant pseudonym identity. The Pseudonym username identities are used to protect the privacy of subscriber identities.

SendReAuthIDInAccept

The value is set to False by default. When set to True, Cisco AR sends SN-Fast-ReAuth-UserName (Starent VSA) in access-accept message.

Outage Script

Optional; if you set this property to the name of a script, Cisco AR runs it when an outage occurs. This property allows you to create a script that notifies you when the RADIUS server detects a failure.

Remote Servers tab

Attribute

List of remote RADIUS servers which are map gateways. The remote server type must be set to map-gateway. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.


Click the Submit button to save the specified details in the Add EAP Service List page. To return to the EAP Service List page without saving the details, click the Cancel button. On successful creation of the EAP Service properties, the EAP Service List page is displayed else a respective error message is displayed.

Editing EAP Service Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit properties of EAP service, check the appropriate check box and click the Edit button. The Edit EAP Services List page appears. To modify the service properties, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the EAP Services List page. If the modification is not successful, Cisco AR displays an error message.

Diameter Service

Proxy agents assist in routing Diameter messages using the Diameter routing table. Diameter proxy service works in tandem with the rule policy engine to perform the routing for multiple realms or applications. The following are the multiple peer policies supported by the proxy service:

RoundRobin

FailOver

IMSI Range Based.

Use the Diameter Services List page for the following:

Filtering Records

Adding Diameter Service Details

Editing Diameter Service Details

Deleting Records

Adding Diameter Service Details

To add a new Diameter service details, choose Configuration > Services > Diameter. The Diameter Services List page appears.

Click the Add button to add new Diameter service details. The Add Diameter Services List page appears. Table 3-14 lists and describes the fields in the Add Diameter Services List page. The fields listed below are the entire list of all the available roles. The fields are displayed based on the role selected.

Table 3-14 Diameter Service Properties 

Fields
Description

Name

Required; name of the Diameter server.

Realm

Required; realm of the route. Must be unique for a route table.

Incoming Script

Optional; enabled when role is set to Proxy or Local. When set, must be the name of a known incoming script. Cisco AR runs the IncomingScript before proxying the diameter packet to the remote diameter server.

Outgoing Script

Optional; enabled when role is set to Proxy or Local. When set, must be the name of a known outgoing script. Cisco AR runs the OutgoingScript after it receives the response from the remote Diameter server.

Description

Optional; description of the Diameter server.

Role

Required; specifies the role that the diameter entity will play in resolving messages matching the realm.

The role can be any one of the following:

Relay - Application acting as a Relay Agent.

Redirect - Application acting as a Redirect Agent.

Proxy - Application acting as a Proxy Agent. When the role is set to Proxy, the IncomingScript and OutgoingScript points are enabled.

Local - Application processes the requests locally. When the role is set to Local, the AuthenticationService and AccountingService are enabled.

By default, the Proxy option is selected. However, you can select another option from the drop-down list.

AuthenticationService

Required; used when service is configured to process the diameter requests locally. Set to valid service of type (local/ldap/odbc) to authenticate the user. This field is displayed when you select the role type as `Local' in the Role field.

AccountingService

Required; used when service is configured to process the accounting requests locally. Set to valid accounting service of type(file/odbc-accounting) to write the accounting records. This field is displayed when you select the role type as `Local' in the Role field.

Type

Required; specifies the service type.The service type `Diameter' is automatically displayed in this field.

Peer Definitions tab
This tab is displayed when you select the `Local', `Relay', or `Redirect'option in the Role field.

Name

Required; name of the peer.

Host Name

Required; the hostname or IP address of the peer. The hostname must exist in the client list for the route to be active.

Metric

Required; metric value for the peer entry. The higher the value the lower the preference. The highest value of preference is 0.

VendorSpecific

Required; the default is FALSE. If set to FALSE, the application is ordinary application and user is prompted to enter the ApplicationID. If set to TRUE, the application is a VendorSpecific Application. User is prompted to enter VendorSpecificApplicationID and VendorID.

VendorID

Required; specifies the VendorID for the application.

Example:

DIAMETER 3GPP Cx APPLICATION

VendorSpecificApplicationID 16777216

VendorID 10415

VendorSpecificApplicationID

Required; specifies the integer value for the vendor specific application.

ApplicationID

Required; application used in the route. The application Id should be available in /Advanced/Diameter/Applications.

Applications tab

This tab is displayed when you select the `Proxy' option in the Role field.

Name

Required; name of the application.

Description

The description of the application.

ApplicationID

Required; specifies the unique integer value for the application. It represents the applicationid of the Application used for load balancing the diameter messages.

EnableSticky

Required; default is FALSE. If set to True, the sticky entries for load balancing is enabled and the user is prompted to enter the values for StickySessionKey, StickyCreationCmdList, and StickyDeletionCmdList.

MultiplePeersPolicy

Required; must be set to RoundRobin, FailOver, or IMSIRangeBased. Policy used by the Cisco AR server to load balance the peers.

StickySessionKey

Required; used as the sticky key for mapping the sticky sessions. Set the value to a valid AVP in order to use the sticky key for maintaining diameter sessions. This ensures that Cisco AR maps the request to the same server for all the subsequent messages using the sticky key. For example, set StickyAVP "Session-Id".

When the Cisco AR server receives the CCR-I request, Cisco AR extracts the Session-Id from the request packet, maps the Session to the peer configured in the list, and forwards the request to the chosen peer. Cisco AR chooses the same peer for all the subsequent messages(CCR-Update/CCR-Terminate) with same Session-Id.

StickyCreationCmdList

Required; specifies the command list to create the sticky entries.Specify the list of `||' separated command code, AVP name, and its value to create the sticky sessions.

The following is the StickyCreationCmdList format:

<commandcode1>::<AVPName1=Value1> || <commandcode2<::<AVPName2=Value2>||<commandcode3>

For example, if the sticky session entries need to created based on command code `265'or based on command code `271' with Accounting-Record-Type value as 2, use the format below:

Set StickyCreationCmdList "265||271:: Accounting-Record-Type=2"

StickyDeletionCmdList

Required; specifies the command list to delete the sticky entries.Specify the list of `||' separated command code, AVP name, and its value to delete the sticky sessions.

The following is the StickyDeletionCmdList format:

<commandcode1>::<AVPName1=Value1> || <commandcode2<::<AVPName2=Value2>||<commandcode3>

For example, if the sticky session entries need to deleted based on command code `271' with Accounting-Record-Type value as 4, use the format below:

Set StickyDeletionCmdList "271:: Accounting-Record-Type=4"

Peer Definitions Proxy tab

Name

Required; name of the peer.

Host Name

Required; hostname or IP address of the peer. The HostName must exist in the client list for the route to be active.

Metric

Required; metric value for this peer entry. The higher the value the lower the preference. The highest value of preference is 0.

Weight

Required; default value is 0. Specifies the weight percentage for which the service needs to load balance the peer.

Note When you set the weight to a value other than 0, the weight should be in multiples of 10 and the sum of the weights configured in the peer list should be equal to 100.

IMSIRanges

Required; used for load balancing. The value is set to comma separated values of IMSI Ranges.

For example, set IMSIRanges "123156000000001-123156001000000,123156010000001-123156011000000"

Note Cisco AR uses the AVP configured in StickyAVP property to check whether the IMSI is in valid range.


Click the Save button to save the specified details in the Add Diameter Service List page. To return to the Diameter Service List page without saving the details, click the Cancel button. On successful creation of the Diameter Service properties, the Diameter Service List page is displayed else a respective error message is displayed.

To add the peer statements, click the Add button in Peer Definitions tab. Enter the required details and click the Save button. To edit the peer statements, select the appropriate radio button and click the Edit button. To modify the peer statements, enter new information in the editable fields and click the Save button. To delete the peer statements, select the appropriate radio button and click the Delete button. To cancel the peer statements details, click the Cancel button.

To add the application specific details, click the Add button in Applications tab. Enter the required details and click the Add Diameter Service button. To edit the application specific details, select the appropriate radio button and click the Edit button. To modify the peer statements, enter new information in the editable fields and click the Save button. To delete the peer statements, select the appropriate radio button and click the Delete button.

To add the proxy peer statements, click the Add button in Peer Definitions Proxy tab. Enter the required details and click the Save button. To edit the peer statements, select the appropriate radio button and click the Edit button. To modify the peer statements, enter new information in the editable fields and click the Save button. To delete the peer statements, select the appropriate radio button and click the Delete button. To cancel the peer statements details, click the Cancel button.

Click the Add Diameter Service button to save the specified details in the Add Diameter Service List page. To return to the Diameter Services List page without saving the details, click the Cancel button. On successful creation of the Diameter service details, the Diameter Services List page is displayed else a respective error message is displayed.

Editing Diameter Service Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit properties of Diameter service, check the appropriate check box and click the Edit button. The Edit Diameter Services List page appears. To modify the service properties, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Diameter Services List page. If the modification is not successful, Cisco AR displays an error message.

Replication

The replication feature of Cisco AR allows you in maintaining identical configurations on multiple machines simultaneously. It eliminates the need to have administrators with multiple Cisco AR installations, make the same configuration changes at each of their installations. Instead, only the master's configuration must be changed and the slave is automatically configured eliminating the need to make repetitive, error-prone configuration changes for each individual installation. In addition to enhancing server configuration management, using replication eliminates the need for a hot-standby machine.

Employing Cisco AR's replication feature, both servers can perform RADIUS request processing simultaneously, eliminating wasted resources. It focuses on configuration maintenance only, not session information or installation-specific information.

Use the Replication Details page for the following:

Adding Replication Details

Editing Replication Member Details

Deleting Records

Adding Replication Details

To add new replication details, choose Configuration > Replication. The Replication Details page appears.Table 3-15 lists and describes the fields in the Replication Details page.

Table 3-15 Replication Properties 

Fields
Description

General Properties tab

Replication Type

Indicates the type of replication

Transaction Sync Interval (in ms)

Duration between periodic transmission of the TransactionSync message expressed in milliseconds. The default is 60000 or 1 minute.

Transaction Archive Limit

The default setting is 100.

The value set for RepTransactionArchiveLimit should be the same on the master and the slave.

Replication Secret

The value of this setting must be identical on both the master and the slave.

Is Master

On the master, set RepIsMaster to TRUE. On the slave, set it to FALSE.

Master IP Address

Specifies the IP Address of the master.

Master Port

Specifies the port to be used to send replication messages to the master.

Replication IP Address

The value is set to the IP Address of the machine containing the Cisco AR installation.

Replication Port

Defaults to port1645.

Replication Members tab

Name

Name of the slave. The name must be unique.

IP Address

Indicates the IP Address of the slave.

Port

Port upon which the master will send replication messages to the slave.


Click the Save button to save the new replication details. To restore the default values, click the Reset button. You can also add the replication member details by entering the required details in the fields displayed in Replication Members tab. Click the Submit button to add the replication member details. On successful creation of the replication details, a success message is displayed else a respective error message is displayed. To delete the replication member details, select the appropriate radio button and click the Delete button.

Editing Replication Member Details

To edit the replication member details, check the appropriate radio button and click the Edit button. To modify the details, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR lists the modified details else a respective error message is displayed.

RADIUS Dictionary

The RADIUS dictionary passes information between a script and the RADIUS server, or between scripts running on a single packet.

Use the Radius Attributes page for the following:

Filtering Records

Adding Radius Dictionary Details

Editing Radius Dictionary Details

Deleting Records

Adding Radius Dictionary Details

To add new Radius dictionary details, choose Configuration > Radius Dictionary. The Radius Attributes page appears.

Click the Add button to add new Radius dictionary details. The Add Radius Attributes page appears. Table 3-16 lists and describes the fields in the Add Radius Attributes page. The fields listed below are the entire list of all the available types. The fields are displayed based on the type selected.

Table 3-16 Radius Dictionary Properties 

Fields
Description

Name

Required; must be unique in the Radius dictionary list

Description

Optional; description of the attribute

Attribute

Required; must be a number between 1-255. It must be unique within the Attribute dictionary list.

Type

Required; type governs how the value is interpreted and printed.

Minimum

Set to zero

Maximum

Set to 253

Enum Number

Enums allow you to specify the mapping between the value and the strings. After you have established this mapping, Cisco AR then replaces the number with the appropriate string. The min/max properties represent the lowest to highest values of the enumeration.

Enum Equivalent

The value can range from 1 through 255. Click the Add button to save the details and list it in the Enums list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

Tag

The tag number value can range from 0 through 31. The default value is zero.


Click the Submit button to save the specified details in the Add Radius Attributes page. To return to the Radius Attributes page without saving the details, click the Cancel button. On successful creation of the Radius Attributes, the Radius Attributes page is displayed else a respective error message is displayed.

Editing Radius Dictionary Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit Radius dictionary details, check the appropriate check box and click the Edit button. The Edit Radius Attributes page appears. To modify the Radius dictionary details, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Radius Attributes page. If the modification is not successful, Cisco AR displays an error message.

Vendor Dictionary

The vendor dictionary allows the user to maintain the attributes of the vendor with respect to vendor id, vendor type and the attributes required to support the major NAS.

Use the Vendor Dictionary page for the following:

Filtering Records

Adding Vendor Dictionary Details

Editing Vendor Dictionary Details

Deleting Records

Adding Vendor Dictionary Details

To add new vendor dictionary details, choose Configuration > Vendor Dictionary. The Vendor Dictionary page appears.

Click the Add button to add new Vendor dictionary details. The Add Vendor Dictionary page appears. Table 3-17 lists and describes the fields in the Add Vendor Dictionary page. The fields listed below are the entire list of all the available types. The fields are displayed based on the type selected.

Table 3-17 Vendor Dictionary Properties 

Fields
Description

Name

Required; must be unique in the Vendor dictionary list

Description

Optional; description of the attribute

Vendor ID

Required; must be a valid number and unique within the entire attribute dictionary

Type

Required; type governs how the value is interpreted and printed.

Minimum

Set to zero

Maximum

Set to 253

Enum Number

Enums allow you to specify the mapping between the value and the strings. After you have established this mapping, Cisco AR then replaces the number with the appropriate string. The min/max properties represent the lowest to highest values of the enumeration.

Enum Equivalent

The value can range from 1 through 255. Click the Add button to save the details and list it in the Enums list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

Tag

The tag number value can range from 0 through 31. The default value is zero.

Vendor Size

Set the vendor size to 8, 16, or 32 bit

HasSubAttributeLengthField

Indicates that the value field of the attribute has the length field for the sub attribute.


Click the Submit button to save the specified details in the Add Vendor Dictionary page. After adding new vendor dictionary details, you can add vendor attributes. See Adding Vendor Attributes for details. To return to the Vendor Dictionary page without saving the details, click the Cancel button. On successful creation of the vendor dictionary details, the Vendor Dictionary page is displayed else a respective error message is displayed.

Editing Vendor Dictionary Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit Vendor dictionary details, check the appropriate check box and click the Edit button. The Edit Vendor Dictionary page appears. To modify the Vendor dictionary details, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Vendor Dictionary page. If the modification is not successful, Cisco AR displays an error message.

Vendor Attributes

Vendor-specific attributes are included in specific RADIUS packets to communicate prepaid user balance information from the Cisco AR server to the AAA client, and actual usage, either interim or total, between the NAS and the Cisco AR server.

Use the Vendor Attributes page for the following:

Filtering Records

Adding Vendor Attributes

Editing Vendor Attributes

Deleting Records

Adding Vendor Attributes

To add new Vendor attributes, choose Configuration > Vendor Dictionary. The Vendor Dictionary page appears. Click the Vendor name link. The Vendor Attributes page appears. Click the Add button to add new Vendor attributes. The Add Vendor Attributes page appears. Table 3-18 lists and describes the fields in the Add Vendor Attributes page.

Table 3-18 Vendor Attribute Properties 

Fields
Description

Name

Required; must be unique in the Vendor attribute list

Description

Optional; description of the attribute

Attribute

Required; must be a valid number and unique within the entire attribute dictionary

Type

Required; type governs how the value is interpreted and printed.

Minimum

Set to zero

Maximum

Set to 253

Enum Number

Enums allow you to specify the mapping between the value and the strings. After you have established this mapping, Cisco AR then replaces the number with the appropriate string. The min/max properties represent the lowest to highest values of the enumeration.

Enum Equivalent

The value can range from 1 through 255. Click the Add button to save the details and list it in the Enums list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

Tag

The tag number value can range from 0 through 31. The default value is zero.


Click the Submit button to save the specified details in the Add Vendor Attributes page. To return to the Vendor Attributes page without saving the details, click the Cancel button. On successful creation of the Vendor attributes, the Vendor Attributes page is displayed else a respective error message is displayed.

Editing Vendor Attributes

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit Vendor attribute details, check the appropriate check box and click the Edit button. The Edit Vendor Attributes page appears. To modify the Vendor attributes, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Vendor Attributes page. If the modification is not successful, Cisco AR displays an error message.

Vendors

The Vendor object provides a central location for specifying all of the request and response processing a particular NAS or Proxy vendor requires. Depending on the vendor, it might be necessary to map attributes in the request from one set to another, or to filter out certain attributes before sending the response to the client. For more information about standard RADIUS attributes, see Appendix C, "RADIUS Attributes." of User Guide for Cisco Access Registrar, 5.1.


Note When you have also set /Radius/IncomingScript, Cisco AR runs that script before the vendor's script. Conversely, when you have set a /Radius/Outgoing script, Cisco AR runs the vendor's script before that script.


Use the Vendors page for the following:

Filtering Records

Adding Vendor Details

Editing Vendor Details

Deleting Records

Adding Vendor Details

To add new Vendor details, choose Configuration > Vendors. The Vendors page appears.

Click the Add button to add new Vendor details. The Add Vendor page appears. Table 3-19 lists and describes the fields in the Add Vendor page.

Table 3-19 Vendor Properties 

Fields
Description

Name

Required; must be unique in the Vendors list.

IncomingScript

Optional; when you specify an IncomingScript, Cisco AR runs the script on all requests from clients that specify that vendor.

Description

Optional; description of the vendor.

OutgoingScript

Optional; when you specify an OutgoingScript, Cisco AR runs the script on all responses to the Client.


Click the Submit button to save the specified details in the Add Vendor page. To return to the Vendor page without saving the details, click the Cancel button. On successful creation of the Vendor details, the Vendor page is displayed else a respective error message is displayed.

Editing Vendor Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the Vendor details, check the appropriate check box and click the Edit button. The Edit Vendors page appears. To modify an attributes of vendor, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Vendors page. If the modification is not successful, Cisco AR displays an error message.

Translations

Translations add new attributes to a packet or change an existing attribute from one value to another. The Translations subdirectory lists all definitions of Translations the RADIUS server can apply to certain packets.

Under the /Radius/Translations directory, any translation to insert, substitute, or translate attributes can be added. The following is a sample configuration under the /Radius/Translations directory:

cd /Radius/Translations 
Add T1 
cd T1 
Set DeleAttrs Session-Timeout,Called-Station-Id 
cd Attributes 
Set Calling-Station-Id 18009998888
 
   

DeleAttrs is the set of attributes to be deleted from the packet. Each attribute is comma separated and no spaces are allowed between attributes. All attribute value pairs under the attributes subdirectory are the attributes and values that are going to be added or translated to the packet.

Under the /Radius/Translations/T1/Attributes directory, inserted or translated attribute value pairs can be set. These attribute value pairs are either added to the packet or replaced with the new value.

If a translation applies to an Access-Request packet, by referencing the definition of that translation, the Cisco AR server modifies the Request dictionary and inserts, filters and substitutes the attributes accordingly. You can set many translations for one packet and the Cisco AR server applies these translations sequentially.


Note Later translations can overwrite previous translations.


Use the Translations page for the following:

Filtering Records

Adding Translation Details

Editing Translation Details

Deleting Records

Adding Translation Details

To add new translation details, choose Configuration > Translations. The Translations page appears.

Click the Add button to add new translations details. The Add Translations page appears. Table 3-20 lists and describes the fields in the Add Translations page.

Table 3-20 Translations Properties 

Fields
Description

General Properties tab

Name

Required; must be unique in the Translations list.

Description

Optional; description of the Translation

Attribute Type

Select either RADIUS or VENDOR. If Vendor is selected, specify the vendor type from the drop-down list. Select the attributes from the available list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.

Attributes tab

Attribute Type

Select either RADIUS or VENDOR. If Vendor is selected, specify the vendor type from the drop-down list.

Attribute Name

Optional; based on the Attribute Type selected, the attribute name is automated. Set the relevant name for the attribute type selected.

Attribute Value

Optional; set the value for the selected attribute. Click the Add button to save the details and list it in Radius and Value list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Click the Add Translations button to save the specified details in the Add Translations page. To return to the Translations page without saving the details, click the Cancel button. On successful creation of the translation details, the Translations page is displayed else a respective error message is displayed.

Editing Translation Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the translation details, check the appropriate check box and click the Edit button. The Edit Translations page appears. To modify the translation details, enter new information in the editable fields and click the Edit Translation button. If the modification is successful, Cisco AR returns you to the Translations page. If the modification is not successful, Cisco AR displays an error message.

Translation Groups

You can add translation groups for different user groups under TranslationGroups. All Translations under the Translations subdirectory are applied to those packets that fall into the groups. The groups are integrated with the Cisco AR Rule engine.

The Cisco AR Administrator can use any RADIUS attribute to determine the Translation Group. The incoming and outgoing translation group can be different translation groups. For example, you can set one translation group for incoming translations and one for outgoing translations.

Under the /Radius/TranslationGroups directory, translations can be grouped and applied to certain sets of packets, which are referred to in a rule. The following is a sample configuration under the /Radius/TranslationGroups directory:

cd /Radius/TranslationGroups 
Add CiscoIncoming 
cd CiscoIncoming 
cd Translations 
Set 1 T1
 
   

The translation group is referenced through the Cisco AR Policy Engine in the /Radius/Rules/<RuleName>/Attributes directory. Incoming-Translation-Groups are set to a translation group (for example CiscoIncoming) and Outgoing-Translation-Groups to another translation group (for example CiscoOutgoing).

Use the Translation Groups page for the following:

Filtering Records

Adding Translation Group Details

Editing Translation Group Details

Deleting Records

Adding Translation Group Details

To add new translation group details, choose Configuration > TranslationGroups. The Translation Groups page appears.

Click the Add button to add new translation group details. The Add Translation Groups page appears. Table 3-21 lists and describes the fields in the Add Translation Groups page.

Table 3-21 TranslationGroups Properties 

Fields
Description

Name

Required; must be unique in the Translations list.

Description

Optional; description of the Translation Group

Translations

Lists of translation. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.


Click the Add TranslationGroup button to save the specified details in the Add Translation Groups page. To return to the Translation Groups page without saving the details, click the Cancel button. On successful creation of the translation group details, the Translation Groups page is displayed else a respective error message is displayed.

Editing Translation Group Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the translation group details, check the appropriate check box and click the Edit button. The Edit Translation Groups page appears. To modify the translation group details, enter new information in the editable fields and click the Edit TranslationGroup button. If the modification is successful, Cisco AR returns you to the Translation Groups page. If the modification is not successful, Cisco AR displays an error message.

DIAMETER

Diameter is a computer networking protocol forAuthentication, Authorization and Accounting (AAA). It is a successor to RADIUS or an enhanced version of the RADIUS protocol. It includes numerous enhancements in all aspects, such as error handling and message delivery reliability. It extracts the essence of the AAA protocol from RADIUS and defines a set of messages that are general enough to be the core of the Diameter Base protocol. The various applications that require AAA functions can define their own extensions on top of the Diameter base protocol, and can benefit from the general capabilities provided by the Diameter base protocol.

The following sections can be used to configure diameter transportmanagement properties, sessionmanagement properties, add new application, commands associated with it and application specific AVPs:

General

SessionManagement

Applications

Commands

General

This section explains how to set Diameter general configuration such as product name, version, and transport management properties.

Setting General Diameter Parameters

To set general diameter parameters, choose Configuration > Diameter > General. The General Diameter page appears.

Table 3-22 lists and describes the fields in the General Diameter page.

Table 3-22 General Diameter Properties 

Fields
Description

General tab

Product

Optional; name of the product.

AuthApplicationIdList

Specifies the list of AuthApplications that the Cisco AR server registers to Diameter Base stack during start up. It is a combination of Auth ApplicationId's separated by colon.

Version

Optional; version number.

AcctApplicationIdList

Specifies the list of AcctApplications that the Cisco AR server registers to Diameter Base stack during start up. It is a combination of Acct ApplicationId's separated by colon.

Transport Management tab

Identity

Required; identity of the system on which Diameter application is running. Must be set to a valid resolvable string.

Realm

Required; must be set to a valid Realm in the domain.

WatchdogTimeout

Required; specifies the time interval between watch dog messages.

EnableIPV6

Required; if set to TRUE it enables IPV6 for the Diameter application.

ReconnectInterval

Required; specifies the time interval between which Cisco AR server attempts to connect to a disconnected peer. If set to 0, then no attempt will be made to connect to a disconnected peer.

MaxReconnections

Required; specifies the number of times Cisco AR server tries to make a reconnection attempt. If set to 0, then no attempt will be made to reconnect.

RequestRetransmissionInterval

Required; the time for which retransmission of pending requests will be done. If set to 0, then no attempt will be made to retransmit.

MaxRequestRetransmissionCount

Required, maximum number of times Cisco AR server tries to retransmit a pending request. If set to 0, then no attempt will be made to retransmit.

Receive BufferSize

Required; initial size of buffer that is preallocated for message reception.

AdvertisedHostName

Optional, specifies the local hostname address that will be advertised by the Cisco AR server to other peers during CER/CEA exchange.

For example:

AdvertisedHostNames = toby-ar1.cisco.com

TCPListenPort

Required; port number on which the Cisco AR server listens for TCP peer connections.

SCTPListenPort

Required;  port number on which the Cisco AR server listens for SCTP peer connections.


Click the Set button to save the specified details in the General Diameter page. On successful creation of the general diameter parameters, a success message is displayed else a respective error message is displayed.

SessionManagement

Diameter Base protocol stack provides the functionality of SessionManagement. Base Stack maintains sessions separately for authentication and accounting messages. Session-Id AVP is used to identify the user session.

Setting Session Management Properties

To set session management properties, choose Configuration > Diameter > SessionManagement. The Session Management page appears.

Table 3-23 lists and describes the fields in the Session Management page.

Table 3-23 Session Management Properties 

Fields
Description

MaxNumberOfSessions

Required; specifies the maximum number of concurrent Diameter sessions the Cisco AR server will maintain. These sessions include both Auth and Acct sessions.

EnableStatefulSessions

If set to TRUE, the server will enforce stateful sessions and the client will hint for stateful sessions. Default Value is TRUE. Set the property to FALSE to disable stateful sessions.

AuthSessionTimeout

Required; specifies the timeout in seconds before a session requires reauthentication.

LifeTimeTimeout

Required; specifies the timeout in seconds before a session is terminated regardless of whether the session has been reauthenticated.

GracePeriodTimeout

Required; specifies the grace period after the life timeout and before the full termination of the session.

AbortRetryTimeout

Required; specifies the timeout between the subsequent Abort Session Request (ASR) messages if the initial attempt fails.

AcctSessionTimeout

Required; specifies the timeout in seconds before a session requires reauthentication.

InterimInterval

Required; specifies the interim interval dictated to the client if the entity is a server or hint to the server if the entity is a client.

RealTime

Required; RealTime value dictated to the client.


Click the Set button to save the specified details in the Session Management page. On successful creation of the parameters, a success message is displayed else a respective error message is displayed.

Applications

A Diameter application is not a software application, but a protocol based on the Diameter base protocol (defined in RFC 3588). Each application is defined by an application identifier and can add new command codes and/or new mandatory AVPs.

Use the Applications page for the following:

Filtering Records

Adding Diameter Application Details

Editing Diameter Application Details

Deleting Records

Adding Diameter Application Details

To add new Diameter application details, choose Configuration > Diameter > Applications. The Applications page appears.

Click the Add button to add new Diameter application details. The Add Applications page appears. Table 3-24 lists and describes the fields in the Add Applications page.

Table 3-24 Diameter Application Properties 

Fields
Description

Name

Required; name of the application.

Description

Optional; description of the application.

VendorSpecific

Required; the default is FALSE. If set to FALSE, the application is ordinary application and user is prompted to enter the ApplicationID. If set to TRUE, the application is a VendorSpecific Application. User is prompted to enter VendorSpecificApplicationID and VendorID.

AuthApplication

Required; if set to TRUE the application represents AuthApplication else it represents Accounting Application.

Application ID

Required; specifies the unique integer value for the application.

The following are examples of Diameter application:

NASREQ 1

Mobile-IP 2

Diameter Base Accounting 3

Note ApplicationId property must be set to 0 for Base Protocol.

VendorSpecificApplicationID

Required; specifies the integer value for the vendor specific application.

VendorID

Required; specifies the VendorID for the application.

Example:

DIAMETER 3GPP Cx APPLICATION

VendorSpecificApplicationID 16777216

VendorID 10415

ApplicationURI

Optional; specifies the URI of the Application.

Eg: "ftp://ftp.ietf.org/internet-drafts/draft-ietf-aaa-diameter-nasreq- 12.txt"

Commands

Required; an indexed list from 1 to <n>. Each entry in the list is the name of the command. It specifies the list of commands associated with the application.

To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.


Click the Add Application button to save the specified details in the Add Applications page. To return to the Applications page without saving the details, click the Cancel button. On successful creation of the Diameter application details, the Applications page is displayed else a respective error message is displayed.

Editing Diameter Application Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the Diameter application details, check the appropriate check box and click the Edit button. The Edit Applications page appears. To modify the Diameter application details, enter new information in the editable fields and click the Add Application button. If the modification is successful, Cisco AR displays a success message else a respective error message is displayed.

Commands

Each command in Diameter is associated with a command code. The command can be a request command or an answer command which is identified by the 'R' bit in the Command Flags field of the Diameter header.

Use the Commands page for the following:

Filtering Records

Adding Diameter Commands

Editing Diameter Commands

Deleting Records

Adding Diameter Commands

To add new Diameter commands, choose Configuration > Diameter > Commands. The Commands page appears.

Click the Add button to add new Diameter commands. The Add Commands page appears. Table 3-25 lists and describes the fields in the Add Commands page.

Table 3-25 Diameter Commands Properties 

Fields
Description

Name

Required; name of the command.

Description

Optional; description of the command.

Command Code

Required; specifies the integer code of the command.

EnableProxyBit

Required; default is TRUE. When enabled it represents the message is proxiable.

RequestFixed tab

Defines the fixed position of AVP in a request message.

RequestRequired tab

The AVP must be present and can appear anywhere in the request message.

RequestOptional tab

The AVP name in optional cannot evaluate to any avp name which is included in a fixed or required directory. The avp can appear anywhere in the request message.

AnswerFixed tab

Defines the fixed position of AVP in the answer message.

AnswerRequired tab

The AVP must present and can appear anywhere in the answer message.

AnswerOptional tab

The AVP name in optional cannot evaluate to any avp name which is included in a fixed or required directory. The avp can appear anywhere in the answer message.


Click the Add button, to add AVP details. Table 3-26 lists and describes the fields displayed on clicking the Add button.

Table 3-26 Request/Answer Msg AVP Properties 

Fields
Description

Name

Required; name of the AVP.

Description

Optional; description of the AVP.

Min

Specifies the minimum number of times AVP element may be present in a request. The default value is 0.

Max

Specifies the maximum number of times the element may present in a request. A value of zero implies AVP is not present in the request.


Click either Save button to save the specified AVP details or Cancel button to exit.

To edit the AVP details, select the appropriate radio button and click the Edit button. To modify the AVP details, enter new information in the editable fields and click the Save button. To delete the AVP details, select the appropriate radio button and click the Delete button.

Click the Add Command button to save the specified details in the Add Commands page. To return to the Commands page without saving the details, click the Cancel button. On successful creation of the Diameter command details, the Commands page is displayed else a respective error message is displayed.

Editing Diameter Commands

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the Diameter command details, check the appropriate check box and click the Edit button. The Edit Commands page appears. To modify the Diameter command details, enter new information in the editable fields and click the Add Command button. If the modification is successful, Cisco AR displays a success message else a respective error message is displayed.

Advanced

Advanced objects allow configuring system-level properties and the Attribute dictionary. Under normal system operation, the system-level properties should not be changed.

The following list helps you in defining the system-level properties and attribute dictionary:

Default

BackingStore/ServerParam

RemoteSessionServer

SNMP

DDNS

ODBCDataSources

Log

Ports

Interfaces

Attribute Groups

Rules

Default

This feature of GUI allows you in configuring the default values for other functionalities of GUI. The configurations set in this feature reflects on all the other features.

Setting Default Configuration

To set new default configuration details, choose Configuration > Advanced > Default. The Default Advanced Details page appears.

Table 3-27 lists and describes the fields in the Default Advanced Details page.

Table 3-27 Default Configuration Details 

Fields
Description

Default tab

AAAFileServiceSyncInterval

Required; specified in milliseconds, the default is 75. This property governs how often the file AAA service processes accounting requests and writes the accounting records to the file. You can lower the number to reduce the delay in acknowledging the Account-Request at the expense of more frequent flushing of the accounting file to disk. You can raise the number to reduce the cost of flushing to disk, at the expense of increasing the delays in acknowledging the Accounting-Requests. The default value was determined to provide a reasonable compromise between the two alternatives.

RemoteRadiusServerInterface

When set, specifies the local interface to bind to when creating the RemoteRadiusServer socket. If not set, the Cisco AR binds to IPADDR_ANY.

MaximumNumberOfXMLPackets

Required when using identity caching. Indicates the maximum number of XML packets to be sent or received. The minimum value is 1 and the maximum is a 32-bit unsigned integer. The default is 1024.

MaximumODBCResultSize

Required; specifies maximum size in bytes for an ODBC mapping. This parameter affects both ODBC result sizes and the trace log buffer for tracing script calls that access any of the dictionaries. (Default value is 256.)

XMLUDPPacketSize

Required when using identity caching. Indicates the maximum size of XML packets to be sent or received. The minimum value is 1 and the maximum is a 32-bit unsigned integer. The default is 4096.

InitialBackgroundTimerSleepTime

Required; the default is 5. This property specifies the amount of time the time queue should initially sleep before beginning processing. This property is only used for initial synchronization and should not be changed.

RemoteLDAPServerThreadTimerInterval

Required; specified in milliseconds, the default is 10. This property governs how often the ldap RemoteServer thread checks to see if any results have arrived from the remote LDAP server. You can modify it to improve the throughput of the server when it proxies requests to a remote LDAP server.

AdvancedDuplicateDetectionMemoryInterval

Required when the Advanced Duplicate Detection feature is enabled. This property specifies how long (in milliseconds) Cisco AR should remember a request. You must specify a number greater than zero. The default is 10,000.

RollingEncryptionKeyChangePeriod

Used in conjunction with the session-cache ResourceManager, this property specifies the length of time a given EncryptionKey will be used before a new one is created. When the session-cache ResourceManager caches User-Password attributes, Cisco AR encrypts the User-Password so it is not stored in memory or persisted on disk in clear text. Cisco AR uses up to 255 encryption keys, using a new one after each RollingEncryptionKeyChangePeriod expires. If RollingEncryptionKeyChangePeriod is set to 2 days, Cisco AR will create and begin using a new EncryptionKey every two days. The oldest key will be retired, and Cisco AR will re-encrypt any User-Passwords that used the old key with the new key. This way, if the RollingEncryptionKeyChangePeriod is set to 1 day, no key will be older than 255 days.

DefaultReturnedSubnetSizeIfNoMatch

Optional; used with the ODAP feature and reflects the returned size of the subnet if no matched subnet is found. There are three options to select if an exactly matched subnet does not exist: Bigger, Smaller, and Exact. The default is Bigger.

ODBCEnvironmentMultiValueDelimiter

Optional; allows you to specify a character that separates multivalued attributes in the marker list when using Oracle (or ODBC) accounting

RemoteSigtranServerThreadTimerInterval

Required; specified in milliseconds, the default is 10. This property governs how often the sigtran RemoteServer thread checks to see if any results have arrived from the remote HLR/AuC server. You can modify it to improve the throughput of the server when it proxies requests to a remote sigtran server.

AdditionalNativeOracleErrors

Optional; 5 digit Oracle native error in order to disconnect the ODBC/OCI remote servers.

AR Flags tab

HideSharedSecretAndPrivateKeys

Optional; the default value is TRUE.

The HideSharedSecretAndPrivateKeys property hides:

The secret that is shared between a Radius Client and a Radius Server or between two radius servers in a radius proxy scenario.

The PrivateKeyPassword under the certificate-based EAP services.

When this property is set to TRUE, the following properties are displayed as <encrypted>:

PrivateKeyPasswords in:

peap-v0 service

peap-v1 service

eap-tls service

eap-ttls service

eap-fast service

SharedSecret in:

RemoteServers of type radius

RemoteServers of type map-gateway

Clients object

Resource Manager of type usr-vpn under Gateway subobject

PseudonymSecret in eap-sim service

DynamicAuthSecret under DynamicAuthorizationServer subject in Clients object

RepSecret under Replication

Secret in /radius/advanced/DDNS/TSIGKeys

When the value for this property is set to FALSE, all the above properties are displayed in clear text.

ListenForDynamicAuthorizationRequests

Must be set to TRUE when using the Change of Authorization (CoA) feature or Packet of Disconnect (POD) feature. Default is FALSE.

RequireNASsBehindProxyBeInClientList

Optional; the default is FALSE. If you accept the default, Cisco AR only uses the source IP address to identify the immediate client that sent the request. Leaving it FALSE is useful when this RADIUS Server should only know about the proxy server and should treat requests as if they came from the proxy server. This might be the case with some environments that buy bulk dial service from a third party and thus do not need to, or are unable to, list all of the NASs behind the third party's proxy server. When you set it to TRUE, you must list all of the NASs behind the Proxy in the Clients list.

UseAdvancedDuplicateDetection

Required; the default is FALSE. Set this property to TRUE when you want Cisco AR to use a more robust duplicate request filtering algorithm.

DetectOutOfOrderAccountingPackets

Optional; used to detect accounting packets that arrive out of sequential order. The default is FALSE. This property is useful when using accounting and session management in a RADIUS proxy service.

When the DetectOutOfOrderAccountingPacket property is enabled (set to TRUE), a new Class attribute is included in all outgoing Accept packets. The value for this Class attribute will contain the session magic number. The client will echo this value in the accounting packets, and this will be used for comparison.

The session magic number is a unique number created for all sessions when the session is created or reused and the DetectOutOfOrderAccountingPacket property is set to TRUE. The DetectOutOfOrderAccountingPacket property is used to detect out-of-order Accounting-Stop packets in roaming scenarios by comparing the session magic number value in the session with the session magic number value contained in the Accounting packet.

The value of 0xffffffff is considered by the Cisco AR server to be a wild card magic number. If any accounting stop packets contain the value of 0xffffffff, it will pass the session magic validation even if the session's magic number is something else.

The format of the class attribute is as follows:

<4-byte Magic Prefix><4-byte server IP address><4-byte Magic value>

Java & EAP Parameters tab

ClasspathForJavaExtensions

A string which is the classpath to be used to locate Java classes and jar files containing the classes required for loading the Java extensions, either Java extension points or services.

Note The classpath will always contain the directory $INSTALLDIR/scripts/radius/java and all of the jar files in that directory.

JavaVMOptions

A string that can contain options to be passed to the JRE upon startup. JavaVMOptions should be used only when requested by Cisco TAC.

EapBadMessagePolicy

Set to one of two values: SilentDiscard (the default) or RejectFailure.

When set to SilentDiscard, the Cisco AR server silently discards and ignores bad EAP messages unless the protocol specification explicitly requires a failure message.

When set to RejectFailure, the Cisco AR server sends RADIUS Access-Rejects messages with embedded EAP-Failure in response to bad EAP messages as described in Internet RFC 3579.

CertificateDBPath

Required if you are using an LDAP RemoteServer and you want Cisco AR to use SSL when communicating with that LDAP RemoteServer. This property specifies the path to the directory containing the client certificates to be used when establishing an SSL connection to an LDAP RemoteServer. This directory must contain the cert7.db and cert5.db certificates and the key3.db and key.db files database used by Netscape Navigator 3.x (and above) or the ServerCert.db certificate database used by Netscape 2.x servers.


Click the Set button to save the specified details in the Default Advanced Details page. To restore the default values, click the Reset button. On successful creation of the default configurations, a success message is displayed else a respective error message is displayed.

BackingStore/ServerParam

The Backing Store is a Parsing Tool which helps you in analyzing the session backing store files. It retrieves the information on Radius sessions, clears phantom sessions details manually and processes the binary log files information to user-readable format.

The Server parameters are set to configure objects to remote server using the relevant aregcmd commands.

Setting Server Parameters

To set new server parameters, choose Configuration > Advanced > Backing/ServerParam. The Backing/ServerParam Advanced Details page appears.

Table 3-28 lists and describes the fields in the Backing/ServerParam Advanced Details page.

Table 3-28 BackingStore/ServerParameter Properties 

Fields
Description

SessionBackingStoreSyncInterval

Sessions will be written to the backing store at this interval

PacketBackingStoreSyncInterval

The minimum value is 1 and the maximum is a 32-bit unsigned integer. The default is 75.

SessionBackingStorePruneInterval

Required; specifies the sleep time interval of the session backing store pruning thread. The recommended and default value is 6 hours, but you can modify this based on the traffic patterns you experience.

With SessionBackingStorePruneInterval set to 6 hours, pruning will occur 6 hours after you restart or reload the Cisco AR server and recur every 6 hours.

You can set a very low value for this property to make pruning continuous, but there might not be enough data accumulated for the pruning to occur and pruning might be less effective compared to the default setting.

PacketBackingStorePruneInterval

Required; specifies the sleep time interval of the packet backing store pruning thread. The recommended value is 6 hours, but you can modify this based on the traffic patterns you experience.

When PacketBackingStorePruneInterval is set to 6 hours, pruning will occur 6 hours after you restart or reload the Cisco AR server and recur every 6 hours.

You can set a very low value for this property to make pruning continuous, but there might not be enough data accumulated for the pruning to occur and pruning might be less effective compared to the default setting.

BackingStoreDiscThreshold

Required; the default is 10 gigabytes. The value of BackingStoreDisc-
Threshold is made up of a number of units which can be K, kilobyte, or kilobytes, M, megabyte, or megabytes, or G, gigabyte, or gigabytes.

BackingStoreDiscThreshold is used with session management and ODBC accounting and ensures that any data log files generated will not cross the BackingStoreDiscThreshold.

SessionPurgeInterval

Optional; the SessionPurgeInterval property determines the time interval at which to check for timed-out sessions. If no value is set, the session timeout feature is disabled. The checks are performed in the background when system resources are available, so checks might not always occur at the exact time set.

The minimum recommended value for SessionPurgeInterval is 60 minutes. The SessionPurgeInterval value is comprised of a number and a units indicator, as in n units, where a unit is one of minutes, hours, days, or weeks.

StaleSessionTimeout

Required; the default value is "1 hour." Specifies the time interval to maintain a session when a client does not respond to Accounting-Stop notification.

When the Cisco AR server does not receive an Accounting-Response from a client after sending an Accounting-Stop packet, Cisco AR maintains the session for the time interval configured in this property before releasing the session.

This property is stored as a string composed of two parts: a number and a unit indicator (<n> <units>) similar to the MaxFileAge property where the unit is one of: M, Minute, Minutes, H, Hour, Hours, D, Day, Days, W, Week, or Weeks.

NumberOfRadiusIdentifiersPerSocket

This represents the number of RADIUS Identifiers that Cisco AR can use per source port, while proxying requests to remote servers.

To use a different source port for every request that is proxied, you need to set the value of this property to one.

EnableStickySessionCount

Required; either True or False and the default value is True. When set to True, Cisco AR displays the peer specific stats showing the number of sticky sessions associated with a peer for diameter proxy service in name_radius_log file.

StickySessionCountInterval

Required; specified in milliseconds and the default is 60000. When the EnableStickySessionCount is set to True, this field specifies how often the diameter proxy service will display the number of sticky sessions associated with a peer.

StickySessionSyncInterval

Required; specified in milliseconds and the default value is 500. Specifies how often the diameter proxy service will write the sticky sessions to a file located in /cisco-ar/temp/__sticky_sessions_store location.

MaximumNumberOfRadiusPackets

Required; the default is 8192. This is a critical property you should set high enough to allow for the maximum number of simultaneous requests. When more requests come in than there are packets allocated, Cisco AR will drop those additional requests.

NumberOfRemoteUDPServerSocket

Required; the default value for this property is 4.

The NumberOfRemoteUDPServerSockets property allows you to configure the number of source ports used while proxying requests to a remote radius server. If the NumberOfRemoteUDPServerSockets property is set to a value n, all remote servers share and use n sockets.

The NumberOfRemoteUDPServerSockets value comprises a number, as in n, where n should be less than or equal to the current process file descriptor limit divided by 2.

Note By default, the Radius process supports up to 1024 file descriptors. To increase the file descriptors, stop the arserver; in the arserver script, specify the required value to "NUMBER_OF_FILE_DESCRIPTORS" and restart the server. The value for "NUMBER_OF_FILE_DESCRIPTORS" should be in the range between 1024 to 65535.

MemoryLimitForRadiusProcess

This property is used to avoid crashing of the radius process.

UDPPacketSize

Required; the default is 4096. RFC 2138 specifies the maximum packet length can be 4096 bytes. Do not change this value.

PerPacketHeapSize

Required; the default is 6500. This property sets the size of the initial heap for each packet. The heap is the dynamic memory a request can use during its lifetime. By preallocating the heap size at the beginning of request processing, we can minimize the cost of memory allocations. If PerPacketHeapSize is too low, Cisco AR will ask the system for memory more often. If PerPacketHeapSize is too high, Cisco AR will allocate too much memory for the request causing the system to use more memory than required.

MinimumSocketBufferSize

Required; the default is 65536 (64 K). This property governs how deep the system's buffer size is for queueing UDP datagrams until Cisco AR can read and process them. The default is probably sufficient for most sites. You can, however, raise or lower it as necessary.

MaximumOutstandingRequests

Optional; the default value for this property is 0.

The MaximumOutstandingRequests property is used to limit the incoming traffic in terms of "requests processed". Serves as a hard limit.

The MaximumOutstandingRequests property comprises a number n, where n can be any nonzero value.

MaximumIncomingRequests

Optional; the default value for this property is 0.

ARIsCaseInsensitive

When set to FALSE, requires that you provide exact pathnames with regard to upper and lower case for all objects, subobjects, and properties. The default setting, TRUE, allows you to enter paths such as /rad/serv instead of /Rad/Serv.

Note Cisco AR always authenticates the RADIUS attribute User-Name with regard to upper and lower case, regardless of the setting of this flag.

EnableDiameter

Optional; Either TRUE or FALSE; default is TRUE. Set to True when you want to use the Diameter protocol in Cisco AR.

NumberOfKeys

Number (from 1-1024) that specifies the maximum number of keys stored for EAP-FAST.

RolloverPeriod

Specifies the amount of time between key updates.


Click the Set button to save the specified details in the Backing/ServerParamAdvanced Details page. On successful creation of the server parameters, a success message is displayed else a respective error message is displayed.

RemoteSessionServer

Cisco AR 5.1 sessions can also be stored on a remote database. This improves the overall scalability of the number of sessions that AR can simultaneously handle. The remote session manager internally uses the following two ODBC remote servers:

Internal-ODBC-Read-Server

Internal-ODBC-Write-Server.

Configurations pertaining to these internal remoteservers can be done under the RemoteSessionServer section.


Note Ensure that the length of fields such as Username, Session/Resource Manager name Session-Key, Query-Key and so on are limited to the value specified in the schema, while it is configured. Although the field length of entire session record is 3KB it is limited to 2KB. This is practically sufficient to hold all the session parameters as well as the cached attributes (if any). For more information about the schema, see section Remote Session Management of the Cisco Access Registrar 5.1 User Guide:
http://www.cisco.com/en/US/docs/net_mgmt/access_registrar/5.1/user/guide/features.html



Note Remote session manager will work only with Oracle database.


Setting RemoteSessionServer Details

To set new RemoteSessionServer details, choose Configuration > Advanced > RemoteSessionServer. The RemoteSessionServer Advanced Details page appears.

Table 3-29 lists and describes the fields in the RemoteSessionServer Advanced Details page.

Table 3-29 RemoteSessionServer Properties 

Fields
Description

ReactivateTimerInterval

Mandatory time interval (in milliseconds) to activate an inactive server; defaults to 300000 ms.

Timeout

Mandatory time interval (in seconds) to wait for SQL operation to complete; defaults to 15 seconds

DataSourceConnections

Mandatory number of connections to be established; defaults to 8

ODBCDataSource

Name of the ODBCDataSource to use and must refer to one entry in the list of ODBC datasources configured under /Radius/Advanced/ODBCDataSources. Mandatory; no default.

KeepAliveTimerInterval

Mandatory time interval (in milliseconds) to send a keepalive to keep the idle connection active; defaults to zero (0) meaning the option is disabled

MaximumBufferFileSize

Mandatory if BufferAccountingPackets is set to TRUE, determines the maximum buffer file size, defaults to 10 Megabyte)

CacheLimit

Default is 250000; This represents the overall limit on cache of all 'remote' session managers. This value is interpreted as the maximum number of packets that can be present in cache. When the number of sessions hits this limit, sessions will be 'cached out'. This cache out operation will continue, until the cache is at least 20% free.

BufferAccountingPackets

Mandatory, TRUE or FALSE, determines whether to buffer the accounting packets to local file, defaults to TRUE which means that packet buffering is enabled.

Note When set to TRUE, a constant flow of incoming accounting packets can fill the buffer backing store files in /cisco-ar/data/odbc beyond the size configured in MaximumBufferFileSize. Configure BackingStoreDiscThreshold in /Radius/Advanced when using ODBC accounting.

UseCacheIndex

Mandatory;


Click the Set button to save the specified details in the RemoteSessionServer Advanced Details page. On successful creation of the RemoteSessionServer details, a success message is displayed else a respective error message is displayed.

SNMP

Cisco AR provides SNMP MIB for users of network management systems. The supported MIBs enable the network management station to collect state and statistic information from a Cisco AR server. It enables a standard SNMP management station to check the current state of the server as well as the statistics on each client or each proxy remote server. These messages contain information indicating that either the server was brought up or down or that the proxy remote server is down or has come back online.

Setting SNMP Details

To set new SNMP details, choose Configuration > Advanced > SNMP. The SNMP Advanced Details page appears.

Table 3-30 lists and describes the fields in the SNMP Advanced Details page.

Table 3-30 SNMP Properties 

Fields
Description

InputQueueHighThreshold

An integer; default is 90.

InputQueueLowThreshold

An integer; default is 60.

Enabled

Either TRUE or FALSE; default is FALSE. To disable SNMP setting, uncheck the Enabled check box.

TracingEnabled

Either TRUE or FALSE; default is FALSE.

MasterAgentEnabled

Either TRUE or FALSE; default is TRUE.

AllowRejectAttrs

When AllowRejectAttrs is set to FALSE, Reply-Message attributes will not be passed in an Access Reject packet. When AllowRejectAttrs is set to TRUE, attributes will be allowed to pass in an Access Reject packet.

AllowEAPRejectAttrs

When AllowEAPRejectAttrs is set to FALSE, Reply-Message attributes will not be passed in an Access Reject packet if the packet contains EAP-Message attribute. When AllowEAPRejectAttrs is set to TRUE, attributes will be allowed to pass in an Access Reject packet even if the packet contains EAP-Message attribute.

Default

Optional; when you set this property, Cisco AR sends this value when the property corresponding to the reject reason is not set.

UnknownUser

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever Cisco AR cannot find the user specified by User-Name.

UserNotEnabled

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever the user account is disabled.

UserPasswordInvalid

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever the password in the Access-Request packet did not match the password in the database.

UnableToAcquireResource

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever one of the Resource Managers was unable to allocate the resource for this request.

ServiceUnavailable

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever a service the request needs (such as a RemoteServer) is unavailable.

InternalError

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever an internal error caused the request to be rejected.

MalformedRequest

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever a required attribute (such as User-Name) is missing from the request.

ConfigurationError

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever the request is rejected due to a configuration error. For example, if a script sets an environment variable to the name of an object such as Authentication-Service, and that object does not exist in the configuration, the reason reported is ConfigurationError.

IncomingScriptFailed

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever one of the IncomingScripts fails to execute.

OutgoingScriptFailed

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever one of the OutgoingScripts fails to execute.

IncomingScriptRejectedRequest

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever one of the IncomingScripts rejects the Access-Request.

TerminationAction

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever Cisco AR processes the Access-Request as a Termination-Action and is being rejected as a safety precaution.

OutgoingScriptRejectedRequest

Optional; when you set this property, Cisco AR sends back this value in the Reply-Message attribute whenever one of the OutgoingScripts rejects the Access-Request.


Click the Set button to save the specified details in the SNMP Advanced Details page. On successful creation of the SNMP details, a success message is displayed else a respective error message is displayed.

DDNS

Cisco AR supports Dynamic DNS Remote server. It is a method, protocol, or network that notifies the server to change the active DNS configuration of its configured hostnames, addresses or other information stored in DNS.

Use the DDNS Details page for the following:

Filtering Records

Setting DDNS Details

Adding DDNS Details

Editing DDNS Details

Deleting Records

Setting DDNS Details

To set new DDNS details, choose Configuration > Advanced > DDNS. The DDNS Details page appears.

Check the SynthesizeReverseZone check box, and click the Set DDNS button.

Adding DDNS Details

To add new DDNS details, choose Configuration > Advanced > DDNS. The DDNS Details page appears.

Click the Add button to add new DDNS details. The Add DDNS Details page appears. Table 3-31 lists and describes the fields in the Add DDNS Details page.

Table 3-31 DDNS Properties 

Fields
Description

Name

Name of the TSIG Key.

Secret

Set to the same base64-encoded string as defined in the DNS server.

Description

Description of the TSIG Key


Click the Add button to save the specified details in the Add DDNS Details page. On successful creation of the DDNS details, a success page is displayed else a respective error message is displayed.

Editing DDNS Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the DDNS details, check the appropriate check box and click the Edit button. The Edit DDNS Details page appears. To modify the DDNS details, enter new information in the editable fields and click the Update button. If the modification is successful, Cisco AR displays a success message else a respective error message is displayed.

ODBCDataSources

Cisco AR uses ODBC as the datasource name to be used by the remote server. Multiple remote servers can use the same ODBCDataSource. Under the ODBCDataSource object definition, a list defines ODBC.ini filename/value pairs for a connection. The list includes a Type field and a Driver field, different for each Driver and Data Source, to indicate its Driver and Data Source. Cisco AR supports only the Easysoft Open Source Oracle Driver.

Use the ODBC DataSources page for the following:

Filtering Records

Adding ODBC Data Source

EditingODBC Data Source

Deleting Records

Adding ODBC Data Source

To add new ODBC data source details, choose Configuration > Advanced > ODBC DataSources. The ODBC DataSources page appears.

Click the Add button to add new ODBC data source details. The Add ODBC DataSources page appears. Table 3-32 lists and describes the fields in the Add ODBC DataSources page.

Table 3-32 ODBCDataSource Properties 

Fields
Description

Name

Name of the ODBCDataSource

Description

Optional; Description of the ODBC Data Source

Type

Required; must be Oracle_es

Driver

Required; liboarodbc.so (default value)

Note This attribute is supported only for OBDC.

UserID

Required; database username (no default value)

Password

Optional; user password; shown encrypted

DataBase

Required; Oracle Client configuration database name (no default value)

Server

Set the name of the server

Port

Set the port details.


Click the Submit button to save the specified details in the Add ODBC DataSources page. To return to the ODBC DataSources page without saving the details, click the Cancel button. On successful creation of the ODBC data source details, the ODBC DataSources page is displayed else a respective error message is displayed.

EditingODBC Data Source

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the ODBC data source details, check the appropriate check box and click the Edit button. The Edit ODBC DataSources page appears. To modify the ODBC data source details, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR displays a success message else a respective error message is displayed.

Log

The log files defined in Cisco AR assist you in identifying the issues related to it. Cisco AR holds sets of log files to store information relevant to server agent processes, monitoring arserver utility, execution of aregcme commands, mcd internal database details, radius server processes and debug details of RADIUS request process.

Use the Log Files page for the following:

Filtering Records

Viewing Log Details

Downloading Log Details

Setting Log Details

Viewing Log Details

To view the log files, choose Configuration > Advanced > Log. The Log Files page appears. Select the appropriate radio button and click the View button to view the file.

Downloading Log Details

To download the log files, choose Configuration > Advanced > Log. The Log Files page appears. Select the appropriate radio button and click the Download button to download the file.

Setting Log Details

To set the log details, choose Configuration > Advanced > Log. The Log Files page appears. Table 3-33 lists and describes the fields in the Log Files page.

Table 3-33 Log Details 

Fields
Description

LOG LEVEL

Select either debug level or Error.

MaxFileSize

Set the maximum size of the log file.

LogFileSize

Required; the default is 1 megabyte. This property specifies the maximum size of the RADIUS server log file. The value for the LogFileSize field is a string composed of two parts; a number, and a units indicator (<n> <units>) in which the unit is one of: K, kilobyte, kilobytes, M, megabyte, megabytes, G, gigabyte, or gigabytes.

The LogFileSize property does not apply to the config_mcd_1_log or agent_server_1_log files.

Note This does not apply to the trace log.

LogFileCount

Required; the default is 2. This property specifies the number of log files to be kept on the system. A new log file is created when the log file size reaches LogFileCount.

The LogFileCount property does not apply to the config_mcd_1_log or agent_server_1_log files.

TraceFileSize

Required; the default is 1 GB. This property specifies the size of the trace files to be kept on the system. A new trace file is created when the trace file size reaches TraceFileSize. The value for the TraceFileSize field is a string composed of two parts; a number, and a units indicator (<n> <units>) in which the unit is one of: K, kilobyte, kilobytes, M, megabyte, megabytes, G, gigabyte, or gigabytes.

TraceFileCount

Required; this value can be set from 1-100, and the default is 2. This property specifies the number of trace files to maintain. A value of 1 indicates that no file rolling occurs.

LogServerActivity

Required; the default is FALSE, which means Cisco AR logs all responses except Access-Accepts and Access-Challenges. Accepting the default reduces the load on the server by reducing that amount of information it must log. Note, the client is probably sending accounting requests to an accounting server, so the Access-Accept requests are being indirectly logged. When you set it to TRUE, Cisco AR logs all responses to the server log file.

TraceLevel

Set the trace level.


Click the Set button to save the specified details in the Add Log Files page.

Ports

The Ports list specifies which ports to listen to for requests. When you specify a port, Cisco AR makes no distinction between the port used to receive Access-Requests and the port used to receive Accounting-Requests. Either request can come in on either port.

Most NASs send Access-Requests to port 1645 and Accounting-Requests to 1646, however, Cisco AR does not check.

When you do not specify any ports, Cisco AR reads the /etc/services file for the ports to use for access and accounting requests. If none are defined, Cisco AR uses the standard ports (1645 and 1646).

Use the Ports page for the following:

Filtering Records

Adding Port Details

Editing Port Details

Deleting Records

Adding Port Details

To add new port details, choose Configuration > Advanced > Port. The Ports page appears.

Table 3-34 lists and describes the fields in the Ports page.

Table 3-34 Port Properties 

Fields
Description

Port

Required; allows you to use ports other than the default, 1645 and 1646. You can use this option to configure Cisco AR to use other ports,. If you add additional ports, however, Cisco AR will use the added ports and no longer use ports 1645 and 1646. These ports can still be used by adding them to the list of ports to use.

Type

Set the port type.

Description

Optional; description of the port.


Click the Add button to add new port details. The new port details will be listed in the Ports page.

Editing Port Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the port details, check the appropriate check box and click the Edit button. To modify the port details, enter new information in the editable fields and click the Save button. If the modification is successful, Cisco AR displays a success message else a respective error message is displayed.

Interfaces

The Interfaces list specifies the interfaces on which the RADIUS server receives and sends requests. You specify an interface by its IP address.

When you list an IP address, Cisco AR uses that interface to send and receive Access-Requests.

When no interfaces are listed, the server performs an interface discover and uses all interfaces of the server, physical and logical (virtual).


Note The IP address format is enhanced to support both IPv4 and IPv6.


Use the interfaces page for the following:

Filtering Records

Adding IP Addressing Interface

Deleting Records

Adding IP Addressing Interface

To add a new IP address interface to define an interface, choose Configuration > Advanced > Interfaces. The Interfaces page appears. Enter the IP address, and click the Add button. The new IP address will be listed in the Interfaces page.

Attribute Groups

The Attributes can be grouped using Cisco AR Profile object. The attributes for a particular user group can be grouped under a profile and the attributes contained in the profiles will be returned in their access-accepts.

Use the Attribute Groups page for the following:

Filtering Records

Adding Attribute Group Details

Editing Attribute Group Details

Deleting Records

Adding Attribute Group Details

To add new attribute groups details, choose Configuration > Advanced > Attributes Groups. The Attribute Groups page appears.

Click the Add button to add new attribute groups details. The Add Attribute Groups page appears. Table 3-35 lists and describes the fields in the Add Attribute Groups page.

Table 3-35 AttributeGroups Properties 

Fields
Description

Name

Name of the attribute group.

Description

Optional; description of the attribute group.

Attribute type

Select either RADIUS or VENDOR. If Vendor is selected, specify the vendor type from the drop-down list.

Attribute Name

Optional; based on the Attribute Type selected, the attribute name is automated. Set the relevant name for the attribute type selected. Click the Add button to save the details and list it in Attribute list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Click the Submit button to save the specified details in the Add Attribute Groups page. To return to the Attribute Groups page without saving the details, click the Cancel button. On successful creation of the attribute group details, the Attribute Groups page is displayed else a respective error message is displayed.

Editing Attribute Group Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the attribute group details, check the appropriate check box and click the Edit button. To modify the attribute group details, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Attribute Groups page. If the modification is not successful, Cisco AR displays an error message.

Rules

A Rule is a function that selects services based on all input information used by the function.

Use the Rules List page for the following:

Filtering Records

Setting Rules

Editing Rules

Deleting Records

Setting Rules

To set new rules, choose Configuration > Rules. The Rules List page appears.

Click the Add button to set new rules. The Add Rules List page appears. Table 3-36 lists and describes the fields in the Add Rules List page.

Table 3-36 Rule Properties 

Fields
Description

General Properties tab

Name

Required; must be unique in the Rule list.

Description

Optional; description of the rule.

Type

Required; specifies the type of the rule which can be Radius or Diameter.

Script Name

Name of the script.

Attribute Details tab
The fields displayed in the tab is displayed based on the type of the rule selected in the Type field.

RADIUS

Optional; set Radius, if the attribute and value needs to be defined for Radius.

VENDOR

Optional; set Vendor, if the attribute and value needs to be defined for Vendor.

AttributeName

Optional; based on the Attribute Type selected, the attribute name is automated. Set the relevant name for the attribute type selected.

AttributeValue

Optional; set the value for the selected attribute. Click the Add button to save the details and list it in Name and Value list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Click the Submit button to save the specified details in the Add Rules List page. To return to the Rules List page without saving the details, click the Cancel button. After successfully setting the rules, the Rules List page is displayed else a respective error message is displayed.

Editing Rules

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the rules, check the appropriate check box and click the Edit button. To modify the rules, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Rules List page. If the modification is not successful, Cisco AR displays an error message.

Session Managers

You can use Session Managers to track user sessions. The Session Managers monitor the flow of requests from each NAS and detect the session state. When requests come through to the Session Manager, it creates sessions, allocates resources from appropriate Resource Managers, and frees and deletes sessions when users log out.

The Session Manager enables you to allocate dynamic resources to users for the lifetime of their session. You can define one or more Session Managers and have each one manage the sessions for a particular group or company.


Note Session record size is limited by the operating system (OS) paging size (8 KB in Solaris and 4 KB in Linux). If a request triggers creation of a session that exceeds the OS paging size, the request will be dropped and the session will not be created.



Note In this release of Cisco AR, the memory capacity is enhanced to store more than 4 million active session's by storing the active session records in database server instead of storing it in the main memory. The capacity is dependent on the number of attributes that are being captured for each session.



Note If the disk partition where Cisco AR stores session backing store data (usually the disk partition where Cisco AR is installed, such as /opt/CSCOar) is full, the subsequent packets that try to create sessions will be dropped and no sessions will be created due to lack of disk space.


Session Managers use Resource Managers, which in turn, manage a pool of resources of a particular type.

Use the Session Managers page for the following:

Filtering Records

Adding Session Manager Details

Editing Session Manager Details

Deleting Records

Adding Session Manager Details

To add new session manager details, choose Configuration > Session Managers. The Session Managers page appears.

Click the Add button to add new session managers details. The Add Session Managers page appears. Table 3-37 lists and describes the fields in the Add Session Managers page.

Table 3-37 Session Manager Properties 

Fields
Description

Name

Required; must be unique in the Session Managers list.

Description

Optional description of the Session Manager.

Type

Required; set to local or remote. Local is the traditional session manager that maintains sessions in memory and has good performance. The remote session manager operates on a remote ODBC database, and its performance is highly dependent on the performance of the ODBC database.

SessionKey

SessionKey property is used to set the sessionkey value for the Session Manager.

The SessionManager checks whether the environmental variable Session-Key is set or not. If the environmental variable is set, the server uses it as the sessionkey. If environmental variable Session-Key is not set then SessionManager gets the value configured in the SessionKey property under SessionManager.

SessionKey can be a combination of attributes separated by colon. The values for those attributes are obtained from the RequestDictionary. If any one of the attribute that is configured for the sessionkey is not present in the RequestDictionary, Cisco AR will drop the request.

However, if Session-Key is not set, SessionManager uses NAS-Identifier and NAS-Port to create the sessionkey. An example configuration,

--> set SessionKey "User-Name:NAS-Port"

The following shows the sample configuration of sessionkey for Session Manager:

[ //localhost/Radius/SessionManagers/session-mgr-1 ] 
Name = session-mgr-1 
Description = 
IncomingScript = 
OutgoingScript = 
AllowAccountingStartToCreateSession = TRUE 
SessionTimeOut = 
PhantomSessionTimeOut = 
SessionKey = 
ResourceManagers/

AllowAccountingStartToCreateSession

Set to TRUE by default; start the session when the Cisco AR server receives an Access Accept or an Accounting-Start.

When set to FALSE, start the session when the Cisco AR server receives an Access Accept.

IncomingScript

Optional; name of script to run when the service starts. This script is run as soon as the session is acquired in Cisco AR 4.1.

OutgoingScript

Optional; script to be run just before the session is written to backing store.

SessionTimeOut

The SessionTimeOut property is optional; no value for this property means the session timeout feature is disabled.

Used in conjunction with /Radius/Advanced/SessionPurgeInterval for the session timeout feature. Enables the session timeout feature for a Session Manager. If the SessionTimeOut property is set to a value under a session manager, all sessions that belong to that session manager will be checked for timeouts at each SessionPurgeInterval. If any sessions have timed out, they will be released, and all resources associated with those sessions are also released.

The SessionTimeOut property determines the timeout for a session. If the time difference between the current time and the last update time is greater than this property's value, the session is considered to be stale. The last update time of the session is the time at which the session was created or updated.

The SessionTimeOut value is comprised of a number and a units indicator, as in n units, where a unit is one of minutes, hours, days, or weeks. The default unit is `days'.

PhantomSessionTimeOut

Optional; no value for this property means the phantom session timeout feature is disabled.

The PhantomSessionTimeOut property is used in conjunction with /Radius/Advanced/SessionPurgeInterval to enable the phantom session timeout feature for Session Manager.

If the PhantomSessionTimeOut property is set to a value under a session manager, all sessions that belong to that session manager will be checked for receipt of an Accounting-Start packet. Sessions that do not receive an Accounting-Start packet from creation until its timeout will be released.

The PhantomSessionTimeOut value comprises a number and a units indicator, as in n units, where a unit is one of minutes, hours, days, or weeks. The default unit is `days'

Resource Managers List

Ordered list of Resource Managers. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details.

MemoryLimitForRadiusProcess

This property is used to avoid crashing of the radius process. The default value is 3500 Megabytes. This property is under /radius/advanced. When the radius process uses memory more than the configured limit, further sessions are not created and Cisco AR rejects further incoming requests.

MemorySizeCheckInterval

This property is used to avoid crashing of the radius process. This is used in conjunction with MemoryLimitForRadiusProcess. The default value is 5 minutes. MemorySizeCheckInterval is a hidden parameter in mcd database. To modify the default value, you need to export the mcd database. Typically, a separate thread is created to monitor the radius process memory usage for every 5 minutes.


Click the Add button to save the specified details in the Add Session Managers page. To return to the Session Managers page without saving the details, click the Cancel button. On successful creation of the session manager details, the Session Managers page is displayed else a respective error message is displayed.

Editing Session Manager Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the session manager details, check the appropriate check box and click the Edit button. To modify the session manager details, enter new information in the editable fields and click the Add button. If the modification is successful, Cisco AR returns you to the Session Managers page. If the modification is not successful, Cisco AR displays an error message.

Resource Manager

Resource Managers allow you to allocate dynamic resources to user sessions. The following lists the different types of Resource Managers.

IP-Dynamic—manages a pool of IP addresses that allows you to dynamically allocate IP addresses from a pool of addresses

IP-Per-NAS-Port—allows you to associate ports to specific IP addresses, and thus ensure each NAS port always gets the same IP address

IPX-Dynamic—manages a pool of IPX network addresses

Subnet-Dynamic—manages a pool of subnet addresses

Group-Session-Limit—manages concurrent sessions for a group of users; that is, it keeps track of how many sessions are active and denies new sessions after the configured limit has been reached

User-Session-Limit—manages per-user concurrent sessions; that is, it keeps track of how many sessions each user has and denies the user a new session after the configured limit has been reached

Home-Agent—manages a pool of on-demand IP addresses

USR-VPN—manages Virtual Private Networks (VPNs) that use USR NAS Clients.

Home-Agent-IPv6—manages a pool of on-demand IPv6 addresses

Remote-IP-Dynamic—manages a pool of IP addresses that allows you to dynamically allocate IP addresses from a pool of addresses. It internally works with a remote ODBC database.

Remote-User-Session-Limit—manages per-user concurrent sessions; that is, it keeps track of how many sessions each user has and denies the user a new session after the configured limit has been reached. It internally works with a remote ODBC database.

Remote-Group-Session-Limit—manages concurrent sessions for a group of users; that is, it keeps track of how many sessions are active and denies new sessions after the configured limit has been reached. It internally works with a remote ODBC database.

Session Cache—allows you to define the RADIUS attributes to store in cache.

Dynamic-DNS—manages the DNS server.

Remote-Session-Cache—allows you to define the RADIUS attributes to store in cache. It should be used with session manager of type 'remote'.

Each Resource Manager is responsible for examining the request and deciding whether to allocate a resource for the user, do nothing, or cause Cisco AR to reject the request.

Use the Resource Manager List page for the following:

Filtering Records

Adding Resource Manager Details

Editing Resource Manager Details

Deleting Records

Adding Resource Manager Details

To add new resource manager details, choose Configuration > Resource Manager. The Resource Manager List page appears.

Click the Add button to add new resource manager details. The Add Resource Manager List page appears. Table 3-38 lists and describes the fields in the Add Resource Manager List page.

Table 3-38 Resource Manager Properties 

Fields
Description

Resource Manager Name

Required; must be unique in the Resource Managers list.

Description (optional)

Optional; description of the Resource Manager.

Type

Required; must be either Dynamic-DNS, IP-Dynamic, IP-Per-NAS-Port, IPX-Dynamic, Session Cache, Subnet-Dynamic, Group-Session-Limit, Home-Agent, User-Session-Limit, USR-VPN, Home-Agent-IPv6, Remote-IP-Dynamic, Remote-User-Session-Limit, Remote-Group-Session-Limit or Remote-Session-Cache.


Click the Submit button to save the specified details in the Add Resource Manager List page. To return to the Resource Manager List page without saving the details, click the Cancel button. On successful creation of the resource manager details, the Resource Manager List page is displayed else a respective error message is displayed.

DYNAMIC-DNS

Table 3-39 lists and describes the fields in the Add Resource Manager List page.

Table 3-39 DYNAMIC-DNS Properties 

Fields
Description

General tab

Max DNS TTLS

Set the maximum TTL of the DNS record.

DNS Host bytes

Set the number of bytes to be used to construct the reverse zone entry.

Forward Zone Name

Set the name of the forward zone. For a given Resource Manager you must decide which forward zone you will be updating for sessions the resource manager will manage.

Reverse Zone Name

Set the name of the reverse zone.

Forward Zone Server

Set the Server IP of the forward zone

Reverse Zone Server

Set the Server IP of the reverse zone

Forward Zone TSIG KeyS

Server-wide security key to process all forward zone dynamic DNS updates. This is used if a ForwardZoneTSIGKey was not specified on the Resource Manager.

Reverse Zone TSIG Keys

Server-wide security key to process all reverse zone dynamic DNS updates. This is used if a ReverseZoneTSIGKey was not specified on the Resource Manager


GROUP-SESSION-LIMIT

Table 3-40 lists and describes the fields in the Add Resource Manager List page.

Table 3-40 GROUP-SESSION-LIMIT Properties 

Fields
Description

Group Session Limit

Set the GroupSessionLimit property to the maximum number of concurrent sessions for all users.


REMOTE-GROUP-SESSION-LIMIT

Table 3-41 lists and describes the fields in the Add Resource Manager List page.

Table 3-41 REMOTE-GROUP-SESSION-LIMIT Properties 

Fields
Description

Group Session Limit

Set the GroupSessionLimit property to the maximum number of concurrent sessions for all users.


HOME-AGENT

Table 3-42 lists and describes the fields in the Add Resource Manager List page.

Table 3-42 HOME-AGENT Properties 

Fields
Description

HomeAgentIPAddresses tab

Start

Required; must be an IP address.

End

Required; must be an IP address.


Click the Add button to save the details and list it in Start and End IP list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

HOME-AGENT-IPv6

Table 3-43 lists and describes the fields in the Add Resource Manager List page.

Table 3-43 HOME-AGENT-IPv6 Properties 

Fields
Description

HomeAgentIPv6Addresses tab

Start

Required; must be an IPv6 address.

End

Required; must be an IPv6 address.


Click the Add button to save the details and list it in Start and End IPv6 list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

IP-DYNAMIC

Table 3-44 lists and describes the fields in the Add Resource Manager List page.

Table 3-44 IP-DYNAMIC Properties 

Fields
Description

General tab

Reuse IP for same SessionKey and User

When set to TRUE, this property supports overlapping IP addresses between session managers for VPN users. Default value is FALSE.

Net Mask

Required; must be set to a valid net mask.

Allow Overlapped IP Addresses

When set to TRUE, this property supports overlapping IP addresses between session managers for VPN users. Default value is FALSE.

IP Addresses tab

Start

Required; must be an IP address.

End

Required; must be an IP address.


Click the Add button to save the details and list it in Start and End IP list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

REMOTE-IP-DYNAMIC

Table 3-45 lists and describes the fields in the Add Resource Manager List page.

Table 3-45 REMOTE-IP-DYNAMIC Properties 

Fields
Description

General tab

Reuse IP for same SessionKey and User

When set to TRUE, this property supports overlapping IP addresses between session managers for VPN users. Default value is FALSE.

Net Mask

Required; must be set to a valid net mask.

Allow Overlapped IP Addresses

When set to TRUE, this property supports overlapping IP addresses between session managers for VPN users. Default value is FALSE.

IP Addresses tab

Start

Required; must be an IP address.

End

Required; must be an IP address.


Click the Add button to save the details and list it in Start and End IP list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

IP-PER-NAS-PORT

Table 3-46 lists and describes the fields in the Add Resource Manager List page.

Table 3-46 IP-PER-NAS-PORT Properties 

Fields
Description

General tab

Net Mask

Required; if used, must be set to a valid net mask.

Allow Overlapped IP Addresses

When set to TRUE, this property supports overlapping IP addresses between session managers for VPN users. Default value is FALSE.

NAS

Required; must be the name of a known Client.This value must be the same as the NAS-Identifier attribute in the Access-Request packet.

IP Config tab

Start

Required; must be an IP address.

End

Required; must be an IP address.

Port Config tab

Start

Required; set the NAS port

End

Required; set the NAS port


Click the Add button to save the details and list it in Start and End IP list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

IPX-DYNAMIC

Table 3-47 lists and describes the fields in the Add Resource Manager List page.

Table 3-47 IPX-DYNAMIC Properties 

Fields
Description

Networks tab

Start

Required; must be an IP address.

End

Required; must be an IP address.


Click the Add button to save the details and list it in Start and End IP list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

SESSION-CACHE

Table 3-48 lists and describes the fields in the Add Resource Manager List page.

Table 3-48 SESSION-CACHE Properties 

Fields
Description

General tab

Overwrite Attributes

Specifies whether to overwrite the existing attributes if there are any in the session record.

Query Key

Required; set the QueryKey to the a RADIUS attribute you want to key on, such as Framed-IP-Address.

A change made in Cisco AR 4.0 requires that this attribute not be an XML attribute, even if this session-cache resource manager is being used for an XML query.

Note Any existing session-cache resource managers using an XML attribute for the Query Key must be changed to a RADIUS attribute that this XML attribute is mapped to under QueryMappings.

Pending Removal Delay

Required; length of time information remains in the cache after the session ends (defaults to 10 seconds)

Query Mapping tab

XML Attribute

Set the QueryKey property to the XML attribute you want to key on such as XML-Address-format-IPv4 and list all attributes to be cached in the AttributesToBeCached subdirectory.

Radius Attribute

Required; list of attribute pairs, mapping the XML attributes on the left-hand side to the RADIUS attribute on the right-hand side.

AttributeToBeCached tab

RADIUS

Optional; set Radius, if the attribute needs to be defined for Radius.

VENDOR

Optional; set Vendor, if the attribute needs to be defined for Vendor. If Vendor is selected, specify the vendor type from the drop-down list.

Attribute Name

Required; use this subdirectory to provide a list of RADIUS attributes you want to store in cache


Click the Add button to save the details and list it in Start and End IP list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

SUBNET-DYNAMIC

Table 3-49 lists and describes the fields in the Add Resource Manager List page.

Table 3-49 SUBNET-DYNAMIC Properties 

Fields
Description

Subnet Dynamic tab

Net Mask

Required; must be set to the size of the managed subnets

Start

Required; must be an IP addresses

End

Required; must be an IP addresses


Click the Add button to save the details and list it in Start and End IP list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

USER-SESSION-LIMIT

Table 3-50 lists and describes the fields in the Add Resource Manager List page.

Table 3-50 USER-SESSION-LIMIT Properties 

Fields
Description

User Session Limit

Set the user session limit property to the maximum number of concurrent sessions for a particular user


REMOTE-USER-SESSION-LIMIT

Table 3-51 lists and describes the fields in the Add Resource Manager List page.

Table 3-51 REMOTE-USER-SESSION-LIMIT Properties 

Fields
Description

User Session Limit

Set the user session limit property to the maximum number of concurrent sessions for a particular user


USR-VPN

Table 3-52 lists and describes the fields in the Add Resource Manager List page.

Table 3-52 USR-VPN Properties 

Fields
Description

General tab

Identifier

Required; must be set to the VPN ID the USR NAS will use to identify a VPN.

Neighbor

Optional; if set, should be the IP address of the next hop router for the VPN.

Framed Routing

Optional; if set, should be RIP V2 Off or RIP V2 On if the USR NAS is to run RIP Version 2 for the user.

Gateway tab

Name of Gateway

Required; name of the gateway.

Description (optional)

Optional; description of the gateway.

IP Address

Required; IP address of the gateway

Shared Secret

Required; must match the shared secret of the gateway.

Tunnel Refresh

Optional; if specified it is the number of seconds the tunnel stays active before a secure "keepalive" is exchanged between the tunnel peers in order to maintain the tunnel open.

Location ID

Optional; if specified it is a string indicating the physical location of the gateway. Click the Save button, to save the details.


To edit the gateway details, check the appropriate check box and click the Edit button. Enter new information in the editable fields and click the Save button. You can also delete the record using Delete button.

REMOTE-SESSION-CACHE

Table 3-53 lists and describes the fields in the Add Resource Manager List page.

Table 3-53 REMOTE-SESSION-CACHE Properties 

Fields
Description

General tab

Overwrite Attributes

Specifies whether to overwrite the existing attributes if there are any in the session record.

Query Key

Required; set the QueryKey to the a RADIUS attribute you want to key on, such as Framed-IP-Address.

A change made in Cisco AR 4.0 requires that this attribute not be an XML attribute, even if this session-cache resource manager is being used for an XML query.

Note Any existing session-cache resource managers using an XML attribute for the Query Key must be changed to a RADIUS attribute that this XML attribute is mapped to under QueryMappings.

Pending Removal Delay

Required; length of time information remains in the cache after the session ends (defaults to 10 seconds)

Remote Query Mapping tab

XML Attribute

Set the QueryKey property to the XML attribute you want to key on such as XML-Address-format-IPv4 and list all attributes to be cached in the AttributesToBeCached subdirectory.

Radius Attribute

Required; list of attribute pairs, mapping the XML attributes on the left-hand side to the RADIUS attribute on the right-hand side.

RemoteAttributeToBeCached tab

RADIUS

Optional; set Radius, if the attribute needs to be defined for Radius.

VENDOR

Optional; set Vendor, if the attribute needs to be defined for Vendor. If Vendor is selected, specify the vendor type from the drop-down list.

Attribute Name

Required; use this subdirectory to provide a list of RADIUS attributes you want to store in cache


Click the Add button to save the details. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Note Resource Manager supports the following remote type session managers: remote-ip-dynamic, remote-session-cache, home-agent, remote-user-session-limit, home-agent-ipv6 and remote-group-session-limit.


Editing Resource Manager Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the resource manager details, check the appropriate check box and click the Edit button. To modify the resource manager details, enter new information in the editable fields and click the Submit button. If the modification is successful, Cisco AR returns you to the Resource Manager List page. If the modification is not successful, Cisco AR displays an error message.

Network Resources

Network Resources constitutes the maintenance and management of the details of the clients and remote servers. The clients IP address and shared secret details are maintained under clients, The management of server directory with use of remote server protocols details are maintained in remote server.

This section describes the following:

Clients

Remote Servers

Clients

All NASs and proxy clients that communicate directly with Cisco AR must have an entry in the Clients list. This is required because NAS and proxy clients share a secret with the RADIUS server which is used to encrypt passwords and to sign responses.

Use the Clients page for the following:

Filtering Records

Adding Client Details

Editing Client Details

Deleting Records

Adding Client Details

To add new Client details, choose Network Resources > Clients. The Clients page appears.

Click the Add button to add new Client details. The Add Clients page appears. Table 3-54 lists and describes the fields in the Add Clients page.

Table 3-54 Client Properties 

Fields
Description

Name

Required and should match the Client identifier specified in the standard RADIUS attribute, NAS-Identifier. The name must be unique within the Clients list.

IncomingScript

Optional; you can use this property to specify a Script you can use to determine the services to use for authentication, authorization, and/or accounting.

OutgoingScript

Optional; you can use this property to specify a Script you can use to make any Client-specific modifications when responding to a particular Client.

Protocol

Required; set it to Radius or Diameter.

Description

Optional description of the client.

Vendor

Optional; displays when the protocol is set to Diameter. When set, must be the name of a known Vendor.

Server Identity

Optional; displays when the protocol is set to Diameter. While exchanging the CER information in the client, Cisco AR sends the configured server identity value as the origin-host value. When set, it takes precedence over the /Radius/Advance/Diameter/TransportManagement configuration.

HostName

Required; hostname or IP address of the diameter client.

Port

Required; port on which client connects with the Cisco AR server.

SCTP-Enabled

Required; displays when the protocol is set to Diameter and indicates whether the connection will be an SCTP. If set to TRUE , SCTP will be used. If set to FALSE, TCP will be used.

Server Realm

Optional; displays when the protocol is set to Diameter. While exchanging the CER information in the client, Cisco AR sends the configured server realm value as the origin-realms value. it takes precedence over the /Radius/Advance/Diameter/TransportManagement configuration.

General Properties tab

IPAddress

Required; must be a valid IP address and unique in the Clients list. Cisco AR uses this property to identify the Client that sent the request, either using the source IP address to identify the immediate sender or using the NAS-IP-Address attribute in the Request dictionary to identify the NAS sending the request through a proxy.

When a range is configured for a Client's IPAddress property, any incoming requests whose source address belongs to the range specified, will be allowed for further processing by the server. Similarly when a wildcard (an asterisk `*' in this case) is specified, any incoming requests whose source address matches the wildcard specification will be allowed. In both the cases, the configured client properties like SharedSecret, and Vendor are used to process the requests.

You can specify a range of IP addresses using a hyphen as in:

100.1.2.11-20

You can use an asterisk wildcard to match all numbers in an IP address octet as in:

100.1.2.*

You can specify an IPAddress and a subnet mask together using Classless Inter-Domain Routing (CIDR) notation as in:

100.1.2.0/24

You can use the IPAddress property to set a base address and use the NetMask property to specify the number of clients in the subnet range.

SharedSecret

Required; must match the secret configured in the Client.

Type

Required; accept the default (NAS), or set it to ATM, Proxy, or NAS+Proxy.

Vendor

Optional; you can use this property when you need special processing for a specific vendor's NAS. To use this property, you must configure a Vendor object and include a script. Cisco AR provides five Scripts you can use: one for Ascend, Cisco, Cabletron, Altiga, and one for USR. You can also provide your own Script.

NetMask

Specifies the subnet mask used with the network address setting configured for the IPAdress property when configuring a range of IP addresses.

This property is not used for a single client with an IP address only. The NetMask property is used to configure multiple clients when you configure a base IP address in the IPAddress property. You can set the NetMask property for a range of 256 clients using the following example:

set NetMask 255.255.255.0

Note If you set the NetMask property, validation will fail if you attempt to specify a subnet mask using CIDR notation with the IPAddress property (described above).

Enforce Traffic Throttling

By default, the value is set to FALSE. When set to TRUE, the traffic throttling check for the packet will be executed.

Dynamic Authorization tab

EnableDynamicAuthorization

Optional; when set to TRUE, this property enables Change of Authorization (CoA) and Packet of Disconnect (PoD) features.

Shared Secret

Located under the DynamicAuthorizationServer subdirectory, this is the shared secret used for communicating CoA and PoD packets with the client.

Port

Located under the DynamicAuthorizationServer subdirectory, the default port is 3799.

InitialTimeout

Located under the DynamicAuthorizationServer subdirectory, the default is 5000.

MaxTries

Located under the DynamicAuthorizationServer subdirectory, the default is 3.

COA Attribute

This property is found under the DynamicAuthorizationServer subdirectory and points to a group of attributes to be included in a CoA request sent to this client. These attribute groups are created and configured under the AttributeGroups subdirectory in /Radius/Advanced.

POD Attribute

This property is found under the DynamicAuthorizationServer subdirectory and points to a group of attributes to be included in a POD request sent to this client. These attribute groups are created and configured under the AttributeGroups subdirectory in /Radius/Advanced.

Notification Properties tab

EnableNotifications

Required; the default value is FALSE and indicates the client is not capable of receiving Accounting-Stop notifications from the Cisco AR server.

When set to TRUE, the client can receive Accounting-Stop notifications from the Cisco AR server and additional properties must be configured under a new sub-directory named NotificationProperties.

InitialTimeout

Located under the NotificationProperties subdirectory, specifies the timeout value in milliseconds the Cisco AR server waits for an Accounting-Response packet before attempting a retry (sending another Accounting-Stop packet to the client).

Required when EnableNotifications is set to TRUE; the default value is 5000.

Port

Located under the NotificationProperties subdirectory, specifies the port used by the Cisco AR server to receive Accounting-Stop packets. Required when EnableNotifications is set to TRUE; the default value is 1813.

MaxTries

Located under the NotificationProperties subdirectory, specifies the number of times the Cisco AR server sends an Accounting-Stop packet to a client.

Required when EnableNotifications is set to TRUE; the default value is 3.

NotificationProperties

When the EnableNotifications property is set to TRUE, this subdirectory contains additional properties required to support the Query-Notify feature.

NotificationAttributeGroup

Located under the NotificationProperties subdirectory, specifies the name of an attribute group under /Radius/Advanced/AttributeGroups that contains the attributes to be included when sending an the Accounting-Stop packet to this client.

Required when EnableNotifications is set to TRUE; there is no default value. You must provide the name of a valid AttributeGroup and the named AttributeGroup must contain at least one valid attribute, or validation will fail.


Click the Submit button to save the specified details in the Add Clients page. To return to the Clients page without saving the details, click the Cancel button. On successful creation of the client details, the Clients page is displayed else a respective error message is displayed.

Editing Client Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the Client details, check the appropriate check box and click the Edit button. To modify the Client details, enter new information in the editable fields and click the Save button. If the modification is successful, Cisco AR returns you to the Clients page. If the modification is not successful, Cisco AR displays an error message.

Remote Servers

You can use the RemoteServers object to specify the properties of the remote servers to which Services proxy requests.

Cisco AR 5.1 provides the following RemoteServer protocol types:

LDAP

LDAP Accounting

Domain Authentication

ODBC/OCI

ODBC/OCI-Accounting

Others

LDAP

Specify the ldap service type when you want to use a particular LDAP remote server for authentication and/or authorization.When using LDAP for authentication and a local database for authorization, ensure that the usernames in both locations are identical with regard to case-sensitivity.

Use the LDAP-RemoteServers page for the following:

Filtering Records

Adding LDAP Details

Editing LDAP Details

Deleting Records

Adding LDAP Details

To add new LDAP details, choose Network Resources > RemoteServers > LDAP. The LDAP-RemoteServers page appears.

Click the Add button to add new LDAP details. The Add LDAP-RemoteServers page appears. Table 3-55 lists and describes the fields in the Add LDAP-RemoteServers page.

Table 3-55 LDAP Server Properties 

Fields
Description

LDAP Properties tab

Name

Required; name of the LDAP server

Host Name

Required; the LDAP server's hostname or IP address.

Port

Required; defaults to port 389.

Description

Description of the LDAP server.

Timeout

Required; the default is 15. The timeout property indicates how many seconds the RADIUS server will wait for a response from the LDAP server.

Note Use InitialTimeout from above as a template, except this is timeout is specified in seconds.

Reactivate Time Interval

Required; the amount of time (in milliseconds) to wait before retrying a remote server that was offline. You must specify a number greater than zero. The default is 300,000 (5 minutes).

MaxReferrals

Required; must be a number equal to or greater than zero. This property indicates how many referrals are allowed when looking up user information. When you set this property to zero, no referrals are allowed.

Cisco AR manages referrals by allowing the RADIUS server's administrator to indicate an LDAP "referral attribute," which might or might not appear in the user information returned from an LDAP query. When this information is returned from a query, Cisco AR assumes it is a referral and initiates another query based on the referral. Referrals can also contain referrals.

Note This is an LDAP v2 referral property.

Referral Attribute

Required when you have specified a MaxReferrals value. This property specifies which LDAP attribute, returned from an LDAP search, to check for referral information.

Note This is an LDAP v2 referral property.

Referral Filter

Required when you have specified a MaxReferral value. This is the filter Cisco AR uses when processing referrals. When checking referrals, the information Cisco AR finds in the referral itself is considered to be the search path and this property provides the filter. The syntax is the same as that of the Filter property.

Note This is an LDAP v2 referral property.

Bind Name

Optional; the distinguished name (dn) to use when establishing a connection between the LDAP and RADIUS servers.

Bind Password

Optional; the password associated with the BindName.

Search Path

Required; the path that indicates where in the LDAP database to start the search for user information.

Limit Outstanding Requests

Required; the default is FALSE. Cisco AR uses this property in conjunction with the MaxOutstandingRequests property to tune the RADIUS server's use of the LDAP server.

When you set this property to TRUE, the number of outstanding requests for this RemoteServer is limited to the value you specified in MaxOutstandingRequests. When the number of requests exceeds this number, Cisco AR queues the remaining requests, and sends them as soon as the number of outstanding requests drops to this number.

User Password Attribute

Required; this specifies which LDAP field the RADIUS server should check for the user's password.

Escape Spl.Character in UserName

FALSE by default

Datasource Connections

Specifies the number of concurrent connections to the LDAP server. The default value is 8.

Use SSL

A boolean field indicating whether you want Cisco AR to use SSL (Secure Socket Layer) when communicating with this RemoteServer. When you set it to TRUE, be sure to specify the CertificateDBPath field in the Advanced section, and be sure the port you specified for this RemoteServer is the SSL port used by the LDAP server.

EnableKeepAlive

Default is FALSE. This is enabled to send a TCP keepalive to keep the idle connection active.

Filter

Required; this specifies the search filter Cisco AR uses when querying the LDAP server for user information. When you configure this property, use the notation "%s" to indicate where the user ID should be inserted. For example, a typical value for this property is "(uid=%s)," which means that when querying for information about user joe, use the filter uid=joe.

Max Outstanding Requests

Required when you have set the LimitOutstandingRequests to TRUE. The number you specify, which must be greater than zero, determines the maximum number of outstanding requests allowed for this remote server.

Password Encryption Style

The default is None. You can also specify crypt, dynamic, SHA-1, and SSHA-1.

DNSLookup and LDAP RebindInterval

Specifies the timeout period after which the Cisco AR server will attempt to resolve the LDAP hostname to IP address (DNS resolution); 0 by default

Search Scope

Specifies how deep to search within a search path; default is SubTree which indicates a search of the base object and the entire subtree of which the base object distinguished name is the highest object.

Base indicates a search of the base object only.

OneLevel indicates a search of objects immediately subordinate to the base object, but does not include the base object.

Use Binary Password Comparison

A boolean field that enables binary password comparison for authentication. This property when set to TRUE, enables binary password comparison. By default, this property is set to FALSE.

Use Bind Based Authentication

A boolean field that enables bind-based authentication with LDAP server. By default, this property is set to FALSE. When set to FALSE, it uses existing legacy authentication method.

On setting this property to TRUE, the mappings LDAPToRadius, LDAPToEnvironment, and LDAPToCheckItem will not work.

LDAPToRadiusMappings tab

LDAPAttribute

Set the value for the LDAP attribute

RadiusAttribute

A list of name/value pairs in which the name is the name of the ldap attribute to retrieve from the user record, and the value is the name of the RADIUS attribute to set to the value of the ldap attribute retrieved.

For example, when the LDAPToRadiusMappings has the entry: FramedIPAddress = Framed-IP-Address, the RemoteServer retrieves the FramedIPAddress attribute from the ldap user entry for the specified user, uses the value returned, and sets the Response variable Framed-IP-Address to that value.

Click the Add button to save the details and list it in the attribute list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

LDAPToCheckItems Mappings tab

Attribute Type

Select either RADIUS or VENDOR. If Vendor is selected, specify the vendor type from the drop-down list.

LDAPAttribute

Set the value for the LDAP attribute

CheckedItems

A list of LDAP attribute/value pairs which must be present in the RADIUS access request and must match, both name and value, for the check to pass.

For example, when the LDAPToCheckItemMappings has the entry: group = User-Group, the Access Request must contain the attribute group, and it must be set to User-Group.

Click the Add button to save the details and list it in the attribute list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

LDAPToEnvironmentalMappings tab

LDAPAttribute

Set the value for the LDAP attribute

EnvironmentalAttribute

A list of name/value pairs in which the name is the name of the ldap attribute to retrieve from the user record, and the value is the name of the Environment variable to set to the value of the ldap attribute retrieved.

For example, when the LDAPToEnvironmentMappings has the entry: group = User-Group, the RemoteServer retrieves the group attribute from the ldap user entry for the specified user, uses the value returned, and sets the Environment variable User-Group to that value.

Click the Add button to save the details and list it in the attribute list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Click the Save LDAP Server button to save the specified details in the Add LDAP-RemoteServers page. To return to the LDAP-RemoteServers page without saving the details, click the Cancel button. On successful creation of the LDAP details, the LDAP-RemoteServers page is displayed else a respective error message is displayed.

Editing LDAP Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the LDAP details, check the appropriate check box and click the Edit button. To modify the LDAP details, enter new information in the editable fields and click the Save LDAP Server button. If the modification is successful, Cisco AR returns you to the LDAP-RemoteServers page. If the modification is not successful, Cisco AR displays an error message.

LDAP Accounting

Previous releases of Cisco AR supported accessing user data from an LDAP server, but this feature was limited to performing authentication and authorization (AA). You could only write the accounting records to local file or oracle database or proxy to another RADIUS server. Cisco AR supports writing accounting records into LDAP server enabling integration between billing systems and LDAP.

Use the LDAP Accounting-RemoteServers page for the following:

Filtering Records

Adding LDAP Accounting Details

Editing LDAP Accouting Details

Deleting Records

Adding LDAP Accounting Details

To add new LDAP accounting details, choose Network Resources > RemoteServers > LDAP Accounting. The LDAP Accounting-RemoteServers page appears.

Click the Add button to add new LDAP accounting details. The Add LDAP Accounting-RemoteServers page appears. Table 3-56 lists and describes the fields in the LDAP Accounting-RemoteServers page.

Table 3-56 LDAP Accounting Server Properties 

Fields
Description

LDAP Acct Properties tab

Name

Name of the remote server; this property is mandatory, and there is no default.

Description

Optional description of server.

HostName

Required; the LDAP server's hostname or IP address.

Port

Required; the default value is 389. Port the LDAP server is listening on.

Timeout

Mandatory time interval (in seconds) to wait for LADP-write operation to complete; defaults to 15 seconds.

ReactivateTimerInterval

Mandatory time interval (in milliseconds) to activate an inactive server; defaults to 300000 ms.

BindName

Optional; the distinguished name (dn) to use when establishing a connection between the LDAP and RADIUS servers.

EnableKeepAlive

Required; default is FALSE. This is enabled to send a TCP keepalive to keep the idle connection active.

Delimiter

Character used to separate the values of the attributes given in AttributeList property.

LDAPEnvironmentMultiValueDelimiter

Optional; allows you to specify a character that separates multi-valued attribute lists when using ldap-accounting.

BindPassword

Optional; the password associated with the BindName.

DnPath

Required; the path that indicates where in the LDAP database to start the write for user information.

EntryName

Required; this specifies the write entry name Cisco AR uses when insetting the LDAP server for user information. When you configure this property, use the notation "%s" to indicate where the user ID should be inserted. For example, a typical value for this property is "(uid=%s)," which means that when insetting for information about user joe, use the fentry name uid=joe.

LimitOutstandingRequests

Required; the default is FALSE. Cisco AR uses this property in conjunction with the MaxOutstandingRequests property to tune the RADIUS server's use of the LDAP server.

When you set this property to TRUE, the number of outstanding requests for this RemoteServer is limited to the value you specified in MaxOutstandingRequests. When the number of requests exceeds this number, Cisco AR queues the remaining requests, and sends them as soon as the number of outstanding requests drops to this number.

MaxOutstandingRequests

Required when you have set the LimitOutstandingRequests to TRUE. The number you specify, which must be greater than zero, determines the maximum number of outstanding requests allowed for this remote server.

ObjectClass

Required; list of object classes which are all schemas defined in LDAP server. These schemas define required attributes and allowed attributes for an entry which is inserted from Cisco AR.

DNSLookup and LDAPAcct RebindInterval

Specifies the timeout period after which the Cisco AR server will attempt to resolve the LDAP hostname to IP address (DNS resolution).

Escape Spl.Character in UserName

FALSE by default.

AttributeList

List of comma-separated attribute names.

Datasource Connections

Mandatory number of connections to be established; defaults to 8.

UseLocalTimeZone

Optional; the default is FALSE. It determines the timezone of accounting records TimeStamp.

UseSSL

A boolean field indicating whether you want Cisco AR to use SSL (Secure Socket Layer) when communicating with this RemoteServer. When you set it to TRUE, be sure to specify the CertificateDBPath field in the Advanced section, and be sure the port you specified for this RemoteServer is the SSL port used by the LDAP server.

AttributestoWrite tab

LDAPAcctAttribute

Set the LDAP Accounting attribute.

EnvironmentalAttribute

A list of name and value pairs in which the name is the name of the data store attribute to retrieve from the user record, and the value is the name of the RADIUS attribute to set to the value of the data store attribute retrieved. The data store attributes must match those defined in the external SQL file.

Click the Add button to save the details and list it in the Attributes list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Click the Add LDAP-Accounting Server button to save the specified details in the Add LDAP Accounting-RemoteServers page. To return to the LDAP Accounting-RemoteServers page without saving the details, click the Cancel button. On successful creation of the LDAP accounting details, the LDAP Accounting-RemoteServers page is displayed else a respective error message is displayed.

Editing LDAP Accouting Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the LDAP Accounting details, check the appropriate check box and click the Edit button. To modify the LDAP Accounting details, enter new information in the editable fields and click the Edit LDAP-Accounting Server button. If the modification is successful, Cisco AR returns you to the LDAP Accounting-RemoteServers page. If the modification is not successful, Cisco AR displays an error message.

Domain Authentication

The Domain Authentication service type, domain-auth, is used with a Remote Server of the same type to provide support for authentication against Windows Domain Controller/Active Directory (WDC/AD).

Use the Domain Authentication-RemoteServers page for the following:

Filtering Records

Adding Domain Authentication Details

Editing Domain Authentication Details

Deleting Records

Adding Domain Authentication Details

To add new domain authentication details, choose Network Resources > RemoteServers > Domain Authentication. The Domain Authentication-RemoteServers page appears.

Click the Add button to add new domain authentication details. The Add Domain Authentication-RemoteServers page appears. Table 3-57 lists and describes the fields in the Add Domain Authentication-RemoteServers page.

Table 3-57 Domain Authentication Server Properties 

Fields
Description

General Properties tab

Name

Required; name of the domain authentication server.

Host Name

Required; hostname or IP address of the remote server.

Port

Required; port used for communication with WDC/AD; defaults to 2004.

Default Domain

Species the default domain for authentication if the user does not include a domain during log in. Otherwise, authentication is performed on the local domain.

Agent Connections

Required; default is 15. Represents the total number of connections Cisco AR can open with the CSRA.

Description

Optional; description of the domain authentication server.

Timeout

Required; defaults to 15.

Reactivate Time Interval

Required; default is 300,000 milliseconds. Specifies the length of time to wait before attempting to reconnect if a thread is not connected to a data source.

Workstation

Optional; if a user has this workstation property set to some value, in Active Directory, then during authentication, AD will check with the CLI workstation value of AR. Only if they match authentication will succeed.

If this workstation value is not set in AD, no comparison with CLI workstation field happens.

Default Usergroup

User group to be used when no mapping is found in the list of maps in the GroupMap property or when there is no hit in the groups listed in GroupMaps. The DefaultUserGroup is used to authorize users that are authenticated by this domain-auth RemoteServer.

GroupMaps tab

AR UserGroup

Select a user group from the drop-down list.

AD UserGroups

A list of groups to which the user belongs in the WDC/AD mapped to an internal group in the Cisco AR server. Entries are of the form:

1. "InternalGroup1 = ExternalGroup1, ExternalGroup2, ..."

2. "InternalGroup2 = ExternalGroup3, ExternalGroup4, ..."

To configure group mappings, use the following syntax:

set 1 "Group1 = ExternalGroup1,ExternalGroup2, ExternalGroup3"

Click the Add button to save the details and list it in the attribute list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


Click the Add Domain-Auth Server button to save the specified details in the Add Domain Authentication-RemoteServers page. To return to the Domain Authentication-RemoteServers page without saving the details, click the Cancel button. On successful creation of the domain authentication details, the Domain Authentication-RemoteServers page is displayed else a respective error message is displayed.

Editing Domain Authentication Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the domain authentication details, check the appropriate check box and click the Edit button. To modify the domain authentication details, enter new information in the editable fields and click the Edit Domain-Auth Server button. If the modification is successful, Cisco AR returns you to the Domain Authentication-RemoteServers page. If the modification is not successful, Cisco AR displays an error message.

ODBC/OCI

Specify odbc or oci when you want to use an ODBC or OCI service for authentication, authorization and accounting through an ODBC or OCI data store respectively. Use an ODBC or OCI service to authenticate and authorize an access requests by querying user information through ODBC or OCI and to insert accounting records into a data store through ODBC or OCI.


Note The ODBC service supports MYSQL and Oracle database service and OCI supports Oracle with 10.2.0 to 11.2.0 Oracle client.


Use the ODBC/OCI-RemoteServers page for the following:

Filtering Records

Adding ODBC/OCI Details

Editing ODBC/OCI Details

Deleting Records

Adding ODBC/OCI Details

To add new ODBC or OCI details, choose Network Resources > RemoteServers > ODBC/OCI. The ODBC/OCI-RemoteServers page appears.

Click the Add button to add new ODBC or OCI details. The Add ODBC/OCI-RemoteServers page appears. Table 3-58 lists and describes the fields in the Add ODBC/OCI-RemoteServers page.

Table 3-58 ODBC/OCI Server Properties 

Fields
Description

Name

Required; name of the ODBC/OCI Server.

Protocol

The type of remote server. You select the option ODBC or OCI from the dropdown list.

Datasource Connections

Required; default is 8. This represents the total number of connections Cisco AR can open with the ODBC server; total number of threads Cisco AR can create for the ODBC server.

ODBC Datasource Name

Required; name of the ODBCDataSource to use and must refer to one entry in the list of ODBC datasources configured under /Radius/Advanced/ODBCDataSources.

User Password Attribute

Set the user password.

SNMPTrapIP

The SNMP trap IP for the remote servers.

Description

Description of the ODBC Server

Timeout

Required; the default is 15. The timeout property indicates how many seconds the RADIUS server will wait for a response from the ODBC server.

Note Use InitialTimeout from above as a template, except this is timeout is specified in seconds.

Reactivate Time Interval

Required; default is 300,000 milliseconds. Length of time to wait before attempting to reconnect if a thread is not connected to a data source.

Keep Alive Timer Interval

Mandatory time interval (in milliseconds) to send a keepalive to keep the idle connection active; defaults to zero (0) meaning the option is disabled

SNMPTrapPort

The SNMP trap port for the remote server; defaults to 1521.

SQL Definitions tab

Name

SQLDefinition properties define the SQL you want to execute.

Description

Description of the SQL

Type

Cisco AR supports only type query.

SQL

SQL query used to add, update or delete a record from a database

Execution SequenceNumber

Sequence number for SQLStatement execution, must be greater than zero (mandatory, no default)

Marker List

Defines all markers for the query. MarkerList uses the format UserName/SQL_DATA_TYPE.

RadiusMappings tab

ODBC/OCI Attribute

Set the ODBC or OCI attribute

RADIUS Attribute

A list of name and value pairs in which the name is the name of the data store attribute to retrieve from the user record, and the value is the name of the RADIUS attribute to set to the value of the data store attribute retrieved. The data store attributes must match those defined in the external SQL file.

Click the Add button to save the details and list it in the Attributes list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

CheckItemsMappings tab

Attribute Type

Select either RADIUS or VENDOR. If Vendor is selected, specify the vendor type from the drop-down list.

ODBC/OCI Attribute

Set the ODBC or OCI attribute

CheckItem

A list of ODBC attribute/value pairs.

Click the Add button to save the details and list it in the Attributes list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.

EnvironmentalMappings tab

ODBC/OCI Attribute

Set the ODBC or OCI attribute

Environmental Attribute

A list of name/value pairs in which the name is the name of the data store attribute to retrieve from the user record, and the value is the name of the Environment variable to set to the value of the ODBC attribute retrieved.

Click the Add button to save the details and list it in the Attributes list. To navigate between the listed attributes, use the navigation option available adjacent to the list. See Relocating Records for more details. To delete the available attributes, select the relevant attribute and click the Delete button below.


To add SQL details, click the Add button in SQL Definitions tab. Enter the required details and click the Save button.

Click the Add Server button to save the specified details in the Add ODBC/OCI-RemoteServers page. To return to the ODBC/OCI-RemoteServers page without saving the details, click the Cancel button. On successful creation of the ODBC or OCI details, the ODBC/OCI-RemoteServers page is displayed else a respective error message is displayed.

Editing ODBC/OCI Details

To edit SQL details, check the appropriate check box and click the Edit button in SQL Definitions tab. Enter new information in the editable fields and click the Save button.

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the ODBC or OCI details, check the appropriate check box and click the Edit button. To modify the ODBC or OCI details, enter new information in the editable fields and click the Add Server button. If the modification is successful, Cisco AR returns you to the ODBC/OCI-RemoteServers page. If the modification is not successful, Cisco AR displays an error message.

ODBC/OCI-Accounting

If you use the Oracle Accounting feature, you must configure an ODBC/OCI-Accounting RemoteServer object.

Use the ODBC/OCI Accounting-RemoteServers page for the following:

Filtering Records

Adding ODBC/OCI Accounting Details

Editing ODBC/OCI Accounting Details

Deleting Records

Adding ODBC/OCI Accounting Details

To add new ODBC accounting details, choose Network Resources > RemoteServers > ODBC/OCI Accounting. The ODBC/OCI Accounting-RemoteServers page appears.

Click the Add button to add new ODBC or OCI accounting details. The Add ODBC/OCI Accounting-RemoteServers page appears. Table 3-59 lists and describes the fields in the Add ODBC/OCI Accounting-RemoteServers page.

Table 3-59 ODBC/OCI Accounting Server Properties 

Fields
Description

General Properties tab

Name

Name of the remote server; this property is mandatory, and there is no default.

Protocol

The type of Accounting remote server. You can select the option odbc-accounting or oci-accounting from the drop-down list.

Datasource Connections

Mandatory number of connections to be established; defaults to 8

ODBC Datasource Name

Name of the ODBCDataSource to use and must refer to one entry in the list of ODBC datasources configured under /Radius/Advanced/ODBCDataSources. Mandatory; no default

Buffer Accounting Packets

Mandatory, TRUE or FALSE, determines whether to buffer the accounting packets to local file, defaults to TRUE which means that packet buffering is enabled.

Note When set to TRUE, a constant flow of incoming accounting packets can fill the buffer backing store files in /cisco-ar/data/odbc beyond the size configured in MaximumBufferFileSize. Configure BackingStoreDiscThreshold in /Radius/Advanced when using ODBC accounting.

Max. Buffer Filesize

Mandatory if BufferAccountingPackets is set to TRUE, determines the maximum buffer file size, defaults to 10 Megabyte)

Backing Store Environment Variables

Optional; when BufferAccountingPackets is set to TRUE, contains a comma-separated list of environment variable names to be stored into a local file along with buffered packet. No default. BackingStoreEnvironmentVariables can also be specified in scripts using the BackingStoreEnvironmentVariables environment variable.

Attribute List

List of comma-separated attribute names.

SNMPTrapIP

Optional; when set to a valid IP address, the traps (responding/not responding traps) for the ODBC/OCI Accounting server will have this IP address. This is used to identify the server. If the value is not set, SNMP traps use 255.255.255.255 as the IP address.

Description

Optional; description of server.

Timeout

Mandatory time interval (in seconds) to wait for SQL operation to complete; defaults to 15 seconds.

Reactivate Time Interval

Mandatory time interval (in milliseconds) to activate an inactive server; defaults to 300000 ms.

Keep Alive Timer Interval

Mandatory time interval (in milliseconds) to send a keepalive to keep the idle connection active; defaults to zero (0) meaning the option is disabled.

No. of Retries for Buffered Packet

Mandatory if BufferAccountingPackets is set to TRUE. A number greater than zero determines the number of attempts to be made to insert the buffered packet into Oracle. Defaults to 3.

Use Local Timezone

Set to TRUE or FALSE, determines the timezone of accounting records' TimeStamp (defaults to FALSE).

Delimiter

Character used to separate the values of the attributes given in AttributeList property.

SNMPTrapPort

Optional; when set to a valid port, the traps (responding/not responding traps) for the ODBC/OCI Accounting server will have this port. If the value is not set, SNMP traps use 1521 as the IP port.

SQL Definitions tab

Name

Required; SQLDefinition properties define the SQL you want to execute.

Description

Description of the SQL

Type

Required; Cisco AR supports insert, update and delete options.

SQL

Required; SQL query used to acquire the password

Execution SequenceNumber

Required; sequence number for SQLStatement execution, must be greater than zero (mandatory, no default)

Marker List

Required; defines all markers for the query. MarkerList uses the format UserName/SQL_DATA_TYPE.


To add SQL details, click the Add button in SQL Definitions tab. Enter the required details and click the Save button.

Click the Add Accounting Server button to save the specified details in the Add ODBC/OCI Accounting-RemoteServers page. To return to the ODBC/OCI Accounting-RemoteServers page without saving the details, click the Cancel button. On successful creation of the ODBC or OCI accounting details, the ODBC/OCI Accounting-RemoteServers page is displayed else a respective error message is displayed.

Editing ODBC/OCI Accounting Details

To edit SQL details, check the appropriate check box and click the Edit button in SQL Definitions tab. Enter new information in the editable fields and click the Save button.

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the ODBC or OCI accounting details, check the appropriate check box and click the Edit button. To modify the ODBC or OCI accounting details, enter new information in the editable fields and click the ADD Accounting Server button. If the modification is successful, Cisco AR returns you to the ODBC/OCI Accounting-RemoteServers page. If the modification is not successful, Cisco AR displays an error message.

Others

This feature of GUI allows you in setting other specifications.

The various types of protocols are:

Radius

Dynamic DNS

Map-Gateway

Prepaid-CRB

Prepaid IS 835C

Sigtran

Use the RemoteServers page allows for the following:

Filtering Records

Setting Other Specifications

Editing Other Specifications

Deleting Records

Setting Other Specifications

To add other specifications, choose Network Resources > RemoteServers > Others. The RemoteServers page appears.

Click the Add button to add other specifications. The Add RemoteServers page appears. Table 3-60 lists and describes the fields in the Add RemoteServers page. The fields listed below are the entire list of all the available protocols. The fields are displayed based on the type of protocol selected.

Table 3-60 Other Server Properties 

Fields
Description

Name

Required; name of the server.

Description

Optional; description of the server.

IP Address

Required; this property specifies where to send the proxy request. It is the address of the remote server. You must set it to a valid IP address.

Port

By default, Cisco AR listens on ports 1645.

Protocol

Required; the port to which Cisco AR sends proxy requests. You must specify a number greater than zero. If there is no default port number, you must supply the correct port number for your remote server.

If you set a port to zero, Cisco AR sets the port to the default value for the type of remote server being configured.

ReactivateTimerInterval

Mandatory time interval (in milliseconds) to activate an inactive server; defaults to 300000 ms.

MaxTries

Number of times the server tries to send dynamic updates to a server.

Initial Timeout

Time, in milliseconds, that the server waits for a response before retrying a request.

SharedSecret

Required; the secret shared between the remote server and the RADIUS server.

Vendor

Optional; when set, must be the name of a known Vendor.

IncomingScript

Optional; when set, must be the name of a known incoming script. Cisco AR runs the IncomingScript after it receives the response.

OutGoingScript

Optional; when set, must be the name of a known outgoing script. Cisco AR runs the OutgoingScript just before it sends the proxy request to the remote server.

AccountingPort

Port where the RADIUS server sends accounting packets.

AcknowledgeAccounting

When ACKAccounting is TRUE, the Cisco AR server waits for the Accounting-Response from the remote RADIUS server before sending the corresponding Accounting-Response to the client.

When ACKAccounting is FALSE, the Cisco AR server does not wait for the Accounting-Response and immediately returns an Accounting-Response to the client.

Accept Dynamic Authorization Requests

The value is set to False, by default.

MaxRename Retries

Number of times that the resource managers can try to add a host even if it detects that the host's name is already present. This controls the number of times Cisco AR tries to modify a host's name to resolve a conflict on each failed update.

Trim HostName

Controls whether Cisco AR trims the hostname string to the first period character. If this attribute is enabled, the hostname is truncated before the period. If disabled, the server retains the period characters in the hostname.

FwdZoneTSIG

Server-wide security key to process all forward zone dynamic DNS updates. This is used if a ForwardZoneTSIGKey was not specified on the Resource Manager.

ReverseZoneTSIG

Server-wide security key to process all reverse zone dynamic DNS updates. This is used if a ReverseZoneTSIGKey was not specified on the Resource Manager.

File Name

Name of the shared library provided by the billing server vendor, such as libprepaid.so

Connections

Number of threads the prepaid service and billing server can each use (default is 8).

Host Name

Required; hostname of the remote server.

Local Sub System Number

Required; the default value for this property is 0. This represents the subsystem number used by SUA user.

CgPA Global Title Address

Required; represents the Global Title Address of CallingPartyAddress.

Set OPC In CgPA

Required; if it is set to TRUE, OPC will be used in CallingPartyAddress.

CdPANumberingPlan

Required; used to specify the numbering plan of the called party. The default vaue is 7.

CgPANumberingPlan

Required; used to specify the numbering plan of the calling party. The default vaue is 7.

Global Title Translation Script

This is used to specify the name of script which is responsible for translating IMSI to GTA.

SUA Configuration Filename

Required; used to specify the name of configuration file for SUA stack initialization.

Max Outstanding Requests

This represents the maximum outstanding request to HLR.

Timeout

Required; represents the how long the remote server should wait before marking the request as timedout.

Limit Outstanding Requests

Limits the outstanding request to HLR when it is set to TRUE.


Click the Add button to save the specified details in the Add RemoteServers page. To return to the RemoteServers page without saving the details, click the Cancel button. On successfully adding other specifications, the RemoteServers page is displayed else a respective error message is displayed.

Editing Other Specifications

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the specifications, check the appropriate check box and click the Edit button. To modify the specifications, enter new information in the editable fields and click the Edit button. If the modification is successful, Cisco AR returns you to the RemoteServers page. If the modification is not successful, Cisco AR displays an error message.

Administration

Administration constitutes the maintenance and management of details specific administrator, various statistical data respective to the administrators, backing up and restoring server details and license management of the server.

This section describes the following:

Administrators

Statistics

Diameter Statistics

Backup and Restore

License Upload

Administrators

Cisco AR provided super-user administrative access in which administrator can perform all tasks including starting and stopping the system and changing the configuration. Cisco AR also provides view-only administrative access. View-only access restricts an administrator to only being

able to observe the system and prevents that user from making changes.

Use the Administrators page for the following:

Filtering Records

Adding Administrator Details

Editing Administrator Details

Deleting Records

Adding Administrator Details

To add new Administrator details, choose Administration > Administrators. The Administrators page appears.

Click the Add button to add new Administrator details. The Add Administrators page appears. Table 3-61 lists and describes the fields in the Add Administrators page.

Table 3-61 Administrator Properties 

Fields
Description

Name

Required; administrator's user ID.

Description

Optional; description of the administrator.

New Password

Required; encrypted password of the administrator.

Confirm New Password

Required; encrypted password of the administrator and must match Password.

View Only

Default value (FALSE) indicates that the administrator is able to modify the configuration. When set to TRUE, the administrator can only view the server configuration and set the change the server trace level.


Click the Submit button to save the specified details in the Add Administrators page. To return to the Administrators page without saving the details, click the Cancel button. On successful creation of the Administrator details, the Administrators page is displayed else a respective error message is displayed.

Editing Administrator Details

To locate a record that has to be edited, use the filter option. See Filtering Records for more details on filtering the records. To edit the Administrator details, check the appropriate check box and click the Edit button. To modify the Administrator details, enter new information in the editable fields and click the Edit button. If the modification is successful, Cisco AR returns you to the Administrators page. If the modification is not successful, Cisco AR displays an error message.

Statistics

This feature provides statistical information on the specified server.

Table 3-62 lists the statistics information and the meaning of the values.

Table 3-62 aregcmd stats Information 

Stats Value
Meaning

serverStartTime

Indicates the start time of the server.

serverResetTime

Indicates the time when the server was reloaded.

serverStat

Indicates if the server is running or stopped.

totalPacketsInPool

Number of packets that can be accommodated in the pool.

totalPacketsReceived

Number of packets that are received by radius server.

totalPacketsSent

Number of packets that are sent by radius server.

totalRequests

Number of requests received by radius server. This includes access requests and accounting requests.

totalResponses

Number of responses sent by radius server. This includes access accepts/rejects and accounting responses.

totalAccessRequests

Number of access requests received/processed by radius server.

totalAccessAccepts

Number of access accepts sent by radius server.

totalAccessChallenges

Number of access challenges sent by radius server.

totalAccessRejects

Number of access rejects sent by radius server.

totalAccessResponses

Number of access responses sent by radius server.

totalAccountingRequests

Number of accounting requests received by radius server.

totalAccountingResponses

Number of accounting responses sent by radius server.

totalStatusServerRequests

Number of status server request received by radius server.

totalAscendIPAAllocateRequests

Number of requests received related to Ascend IP address allocation.

totalAscendIPAAllocateResponses

Number of responses sent related to Ascend IP Address Allocation.

totalAscendIPAReleaseRequests

Number of requests received related to Ascend IP Address release.

totalAscendIPAReleaseResponses

Number of responses sent related to Ascend IP Address release.

totalUSRNASRebootRequests

Number of user NAS reboot request received by radius server.

totalUSRNASRebootResponses

Number of user NAS reboot response sent by radius server.

totalUSRResourceFreeRequests

Number of user resource free request received by radius server.

totalUSRResourceFreeResponses

Number of user resource free response sent by radius server.

totalUSRQueryResourceRequests

Number of user query resource request received by radius server.

totalUSRQueryResourceResponses

Number of user query resource response sent by radius server.

totalUSRQueryReclaimRequests

Number of user query reclaim request received by radius server.

totalUSRQueryReclaimResponses

Number of user query reclaim response sent by radius server.

totalPacketsInUse

Number of packets that are being used.

totalPacketsDrained

Number of packets that are drained.

totalPacketsDropped

Number of packets that are dropped.

totalPayloadDecryptionFailures

Number of failures due to payloads decryption.

RemoteServer statistics for:

Provides server's type, name, IP address, and port used.

active

Indicates whether the server was active (not in a down state).

maxTries

Number of retry attempts to be made by the RemoteServer Object based on the RemoteServer's maxTries property setting .

RTTAverage

Average round trip time since the last server restart.

RTTDeviation

Indicates a standard deviation of the RTTAverage.

TimeoutPenalty

Indicates any change made to the initial timeout default value.

totalRequestsPending

Number of requests currently queued.

totalRequestsSent

Number of requests sent since the last server restart.

Note totalRequestsSent should equal the sum of totalRequestsOutstanding and totalRequestsAcknowledged.

totalRequestsOutstanding

Number of requests currently proxied that have not yet returned

totalRequestsTimedOut

Number of requests that have timed out since last server restart or number requests not returned from proxy server within the [configured] initial timeout interval.

totalRequestsAcknowledged

Number of responses received since last server restart

totalResponsesDroppedForNotInCache

Number of responses dropped because their ID did not match the ID of any Pending requests.

totalResponsesDroppedForSignatureMismatch

Number of responses dropped because their response authenticator did not decode to the correct shared secret.

totalRequestsDroppedAfterMaxTries

Number of requests dropped because no response was received after retrying the configured number of times. This value is different from totalRequestsTimedOut because using the default configuration values, no response within 2000 ms bumps the TimedOut counter, but it waits 14000 ms (2000 + 4000 + 8000) to bump this counter.

lastRequestTime

Date and time of last proxy request.

lastAcceptTime

Date and time of last ACCEPT response to a client.


Click the Reset button, to reset all the server statistics.

Diameter Statistics

Cisco AR 5.1 supports statistic of Diameter messages through the CLI/GUI and SNMP. The existing `stats' module has been extended to include additional counters related to Diameter. The diameter statistics includes peer statistics and global summary statistics details on the specified server.

Table 3-63 and Table 3-64 lists the statistics information and the meaning of the values. The statistical information in Table 3-64 is displayed based on the peer selected.

Table 3-63 aregcmd stats Information 

Metric
Value

Diameter Statistics

serverStartTime

The start time of the server.

serverResetTime

The reset time of the server.

serverState

The state of the server.

cdbpLocalStatsTotalUpTime

The total time for which the Diameter server is up.

cdbpLocalResetTime

The time elapsed since a server was reset.

cdbpLocalStatsTotalPacketsIn

The total number of packets received by a Diameter Base protocol.

cdbpLocalStatsTotalPacketsOut

The total number of packets transmitted by a Diameter Base protocol.

Peer

The name of the peer. You can select a peer from the drop-down list.


Table 3-64 aregcmd peer stats Information 

Metric
Value

Diameter Peers

Stats for the Remote Server

The name of the selected peer.

ipaddress

The IP address of the peer.

port

The port of the peer.

cdbpPeerStatsState

Indicates the connection state in the Peer State Machine of the peer with which the Diameter server is communicating.

cdbpPeerStatsASAsOut

Number of Abort-Session-Answer messages that are sent to the peer.

cdbpPeerStatsACRsIn

Number of Accounting-Request messages that are received from the peer

cdbpPeerStatsACRsOut

Number of Accounting-Request messages that are sent to the peer.

cdbpPeerStatsACAsIn

Number of Accounting-Answer messages that are received from the peer.

cdbpPeerStatsACAsOut

Number of Accounting-Answer messages that are sent to the peer.

cdbpPeerStatsCERsIn

Number of Capabilities-Exchange-Request messages received from the peer.

cdbpPeerStatsCERsOut

Number of Capabilities-Exchange-Request messages sent to the peer.

cdbpPeerStatsCEAsIn

Number of Capabilities-Exchange-Answer messages received from the peer.

cdbpPeerStatsCEAsOut

Number of Capabilities-Exchange-Answer messages sent to the peer.

cdbpPeerStatsDWRsIn

Number of Device-Watchdog-Request messages received from the peer.

cdbpPeerStatsStateDuration

Represents the Peer state duration.

cdbpPeerStatsDWRsOut

Number of Device-Watchdog-Request messages sent to the peer.

cdbpPeerStatsDWAsIn

Number of Device-Watchdog-Answer messages received from the peer.

cdbpPeerStatsDWAsOut

Number of Device-Watchdog-Answer messages sent to the peer.

cdbpPeerStatsDPRsIn

Number of Disconnect-Peer-Request messages received from the peer.

cdbpPeerStatsDPRsOut

Number of Disconnect-Peer-Request messages sent to the peer.

cdbpPeerStatsDPAsIn

Number of Disconnect-Peer-Answer messages received from the peer.

cdbpPeerStatsDPAsOut

Number of Disconnect-Peer-Answer messages sent to the peer.

cdbpPeerStatsRARsIn

Number of Re-Auth-Request messages that are received from the peer.

cdbpPeerStatsRARsOut

Number of Re-Auth-Request messages that are sent to the peer.

cdbpPeerStatsRAAsIn

Number of Re-Auth-Answer messages that are received from the peer.

cdbpPeerStatsRAAsOut

Number of Re-Auth-Answer messages that are sent to the peer.

cdbpPeerStatsSTRsIn

Number of Session-Termination-Request messages that are received from the peer.

cdbpPeerStatsSTRsOut

Number of Session-Termination-Request messages that are sent to the peer.

cdbpPeerStatsSTAsIn

Number of Session-Termination-Answer messages that are received from the peer.

cdbpPeerStatsSTAsOut

Number of Session-Termination-Answer messages that are sent to the peer.

cdbpPeerStatsDWReqTimer

The interval between the packets that are sent to the peers.

cdbpPeerstatsRedirectEvents

Number of redirects that are sent from a peer.

cdbpPeerStatsAccDupRequests

Number of duplicate Diameter Accounting-Request packets.

cdbpPeerStatsMalformedReqsts

Number of malformed diameter packets that are received.

cdbpPeerStatsAccsNotRecorded

Number of Diameter Accounting-Request packets that are received and responded but not recorded.

cdbpPeerStatsWhoInitDisconnect

Indicates whether the host or peer initiated the disconnect.

cdbpPeerStatsAccRetrans

Number of Diameter Accounting-Request packets that are retransmitted to the Diameter server.

cdbpPeerStatsTotalRetrans

Number of diameter packets that are retransmitted to the Diameter server. This does not include the Diameter Accounting-Request packets that are retransmitted.

cdbpPeerStatsAccPendReqstsOut

Number of Diameter Accounting-Request packets that are sent to the peer which have not yet timed out or received a response. This variable is incremented when an Accounting-Request is sent to the server and decremented due to receipt of an Accounting-Response, a timeout or a retransmission.

cdbpPeerStatsAccReqstsDropped

Number of Accounting-Requests to the server that are dropped.

cdbpPeerStatsHByHDropMessages

An answer message that is received with an unknown hop-by-hop identifier. This does not include the accounting requests that are dropped.

cdbpPeerStatsEToEDupMessages

The duplicate answer messages that are locally consumed. This does not include duplicate accounting requests that are received.

cdbpPeerStatsUnknownTypes

Number of Diameter packets of unknown type that are received from the peer.

cdbpPeerStatsProtocolErrors

Number of protocol errors that are returned to peer, but not including the redirects.

cdbpPeerStatsTransientFailures

Indicates the transient failure count.

cdbpPeerStatsDWCurrentStatus

Indicates the connection status of the peer.

cdbpPeerStatsTransportDown

Number of unexpected transport failures.

cdbpPeerStatsTimeoutConnAtmpts

Number of times the server attempts to connect to a peer when there is no transport connection with the peer. This is reset on disconnection.

cdbpPeerStatsASRsIn

Number of Abort-Session-Request messages that are received from the peer.

cdbpPeerStatsASRsOut

Number Abort-Session-Request messages that are sent to the peer.

cdbpPeerStatsASAsIn

Number of Abort-Session-Answer messages that are received from the peer.


Select the required peer from the Client drop-down list and click the Show Peer Stats button to view the diameter statistics of the peer. Click the Reset button, to reset all the diameter statistics of the peer.

Backup and Restore

To backup and restore the server details, choose Administration > Backup & Restore. The Backup page is displayed with the list of recently backed up details of the server with the date and time. This option allows you to take a backup of the database, sessions, and scripts, and stores it in /cisco-ar/backup directory. To back up the server details, click the Backup button. The details will be backed up and appended to the backup list. To restore the backed-up details, select the record from the backup list. The details of the selected backup file will be restored successfully.

License Upload

To upload the license file, choose Administration > License Upload. The Cisco AR License - Upload page appears. Click the Browse button, to locate the license file. The file selector dialog box appears. Select the file. To upload the license file, click the Upload button. To clear the text in the field, click the Reset button.

Read-Only GUI

Cisco AR provides a read-only GUI that enables an administrator to observe the system but prevents that administrator from making changes.

When you configure a user to be an administrator, check the View-Only check box to limit the administrator to view-only operation. You can also use the CLI by setting the View-Only property to TRUE under /Administrator/admin_name.

When using the Read-Only GUI, the Configuration, Network Resources and Administration sections are displayed as same as a fully-enabled administrator. The details of these sections are displayed in text format and cannot be edited.