Previous Topic: Specifying Form Content and Access ControlNext Topic: Daily Processing (APSExpire)


Running APSAdmin from the Command Line

APSAdmin can also be run from the command line. This is not useful (or recommended!) for a production system, but can be used effectively during automated or semi-automated testing to 1) reset user records to known states and 2) determining if expected updates to the user record are taking place.

The command line syntax is:

APSAdmin -A<adminPath>
		-C<adminCreds>
		-R<userPath>|-W<xmlPath>
		[<macro1>=<value1>]

Where:

-A<adminPath>

The fully qualified path name of the administrator. This is the SiteMinder login user, not the SiteMinder GUI administrator.

This value is a full user path in the form

<Namespace>://<server>/<user>

such as:

LDAP://127.0.0.1/uid=erict,o=Airius.com

-C<adminCreds>

The credentials of an administrator defined to the SiteMinder Policy Server User Interface (GUI). This is not a SiteMinder login. This administrator must have User Management rights. Both the administrator ID and the password must be supplied, separated by a semicolon (";"). The combination can be passed encrypted (using APSEncrypt).

-R<userPath>

The fully qualified path to the user whose information is to be retrieved. You can specify either the -R option (to read a user) or -W (to write a user), but not both.

This value is a full user path in the form

<Namespace>://<server>/<user>

such as:

LDAP://127.0.0.1/uid=erict,o=Airius.com

-W<xmlPath>

Specifies the file containing the updates to write, in XML format. For a description of the format of this file, see the description for the APSAdminWrite API function starting on Unsupported "Page" Cross-Reference.

<macro1>=<value1>

Context macros can be defined on the command line using this syntax (multiples can be specified). These macros are passed to APS and can be used in Settings Overrides in the APS Configuration File. This can be really useful to limit the output on a user read.

Security Note

There may be a security concern with command line use of APSAdmin. Specifically, when run under the Web, APSAdmin can "guarantee" that the adminPath is the currently authenticated user. However, when run from the command line, this is not possible. There are two things to consider here: