Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
  
[+] Expand All
[-] Collapse All

Action Arguments

Action arguments in the command line indicate the type of action requested, search conditions, and additional arguments needed by the controlled device (NAS).

Syntax

-m Action -a Attr -v Value [,-a Attr -v Value...][,-a Attr -x hex-value...][-sl session_limit][-force]

Note: The asterisk character (*) represents a wildcard. Wildcards are only accepted for the User and Device Name text attributes. Leading wildcards may be used for User.

Arguments

Table 109 describes the functions of each Action argument.

Table 109: Action Arguments

Action Argument

Description

Example

-m Action

Specifies the name of the action you want to perform. Each action must be defined in the deviceModels.xml file.

By default, the actions query, view and delete are defined in the deviceModels.xml file. After you define other actions in the deviceModels.xml file, you can use those names as arguments.

Valid actions (by default):

query

view

delete

-m query

-a Attr -v Val

Attribute name and value for which you want to search

or

The attribute name and value to pass to a NAS if the NAS requires an additional attribute.

The valid (searchable) attributes are:

Acct-Multi-Session-Id

Acct-Session-Id*

Called-Station-Id

Calling-Station-Id

Funk-Attribute-Range

Funk-Session-Handle

Framed-IP-Address

NAS-Identifier

NAS-IP-Address

User-Name

-a Framed-IP-Address -v 127.0.0.1

Note: IP addresses may be in either IPv6 or IPv4 format.

-a Attr -x hex-val

Specifies the information being submitted is in hexadecimal format.

-a NAS-IPv6-Address -x 12cdef125f3d

-sl session_
limit

Session limit. Upper limit of number of sessions to be found. (See -force to learn how the -force variable affects the interpretation of the session limit.)

-sl 10

-force

Presence of the -force argument specifies use of the session limit even if the number of found sessions exceeds the session limit. The absence of the -force argument specifies that no sessions be returned or acted upon if the number of matching sessions exceeds the session limit.

See Setting Session Limits Using the Command Line Utility for information about the -force argument.

-sl 10 -force

*The Acct-Session-Id attribute is commonly used in CoA/DM packing lists for router requirements. Packing lists represent the router’s requirements for a valid DM or CoA request. Attributes that are not in the CST must come from the actual query to fulfill the request.

To have data available for queries using the command line utility (SessionControl.sh), you must configure this attribute in the packing list. If the Sbr_AcctSessionId does not exist in the CST or is not found by the query itself, the request fails.

Note: The RADIUS attributes for a controlled device are contained in a file with a .dic or .dct extension on the machine on which CoA/DM is installed. Open these files to find the names of additional attributes that you might want to pass to the controlled device.

IP Address Ranges

For IP address ranges, specify rangeBegin and rangeEnd as shown in the following example. Quotation marks are necessary because of the space between rangeBegin and rangeEnd.

-a Funk-Attribute-Range
-v "attribute=NAS-IP-Address rangeBegin=172.16.0.84 rangeEnd=172.16.0.90"

Unique Session IDs

For a specific session in the CST, specify the internal session handle returned from a previous query.

-a Funk-Session-Handle -v 42A0BA6500000002

Modified: 2017-09-27