21
Administration Tool Command Line Reference

This chapter contains an entry for each command available in the Administration Tool command-line interface. Each command is followed by a brief description of its purpose. In addition, the proper syntax, keywords, and command parameters are provided. Refer to "Using the Administration Tool Command-Line Interface" for general instructions on how to start and use the Administration Tool command-line interface.

---

alias

Use alias to create an alias that you can use as a regular command. The alias can accept arguments and perform multiple commands.

Syntax

alias <aliasName> "<command1>;<command2>..."

Guidelines

The first argument is represented by command1 in the command. The second argument is command2. The commands of an alias may contain other aliases that have already been created.

Example

To create an alias (showchild) that changes to an object in the navigation tree (cd) specified by an argument (bluesky) that the user enters when executing the alias, and then displays the child objects of the specified object (ls):

Admin> alias showchild "cd bluesky;ls;"

To use the alias to display the child objects of messaging:

Admin> showchild messaging

See Also: "unalias"

---

cd

Use cd to move to a different object in the navigation tree (similar to changing directories in your operating system's file system).

Syntax

cd or cd /	Change to admin root (admin root is represented by a /).
cd <path>	Change to an object path.
cd <indexNumber>	Change to an object in the navigation tree, use the object index number. Note: To find the object index number, use cd to change to the parent object and use ls to display the child objects. The object index number is displayed in brackets [ ] next to the child object.
cd nextPage	Change to the next step in a wizard. This is equivalent to clicking the Next button in a GUI wizard.

Example

To change to the /messaging object:

Admin> cd /messaging

---

commit

Use commit to save all the changes that you have made for the current object.

Syntax

commit

Example

To commit a new location object:

Admin> set name=HQ1 admin=jdoe desc="Headquarters Building 1" parent=HQ
Admin> commit

See Also: "set"

---

desc

Use desc to display the properties for the current object, including property names, descriptions and possible values if there are limitations.

Syntax

desc	Display all property names, descriptions, and possible values for the current object.
desc <prop1> <prop2>...	Display specific properties for the current object.

---

echo

Use echo to display arguments that you specify on the next line.

Syntax

echo	Display a blank line.
echo <arg1> <arg2>...	Display arguments that you specify.

---

execfile

Use execfile to read and execute one line at a time from a file that you specify. You can use this to execute Administration Tool command-line scripts (you cannot use this command to execute OOMGR scripts).

Syntax

execfile <filename>

Example

To open the commandFile file and execute each line in the file as a command:

Admin> execfile commandFile

---

exit

Use exit to disconnect, or log off, from the database and exit the command-line tool.

Syntax

exit

---

find

Use find to search the directory for a directory entry.

Syntax

find <prop1>=<value1> <prop2>=<value2>...

Example

To find a person entry with the first name beginning with J and an office location at HQ:

find "Search in"=Person firstname=J% office="HQ"

---

get

Use get to display all the available properties for an object.

Syntax

get	Display all available properties for the current object.
get . <prop1> <prop2>...	Display a subset of the available properties for the current object.
get <objectName> or get <indexNumber>	Display all available properties for a specific object. You can enter the name of the object or the object index number. Note: To find the object index number, use cd to change to the parent object and use ls to display the child objects. The object index number is displayed in brackets [ ] next to the child object.
get <objectName> <prop1> <prop2>... or get <indexNumber> <prop1> <prop2>...	Display a subset of the available properties for a specific object. You can enter the name of the object or the object index number, as well the specific property names. Note: To find the object index number, use cd to change to the parent object and use ls to display the child objects. The object index number is displayed in brackets [ ] next to the child object.

Guidelines

To display properties for a specific object, you must cd to the parent object in the navigation tree before executing the get <objectName> command.

Example

To display all available properties for the Directory Entries object, enter the following command:

Admin> get "Directory Entries"

To display the value property for the Directory Entries object:

Admin> get "Directory Entries" value

---

help

Use help to display information about how to use the commands.

Syntax

help	Display a list of commands.
help <command>	Display details of how to use a specific command.

Example

To display instructions for using the ls command:

Admin> help ls

---

helplevel

Use helplevel to set the level of help.

Syntax

helplevel	Display the current help level.
helplevel <number>	Set the help level (enter a number).

Guidelines

The help level can be 0, 1, or 2.

Example

To set the help level to 1:

Admin> helplevel 1

---

if

Use if to specify that a command should be executed if the specified child object exists or does not exist, or if the last command was or was not successful.

Syntax

if exists <childObject1> then <command1> <command2>... else <command3> <command4>... endif	If childObject1 exists, then the commands after then (command1 and command2) are executed. If childObject1 does not exist, then the commands after else (command3 and command4) are executed.
if not exists <childObject2> then <command1> <command2>... else <command3> <command4>... endif	If childObject2 does not exist, then the commands after then (command1 and command2) are executed. If childObject2 does exist, then the commands after else (command3 and command4) are executed.
if success then <command1> <command2>... else <command3> <command4>... endif	If the last command was successful, then the commands after then (command1 and command2) are executed. If the last command was not successful, then the commands after else (command3 and command4) are executed.
if not success then <command1> <command2>... else <command3> <command4>... endif	If the last command was not successful, then the commands after then (command1 and command2) are executed. If the last command was successful, then the commands after else (command3 and command4) are executed.

Example

---

listalias

Use listalias to display all aliases that have been defined using the alias command. The first column in the list displays the alias name, and the remaining columns display the commands that are executed by the alias.

Syntax

listalias

See Also: "alias"

---

loadalias

Use loadalias to load aliases listed in a file. You can use one file to store multiple alias commands.

Syntax

loadalias <filename>

Guidelines

Aliases listed in the alias file should be defined using the syntax for the alias command. Each alias should be on a separate line in the file.

<aliasName1> "<command1>;<command2>;..."
<aliasName2> "<command3>;<command4>;..."

See Also: "alias"

---

logon

Use logon to specify properties for an object (such as password or domain) and then connect to that object.

Syntax

logon <objectName> <prop1>=<value1> <prop2>=<value2>...

Example

To log on to the messaging system, you must specify a user, password, connect string, and domain:

Admin> logon "messaging system" user=admin password=hello "Connect String"=acme 
domain=acme.com

---

ls

Use ls to display a list of child objects located in the current object in the navigation tree. This display includes index numbers that you can use to represent objects in other commands such as the get command.

Syntax

ls	Display a list of all child objects.
ls -l	Display a list of all child objects and all their properties, if available.
ls -l <prop1> <prop2>...	Display a list of all child objects and specific properties, if available.

---

pwd

Use pwd to display the complete path for the current object in the navigation tree.

Syntax

pwd

---

rem

Use rem to indicate a comment line in a file that contains commands that are to be executed. Comment lines are ignored by the system.

Syntax

rem

Example

Admin> rem This is a new test case.

---

run

Use run to execute the command for the current object using the provided arguments.

Syntax

run <command>	Run a command.
run <command> <table_selection1> <table_selection2>...	Run a command to apply an item in a table.

Examples

If you are at the Directory Entries level of the navigation tree, then you can run a directory search after you have specified the search properties using the set command:

Admin> run search

To see the results, use the ls command.

Admin> ls

If you are at the Directory Entries level of the navigation tree, then you can run the new command to add a new user entry to the directory:

Admin> run new user=tester1

If you are at the Directory Entries level of the navigation tree, then you can run the delete command to remove a user entry from the directory (make sure the entry exists first):

Admin> run delete tester1

---

select

Use select to store the selected child objects located under the current object in the navigation tree. This command can only be used for objects that can be selected.

Syntax

select <objectName1> <objectName2>... or select <indexNumber1> <indexNumber2>...

Select an object. You can enter the object name or the index number. Note: To find the object index number, use cd to change to the parent object and use ls to display the child objects. The object index number is displayed in brackets [ ] next to the child object.

Example

To select the objects testobj1 and testobj3:

Admin> select testobj1 testobj3

See Also: "unselect"

---

set

Use set to specify the property values for the current object.

Syntax

set <prop1>=<value1> <prop2>=<value2>...

Example

To set the name property to jdoe:

Admin> set name=jdoe

See Also: "commit"

---

settimeout

Use settimeout to display or set the timeout value for log on (in seconds).

Syntax

settimeout	Display the current timeout value.
settimeout <seconds>	Set the timeout value.

Example

To set the timeout value to 15 seconds:

Admin> settimeout 15

---

shell

Use shell to execute the specified arguments in a system subshell.

Syntax

shell <argument1> <argument2>...

Example

To execute the ls command in a system subshell:

Admin> shell ls foo.java

---

unalias

Use unalias to remove an alias that was previously created using the alias command.

Syntax

unalias <aliasName>

Example

To remove an alias called display:

Admin> unalias display

See Also: "alias"

---

unselect

Use unselect to cancel a selection made with the select command.

Syntax

unselect <objectName1> <objectName2>... or unselect <indexNumber1> <indexNumber2>...

Unselect an object. You can enter the object name or the index number. Note: To find the object index number, use cd to change to the parent object and use ls to display the child objects. The object index number is displayed in brackets [ ] next to the child object.

Example

To unselect the objects called obj1 and obj2:

Admin> unselect obj1 obj2 

See Also: "select"

---

wait

Use wait to insert breaks between commands when running in batch mode. You must enter the number of seconds to wait before executing the next command.

Syntax

wait <seconds>

Guidelines

For the number of seconds, you can specify any integer from 0 to 2147483647.

Example

To wait 10 seconds before executing the next command, enter the following command:

Admin> wait 10