Table of Contents

Cisco Access Registrar Environment Dictionary Variables

Variables Set During System Initialization
Variables Set for Each Request Before Calling Any Extension Points
Variables Read After Calling Server and Client Incoming Scripts
Variables Read by Local Services (During Authentication)
Variables Read in Local Services (During Authorization)
Variables Read After Authorizing User
Variables Set and Read for Resource Management Override
Variables Set and Read Throughout the Processing
Reject Reason Variable
PAGER Environment Variable

Environment Dictionary

This appendix describes the environment variables the scripts use to communicate with Cisco Access Registrar or to communicate with other scripts.

Cisco Access Registrar Environment Dictionary Variables

The following variables are text strings stored in the Environment dictionary passed to each scripting point.

Variables Set During System Initialization

Cisco Access Registrar sets the arguments variable in the Environment dictionary, before calling the InitEntryPoint of each script. The arguments variable is set to the value of the InitEntryPointArgs property corresponding to that script, and it allows the administrator to pass (possibly unique) information to each script initialization function.

Variables Set for Each Request Before Calling Any Extension Points

These environment variables exist solely for use by scripts. Cisco Access Registrar sets them for each request, but never examines them.

• Source-IP-Address---set when a request is first received. It contains the IP address of the NAS or proxy server that sent the request to this server.

• Source-Port---set when a request is first received. It contains the port on the NAS or proxy server that was used to send the request to this server.

• Request-Type---set when a request is first received. It contains a string representation of the RADIUS packet type (code). When Cisco Access Registrar does not recognize the packet type, it is represented as "Unknown-Packet-Type-<N>," where <N> is the numeric value of the packet type (for example "Unknown-Packet-Type-9"). The known packet types are listed in Table B-1.

Variables Read After Calling Server and Client Incoming Scripts

Cisco Access Registrar reads these environment variables and determines which authentication, authorization, and/or accounting service to use to process a request. When a variable is not set, Cisco Access Registrar uses the default service(s) configured in the Radius object.

• Authentication-Service---used to determine which service is used to authenticate the user. When Authentication-Service is not set in the Environment dictionary, the DefaultAuthenticationService (as defined in the server configuration) is used instead.

• Authorization-Service---used to determine which service to use to authorize the user. When Authorization-Service is not set in the Environment dictionary, the DefaultAuthorizationService (as defined in the server configuration) is used instead.

• Accounting-Service---used to determine which accounting service is used for this request. When Accounting-Service is not set in the Environment dictionary, the DefaultAccountingService (as defined in the server configuration) is used instead.

• Ignore-Accounting-Signature---used to ignore missing or incorrect accounting signatures from NASs. When set to TRUE, Cisco Access Registrar does not check whether the account request packet has been signed with the same shared secret as the NAS.

Variables Read by Local Services (During Authentication)

User-Name---read by a local service. When it is set in the Environment dictionary, it is the name used to authenticate and/or authorize instead of the User-Name in the Request.

Variables Read in Local Services (During Authorization)

User-Group, User-Profile, and User-Authorization-Script.

Variables Read After Authorizing User

Session-Manager---reads and determines which dynamic resources to allocate for this user, when one is needed. When it is not set, the SessionManager (as defined in DefaultSessionManager) is used when needed.

Variables Set and Read for Resource Management Override

These environment variables provide scripts further control over session management. They can be set at any point before session management is invoked. They are read as the packet flows through each Resource Manager that the chosen Session Manager calls. The default setting for these environment variables is TRUE. See the "Resource Managers" section for additional information about Resource Managers.

Acquire-User-Session-Limit---set to FALSE to override the use of user session limit resource management.

Acquire-Group-Session-Limit---set to FALSE to override the use of group session limit resource management.

Acquire-IP-Dynamic---set to FALSE to override the use of a managed pool of IP addresses resource management.

Acquire-IP-Per-NAS-Port---set to FALSE to override the use of ports associated to specific IP addresses resource management.

Acquire-IPX-Dynamic---set to FALSE to override the use of a managed pool of IPX addresses resource management.

Acquire-USR-VPN---set to FALSE to override the use of Virtual Private Networks (VPNs) that use USR NAS Clients resource management.

Variables Set and Read Throughout the Processing

Response-Type---used to determine whether the request should be accepted, rejected, or challenged. When this environment variable is set to "Access-Reject", at any time during the processing of a request, no more processing of the request is done, and an Access-Reject response is sent. For other valid values for this variable, see Table B-1.

Reject Reason Variable

Contains the Reject-Reason. Cisco Access Registrar uses the value of this environment variable to look up the reject reason in the reply message table.

PAGER Environment Variable

The aregcmd command supports the PAGER environment variable. When the aregcmd command stats is used and the PAGER environment variable is set, the output of the stats command is displayed using the program specified by the PAGER environment variable.

Posted: Thu Aug 19 08:15:02 PDT 1999
Copyright 1989-1999©Cisco Systems Inc.