Oracle eMail Server Administrator's Guide Release 5.2 A86653-01 |
|
This chapter contains an entry for each valid OOMGR command. Each command is followed by a brief description of its purpose and any prerequisites for proper use. In addition, the proper syntax, keywords, and command parameters are provided.
See "Using OOMGR" for general instructions on how to start and use OOMGR.
Specifies whether the Autocommit feature, which automatically commits changes to the database after each command, is enabled or disabled. If no parameters are specified, checks if Autocommit is enabled.
Note: Autocommit is enabled by default.
None
autocommit {on | off}
on |
Enables Autocommit |
off |
Disables Autocommit |
When Autocommit is disabled, use the commit command to explicitly commit changes to the database.
To check whether Autocommit is enabled, enter the following:
IOFCMGR> autocommit
To enable Autocommit, enter the following:
IOFCMGR> autocommit on
To disable Autocommit, enter the following:
IOFCMGR> autocommit off
Preconfigures a new domain configuration node (DCN), which allows you to bring it up manually.
None.
boot domain qualifiedName=<qualified_name> [description=<description>] autoinit={enabled | disabled} node=<node_name> dbconnect=<string> dbpassword=<pwd> [status=<status>] [maxsize=<number1>] [packagesize=<number2>] NUMBINFO=<info> community=<community> ;
IOFCMGR> boot domain qualifiedName=oracle.com node=node_28 dbconnect=t:node_ 28:db_50 dbpassword=28spwd community=comm1;
Preconfigures a new member node, which allows you to bring it up manually.
None.
boot node node=<name> dbconnect=<string> dbpassword=<pwd> community=<community> [maxsize=<number1>] [packagesize=<number2>];
IOFCMGR> boot node node=node_28 dbconnect=t:node_28:db_50 dbpassword=28spwd community=comm1;
Sends a specific message in a specified queue back to the sender.
None.
bounce queueid=<queueid> msgid=<msgid> [reason="<bounce_message>"];
IOFCMGR> bounce queueid=299 msgid=848848 reason="No such address.";
Edits the command in the buffer.
You must have entered a command from a category other than General.
change /<old_string>/<new_string>
<old_string> |
Specifies the value you want to change |
<new_string> |
Specifies the value you want to insert in place of the existing value |
Use the change command with the list and Run commands to display, modify, and run the command saved in the buffer.
The last command entered that manipulated data is saved in the buffer. The list command displays the contents of the buffer. The change command allows you to modify the command in the buffer. The Run command runs the modified command in the buffer.
If the following command is entered:
IOFCMGR> fetch person username=ating;
and you now want to fetch information on user jsmith, enter the following:
IOFCMGR> change /ating/jsmith
Enter the Run command to run the modified command.
Displays the privileges assigned to a person, role, or organization, or the privileges assigned on an object.
None.
check [user={<object1> | all}] [userclass=<class1>] item={<object2> | <class2> | all} [itemclass=<class3>];
If you use the check command without specifying a user, displays all users that have explicit grants on the item. Also shows any non-explicit (inherited) grants on the same item.
IOFCMGR> check user=all item=alias;
Removes inactive, or overdue, database shadow processes.
None.
cleanup shadows;
IOFCMGR> cleanup shadows;
Commits data changes made since the last commit or rollback command to the database.
You must have made changes to the data.
commit
If Autocommit is enabled, do not use the commit command. If you use the commit command when Autocommit is enabled, the following message appears:
Autocommit is set to on. Committing has no effect.
IOFCMGR> commit
Connects the current session to another eMail Server domain.
You must have access to an administrative account for the new domain.
connect <username>/<password>/<connect_string>/<domain>
The connect command allows the administrator to manage multiple domains without having to log out and log in to the new domain.
IOFCMGR> connect admin/welcome/T:node2:DB2/domain_2
Deletes an eMail Server object.
There must be objects to delete.
delete <class> <keyattr_n>=<value_n> ;
IOFCMGR> delete person username=jsmith;
Removes a process, parameter, or setting.
None.
deregister <class> <keyattr_n>=<value_n> [...];
IOFCMGR> deregister PARAMTIME server=postman instance=1 STARTTIME=4; IOFCMGR> deregister process server=postman instance=2;
Displays system status information, such as space usage and queue, process, or replicator package status.
None.
display {DB_SPACE | processes | queueS};
or
display {QUOTA | shadows} user=<user_name>;
or
display replicator PACKAGE filename=<value>
or
display replicator {queue | FOLDERS | ACTIVITY };
or
display message queueid=<queue_id>;
IOFCMGR> display processes; IOFCMGR> display message queueid=1;
Displays messages on the computer screen during batch file execution.
None.
echo <message>
<message> |
Specifies the message you want to appear on the screen |
Use the echo command in batch files to display messages that indicate the program is running and has reached a certain point.
echo Batch updates in progress...echo Batch updates 10% done...echo Batch updates completed.
Runs a batch file.
There must be a batch file to execute.
execute <filename>;
<filename> |
Specifies the name of the batch file to execute |
IOFCMGR> execute update.bat;
Exits from OOMGR.
None.
exit
Commits uncommitted transactions, exits IOFCMGR, and returns to the operating system prompt.
IOFCMGR> exit
Creates an editable file containing a distribution list or alias data text.
None.
explst {<object_class>} filename=<filename> name=<objectname>;
The explst command is used with the implst command to move aliases and distribution lists in text format from one node to another.
IOFCMGR> explst dl filename=list.exp name=managers;
Exports eMail Server data and user accounts as binary data.
There must be data or accounts to export.
export {<filename> | end};
filename |
Specifies the name of the export file you want to create |
end |
Disables the export function |
The export command must be used with the fetch command. Use the fetch command to select the data to export. The export command is used with the import command to move eMail Server data and user accounts from one node to another.
The following example shows the steps necessary to export eMail Server data:
Enter the export command at the prompt, specifying the export filename as follows:
IOFCMGR> export file1;
Fetch the data you want to export as follows:
IOFCMGR> fetch person username=%; <Person_record_1> <Person_record_2> <...> N record(s) exported.
You can enter as many fetch statements as you need to select the data to export. For each fetch statement, OOMGR displays the fetched records, ending with a message that provides the number of records fetched for the export file.
Disable the export function as follows:
IOFCMGR> export end;
Retrieves and displays an object or class.
None.
fetch <class> <attribute_n>=<value_n> [...];
The fetch command supports the use of the percent sign (%) as a wildcard.
To retrieve an entire class with the fetch command, use wildcards for the key attribute values. For example, to retrieve all persons, enter the following:
IOFCMGR> fetch person username=%;
To fetch a single object, specify its class and key attributes. For example, to fetch a ConnectData record, enter the following:
IOFCMGR> fetch ConnectData node=node1 community=comm1;
To fetch a subset of a class, specify the attributes that identify the subset. For example, to fetch all managers, enter the following:
IOFCMGR> fetch person primaryrole=manager;
To fetch all sales managers, enter the following:
IOFCMGR> fetch person primaryrole=manager primaryorg=sales;
To fetch all persons whose last names begin with S, enter the following:
IOFCMGR> fetch person lastname=S%;
Provides a user, role, or organization with access to an object.
None.
grant user={<object1> | all} [userclass=<class1>] item={<object2> | <class2> | all} [itemclass=<class3>] priv={admin | list | save | send | discover | contents | moderate | child};
IOFCMGR> grant user=managers userclass=role item=managers itemclass=dl priv=send;
Starts the online help.
None.
help [<command> [<class>]]
<command> |
Specifies the command for which you want help |
<class> |
Specifies the class of object for which you want help |
IOFCMGR> help IOFCMGR> help insert IOFCMGR> help insert person
Displays the operating system prompt and opens a subshell without exiting OOMGR.
None.
host
When you use the host command and quit or exit at the operating system prompt, you return to OOMGR.
IOFCMGR> host
Imports a text file of alias or distribution list data.
The file must match the expected format.
implst {<object_class>} filename=<filename> overwrite={Y | N};
The implst command is used with the explst command to move aliases and distribution lists in text format from one node to another. Set overwrite to Y if you want to update data.
IOFCMGR> implst DL filename=list.imp overwrite=Y;
Imports data stored in binary format into eMail Server.
The file to import must be in binary format.
import filename=<filename> [owner=<owner>];
filename |
Specifies the name of the file containing the binary data |
owner |
When importing user data, specifies the username of the account into which you are importing the user |
The import command is used with the export command to move eMail Server data and user accounts from one node to another.
IOFCMGR> import filename=file.exp;
Adds an eMail Server object record.
None.
insert <class> <keyatt_n>=<value_n> [<attribute_n>=<value_n>];
Use the insert command to create directory objects, messaging objects, and configuration objects. Use the register command to create other types of objects, such as processes.
IOFCMGR> insert person username=jdoe; IOFCMGR> insert dl name=HR_all member=jdoe,dsmith,pwhite,ckent;
Displays the command in the buffer.
You must have entered a command from a category other than General.
list
Use the list command with the change and Run commands to display, modify, and run the command saved in the buffer.
The last command entered that manipulates data is saved in the buffer. The list command displays the contents of the buffer. The change command allows you to modify the command in the buffer. The Run command runs the modified command in the buffer.
IOFCMGR> list
Changes parameter or attribute values.
None.
modify <class> <keyatt_n>=<value_n> [...] to <attribute_n>=<newvalue_n> [...];
After modifying a parameter or attribute value, use the refresh command to restart the process and enable the changes.
Use the update command to change directory objects, messaging objects, and configuration objects. Use the modify command to change other types of objects such as processes.
IOFCMGR> modify paramtime server=postman instance=1 starttime=0 to sleeptime=5;
Moves the system configuration node (SCN) or the domain configuration node (DCN) services to another node.
If you use the move DCN command, the new DCN must be in the same domain and must have received and executed all updates.
move {SCN | DCN} name=<node>;
SCN |
Move SCN services to another node |
DCN |
Move DCN services to another node in the domain |
name |
Name of the node to which you want to move the SCN or DCN services |
IOFCMGR> move SCN node=node1 move DCN node=node2;
Pauses the screen display after a given number of lines. Also used to view the pause setting or disable the pause function.
None.
pause [{<number> | off}]
<number> |
Specifies the number of lines after which the display should pause until the user presses Enter |
off |
Disables the pause function |
To pause the screen display after every 24 lines, enter the following:
IOFCMGR> pause 24
To view the pause setting, enter the following:
IOFCMGR> pause
To disable the pause function, enter the following:
IOFCMGR> pause off
Creates a public distribution list or template from a private distribution list or template.
None.
publish {DL | template} owner=<username> oldname=<oldname> [newname=<newname>];
publish template owner=rmiller oldname=enrollform newname="Class Enrollment Template";
Restarts all or specific processes.
The process or processes must be running.
refresh all;
or
refresh server=<processtype> [instance=<number>];
Use after you use the modify command to change process parameters so that changes can take effect.
The refresh command operates on the local computer only. Do not use the refresh command on a different computer from the one on which the eMail Server system you are managing is installed.
To refresh all running eMail Server processes, enter the following:
IOFCMGR> refresh all;
To refresh all instances of the postman, enter the following:
IOFCMGR> refresh server=postman;
To refresh instance 2 of the postman, enter the following:
IOFCMGR> refresh server=postman instance=2;
Adds an eMail Server object.
None.
register <class> <attribute_n>=<value_n> [...];
Use the insert command to create directory objects, messaging objects, and configuration objects. Use the register command to create other types of objects such as processes.
IOFCMGR> register process server=postman instance=2 DefaultStartup=enabled;
Denotes comments in an OOMGR batch file that are not executed.
None.
rem <text>
<text> |
Text of the comment you want to include |
rem This file contains updates rem for February 29
Copies a domain or a single class in a domain onto a node.
The node must be subscribed to the domain that owns the information to be copied. Also, you must perform this command on the domain configuration node (DCN).
replicate to {file= <file_name> | node=<node_name>} class={<class_name> | all};
or
replicate from file=<file_name>;
file |
Specifies the name of the file |
node |
Identifies the node to receive the information. |
class |
Specifies the name of the class or, if set to all, copies all classes onto the node |
Use the replicate command to synchronize the information on a node with the information on its DCN. You typically use the replicate command if the node is unable to receive replicator packages for an extended amount of time; if the database is corrupted; or if you do not want to wait for the next automatic update.
IOFCMGR> replicate node=node1 class=all; IOFCMGR> replicate node=node2 class=person;
Moves all messages in one outbound queue to another outbound queue.
If you are rerouting because of a blocked queue, first change the message delivery routes so that messages are routed to an alternate queue rather than to the blocked queue. Ensure that the node with the blocked queue receives the updated message delivery route information and that all instances of the postman on the node with the blocked queue are refreshed.
reroute sourceq=<sourceqid> targetq=<targetqid>;
sourceq |
Specifies the ID of the queue whose messages you want to reroute |
targetq |
Specifies the ID of the alternate queue |
Use the reroute command as the last step in circumventing a blocked outbound queue. See the following example for the other steps.
To use the command line interface to reroute a message, complete the following steps:
In general, to change the cost of a message delivery route, enter the following:
IOFCMGR> update commroute sourcecomm=<source_community> targetcomm=<target_ community> connectcomm=<connect_community> to cost=<cost>;
IOFCMGR> fetch commroute sourcecomm=<source community> targetcomm=<target community> connectcomm=<connect community>;
IOFCMGR> refresh server=postman;
IOFCMGR> reroute sourceq=<blocked_queueID> targetq=<alternate_queueID>;
Resets the replicator to accept a package regardless of its number. Generally, the replicator accepts packages in order of their number. The reset command resets replicator sequencing starting with the number of the next package received.
None.
reset replicator;
IOFCMGR> reset replicator;
Restarts queue or message processing after stopping it.
You must first use the suspend command to stop the queue or message.
resume queue queueid=<queueid>;
or
resume message queueid=<queueid> msgid=<msgid>;
IOFCMGR> resume queue queueid=27; IOFCMGR> resume message queueid=23 msgid=28384;
Removes access to an object from a person, role, or organization.
You must use the grant command to grant the user the privilege you are revoking.
revoke user={<object1> | all} [userclass=<class1>] item={<object2> | <class2> | all} [itemclass=<class3>] priv={admin | list | save | send | discover | contents | moderate | child};
IOFCMGR> revoke user=rmiller item=VP itemclass=DL priv=send;
Discards all information entered since starting OOMGR or since the last commit or rollback, whichever is most recent.
You must have made changes to the data.
rollback
If Autocommit is enabled, you cannot roll back because changes are committed immediately rather than stored in a buffer.
IOFCMGR> rollback
Executes the command in the buffer.
You must have entered a command from a category other than General.
Run
You can use the run command with the change and list commands to display, modify, and run the command saved in the buffer.
The last command entered that manipulate data is saved in the buffer. The list command displays the contents of the buffer. The change command allows you to modify the command in the buffer. The Run command runs the modified command in the buffer.
IOFCMGR> Run
Changes the password for current login or the database for the current node.
None.
setpwd {admin | database};
or
setpwd user name=<account_id>;
admin |
Identifies the admin password |
database |
Identifies the database password |
user |
Identifies the user to whom you are assigning the password |
name |
Identifies the name of the mail account |
When you enter the setpwd command, OOMGR prompts you to enter the new password and re-enter it to confirm it.
IOFCMGR> setpwd user name=blake;
Displays eMail Server object records.
None.
show <class> [<attribute_n>=<value_n>] [...] ; or show <class> all ;
Use the fetch command to display directory objects, messaging objects, and configuration objects. Use the show command to display other types of objects such as processes.
IOFCMGR> show gateway; IOFCMGR> show process all server=postman instance=1; IOFCMGR> show monitor active=Y;
Stops all or selected processes.
At least one eMail Server process must be started up.
shutdown all;
or
shutdown server=<servername> [instance=<number>];
all |
Shuts down all running eMail Server processes |
server |
Identifies the type of process to shut down |
instance |
Identifies the specific instance you want to shut down |
When the last process is shut down, eMail Server prohibits client logins.
Shutdown operates on the local computer only. Do not use the shutdown command on a different computer from the one on which the eMail Server system you are managing is installed.
IOFCMGR> shutdown server=postman instance=2;
Opens a file for output.
None.
spool [<filename> | off]
<filename> |
Specifies the name of the file you want to open |
off |
Disables the spool function |
Use the spool command whenever you want a record of what you have done. For example, you might want to open a spool file before using the verify command to obtain a copy of the results.
IOFCMGR> spool file1 spool off
To display the name of the current spool file, enter the following:
IOFCMGR> spool
Starts all or selected processes.
None.
startup all;
or
startup server=<servername> [instance=<number>];
The startup command operates on the local computer only. Do not use the startup command on a different computer from the one on which the eMail Server system you are managing is installed.
IOFCMGR> startup server=replicator instance=2 startup all;
To start up all instances of the postman, enter the following:
IOFCMGR> startup server=postman;
Adds a node to a community or designates a node to receive information from a domain.
You must log in to the system configuration node (SCN) to subscribe to a community. To subscribe to a domain, you must log in to the domain configuration node (DCN) for the domain.
subscribe community node=<node> community=<community>;
or
subscribe domain node=<node>;
IOFCMGR> subscribe domain node=node1; IOFCMGR> subscribe community node=node1 community=comm1;
Stops queue or message processing.
None.
suspend queue queueid=<queueid>;
or
suspend message queueid=<queueid> msgid=<msgid>;
Use the resume command to restart suspended queues or messages.
IOFCMGR> suspend queue queueid=23; IOFCMGR> suspend message queueid=28 msgid=837737;
Removes an eMail Server node from a domain or community.
The node must subscribe to the domain or community. You must log in to the SCN to unsubscribe from a community. To unsubscribe from a domain, you must log in to the DCN.
unsubscribe community node=<node> community=<community>;
or
unsubscribe domain node=<node>;
IOFCMGR> unsubscribe domain node=node1; IOFCMGR> unsubscribe community node=node1 community=comm1;
Changes or adds attributes of an object.
None.
update <class> <keyatt_n>=<value_n> [...] to <attribute_n>=<newvalue_n> [...];
Use the update command to change directory objects, messaging objects, and configuration objects. Use the modify command to change other types of objects, such as processes.
IOFCMGR> update person username=rmiller to manager=jclark;
Checks tables and cleans up inconsistent data.
None.
verify {mail | scheduler | directory | names};
To keep a record of work done by the verify command, use the verify command with the spool command.
Use the verify command before and after any changes to, or transfers of, large amounts of data.
To use the verify and spool commands together, enter a series of commands such as the following:
IOFCMGR> spool filename; IOFCMGR> verify mail; IOFCMGR> spool off;
Displays the current OOMGR login name, node, and domain.
None.
WHOAMI
Use the WHOAMI command to check which node and domain you are managing.
IOFCMGR> WHOAMI
|
![]() Copyright © 2001 Oracle Corporation. All Rights Reserved. |
|