|
Sun Java System Access Manager version 6 2005Q1 Sample |
amadmin - Command Line Interface
1. Description
One of the two primary features of the
The other key features is to create, delete and modify Access Manager's
objects such organization, user, group, role, etc. For these operation,
2. Installation PropertiesThe following assumptions are made regarding the installation directories. You may need to change the examples to reflect your actuall installation properties and locations.
3. Requirements
Services must follow the DTD found in
Bulk operations need to follow the DTD specifications defined in
4. Main Usage of amadmin
5. Usage
amadmin ARGUMENTS COMMANDS OPTIONS
ARGUMENTS:
Must specify either a user ID and password, or the version argument.
-u <userdn>, --runasdn <userdn>
Full DN of the user running the command
-w <password>, --password <password>
-f <filename>, --passwordfile <filename>
Full DN of the user used to run the command
COMMANDS:
One of the following commands must be specified in each amadmin command issued.
-t <filename>, --data <filename>
Load the data from the specified filename.
-s <filename>, --schema <filename>
Load the schema from the spefied filename.
-r <servicename>, --deleteservice <servicename>
Deletes the service name from the system.
-m <servername>, --session <servername>
Manage the active sessions on the specified server.
Example: -m http://server.east.company.com:8080
-a <serviceName> <schemaType> <xmlfile>
--addattributes <serviceName> <schemaType> <xmlfile>
Adds a new attribute to the specified serviceName and
schemaType(global, dynamic, organization, or user).
The attribute schema being added is defined in the xmlfile.
-g <filename>, --import <filename>
Load the Liberty meta compliance XML into Directory Server.
filename contains the meta information and should adhere to
the Liberty meta specification and XSD.
-e <entity name>, --entityname <entity name>
-o <filename>, --export <filename>
Export an entity to the specified filename. The --entityname
parameter must be used to specify the entity name. May also
specify --verifysig, --defaulturlprefix, or --metaalias.
-n, --version
Output the version of Access Manager currently installed.
OPTIONS:
-l <localename>, --locale <localename>
Name of the locale to display the results.
-v, --verbose
Run in verbose mode. Results sent to standard output
-d, --debug
Run in debug mode. Results sent to the debug file.
-c, --continue
Continue processing the input if errors are encountered.
-y, --verifysig
Used in conjunction with the --import command.
The imported xml file will run through an xml signature validator.
-k <url>, --defaulturlprefix <url>
Used in conjuction with --import .
Implies the imported EntityDescriptor is a local entity. A
series of Access Manager specific attributes will automatically
loaded in the directory server. defaulturlprefix is used to build
one of the attribute.
-q <meta alias name>, --metaalias <meta alias name>
Used in conjunction with --import.
Implies the imported EntityDescriptor is a local entity. A series
of Access Manager specific attributes will be automatically loaded
to directory server. metaAlias is one of the customizable
attribute.
-x, --xmlsig
Used in conjunction with --export.
If specifed, the exported doc will be signed.
6. Examples
Some of the examples require a dn for operations such as creating new
objects. A base dn of
6.1 Import a service using --schema
A sample service, sampleMailService.xml, is provided and based on the
cd <INSTALL_DIR>/bin
amadmin --runasdn uid=amAdmin,ou=People,dc=example,dc=com
--password passwordvalue
--schema <INSTALL_DIR>/samples/um/user/sampleMailService.xml
To verify this service was imported into Directory Server, follow these
steps.
cd /var/Sun/mps/slapd-<hostname>
db2ldif -s dc=example,dc=com
This displays name of the ldif file stored under the
<DIR_INSTALL_DIR>/slapd-<hostname>/ldif directory.
View that file to ensure that all the attributes and values of the service were imported correctly. WARNING: process may take hours if the number of users is large.
6.2 Create new objects using the
|