This documentation supports the 9.0 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

arcache.exe or arcache

In this topic:

Description

The arcache utility executes the AR System interface that lets you update an entry in the access control cache for a user or group, and lets you distribute your change to the specified AR System servers. This program is generally used in a multiple server environment with centralized access control. The program is also used for error recovery in a single server environment.

Filters that execute on submit and modify to the User and Group forms are typically used to run this program. Changes to those forms update the local cache automatically. The filters make sure that all changes to user or group information are distributed across the system.

If the server is running on a specific port and arcache cannot obtain the port information from the portmapper, you must set the ARTCPPORT variable. For example, if the port number is 2020, type the following command at a command prompt:

set ARTCPPORT=2020

At a UNIX prompt, type:

setenv ARTCPPORT 2020

Synopsis

arcache {-U|-G}{a|d} -e entryID [-g groupList] [-i groupID]
[-c groupCategory] [-q "computedGroupQqualification"]
[-t groupType] [-lw writeLicense] [-m mailAddress] [-n name]
[-p password] [-x notifyMech] [-d] [-u authenticationAliasName]
[-r authenticationAliasString][-H groupID] [-V overlayid]

Options

You can specify the following options in any order on the command line:

OptionDescription
-eSpecifies the Request ID associated with the user or group in the access control cache (required). If you are adding a user or group, you can specify any value that does not already exist in the cache.
-gSpecifies the set of groups to which the user belongs (applicable for adding or updating users only). Group membership defines the permissions the user has in the system. Use the group ID to identify each group (separated by semicolons). Special group IDs are 1 (Administrator), 2 (Customize), and 5 (Subadministrator). For example, if the group ID for the Technical Support group is 43, and you want to assign the user to the Customize and Technical Support groups, specify this option as -g "2;43;".
-GSpecifies the type of group cache operation. Valid values for this option are a (add or update group) and d (delete group). The -G and -U options are mutually exclusive.
-iSpecifies the group ID (applicable for adding or updating groups only).
-cSpecifies the group category. Valid values for this option are 0 (regular group), 1 (dynamic group), or 2 (computed group). The default value is 0.
-qSpecifies the qualification for a computed group only. Specify this option as "\ "A\ " OR 121 ", "121 OR 'Demo' ".
-t Specifies the group type (applicable for adding or updating groups only). Valid values for this option are 0 (none), 1 (view only), or 2 (view/change). The default value is 0.
-lwSpecifies the type of write license to assign (applicable for adding or updating users only). Valid values for this option are 0 (read), 1 (fixed), or 2 (floating). The default value is 0.
-mSpecifies the default email address for sending messages (applicable for adding or updating users only).
-nSpecifies the name of the user or group (required for add operations, recommended for delete operations).
-pSpecifies the password to assign (applicable for adding or updating users only).
-USpecifies the type of user cache operation. Valid values for this option are a (add or update user) or d (delete user). The -U and -G options are mutually exclusive.
-xSpecifies the default alert mechanism to use (applicable for adding or updating users only). Valid values for this option are 0 (none), 1 (notifier), or 2 (email). The default value is 1.
-dRuns the program in debug mode. Messages that detail the progress of each operation being performed are printed to a log. Use this mode to diagnose problems with the arcache process only.
-uSpecifies the user name of the authentication alias.
-rSpecifies the authentication string of the authentication alias. See Setting up an authentication alias for more information about authentication aliases.
-HSpecifies the parent group for the group being created (applicable in hierarchical group permissions). If not specified, the value is 0 (new group has no parent).
-VSpecifies the overlay group property for the group being created. Valid values for this options are 0 (group gives permissions only to base mode objects) or 1 (group gives permissions only to overlay and custom objects). If not specified, the value is NULL (new group does not restrict access to base or overlay mode objects).

Environment

ARCONFIGDIR

(UNIX only) Specifies the directory where the ar.conf file and other AR System configuration files are stored. The arsystem script sets ARCONFIGDIR to ARSystemServerInstallDir/conf, and you should not need to change this value. However, arsystem does not modify ARCONFIGDIR if a preset value is found.

Scenarios

Add a user, Sam Johnson, to the access control cache of all AR System servers. Use 000000000000104 as the Request ID, samj@bmc.com as the default email address, and notifier as the default alert mechanism. The syntax is as follows:

arcache -Ua -e000000000000104 -n "Sam Johnson" -m "samj@bmc.com" -x 1

No password or group membership is specified for this user.

Add an admin user with a fixed license. The syntax is as follows:

arcache -Ua -eTEMP999 -lw 1 -n "TEMPADMIN" -p "" -g "1;"

To add a group ID, group type, and specify a computed group with a qualification, the syntax is as follows:

arcache -Ga -e000000000000106 -n "TEMPADMIN" -i 8989 -t 2 -c 2 -q "\ "Administrator\ " OR 'Sunnyvale' "

Note

You can disable arcache with a setting in the AR System Administration: AR System Configuration Generic UI form. When the setting is active you can still run arcache, but it has no effect on the server, and the cache does not get flushed. For more information, see Disable-User-Cache-Utilities at Configuration settings C-D.

Was this page helpful? Yes No Submitting... Thank you

Comments