22
IOFCMGR Command Reference

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.

autocommit

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.

Prerequisites

None

Syntax

autocommit {on | off}

Parameters

on

Enables Autocommit

off

Disables Autocommit

Usage Notes

When Autocommit is disabled, use the commit command to explicitly commit changes to the database.

Example

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

boot domain

Preconfigures a new domain configuration node (DCN), which allows you to bring it up manually.

Prerequisites

None.

Syntax

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> ;

Parameters

dbconnect

Specifies the connect string for the node's database

dbpassword

Specifies the node's database password

status

Specifies the status of the queue that connects to the community. Valid values are ACIVE and suspendED. Also indicates whether the connection is open (cached).

maxsize

Specifies the maximum message size in bytes accepted by this node

packagesize

Specifies the maximum package size in bytes accepted by this node

timeout

Specifies the postman time out interval, in minutes, when delivering messages to the node. If timeout is not set, the postman uses packagesize + 10 as the time-out interval.

community

Specifies the node's initial community

Example

IOFCMGR> boot domain qualifiedName=oracle.com node=node_28 dbconnect=t:node_
28:db_50 dbpassword=28spwd community=comm1;

boot node

Preconfigures a new member node, which allows you to bring it up manually.

Prerequisites

None.

Syntax

boot node node=<name> dbconnect=<string> dbpassword=<pwd> community=<community> 
[maxsize=<number1>] [packagesize=<number2>];

Parameters

dbconnect

Specifies the connect string to the node database

dbpassword

Specifies the node's database password

community

Specifies the node's initial community

maxsize

Specifies the maximum message size in bytes accepted by this node

packagesize

Specifies the maximum package size in bytes accepted by this node

Example

IOFCMGR> boot node node=node_28 dbconnect=t:node_28:db_50 dbpassword=28spwd 
community=comm1;

bounce

Sends a specific message in a specified queue back to the sender.

Prerequisites

None.

Syntax

bounce queueid=<queueid> msgid=<msgid> [reason="<bounce_message>"];

Parameters

queueid

Specifies the number assigned to the queue in which the message is located. To view a list of queues, use the display command as follows:
display queues;

msgid

Specifies the number assigned to the message you want to bounce. To view a list of messages in a specific queue, use the display command as follows:
display message queueid=<queueid_number>

reason

An optional note to the sender explaining the message is being bounced

Example

IOFCMGR> bounce queueid=299 msgid=848848 reason="No such address.";

change

Edits the command in the buffer.

Prerequisites

You must have entered a command from a category other than General.

Syntax

change /<old_string>/<new_string>

Parameters

<old_string>

Specifies the value you want to change

<new_string>

Specifies the value you want to insert in place of the existing value

Usage Notes

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.

Example

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.

CHECK

Displays the privileges assigned to a person, role, or organization, or the privileges assigned on an object.

Prerequisites

None.

Syntax

check [user={<object1> | all}] [userclass=<class1>] item={<object2> | <class2> | 
all} [itemclass=<class3>];

Parameters

user

Identifies the object whose privileges you are checking. Set user equal to the use, role, or organization name whose privileges you are checking. Or, to check the default privileges on an object or class, set user equal to all.

userclass

Identifies the class of the object whose privileges you are checking. Use only if <object1> is not a unique name across classes.

item

Identifies the object or class upon which the user object has privileges

itemclass

Identifies the class of the object upon which the user object has privileges. Use only if <object2> is not a unique name across classes.

Usage Notes

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.

Example

IOFCMGR> check user=all item=alias;

CLEANUP shadows

Removes inactive, or overdue, database shadow processes.

Prerequisites

None.

Syntax

cleanup shadows;

Example

IOFCMGR> cleanup shadows;

commit

Commits data changes made since the last commit or rollback command to the database.

Prerequisites

You must have made changes to the data.

Syntax

commit

Usage Notes

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.

Example

IOFCMGR> commit

connect

Connects the current session to another eMail Server domain.

Prerequisites

You must have access to an administrative account for the new domain.

Syntax

connect <username>/<password>/<connect_string>/<domain>

Parameters

<username>

Specifies the administrator's username for the domain to which you want to connect

<password>

Specifies the administrator's password for the domain to which you want to connect

<connect_string>

Specifies the connect string for the database that contains the domain

<domain>

Specifies the name of the domain to which you want to connect

Usage Notes

The connect command allows the administrator to manage multiple domains without having to log out and log in to the new domain.

Example

IOFCMGR> connect admin/welcome/T:node2:DB2/domain_2

delete

Deletes an eMail Server object.

Prerequisites

There must be objects to delete.

Syntax

delete <class> <keyattr_n>=<value_n> ;

Parameters

<class>

Specifies the class of the object you want to delete, such as person, rule, role, room, organization, gateway, domain, equipment, community, commroute, location, alias, dl, attachtype, attachmap, node, template, prv_template, and folder

<keyattr_n>

One or more key attributes that uniquely identify the object you want to delete

Example

IOFCMGR> delete person username=jsmith;

deregister

Removes a process, parameter, or setting.

Prerequisites

None.

Syntax

deregister <class> <keyattr_n>=<value_n> [...];

Parameters

<class>

Specifies the class of the object you want to deregister, such as gateway, application, synctype, process, paramtype, paramvalue, paramtime

<keyattr_n>

One or more key attributes that uniquely identify the object you want to deregister

Example

IOFCMGR> deregister PARAMTIME server=postman instance=1 STARTTIME=4; 

IOFCMGR> deregister process server=postman instance=2;

display

Displays system status information, such as space usage and queue, process, or replicator package status.

Prerequisites

None.

Syntax

display {DB_SPACE | processes | queueS};

display {QUOTA | shadows} user=<user_name>;

display replicator PACKAGE filename=<value>

display replicator {queue | FOLDERS | ACTIVITY };

display message queueid=<queue_id>;

Parameters

DB_SPACE

Check space usage by tablespace

processes

Check process status

queueS

Display a list of queues and related status items

QUOTA

Check space usage by user. Must include username

shadows

Display a list of any database shadow processes used by eMail Server clients. The following information is displayed:

Either ACTIVE or OVERDUE status to indicate if the corresponding client is still alive

The name of the logged in user

The operating system process ID of the shadow process

The database session ID of the corresponding database session

The serial number of the corresponding database session

user

Specifies the user ID

replicator

Check a specific replicator package (include number), or all replicator queues, folders, and general activity

message

Display a list of messages in a queue and related status items. Must include queueid number.

Example

IOFCMGR> display processes; 
IOFCMGR> display message queueid=1;

echo

Displays messages on the computer screen during batch file execution.

Prerequisites

None.

Syntax

echo <message>

Parameters

<message>

Specifies the message you want to appear on the screen

Usage Notes

Use the echo command in batch files to display messages that indicate the program is running and has reached a certain point.

Example (in batch file)

echo Batch updates in progress...echo Batch updates 10% done...echo Batch 
updates completed.

execute

Runs a batch file.

Prerequisites

There must be a batch file to execute.

Syntax

execute <filename>;

Parameters

<filename>

Specifies the name of the batch file to execute

Example

IOFCMGR> execute update.bat;

exit

Exits from OOMGR.

Prerequisites

None.

Syntax

exit

Usage Notes

Commits uncommitted transactions, exits IOFCMGR, and returns to the operating system prompt.

Example

IOFCMGR> exit

explst

Creates an editable file containing a distribution list or alias data text.

Prerequisites

None.

Syntax

explst {<object_class>} filename=<filename> name=<objectname>;

Parameters

<object_class>

Specifies the object class. Valid values are either ALIAS or DL

filename

Specifies the name of the export file you want to create

name

Specifies the name of the alias or distribution list you are exporting

Usage Notes

The explst command is used with the implst command to move aliases and distribution lists in text format from one node to another.

Example

IOFCMGR> explst dl filename=list.exp name=managers;

export

Exports eMail Server data and user accounts as binary data.

Prerequisites

There must be data or accounts to export.

Syntax

export {<filename> | end};

Parameters

filename

Specifies the name of the export file you want to create

end

Disables the export function

Usage Notes

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.

Example

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;

FETCH

Retrieves and displays an object or class.

Prerequisites

None.

Syntax

fetch <class> <attribute_n>=<value_n> [...];

Parameters

<class>

Specifies the class of the information you want to fetch, such as person, rule, role, room, organization, gateway, domain, equipment, community, commroute, location, alias, dl, attachtype, attachmap, node, connectdata, route, template, prv_template, and folder

<attribute_n>

Identifies the information you want to fetch. To fetch a single object, enter one or more key attribute values.

Usage Notes

The fetch command supports the use of the percent sign (%) as a wildcard.

Example

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%;

GRANT

Provides a user, role, or organization with access to an object.

Prerequisites

None.

Syntax

grant user={<object1> | all} [userclass=<class1>] item={<object2> | <class2> | 
all} [itemclass=<class3>] priv={admin | list | save | send | discover | contents 
| moderate | child};

Parameters

user

Identifies the object to which you are granting privileges, where <object1> specifies the username, role name, or organization name to which you are granting privileges, and all specifies that OOMGR grants this as a public privilege

userclass

Identifies the class of the object to which you are granting privileges. Use only if <object1> is not a unique name across classes.

item

Identifies the object or class upon which the user object has privileges.

itemclass

Identifies the class of the object upon which the user object has privileges. Use only if <object2> is not a unique name across classes.

priv

Identifies directory object privilege you want to grant as follows:

admin grants the user permission to perform any administrative operation on the entries in a given domain

Note: The item is specified by giving the qualified domain name.

send grants the user permission to send messages to collective addressable entries; public distribution lists, roles, locations, and organizations

save grants the user permission to save and print the results of directory searches

list grants the user permission to view a class of entries, such as the Organization class, in eMail Server

Identifies folder privilege you want to grant as follows:

discover makes the folder visible to the user

contents allows the user to view folder contents and create new contents

moderate allows the user to delete messages

child allows the user to create subfolders

admin grants the user all folder privileges

Example

IOFCMGR> grant user=managers userclass=role item=managers itemclass=dl 
priv=send;

help

Starts the online help.

Prerequisites

None.

Syntax

help [<command> [<class>]]

Parameters

<command>

Specifies the command for which you want help

<class>

Specifies the class of object for which you want help

Example

IOFCMGR> help
IOFCMGR> help insert
IOFCMGR> help insert person

host

Displays the operating system prompt and opens a subshell without exiting OOMGR.

Prerequisites

None.

Syntax

host

Usage Notes

When you use the host command and quit or exit at the operating system prompt, you return to OOMGR.

Example

IOFCMGR> host

implst

Imports a text file of alias or distribution list data.

Prerequisites

The file must match the expected format.

Syntax

implst {<object_class>} filename=<filename> overwrite={Y | N};

Parameters

<object_class>

Specifies the object class. Valid values are either ALIAS or DL

filename

Specifies the name of the file you are importing

overwrite

If set to Y, specifies that matching aliases or distribution lists are overwritten. If set to N, matching aliases or distribution lists are not overwritten

Usage Notes

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.

Example

IOFCMGR> implst DL filename=list.imp overwrite=Y;

import

Imports data stored in binary format into eMail Server.

Prerequisites

The file to import must be in binary format.

Syntax

import filename=<filename> [owner=<owner>];

Parameters

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

Usage Notes

The import command is used with the export command to move eMail Server data and user accounts from one node to another.

Example

IOFCMGR> import filename=file.exp;

insert

Adds an eMail Server object record.

Prerequisites

None.

Syntax

insert <class> <keyatt_n>=<value_n> [<attribute_n>=<value_n>];

Parameters

<class>

The class of object you are inserting from, such as person, rule, role, room, organization, gateway, domain, equipment, community, commroute, location, alias, dl, attachtype, attachmap, and folder

<keyatt_n>

One or more required key attributes that you must set

<attribute_n>

Optional attributes that can also be set

Usage Notes

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.

Example

IOFCMGR> insert person username=jdoe;
IOFCMGR> insert dl name=HR_all member=jdoe,dsmith,pwhite,ckent;

list

Displays the command in the buffer.

Prerequisites

You must have entered a command from a category other than General.

Syntax

list

Usage Notes

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.

Example

IOFCMGR> list

modify

Changes parameter or attribute values.

Prerequisites

None.

Syntax

modify <class> <keyatt_n>=<value_n> [...] to <attribute_n>=<newvalue_n> [...];

Parameters

<class>

Specifies the class of objects you want to change, such as application, gateway, synctype, local, monitor, paramtime, paramtype, paramvalue, preference, process, or statistics

<keyattr_n>

Specifies one or more key attributes that uniquely identify the object you are modifying

<attribute_n>

Specifies the attribute or attributes you want to change

Usage Notes

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.

Example

IOFCMGR> modify paramtime server=postman instance=1 starttime=0 to sleeptime=5;

move

Moves the system configuration node (SCN) or the domain configuration node (DCN) services to another node.

Prerequisites

If you use the move DCN command, the new DCN must be in the same domain and must have received and executed all updates.

Syntax

move {SCN | DCN} name=<node>;

Parameters

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

Example

IOFCMGR> move SCN node=node1 move DCN node=node2;

pause

Pauses the screen display after a given number of lines. Also used to view the pause setting or disable the pause function.

Prerequisites

None.

Syntax

pause [{<number> | off}]

Parameters

<number>

Specifies the number of lines after which the display should pause until the user presses Enter

off

Disables the pause function

Example

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

publish

Creates a public distribution list or template from a private distribution list or template.

Prerequisites

None.

Syntax

publish {DL | template} owner=<username> oldname=<oldname> [newname=<newname>];

Parameters

DL

Publish a private distribution list.

template

Publish a private template

owner

Username that owns the distribution list or template

oldname

The name of the private distribution list or template

newname

The name you want to assign to the public version of the distribution list or template

Example

publish template owner=rmiller oldname=enrollform newname="Class Enrollment 
Template";

REFRESH

Restarts all or specific processes.

Prerequisites

The process or processes must be running.

Syntax

refresh all;

refresh server=<processtype> [instance=<number>];

Parameters

all

Specifies restarting all running processes

server

Specifies the type of process you are restarting

instance

Specifies the number of the registered process if you have more than one of this type of process

Usage Notes

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.

Example

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;

register

Adds an eMail Server object.

Prerequisites

None.

Syntax

register <class> <attribute_n>=<value_n> [...];

Parameters

<class>

Specifies the class you are registering, such as application, gateway, synctype, paramtime, paramtype, paramvalue, or process

<attribute_n>

Specifies one or more attributes that you want to set

Usage Notes

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.

Example

IOFCMGR> register process server=postman instance=2 DefaultStartup=enabled;

rem

Denotes comments in an OOMGR batch file that are not executed.

Prerequisites

None.

Syntax

rem <text>

Parameters

<text>

Text of the comment you want to include

Example

rem This file contains updates 
rem for February 29

replicate

Copies a domain or a single class in a domain onto a node.

Prerequisites

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).

Syntax

replicate to {file= <file_name> | node=<node_name>} class={<class_name> | all};

replicate from file=<file_name>;

Parameters

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

Usage Notes

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.

Example

IOFCMGR> replicate node=node1 class=all; 
IOFCMGR> replicate node=node2 class=person;

reroute

Moves all messages in one outbound queue to another outbound queue.

Prerequisites

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.

Syntax

reroute sourceq=<sourceqid> targetq=<targetqid>;

Parameters

sourceq

Specifies the ID of the queue whose messages you want to reroute

targetq

Specifies the ID of the alternate queue

Usage Notes

Use the reroute command as the last step in circumventing a blocked outbound queue. See the following example for the other steps.

Example

To use the command line interface to reroute a message, complete the following steps:

To prevent additional messages from being routed to the blocked queue, connect to the SCN and change the message delivery routes so that the blocked route is no longer the lowest-cost route. Assign the lowest cost to the alternate route.

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>; 
```
Wait for the new message delivery route information to propagate to the node with the blocked queue. This depends on when the replicator and postman run and on the number of nodes through which the information must travel before reaching the node with the blocked queue.
To check that the new message delivery route information has reached the node with the blocked queue, run OOMGR on the node, and enter the following:
```
IOFCMGR> fetch commroute sourcecomm=<source community> targetcomm=<target 
community> connectcomm=<connect community>; 
```
On the node with the blocked queue, refresh the postman processes so that they use the new message delivery route information. To do so, enter the following:
```
IOFCMGR> refresh server=postman; 
```

To reroute the blocked queue, enter the following:

IOFCMGR> reroute sourceq=<blocked_queueID> targetq=<alternate_queueID>;

reset replicator

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.

Prerequisites

None.

Syntax

reset replicator;

Example

IOFCMGR> reset replicator;

resume

Restarts queue or message processing after stopping it.

Prerequisites

You must first use the suspend command to stop the queue or message.

Syntax

resume queue queueid=<queueid>;

resume message queueid=<queueid> msgid=<msgid>;

Parameters

queue

Resume processing a queue

message

Resume processing a message

queueid

Specifies the ID of the queue you are restarting or of the queue containing the message you are restarting

msgid

Specifies the ID of the message you are restarting.

Example

IOFCMGR> resume queue queueid=27;
IOFCMGR> resume message queueid=23 msgid=28384;

REVOKE

Removes access to an object from a person, role, or organization.

Prerequisites

You must use the grant command to grant the user the privilege you are revoking.

Syntax

revoke user={<object1> | all} [userclass=<class1>] item={<object2> | <class2> | 
all} [itemclass=<class3>] priv={admin | list | save | send | discover | contents 
| moderate | child};

Parameters

user

Identifies the object whose privileges you are revoking:, such as username, role name, or organization name. If set to all, specifies the name used for public privileges

userclass

Identifies the class of the object whose privileges you are revoking. Use this only if <object1> is not a unique name across classes

item

Identifies the object or class upon which the user object has privileges

itemclass

Identifies the class of the object upon which the user object has privileges. Use this only if <object2> is not a unique name across classes.

priv

Identifies directory object privilege you are revoking as follows:

admin grants the user permission to perform any administrative operation on the entries in a given domain

Note: The item is specified by giving the qualified domain name.

send grants the user permission to send messages to collective addressable entries; public distribution lists, roles, locations, and organizations

save grants the user permission to save and print the results of directory searches

list grants the user permission to view a class of entries, such as the Organization class, in eMail Server

Identifies folder privilege you are revoking as follows:

discover makes the folder visible to the user

contents allows the user to view folder contents and create new contents

moderate allows the user to delete messages

child allows the user to create subfolders

admin grants the user all folder privileges

Example

IOFCMGR> revoke user=rmiller item=VP itemclass=DL priv=send;

rollback

Discards all information entered since starting OOMGR or since the last commit or rollback, whichever is most recent.

Prerequisites

You must have made changes to the data.

Syntax

rollback

Usage Notes

If Autocommit is enabled, you cannot roll back because changes are committed immediately rather than stored in a buffer.

Example

IOFCMGR> rollback

Run

Executes the command in the buffer.

Prerequisites

You must have entered a command from a category other than General.

Syntax

Run

Usage Notes

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.

Example

IOFCMGR> Run

setpwd

Changes the password for current login or the database for the current node.

Prerequisites

None.

Syntax

setpwd {admin | database};

setpwd user name=<account_id>;

Parameters

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

Usage Notes

When you enter the setpwd command, OOMGR prompts you to enter the new password and re-enter it to confirm it.

Example

IOFCMGR> setpwd user name=blake;

show

Displays eMail Server object records.

Prerequisites

None.

Syntax

show <class> [<attribute_n>=<value_n>] [...] ;
or 
show <class> all ;

Parameters

<class>

Specifies the class you are displaying data for, such as application, gateway, local, monitor, oraclesvr, preference, process, synctype, or statistics

<attribute_n>

Specifies one or more attributes that identify the object or objects you want to show. To show a single object, enter the key attribute value or values.

all

Specifies displaying all objects in the given class

Usage Notes

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.

Example

IOFCMGR> show gateway;
IOFCMGR> show process all server=postman instance=1;
IOFCMGR> show monitor active=Y;

shutdown

Stops all or selected processes.

Prerequisites

At least one eMail Server process must be started up.

Syntax

shutdown all;

shutdown server=<servername> [instance=<number>];

Parameters

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

Usage Notes

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.

Example

IOFCMGR> shutdown server=postman instance=2;

spool

Opens a file for output.

Prerequisites

None.

Syntax

spool [<filename> | off]

Parameters

<filename>

Specifies the name of the file you want to open

off

Disables the spool function

Usage Notes

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.

Example

IOFCMGR> spool file1 spool off

To display the name of the current spool file, enter the following:

IOFCMGR> spool

startup

Starts all or selected processes.

Prerequisites

None.

Syntax

startup all;

startup server=<servername> [instance=<number>];

Parameters

all

Starts up all eMail Server processes for which the DefaultStartup is set to enabled

server

Identifies the type of process to start up

instance

Identifies the specific registered process you want to start up

Usage Notes

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.

Example

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.

Prerequisites

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.

Syntax

subscribe community node=<node> community=<community>;

subscribe domain node=<node>;

Parameters

community

Subscribes a node to a community

domain

Subscribes a node to a domain

node

Specifies the name of the node that you are subscribing to the domain or community

community

Specifies the name of the community to which you are subscribing the node

Example

IOFCMGR> subscribe domain node=node1;
IOFCMGR> subscribe community node=node1 community=comm1;

suspend

Stops queue or message processing.

Prerequisites

None.

Syntax

suspend queue queueid=<queueid>;

suspend message queueid=<queueid> msgid=<msgid>;

Parameters

queue

Stop processing a queue

message

Stop processing a message

queueid

Specifies the ID of the queue you are suspending or of the queue containing the message you are suspending

msgid

Specifies the ID of the message you are suspending

Usage Notes

Use the resume command to restart suspended queues or messages.

Example

IOFCMGR> suspend queue queueid=23;
IOFCMGR> suspend message queueid=28 msgid=837737;

unsubscribe

Removes an eMail Server node from a domain or community.

Prerequisites

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.

Syntax

unsubscribe community node=<node> community=<community>;

unsubscribe domain node=<node>;

Parameters

community

Unsubscribes a node from a community

domain

Unsubscribes a node from a domain

node

Specifies the name of the node that you are unsubscribing from the domain or community

community

Specifies the name of the community from which you are unsubscribing the node

Example

IOFCMGR> unsubscribe domain node=node1;
IOFCMGR> unsubscribe community node=node1 community=comm1;

update

Changes or adds attributes of an object.

Prerequisites

None.

Syntax

update <class> <keyatt_n>=<value_n> [...] to <attribute_n>=<newvalue_n> [...];

Parameters

<class>

Specifies the class of objects you want to change, such as person, rule, role, room, organization, gateway, domain, equipment, community, commroute, location, alias, dl, attachtype, attachmap, node, connectdata, route, template, prv_template, folder

<keyatt_n>

Specifies one or more key attributes that uniquely identify the object you are updating.

<attribute_n>

Specifies one or more attributes you want to change or add.

Usage Notes

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.

Example

IOFCMGR> update person username=rmiller to manager=jclark;

verify

Checks tables and cleans up inconsistent data.

Prerequisites

None.

Syntax

verify {mail | scheduler | directory | names};

Parameters

mail

Checks for and deletes any inconsistent data in the mail tables

scheduler

Checks for and deletes any inconsistent data in the scheduler tables

directory

Checks for and deletes any inconsistent data in the directory tables

names

Checks for aliases and distribution lists, public and private, that refer to invalid users. Restores aliases and distribution lists that were temporarily invalid due to moving users.

Usage Notes

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.

Example

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;

WHOAMI

Displays the current OOMGR login name, node, and domain.

Prerequisites

None.

Syntax

WHOAMI

Usage Notes

Use the WHOAMI command to check which node and domain you are managing.

Example

IOFCMGR> WHOAMI

dbconnect	Specifies the connect string for the node's database
dbpassword	Specifies the node's database password
status	Specifies the status of the queue that connects to the community. Valid values are ACIVE and suspendED. Also indicates whether the connection is open (cached).
maxsize	Specifies the maximum message size in bytes accepted by this node
packagesize	Specifies the maximum package size in bytes accepted by this node
timeout	Specifies the postman time out interval, in minutes, when delivering messages to the node. If timeout is not set, the postman uses packagesize + 10 as the time-out interval.
community	Specifies the node's initial community

dbconnect	Specifies the connect string to the node database
dbpassword	Specifies the node's database password
community	Specifies the node's initial community
maxsize	Specifies the maximum message size in bytes accepted by this node
packagesize	Specifies the maximum package size in bytes accepted by this node

<old_string>	Specifies the value you want to change
<new_string>	Specifies the value you want to insert in place of the existing value

user	Identifies the object whose privileges you are checking. Set user equal to the use, role, or organization name whose privileges you are checking. Or, to check the default privileges on an object or class, set user equal to all.
userclass	Identifies the class of the object whose privileges you are checking. Use only if <object1> is not a unique name across classes.
item	Identifies the object or class upon which the user object has privileges
itemclass	Identifies the class of the object upon which the user object has privileges. Use only if <object2> is not a unique name across classes.

<username>	Specifies the administrator's username for the domain to which you want to connect
<password>	Specifies the administrator's password for the domain to which you want to connect
<connect_string>	Specifies the connect string for the database that contains the domain
<domain>	Specifies the name of the domain to which you want to connect

<class>	Specifies the class of the object you want to delete, such as person, rule, role, room, organization, gateway, domain, equipment, community, commroute, location, alias, dl, attachtype, attachmap, node, template, prv_template, and folder
<keyattr_n>	One or more key attributes that uniquely identify the object you want to delete

DB_SPACE	Check space usage by tablespace
processes	Check process status
queueS	Display a list of queues and related status items
QUOTA	Check space usage by user. Must include username
shadows	Display a list of any database shadow processes used by eMail Server clients. The following information is displayed: Either ACTIVE or OVERDUE status to indicate if the corresponding client is still alive The name of the logged in user The operating system process ID of the shadow process The database session ID of the corresponding database session The serial number of the corresponding database session
user	Specifies the user ID
replicator	Check a specific replicator package (include number), or all replicator queues, folders, and general activity
message	Display a list of messages in a queue and related status items. Must include queueid number.

<object_class>	Specifies the object class. Valid values are either ALIAS or DL
filename	Specifies the name of the export file you want to create
name	Specifies the name of the alias or distribution list you are exporting

filename	Specifies the name of the export file you want to create
end	Disables the export function

<class>	Specifies the class of the information you want to fetch, such as person, rule, role, room, organization, gateway, domain, equipment, community, commroute, location, alias, dl, attachtype, attachmap, node, connectdata, route, template, prv_template, and folder
<attribute_n>	Identifies the information you want to fetch. To fetch a single object, enter one or more key attribute values.

user	Identifies the object to which you are granting privileges, where <object1> specifies the username, role name, or organization name to which you are granting privileges, and all specifies that OOMGR grants this as a public privilege
userclass	Identifies the class of the object to which you are granting privileges. Use only if <object1> is not a unique name across classes.
item	Identifies the object or class upon which the user object has privileges.
itemclass	Identifies the class of the object upon which the user object has privileges. Use only if <object2> is not a unique name across classes.
priv	Identifies directory object privilege you want to grant as follows: admin grants the user permission to perform any administrative operation on the entries in a given domain Note: The item is specified by giving the qualified domain name. send grants the user permission to send messages to collective addressable entries; public distribution lists, roles, locations, and organizations save grants the user permission to save and print the results of directory searches list grants the user permission to view a class of entries, such as the Organization class, in eMail Server Identifies folder privilege you want to grant as follows: discover makes the folder visible to the user contents allows the user to view folder contents and create new contents moderate allows the user to delete messages child allows the user to create subfolders admin grants the user all folder privileges

<command>	Specifies the command for which you want help
<class>	Specifies the class of object for which you want help

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

<class>	The class of object you are inserting from, such as person, rule, role, room, organization, gateway, domain, equipment, community, commroute, location, alias, dl, attachtype, attachmap, and folder
<keyatt_n>	One or more required key attributes that you must set
<attribute_n>	Optional attributes that can also be set

<class>	Specifies the class of objects you want to change, such as application, gateway, synctype, local, monitor, paramtime, paramtype, paramvalue, preference, process, or statistics
<keyattr_n>	Specifies one or more key attributes that uniquely identify the object you are modifying
<attribute_n>	Specifies the attribute or attributes you want to change

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

<number>	Specifies the number of lines after which the display should pause until the user presses Enter
off	Disables the pause function

DL	Publish a private distribution list.
template	Publish a private template
owner	Username that owns the distribution list or template
oldname	The name of the private distribution list or template
newname	The name you want to assign to the public version of the distribution list or template

all	Specifies restarting all running processes
server	Specifies the type of process you are restarting
instance	Specifies the number of the registered process if you have more than one of this type of process

<class>	Specifies the class you are registering, such as application, gateway, synctype, paramtime, paramtype, paramvalue, or process
<attribute_n>	Specifies one or more attributes that you want to set

22IOFCMGR Command Reference

autocommit

Prerequisites

Syntax

Parameters

Usage Notes

Example

boot domain

Prerequisites

Syntax

Parameters

Example

boot node

Prerequisites

Syntax

Parameters

Example

bounce

Prerequisites

Syntax

Parameters

Example

change

Prerequisites

Syntax

Parameters

Usage Notes

Example

CHECK

Prerequisites

Syntax

Parameters

Usage Notes

Example

CLEANUP shadows

Prerequisites

Syntax

Example

commit

Prerequisites

Syntax

Usage Notes

Example

connect

Prerequisites

Syntax

Parameters

Usage Notes

Example

delete

Prerequisites

Syntax

Parameters

Example

deregister

Prerequisites

Syntax

Parameters

Example

display

Prerequisites

Syntax

Parameters

Example

echo

Prerequisites

Syntax

Parameters

Usage Notes

Example (in batch file)

execute

Prerequisites

Syntax

Parameters

Example

exit

Prerequisites

Syntax

Usage Notes

Example

22
IOFCMGR Command Reference

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

sourceq	Specifies the ID of the queue whose messages you want to reroute
targetq	Specifies the ID of the alternate queue

queue	Resume processing a queue
message	Resume processing a message
queueid	Specifies the ID of the queue you are restarting or of the queue containing the message you are restarting
msgid	Specifies the ID of the message you are restarting.

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

<class>	Specifies the class you are displaying data for, such as application, gateway, local, monitor, oraclesvr, preference, process, synctype, or statistics
<attribute_n>	Specifies one or more attributes that identify the object or objects you want to show. To show a single object, enter the key attribute value or values.
all	Specifies displaying all objects in the given class

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

<filename>	Specifies the name of the file you want to open
off	Disables the spool function

all	Starts up all eMail Server processes for which the DefaultStartup is set to enabled
server	Identifies the type of process to start up
instance	Identifies the specific registered process you want to start up

community	Subscribes a node to a community
domain	Subscribes a node to a domain
node	Specifies the name of the node that you are subscribing to the domain or community
community	Specifies the name of the community to which you are subscribing the node

queue	Stop processing a queue
message	Stop processing a message
queueid	Specifies the ID of the queue you are suspending or of the queue containing the message you are suspending
msgid	Specifies the ID of the message you are suspending