![]() |
User Guide for Cisco Secure ACS Windows Server 3.1
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cisco Secure ACS Command-Line Database Utility
![]() |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Table of ContentsCisco Secure ACS Command-Line Database UtilityLocation of CSUtil.exe and Related Files CSUtil.exe Syntax CSUtil.exe Options Backing Up Cisco Secure ACS with CSUtil.exe Restoring Cisco Secure ACS with CSUtil.exe Creating a CiscoSecure User Database Creating a Cisco Secure ACS Database Dump File Loading the Cisco Secure ACS Database from a Dump File Compacting the CiscoSecure User Database User and AAA Client Import Option Exporting User List to a Text File Exporting Group Information to a Text File Exporting Registry Information to a Text File Decoding Error Numbers Recalculating CRC Values User-Defined RADIUS Vendors and VSA Sets About User-Defined RADIUS Vendors and VSA Sets
Adding a Custom RADIUS Vendor and VSA Set Deleting a Custom RADIUS Vendor and VSA Set Listing Custom RADIUS Vendors Exporting Custom RADIUS Vendor and VSA Sets RADIUS Vendor/VSA Import File Cisco Secure ACS Command-Line Database UtilityThis appendix details the Cisco Secure ACS command-line utility, CSUtil.exe. Among its several functions, CSUtil.exe enables you to add, change, and delete users from a colon-delimited text file. You can also use the utility to add and delete AAA client configurations.
This appendix contains the following topics:
Location of CSUtil.exe and Related FilesWhen you install Cisco Secure ACS in the default location, CSUtil.exe is located in the following directory: where X.X is the version of your Cisco Secure ACS software. Regardless of where you install Cisco Secure ACS, CSUtil.exe is located in the Files generated by or accessed by CSUtil.exe SyntaxThe syntax for the CSUtil.exe command is as follows: CSUtil.exe [-q] [-c] [-d] [-g] [-i filename] [[-p] -l filename] [-e -number] [-b filename] [-r filename] [-f] [-n] [-u] [-y] [-listUDV] [-addUDV slotfilename] [-delUDV slot]
You can combine many of the options in a single use of CSUtil.exe. If you are new to using CSUtil.exe, we recommend performing only one option at a time, with the exception of those options, such as -p, that must be used in conjunction with other options. Experienced CSUtil.exe users may find it useful to combine CSUtil.exe options, such as in the following example, which would first import AAA client configurations and then generate a dump of all Cisco Secure ACS internal data: CSUtil.exe OptionsCSUtil.exe can perform several actions. The options, listed below in alphabetical order, are detailed in later sections of this chapter.
Backing Up Cisco Secure ACS with CSUtil.exeYou can use the -b option to create a system backup of all Cisco Secure ACS internal data. The resulting backup file has the same data as the backup files produced by the ACS Backup feature found in the HTML interface. For more information about the ACS Backup feature, see Cisco Secure ACS Backup.
To back up Cisco Secure ACS with CSUtil.exe, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 Type: where filename is the name of the backup file. Press Enter. Result: CSUtil.exe displays a confirmation prompt. Step 3 To confirm that you want to perform a backup and to halt all Cisco Secure ACS services during the backup, type Y and press Enter. Result: CSUtil.exe generates a complete backup of all Cisco Secure ACS internal data, including user accounts and system configuration. This process may take a few minutes.
Restoring Cisco Secure ACS with CSUtil.exeYou can use the -r option to restore all Cisco Secure ACS internal data. The backup file from which you restore Cisco Secure ACS can be one generated by the CSUtil.exe -b option or by the ACS Backup feature in the HTML interface. Cisco Secure ACS backup files contain two types of data: You can restore either user and group data or system configuration, or both. For more information about the ACS Backup feature, see Cisco Secure ACS Backup.
To restore Cisco Secure ACS with CSUtil.exe, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 Perform the applicable restoration command: where filename is the name of the backup file. Press Enter. where filename is the name of the backup file. Press Enter. where filename is the name of the backup file. Press Enter. Result: CSUtil.exe displays a confirmation prompt. Step 3 To confirm that you want to perform a restoration and to halt all Cisco Secure ACS services during the restoration, type Y and press Enter. Result: CSUtil.exe restores the specified portions of your Cisco Secure ACS data. This process may take a few minutes.
Creating a CiscoSecure User DatabaseYou can use the -n option to create a CiscoSecure user database.
To create a CiscoSecure user database, follow these steps: Step 1 If you have not performed a backup or dump of the CiscoSecure user database, do so now before proceeding. For more information about backing up the database, see Backing Up Cisco Secure ACS with CSUtil.exe. Step 2 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 3 If the CSAuth service is running, type: Result: The CSAuth service stops. Step 4 Type: Result: CSUtil.exe displays a confirmation prompt. Step 5 To confirm that you want to initialize the CiscoSecure user database, type Y and press Enter. Result: The CiscoSecure user database is initialized. This process may take a few minutes. Step 6 To resume user authentication, type: Creating a Cisco Secure ACS Database Dump FileYou can use the -d option to dump all contents of the CiscoSecure user database into a text file. In addition to providing a thorough, eye-readable, and compressible backup of all Cisco Secure ACS internal data, a database dump can also be useful for the Cisco Technical Assistance Center (TAC) during troubleshooting. Using the -l option, you can reload the Cisco Secure ACS internal data from a dump file created by the -d option. For more information about the -l option, see Loading the Cisco Secure ACS Database from a Dump File.
To dump all Cisco Secure ACS internal data into a text file, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 If the CSAuth service is running, type: Result: The CSAuth service stops. Step 3 Type: Result: CSUtil.exe displays a confirmation prompt. Step 4 To confirm that you want to dump all Cisco Secure ACS internal data into Result: CSUtil.exe creates the Step 5 To resume user authentication, type: Loading the Cisco Secure ACS Database from a Dump File You can use the -l option to overwrite all Cisco Secure ACS internal data from a dump text file. This option replaces the existing all Cisco Secure ACS internal data with the data in the dump text file. In effect, the -l option initializes all Cisco Secure ACS internal data before loading it from the dump text file. Dump text files are created using the -d option. While the -d option only produces dump text files that are named You can use the -p option in conjunction with the -l option to reset password-aging counters.
To load all Cisco Secure ACS internal data from a text file, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 If the CSAuth service is running, type: Result: The CSAuth service stops. Step 3 Type: where filename is the name of the dump file you want CSUtil.exe to use to load Cisco Secure ACS internal data. Press Enter. Result: CSUtil.exe displays a confirmation prompt for overwriting all Cisco Secure ACS internal data with the data in the dump text file.
Step 4 To confirm that you want to replace all Cisco Secure ACS internal data, type Y and press Enter. Result: CSUtil.exe initializes all Cisco Secure ACS internal data, and then loads Cisco Secure ACS with the information in the dump file specified. This process may take a few minutes. Step 5 To resume user authentication, type: Compacting the CiscoSecure User DatabaseLike many relational databases, the CiscoSecure user database handles the deletion of records by marking deleted records as deleted but not removing the record from the database. Over time, your CiscoSecure user database may be substantially larger than is required by the number of users it contains. To reduce the CiscoSecure user database size, you can compact it periodically. Compacting the CiscoSecure user database consists of using in conjunction three CSUtil.exe options: Additionally, if you want to automate this process, consider using the -q option to suppress the confirmation prompts that otherwise appear before CSUtil.exe performs the -n and -l options.
To compact the CiscoSecure user database, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 If the CSAuth service is running, type: Result: The CSAuth service stops. Step 3 Type:
Result: If you do not use the -q option, CSUtil.exe displays a confirmation prompt for initializing the database and then for loading the database. For more information about the effects of the -n option, see Creating a CiscoSecure User Database. For more information about the effects of the -l option, see Loading the Cisco Secure ACS Database from a Dump File. Step 4 For each confirmation prompt that appears, type Y and press Enter. Result: CSUtil.exe dumps all Cisco Secure ACS internal data to Step 5 To resume user authentication, type: User and AAA Client Import OptionThe -i option enables you to update Cisco Secure ACS with data from a colon-delimited text file. You can also update AAA client definitions. For user accounts, you can add users, change user information such as passwords, or delete users. For AAA client definitions, you can add or delete AAA clients. This section contains the following topics: Importing User and AAA Client InformationTo import user or AAA client information, follow these steps: Step 1 If you have not performed a backup or dump of Cisco Secure ACS, do so now before proceeding. For more information about backing up the database, see Backing Up Cisco Secure ACS with CSUtil.exe. Step 2 Create an import text file. For more information about what an import text file can or must contain, see User and AAA Client Import File Format. Step 3 Copy or move the import text file to the same directory as CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 4 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. Step 5 Type: where filename is the name of the import text file you want CSUtil.exe to use to update Cisco Secure ACS. Press Enter. Result: CSUtil.exe displays a confirmation prompt for updating the database. Step 6 To confirm that you want to update Cisco Secure ACS with the information from the import text file specified, type Y and press Enter. Result: Cisco Secure ACS is updated with the information in the import text file specified. This process may take a few minutes. If the import text file contained AAA client configuration data, CSUtil.exe warns you that you need to restart CSTacacs and CSRadius for these changes to take effect. Step 7 To restart CSRadius, follow these steps: Result: The CSRadius service stops. Step 8 To restart CSTacacs, follow these steps: Result: The CSTacacs service stops. User and AAA Client Import File FormatThe import file can contain six different line types. At least two are required. This section contains an overview topic, topics for each of the six line types, and an example section: About User and AAA Client Import File FormatEach line of a CSUtil.exe import file is a series of colon-separated tokens. Some of the tokens are followed by values. Values, like tokens, are colon-delimited. For tokens that require values, CSUtil.exe expects the value of the token to be in the colon-delimited field immediately following the token. ONLINE or OFFLINE StatementCSUtil.exe requires an ONLINE or OFFLINE token in an import text file. The file must begin with a line that contains only an ONLINE or OFFLINE token. The ONLINE and OFFLINE tokens are described in Table D-1.
Table D-1 ONLINE/OFFLINE Statement Tokens
ADD StatementsADD statements are optional. Only the ADD token and its value are required to add a user to Cisco Secure ACS. The valid tokens for ADD statements are listed in Table D-2.
Table D-2 ADD Statement Tokens
For example, the following ADD statement would create an account with the username "John", assign it to Group 3, and specify that John should be authenticated by the CiscoSecure user database with the password "closedmondays": UPDATE StatementsUPDATE statements are optional. They make changes to existing user accounts. Only the UPDATE token and its value are required by CSUtil.exe, but if no other tokens are included, no changes are made to the user account. You can use the UPDATE statement to update the group a user is assigned to or to update which database Cisco Secure ACS uses to authenticate the user. The valid tokens for UPDATE statements are listed in Table D-3.
Table D-3 UPDATE Statement Tokens
For example, the following UPDATE statement causes CSUtil.exe to update the account with username "John", assign it to Group 50, specify that John should be authenticated by a UNIX-encrypted password, with a separate CHAP password "goodoldchap": DELETE StatementsDELETE statements are optional. The DELETE token and its value are required to delete a user account from Cisco Secure ACS. The DELETE token, detailed in Table D-4, is the only token in a DELETE statement. For example, the following DELETE statement causes CSUtil.exe to permanently remove the account with username "John" from the CiscoSecure user database: ADD_NAS StatementsADD_NAS statements are optional. The ADD_NAS, IP, KEY, and VENDOR tokens and their values are required to add a AAA client definition to Cisco Secure ACS. The valid tokens for ADD_NAS statements are listed in Table D-5.
Table D-5 ADD_NAS Statement Tokens
For example, the following ADD_NAS statement causes CSUtil.exe to add a AAA client with the name "SVR2-T+", using TACACS+ with the single connection and keep alive packet options enabled: ADD_NAS:SVR2-T+:IP:IP address:KEY:shared secret:VENDOR:"TACACS+ (Cisco IOS)":NDG:"East Coast":SINGLE_CON:Y:KEEPALIVE:Y
DEL_NAS StatementsDEL_NAS statements are optional. The DEL_NAS token, detailed in Table D-6, is the only token in a DEL_NAS statement. DEL_NAS statements delete AAA client definitions from Cisco Secure ACS. For example, the following DEL_NAS statement causes CSUtil.exe to delete a AAA client with the name "SVR2-T+": Import File ExampleThe following is an example import text file: OFFLINE
ADD:user01:CSDB:userpassword:PROFILE:1 ADD:user02:EXT_NT:PROFILE:2 ADD:chapuser:CSDB:hello:CHAP:chappw:PROFILE:3 ADD:mary:EXT_NT:CHAP:achappassword ADD:joe:EXT_SDI ADD:vanessa:CSDB:vanessaspassword ADD:juan:CSDB_UNIX:unixpassword UPDATE:foobar:PROFILE:10 DELETE:paul ADD_NAS:SVR2-T+:IP:209.165.202.136:KEY:A87il032bzg:VENDOR:"TACACS+ (Cisco IOS)":NDG:"East Coast" DEL_NAS:SVR16-RAD Exporting User List to a Text File You can use the -u option to export a list of all users in the CiscoSecure user database to a text file named
To export user information from the CiscoSecure user database into a text file, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 If the CSAuth service is running, type: Result: The CSAuth service stops. Step 3 Type: Result: CSUtil.exe exports information for all users in the CiscoSecure user database to a file named Step 4 To resume user authentication, type: Exporting Group Information to a Text File You can use the -g option to export group configuration data, including device command sets, from the CiscoSecure user database to a text file named
To export group information from the CiscoSecure user database to a text file, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 If the CSAuth service is running, type: Result: The CSAuth service stops. Step 3 Type: Result: CSUtil.exe exports information for all groups in the CiscoSecure user database to a file named Step 4 To resume user authentication, type: Exporting Registry Information to a Text File You can use the -y option to export Windows Registry information for Cisco Secure ACS. CSUtil.exe exports the Registry information to a file named To export Registry information from Cisco Secure ACS to a text file, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 Type: Result: CSUtil.exe exports Windows Registry information for Cisco Secure ACS to a file named Decoding Error NumbersYou can use the -e option to decode error numbers found in Cisco Secure ACS service logs. These are error codes internal to Cisco Secure ACS. For example, the CSRadius log could contain a message similar to the following: CSRadius/Logs/RDS.log:RDS 05/22/2001 10:09:02 E 2152 4756 Error -1087 authenticating geddy - no NAS response sent
In this example, the error code number that you could use CSUtil.exe to decode is "-1087": C:\Program Files\CiscoSecure ACS vx.x\Utils: CSUtil.exe -e -1087
CSUtil v3.0(1.14), Copyright 1997-2001, Cisco Systems Inc Code -1087 : External database reported error during authentication
For more information about Cisco Secure ACS service logs, see Service Logs. To decode an error number from a Cisco Secure ACS service log, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 Type: where number is the error number found in the Cisco Secure ACS service log. Press Enter. Result: CSUtil.exe displays the text message equivalent to the error number specified. Recalculating CRC ValuesThe -c option is for use by the TAC. Its purpose is to resolve CRC (cyclical redundancy check) value conflicts between files manually copied into your Cisco Secure ACS directories and the values recorded in the Windows Registry.
User-Defined RADIUS Vendors and VSA SetsThis section provides information and procedures about user-defined RADIUS vendors and VSAs. It contains the following topics: About User-Defined RADIUS Vendors and VSA SetsIn addition to a set of predefined RADIUS vendors and vendor-specific attributes (VSAs), Cisco Secure ACS supports RADIUS vendors and VSAs that you define. We recommend that you use RDBMS Synchronization to add and configure custom RADIUS vendors; however, you can use CSUtil.exe to accomplish the same custom RADIUS vendor and VSA configurations that you can accomplish using RDBMS Synchronization. Custom RADIUS vendor and VSA configuration created by either of these two featuresRDBMS Synchronization or CSUtil.execan be modified by the other feature. Choosing one feature for configuring custom RADIUS vendors and VSAs does not preclude using the other feature. For more information about RDMBS Synchronization, see RDBMS Synchronization. Vendors you add must be IETF-compliant; therefore, all VSAs that you add must be sub-attributes of IETF RADIUS attribute number 26. You can define up to ten custom RADIUS vendors, numbered 0 (zero) through 9. CSUtil.exe allows only one instance of any given vendor, as defined by the unique vendor IETF ID number and by the vendor name.
Adding a Custom RADIUS Vendor and VSA SetYou can use the -addUDV option to add up to ten custom RADIUS vendors and VSA sets to Cisco Secure ACS. Each RADIUS vendor and VSA set is added to one of ten possible user-defined RADIUS vendor slots.
To add a custom RADIUS VSA to Cisco Secure ACS, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 Type: where slot-number is an unused Cisco Secure ACS RADIUS vendor slot and filename is the name of a RADIUS vendor/VSA import file. The filename can include a relative or absolute path to the RADIUS vendor/VSA import file. Press Enter. For example, to add the RADIUS vendor defined in Result: CSUtil.exe displays a confirmation prompt. Step 3 To confirm that you want to add the RADIUS vendor and halt all Cisco Secure ACS services during the process, type Y and press Enter. Result: CSUtil.exe halts Cisco Secure ACS services, parses the vendor/VSA input file, and adds the new RADIUS vendor and VSAs to Cisco Secure ACS. This process may take a few minutes. After it is complete, CSUtil.exe restarts Cisco Secure ACS services.
Deleting a Custom RADIUS Vendor and VSA SetYou can use the -delUDV option to delete a custom RADIUS vendor from Cisco Secure ACS.
Verify that, in the Network Configuration section of the Cisco Secure ACS HTML interface, no AAA client uses the RADIUS vendor. For more information about configuring AAA clients, see AAA Client Configuration. Verify that your RADIUS accounting log does not contain attributes from the RADIUS vendor you want to delete. For more information about configuring your RADIUS accounting log, see Accounting Logs. To delete a custom RADIUS vendor and VSA set from Cisco Secure ACS, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 Type: where slot-number is the slot containing the RADIUS vendor that you want to delete. Press Enter.
Result: CSUtil.exe displays a confirmation prompt. Step 3 To confirm that you want to halt all Cisco Secure ACS services while deleting the custom RADIUS vendor and VSAs, type Y and press Enter. Result: CSUtil.exe displays a second confirmation prompt. Step 4 To confirm that you want to delete the RADIUS vendor, type Y and press Enter. Result: CSUtil.exe halts Cisco Secure ACS services, deletes the specified RADIUS vendor from Cisco Secure ACS. This process may take a few minutes. After it is complete, CSUtil.exe restarts Cisco Secure ACS services. Listing Custom RADIUS VendorsYou can use the -listUDV option to determine what custom RADIUS vendors are defined in Cisco Secure ACS. This option also enables you to determine which of the ten possible custom RADIUS vendor slots are in use and which RADIUS vendor occupies each used slot. To list all custom RADIUS vendors defined in Cisco Secure ACS, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 Type: Result: CSUtil.exe lists each user-defined RADIUS vendor slot in slot number order. CSUtil.exe lists slots that do not contain a custom RADIUS vendor as "Unassigned". An unassigned slot is empty. You can add a custom RADIUS vendor to any slot listed as "Unassigned". Exporting Custom RADIUS Vendor and VSA SetsYou can export all custom RADIUS vendor and VSA sets to files. Each vendor and VSA set is saved to a separate file. The files created by this option are in the same format as RADIUS vendor/VSA import files. This option is particularly useful if you need to modify a custom RADIUS vendor and VSA set and you have misplaced the original file used to import the set.
Cisco Secure ACS places all exported vendor/VSA files in a subdirectory of the directory containing CSUtil.exe. The subdirectory is named Each exported vendor/VSA file is named To export custom RADIUS vendor and VSA sets to files, follow these steps: Step 1 On the Cisco Secure ACS server, open an MS DOS command prompt and change directories to the directory containing CSUtil.exe. For more information about the location of CSUtil.exe, see Location of CSUtil.exe and Related Files. Step 2 Type: Result: For each custom RADIUS vendor and VSA set currently configured in Cisco Secure ACS, CSUtil.exe writes a file in the RADIUS Vendor/VSA Import FileTo import a custom RADIUS vendor and VSA set into Cisco Secure ACS, you must define the RADIUS vendor and VSA set in an import file. We recommend that you archive RADIUS vendor/VSA import files. During upgrades, the This section details the format and content of RADIUS VSA import files. It includes the following topics: About the RADIUS Vendor/VSA Import FileRADIUS Vendor/VSA import files use a Windows .ini file format. Each RADIUS vendor/VSA import file comprises three types of sections, detailed in Table D-7. Each section comprises a section header and a set of keys and values. The order of the sections in the RADIUS vendor/VSA import file is irrelevant.
Table D-7 RADIUS VSA Import File Section Types
Vendor and VSA Set DefinitionEach RADIUS vendor/VSA import file must have one vendor and VSA set section. The section header must be "[User Defined Vendor]". Table D-8 lists valid keys for the vendor and VSA set section.
Table D-8 Vendor and VSA Set Keys
For example, the following vendor and VSA set section defines the vendor "Widget", whose IETF-assigned vendor number is 9999. Vendor Widget has 4 VSAs (thus requiring 4 attribute definition sections): [User Defined Vendor]
Name=Widget IETF Code=9999 VSA 1=widget-encryption VSA 2=widget-admin-interface VSA 3=widget-group VSA 4=widget-admin-encryption Attribute DefinitionEach RADIUS vendor/VSA import file must have one attribute definition section for each attribute defined in the vendor and VSA set section. The section header of each attribute definition section must match the attribute name defined for that attribute in the vendor and VSA set section. Table D-9 lists the valid keys for an attribute definition section.
Table D-9 Attribute Definition Keys
For example, the following attribute definition section defines the widget-encryption VSA, which is an integer used for authorization, and for which enumerations exist in the Encryption-Types enumeration section: Enumeration DefinitionEnumeration definitions enable you to associate a text-based name for each valid numeric value of an integer-type attribute. In the Group Setup and User Setup sections of the Cisco Secure ACS HTML interface, the text values you define appear in lists associated with the attributes that use the enumerations. Enumeration definition sections are required only if an attribute definition section references them. Only attributes that are integer-type attributes can reference an enumeration definition section. The section header of each enumeration definition section must match the value of an Enums key that references it. An enumeration definition section can be referenced by more than one Enums key, thus allowing for reuse of common enumeration definitions. An enumeration definition section can have up to 1000 keys. Table D-10 lists the valid keys for an enumeration definition section.
Table D-10 Enumerations Definition Keys
For example, the following enumerations definition section defines the Encryption-Types enumeration, which associates the string value 56-bit with the integer 0 and the string value 128-bit with the integer 1: Example RADIUS Vendor/VSA Import FileThe example RADIUS vendor/VSA import file, below, defines the vendor Widget, whose IETF number is 9999. The vendor Widget has 5 VSAs. Of those attributes, 4 are for authorization and one is for accounting. Only one attribute can have multiple instances in a single RADIUS message. Two attributes have enumerations for their valid integer values and they share the same enumeration definition section. [User Defined Vendor]
Name=Widget IETF Code=9999 VSA 1=widget-encryption VSA 2=widget-admin-interface VSA 3=widget-group VSA 4=widget-admin-encryption VSA 5=widget-remote-address [widget-encryption] Type=INTEGER Profile=OUT Enums=Encryption-Types [widget-admin-interface] Type=IPADDR Profile=OUT [widget-group] Type=STRING Profile=MULTI OUT [widget-admin-encryption] Type=INTEGER Profile=OUT Enums=Encryption-Types [widget-remote-address] Type=STRING Profile=IN [Encryption-Types] 0=56-bit 1=128-bit 2=256-bit
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|