Oracle eMail Server Administrator's Guide Release 5.2 A86653-01 |
|
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.
Use alias
to create an alias that you can use as a regular command. The alias can accept arguments and perform multiple commands.
alias <aliasName
> "<command1
>;<command2
>..."
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.
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
Use cd
to move to a different object in the navigation tree (similar to changing directories in your operating system's file system).
To change to the /messaging object:
Admin> cd /messaging
Use commit
to save all the changes that you have made for the current object.
commit
To commit a new location object:
Admin> set name=HQ1 admin=jdoe desc="Headquarters Building 1" parent=HQ Admin> commit
Use desc
to display the properties for the current object, including property names, descriptions and possible values if there are limitations.
|
Display all property names, descriptions, and possible values for the current object. |
|
Display specific properties for the current object. |
Use echo
to display arguments that you specify on the next line.
|
Display a blank line. |
|
Display arguments that you specify. |
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).
execfile <filename
>
To open the commandFile
file and execute each line in the file as a command:
Admin> execfile commandFile
Use exit
to disconnect, or log off, from the database and exit the command-line tool.
exit
Use find
to search the directory for a directory entry.
find <prop1
>=<value1
> <prop2
>=<value2
>...
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"
Use get
to display all the available properties for an object.
To display properties for a specific object, you must cd
to the parent object in the navigation tree before executing the get <
objectName
>
command.
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
Use help
to display information about how to use the commands.
|
Display a list of commands. |
|
Display details of how to use a specific command. |
To display instructions for using the ls
command:
Admin> help ls
Use helplevel
to set the level of help.
|
Display the current help level. |
|
Set the help level (enter a number). |
The help level can be 0, 1, or 2.
To set the help level to 1:
Admin> helplevel 1
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.
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.
listalias
Use loadalias
to load aliases listed in a file. You can use one file to store multiple alias
commands.
loadalias <filename
>
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
>;..."
Use logon
to specify properties for an object (such as password
or domain
) and then connect to that object.
logon <objectName
> <prop1
>=<value1
> <prop2
>=<value2
>...
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
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.
Use pwd
to display the complete path for the current object in the navigation tree.
pwd
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.
rem
Admin> rem This is a new test case.
Use run
to execute the command for the current object using the provided arguments.
|
Run a command. |
|
Run a command to apply an item in a table. |
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
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.
To select the objects testobj1 and testobj3:
Admin> select testobj1 testobj3
Use set
to specify the property values for the current object.
set <prop1
>=<value1
> <prop2
>=<value2
>...
To set the name
property to jdoe
:
Admin> set name=jdoe
Use settimeout
to display or set the timeout value for log on (in seconds).
|
Display the current timeout value. |
|
Set the timeout value. |
To set the timeout value to 15 seconds:
Admin> settimeout 15
Use shell
to execute the specified arguments in a system subshell.
shell <argument1
> <argument2
>...
To execute the ls
command in a system subshell:
Admin> shell ls foo.java
Use unalias
to remove an alias that was previously created using the alias
command.
unalias <aliasName
>
To remove an alias called display:
Admin> unalias display
Use unselect
to cancel a selection made with the select
command.
To unselect the objects called obj1 and obj2:
Admin> unselect obj1 obj2
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.
wait <seconds
>
For the number of seconds, you can specify any integer from 0 to 2147483647.
To wait 10 seconds before executing the next command, enter the following command:
Admin> wait 10
|
Copyright © 2001 Oracle Corporation. All Rights Reserved. |
|