Cisco Access Registrar User Guide - About This Guide [Cisco Access Registrar]

Table Of Contents

About This Guide

About This Guide

The Cisco Access Registrar User's Guide provides information about how to use Cisco Access Registrar 4.0. This preface contains the following sections:

•How This Book Is Organized

•Obtaining Documentation and Submitting a Service Request

•Notices

How This Book Is Organized

The Cisco Access Registrar User's Guide is organized as follows:

Chapter 1, "Overview," provides an overview of Cisco Access Registrar.

Chapter 2, "Using the aregcmd Commands," provides information about using aregcmd commands.

Chapter 3, "Using the Graphical User Interface," describes how to use the stand-alone graphical user interface (GUI) to configure Cisco AR.

Chapter 4, "Cisco Access Registrar Server Objects," provides information about Cisco Access Registrar server objects.

Chapter 5, "Using the radclient Command," provides information about using radclient commands to test Cisco Access Registrar.

Chapter 6, "Configuring Local Authentication and Authorization," provides information about how to configure local authentication and authorization and helpful examples.

Chapter 7, "RADIUS Accounting," provides information about RADIUS accounting and how to configure Cisco Access Registrar 4.0 to perform accounting.

Chapter 8, "Extensible Authentication Protocols," provides information about Cisco AR 4.0 support of EAP authentication methods.

Chapter 9, "Using Extension Points," provides information about how to use Cisco Access Registrar scripting to customize your RADIUS server.

Chapter 10, "Using Replication," provides information about how to use the replication feature.

Chapter 11, "Using On-Demand Address Pools," provides information about using On-Demand Address Pools.

Chapter 12, "Using Identity Caching," provides information about using the Identity Caching feature.

Chapter 13, "Using Trusted ID Authorization with SESM," describes how Cisco AR can be used in a Service Selection Gateway (SSG) - Cisco Subscriber Edge Services Manager (SESM) deployment to enable the Trusted Identity (Trusted ID) Authorization feature.

Chapter 14, "Using Prepaid Billing," describes how to configure Cisco AR to use prepaid billing.

Chapter 15, "Using Cisco Access Registrar Server Features," provides information about using Cisco Access Registrar features.

Chapter 16, "Directing RADIUS Requests," provides information about using the Cisco Access Registrar Policy Engine.

Chapter 17, "Wireless Support," provides information about Cisco Access Registrar support for wireless features.

Chapter 18, "Using LDAP," provides information about using an LDAP remote server with Cisco Access Registrar.

Chapter 19, "Using Open Database Connectivity," provides information about a new type of RemoteServer object and a new service to support ODBC.

Chapter 20, "Using SNMP," provides information about Cisco AR support for SNMP.

Chapter 21, "Backing Up the Database," describes the Cisco Access Registrar shadow backup facility, which ensures a consistent snapshot of Cisco Access Registrar's database for backup purposes.

Chapter 22, "Using the REX Accounting Script," describes how to use the REX Accounting scripts.

Chapter 23, "Logging Syslog Messages," provides information about logging messages via syslog and centralized error reporting for Cisco Access Registrar.

Chapter 24, "Troubleshooting Cisco Access Registrar," provides information about techniques used when troubleshooting Cisco Access Registrar and highlights common problems.

Appendix A, "Cisco Access Registrar Tcl and REX Dictionaries," describes the Tcl and REX dictionaries that are used when writing Incoming or Outgoing scripts for use with Cisco Access Registrar.

Appendix B, "Environment Dictionary," describes the environment variables the scripts use to communicate with Cisco Access Registrar or to communicate with other scripts.

Appendix C, "RADIUS Attributes," lists the RFC 2865 RADIUS attributes with their names and values.

An index is also provided.

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.

Notices

The following notices pertain to this software license.

OpenSSL/Open SSL Project

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/).

This product includes cryptographic software written by Eric Young (eay@cryptsoft.com).

This product includes software written by Tim Hudson (tjh@cryptsoft.com).

License Issues

The OpenSSL toolkit stays under a dual license, i.e. both the conditions of the OpenSSL License and the original SSLeay license apply to the toolkit. See below for the actual license texts. Actually both licenses are BSD-style Open Source licenses. In case of any license issues related to OpenSSL please contact openssl-core@openssl.org.

OpenSSL License

Copyright © 1998-2007 The OpenSSL Project. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. All advertising materials mentioning features or use of this software must display the following acknowledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)".

4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact openssl-core@openssl.org.

5. Products derived from this software may not be called "OpenSSL" nor may "OpenSSL" appear in their names without prior written permission of the OpenSSL Project.

6. Redistributions of any form whatsoever must retain the following acknowledgment:

"This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)".

THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT "AS IS"' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product includes software written by Tim Hudson (tjh@cryptsoft.com).

Original SSLeay License

Copyright © 1995-1998 Eric Young (eay@cryptsoft.com). All rights reserved.

This package is an SSL implementation written by Eric Young (eay@cryptsoft.com).

The implementation was written so as to conform with Netscapes SSL.

This library is free for commercial and non-commercial use as long as the following conditions are adhered to. The following conditions apply to all code found in this distribution, be it the RC4, RSA, lhash, DES, etc., code; not just the SSL code. The SSL documentation included with this distribution is covered by the same copyright terms except that the holder is Tim Hudson (tjh@cryptsoft.com).

Copyright remains Eric Young's, and as such any Copyright notices in the code are not to be removed. If this package is used in a product, Eric Young should be given attribution as the author of the parts of the library used. This can be in the form of a textual message at program startup or in documentation (online or textual) provided with the package.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. All advertising materials mentioning features or use of this software must display the following acknowledgement:

"This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)".

The word `cryptographic' can be left out if the routines from the library being used are not cryptography-related.

4. If you include any Windows specific code (or a derivative thereof) from the apps directory (application code) you must include an acknowledgement: "This product includes software written by Tim Hudson (tjh@cryptsoft.com)".

THIS SOFTWARE IS PROVIDED BY ERIC YOUNG "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The license and distribution terms for any publicly available version or derivative of this code cannot be changed. i.e. this code cannot simply be copied and put under another distribution license [including the GNU Public License].

	Cisco Access Registrar User Guide
	About This Guide
Cisco Access Registrar User Guide Index About This Guide Overview Using the aregcmd Commands Using the Graphical User Interface Cisco Access Registrar Server Objects Using the radclient Command Configuring Local Authentication and Authorization RADIUS Accounting Extensible Authentication Protocols Using Extension Points Using Replication Using On-Demand Address Pools Using Identity Caching Using Trusted ID Authorization with SESM Using Prepaid Billing Using Cisco Access Registrar Features Using the Policy Engine Wireless Support Using LDAP Using Open Database Connectivity Using SNMP Backing Up the Database Using the REX Accounting Script Logging syslog Messages Troubleshooting Cisco Access Registrar Cisco Access Registrar Tcl and REX Dictionaries Environment Dictionary RADIUS Attributes Glossary Cisco Access Registrar User Guide	Download this chapter About This Guide Table Of Contents About This Guide About This Guide The Cisco Access Registrar User's Guide provides information about how to use Cisco Access Registrar 4.0. This preface contains the following sections: •How This Book Is Organized •Obtaining Documentation and Submitting a Service Request •Notices How This Book Is Organized The Cisco Access Registrar User's Guide is organized as follows: Chapter 1, "Overview," provides an overview of Cisco Access Registrar. Chapter 2, "Using the aregcmd Commands," provides information about using aregcmd commands. Chapter 3, "Using the Graphical User Interface," describes how to use the stand-alone graphical user interface (GUI) to configure Cisco AR. Chapter 4, "Cisco Access Registrar Server Objects," provides information about Cisco Access Registrar server objects. Chapter 5, "Using the radclient Command," provides information about using radclient commands to test Cisco Access Registrar. Chapter 6, "Configuring Local Authentication and Authorization," provides information about how to configure local authentication and authorization and helpful examples. Chapter 7, "RADIUS Accounting," provides information about RADIUS accounting and how to configure Cisco Access Registrar 4.0 to perform accounting. Chapter 8, "Extensible Authentication Protocols," provides information about Cisco AR 4.0 support of EAP authentication methods. Chapter 9, "Using Extension Points," provides information about how to use Cisco Access Registrar scripting to customize your RADIUS server. Chapter 10, "Using Replication," provides information about how to use the replication feature. Chapter 11, "Using On-Demand Address Pools," provides information about using On-Demand Address Pools. Chapter 12, "Using Identity Caching," provides information about using the Identity Caching feature. Chapter 13, "Using Trusted ID Authorization with SESM," describes how Cisco AR can be used in a Service Selection Gateway (SSG) - Cisco Subscriber Edge Services Manager (SESM) deployment to enable the Trusted Identity (Trusted ID) Authorization feature. Chapter 14, "Using Prepaid Billing," describes how to configure Cisco AR to use prepaid billing. Chapter 15, "Using Cisco Access Registrar Server Features," provides information about using Cisco Access Registrar features. Chapter 16, "Directing RADIUS Requests," provides information about using the Cisco Access Registrar Policy Engine. Chapter 17, "Wireless Support," provides information about Cisco Access Registrar support for wireless features. Chapter 18, "Using LDAP," provides information about using an LDAP remote server with Cisco Access Registrar. Chapter 19, "Using Open Database Connectivity," provides information about a new type of RemoteServer object and a new service to support ODBC. Chapter 20, "Using SNMP," provides information about Cisco AR support for SNMP. Chapter 21, "Backing Up the Database," describes the Cisco Access Registrar shadow backup facility, which ensures a consistent snapshot of Cisco Access Registrar's database for backup purposes. Chapter 22, "Using the REX Accounting Script," describes how to use the REX Accounting scripts. Chapter 23, "Logging Syslog Messages," provides information about logging messages via syslog and centralized error reporting for Cisco Access Registrar. Chapter 24, "Troubleshooting Cisco Access Registrar," provides information about techniques used when troubleshooting Cisco Access Registrar and highlights common problems. Appendix A, "Cisco Access Registrar Tcl and REX Dictionaries," describes the Tcl and REX dictionaries that are used when writing Incoming or Outgoing scripts for use with Cisco Access Registrar. Appendix B, "Environment Dictionary," describes the environment variables the scripts use to communicate with Cisco Access Registrar or to communicate with other scripts. Appendix C, "RADIUS Attributes," lists the RFC 2865 RADIUS attributes with their names and values. An index is also provided. Obtaining Documentation and Submitting a Service Request For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at: http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0. Notices The following notices pertain to this software license. OpenSSL/Open SSL Project This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/). This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product includes software written by Tim Hudson (tjh@cryptsoft.com). License Issues The OpenSSL toolkit stays under a dual license, i.e. both the conditions of the OpenSSL License and the original SSLeay license apply to the toolkit. See below for the actual license texts. Actually both licenses are BSD-style Open Source licenses. In case of any license issues related to OpenSSL please contact openssl-core@openssl.org. OpenSSL License Copyright © 1998-2007 The OpenSSL Project. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. All advertising materials mentioning features or use of this software must display the following acknowledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)". 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact openssl-core@openssl.org. 5. Products derived from this software may not be called "OpenSSL" nor may "OpenSSL" appear in their names without prior written permission of the OpenSSL Project. 6. Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)". THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT "AS IS"' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product includes software written by Tim Hudson (tjh@cryptsoft.com). Original SSLeay License Copyright © 1995-1998 Eric Young (eay@cryptsoft.com). All rights reserved. This package is an SSL implementation written by Eric Young (eay@cryptsoft.com). The implementation was written so as to conform with Netscapes SSL. This library is free for commercial and non-commercial use as long as the following conditions are adhered to. The following conditions apply to all code found in this distribution, be it the RC4, RSA, lhash, DES, etc., code; not just the SSL code. The SSL documentation included with this distribution is covered by the same copyright terms except that the holder is Tim Hudson (tjh@cryptsoft.com). Copyright remains Eric Young's, and as such any Copyright notices in the code are not to be removed. If this package is used in a product, Eric Young should be given attribution as the author of the parts of the library used. This can be in the form of a textual message at program startup or in documentation (online or textual) provided with the package. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. All advertising materials mentioning features or use of this software must display the following acknowledgement: "This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)". The word `cryptographic' can be left out if the routines from the library being used are not cryptography-related. 4. If you include any Windows specific code (or a derivative thereof) from the apps directory (application code) you must include an acknowledgement: "This product includes software written by Tim Hudson (tjh@cryptsoft.com)". THIS SOFTWARE IS PROVIDED BY ERIC YOUNG "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The license and distribution terms for any publicly available version or derivative of this code cannot be changed. i.e. this code cannot simply be copied and put under another distribution license [including the GNU Public License].
	Terms & Conditions \| Privacy Statement \| Cookie Policy \| Trademarks