Cisco SCMS SM LEGs User Guide, Release 3.5.5

Book Contents

Find Matches in This Book

Available Languages

Download Options

Book Title

Cisco SCMS SM LEGs User Guide, Release 3.5.5

Chapter Title

Using the RADIUS Listener LEG CLU

PDF - Complete Book (2.33 MB) PDF - This Chapter (368.0 KB)
View with Adobe Reader on a variety of devices

Results

Chapter: Using the RADIUS Listener LEG CLU

Introduction
Information About the p3radius Utility

Using the RADIUS Listener LEG CLU

Revised: July 28, 2009, OL-15752-05

Introduction

This module describes the command-line utility (CLU) commands when the software is installed on the Subscriber Manager (SM).

Information About the p3radius Utility

The p3radius utility displays the RADIUS Listener configurations, status, and statistics. It also provides utilities to test RADIUS configuration and regular expression manipulation. The RADIUS Listener configuration includes all configured NAS devices and general RADIUS Listener parameters.

The p3radius command format is p3radius <operation>.

Table 18-1 lists the p3radius operations.

Table 18-1 p3radius Operations
Operation	Description
--show	Displays all of the NAS and RADIUS configurations and other general information (status of ports, regular expression configuration, etc.)
--show-statistics	Displays counters of RADIUS messages handled and number of logon operations performed.
--test-reg-exp	Returns a value indicating if the regular expression is valid or not.
--test-manipulation	Validates the section definition and performs the manipulation operation on a given field's data against the specified section in a given configuration file.
--test-reduction-rule	Performs reduction of the input string and returns: •The reduction result. •The average time (in milliseconds) for a single reduction operation. The average time is used for performance analysis.
--test-matching-rule	Performs a match of the input string against a given regular expression and returns: •A result indicating if there is a match or not. •Average time (in milliseconds) for a single matching operation. The average time is used for performance analysis.
--reset-statistics	Reset statistics counters.

Table 18-2 lists the p3radius options.

Table 18-2 p3radius Options
Option	Abbreviation	Description
--reg-exp=reg exp rule	—	Tests the validity of regular expression patterns. Possible results are: •<regular expression rule> is a valid regular expression pattern. •<regular expression rule> is an invalid regular expression pattern. Also includes GNU error information.
--performance	—	Use with the test-reduction-rule and test-matching-rule operations to calculate the average time for a single reduction/matching operation.
--file=configuration_file name --fields=fieldname= fieldValue [ ,fieldname=fieldValue ] --section=section name	-f configuration_file name --fields=fieldname= fieldValue [ ,fieldname=fieldValue ] --section=section name	Tests the new/updated configuration file. The tests are done by providing the following parameters: •-f <path> or --file=<path>: Perform the operation on a specified configuration file. •--field=fieldName= fieldValue: Perform the operation using specified field attribute(s), and field attribute(s) data. <fieldName>: Property name as defined in the fields property. <fieldValue>: String value of the field property. •section=section name: Perform the operation on the specified section in the configuration file.
--input=string	—	Provides the input string that is being tested using the --test-reduction-rule or the --test-manipulation-rule operations.
--fields=field=value[,field= value]	—	Perform the operation using specified field attribute(s), and field attribute(s) data. <field>: Attribute us defined in the configuration file. <value>: String value of the field attribute. If value is "none", the operation refers to field whose data was not found in RADIUS packet.
--section=NAME	—	Perform the operation on the specified section in the configuration file.

Viewing the RADIUS Listener LEG Status

The following is an example using the p3radius CLU with the show operation:

>p3radius --show  
RADIUS Listener information 
============================ 
running: true 
accounting port: 1813 
packet types : accounting-start, accounting-interim, accounting-stop 
NASs: none 
Subscriber ID 
============= 
user_name: radius attribute: 1 type: string 
vpn: VSA Vendor-id: 1 sub attribute: 2 type: string 
Separator configuration rule: Separator=user_namevpn 
Subscriber IP Address 
===================== 
IP Configuration: 
filter-id: radius attribute: 2 type: integer 
VPN Configuration: 
vpn: radius attribute: 26 type: integer 
Properties 
========== 
property name: packageId 
------------------------ 
vpn: VSA Vendor-id: 1 sub attribute: 2 type: string 
user_name: radius attribute: 1 type: string 
Reduction configuration rules: 
Field=vpn; Pattern=.* 
Field=user_name; Pattern=.* 
Matching configuration rules: 
Matching Pattern=.*; Matching Value=2 
Matching Pattern=123; Matching Value=3 
property name: monitor 
---------------------- 
filter-id: radius attribute: 2 type: integer 
Matching configuration rules: 
Matching Pattern=^$; Matching Value=1 
property name: upVlinkId 
------------------------ 
property name: downVlinkId 
-------------------------- 
Command terminated successfully 
>

Viewing the RADIUS Listener LEG Statistics

The following is an example of the p3radius CLU with the show-statistics operation:

>p3radius --show-statistics  
Statistics: 
=========== 
Packets Received:     0 
Packets Transmitted:    0 
Accounting Request:     0 
Accounting Start:       0 
Accounting Interim:     0 
Accounting Stop:        0 
Accounting Response:    0 
Dropped:                0 
Successful logins:      0 
Failed logins:          0 
Successful logouts:     0 
Failed logouts:         0 
Command terminated successfully 
>

Testing a Section in a Configuration File

The following is an example of the p3radius CLU with the test-manipulation operation:

p3radius --test-manipulation -f regExpTest.cfg --section="Radius.Subscriber ID" 
--fields=user_name=,vsa=cisco.LTD.sanjose,filter-id=172.16.1.1  
The following fields parameter were being extracted: 
field_name=user_name, field_data= 
field_name=vsa, field_data=cisco.LTD.sanjose 
field_name=filter-id, field_data=172.16.1.1 
reduction rules: 
user_name pattern: (.*)@.* 
vsa pattern: (.*).LTD(.*) 
filter-id pattern: .* 
separator: user_name-vsa@filter-id 
Reduction iteration [0]: field data=, RegExp Pattern=(.*)@.*, concatenated string (with 
separator)=- 
Reduction iteration [1]: field data=cisco.LTD.sanjose, RegExp Pattern=(.*).LTD(.*), 
concatenated string (with separator)=-cisco.sanjose@ 
Reduction iteration [2]: field data=172.16.1.1, RegExp Pattern=.*, concatenated string 
(with separator)=-cisco.sanjose@ 
Manipulation result:-cisco.sanjose@ 
Command terminated successfully 
>

Testing a Reduction Rule

The following is an example of the p3radius CLU with the test-reduction-rule operation:

p3radius --test-reduction-rule --reg-exp=(.*)@.* --input=user@cisco.com --performance 
Pattern: '(.*)@.*'; String to reduce: 'user@cisco.com'; Reduction result: 'user' 
Regular Expression operation time is 0.112 ms 
 
Command terminated successfully 
>

Testing a Matching Rule

The following are examples of the p3radius CLU with the test-matching-rule operation:

p3radius --test-matching-rule --reg-exp=^user$ --input=user@cisco.com --performance 
Pattern: '^user$'; String to match: 'user@cisco.com'; Matching not found 
Regular Expression operation time is 0.0 ms. 
 
p3radius --test-matching-rule --reg-exp=user --input=user@cisco.com --performance 
Pattern: 'user'; String to match: 'user@cisco.com'; Match found 
Regular Expression operation time is 0.045 ms. 
 
p3radius --test-matching-rule --reg-exp=users --input=user@cisco.com --performance 
Pattern: 'users'; String to match: 'user@cisco.com'; Matching not found 
Regular Expression operation time is 0.045 ms. 
 
Command terminated successfully 
>