admwarpmta(1m) admwarpmta(1m)
NAME
adm_warp_mta - manage MTA databases
SYNTAX
adm_warp_mta -o create_file -f <file>
adm_warp_mta -o delete_file -f <file>
adm_warp_mta -o list_files -f <dir>
adm_warp_mta -o restore_backup_file -f <file>
adm_warp_mta -o add -f <file> -m <MTA> <mta_data>
adm_warp_mta -o modify -f <file> -m <MTA> <mta_data>
adm_warp_mta -o delete -f <file> -m <MTA>
adm_warp_mta -o get -f <file> -m <MTA>
adm_warp_mta -o list -f <file> -m <regexp>
adm_warp_mta -o print -f <file> -m <regexp> [-apply_default]
adm_warp_mta -o not_present -f <file> -m <MTA>
adm_warp_mta -o build -f <file> -t <out_file>
adm_warp_mta -o compile -f <file> -t <out_file>
adm_warp_mta -o install -t <out_file>
adm_warp_mta -o deinstall
adm_warp_mta -o reload
adm_warp_mta -o modify_gdi -m <MTA> -p <prmd_id>
<mta_data>: List chosen from:
-ds <description>
-mn <MTA name>
-on <override name>
-mp <MTA password>
-op <override password>
-dt <doc type list>
-dm <dialogue mode>
-mt <mta type>
-fl <flags>
-fx <fixups>
-nd <naming domain>
-ns <nosend>
-mr <max recips>
-inq <IN queue>
-outq <OUT queue>
-uid <User name>
-gid <Group name>
-shf <Share OUTQ flag>
-maxm <Maximum messages>
-maxd <Maximum disk>
-cdir <Create Directory flag>
-ddir <Delete Directory flag>
-gdic <GDI Country>
-gdia <GDI ADMD>
-gdip <GDI PRMD identifier>
Licensed material--property of Data General Corporation Page 1
admwarpmta(1m) admwarpmta(1m)
-osc <country>
-osa <admd>
-osp <prmd>
-oso <organisation>
-osou <org unit> (order sensitive - 0 to 4 allowed)
-osx <X121 address>
-osui <UA identifier>
-aso <y or n> (add only)
-asf <routing prefix file> (add only)
DESCRIPTION
adm_warp_mta manages the MTA database files of the X.400
MTA.
There are 2 types of MTA database fils - local and global.
A global file is maintained at one X.400 MTA, and can then
be used locally or distributed to other X.400 MTAs in the
MTA network (see adm_warpd(1m)).
A local file is maintained at a X.400 MTA solely for the use
of that MTA. The sysadm(1m) menus that manage the X.400 MTA
can manage only a single local file, called local.iwc.
adm_warp_mta provides operations that let you manipulate a
database. you can create file, edit it by adding an MTA
entry to it, and so on. You can also process a file. For
example, you can compile it.
Once you have edited a file, you must compile it and then
install it before the X.400 MTA can use it. After
installing it, you can issue the reload operation or
terminate and restart the MTA; the MTA will then start to
use the new file. Note that if you use adm_warpd (1m) to
distribute a global MTA database file, then the destination
MTA(s) install the file and start to use it as soon as it
arrives.
The X.400 MTA can operate with a single local database file,
a single global database file, or both. In the latter
case, the information in the local file takes precedence
when there is a value for a field in both the local file and
the global file.
Operations
create_file
Create a new MTA database file.
delete_file
Delete an existing MTA database file.
list_files
Licensed material--property of Data General Corporation Page 2
admwarpmta(1m) admwarpmta(1m)
List, to standard output, the names of the MTA database
files.
restore_backup_file
Restore a backup MTA database file. The editing
operations (add, modify, and delete) save the original
file by inserting ~ at the start of its name. If the
system crashes at just the wrong moment the database
file may be lost. This operation restores it from the
backup file.
add Add an entry for a new MTA to an MTA database file.
modify
Modify an entry for an existing MTA in an MTA database
file.
delete
Delete an entry for an existing MTA from an MTA
database file.
get Get the entry for an existing MTA from an MTA database
file. The operation returns the data in a form
suitable for processing by a shell script. This form
is not suitable for display to a user - use the print
operation to display an entry to a user. The operation
writes the data to standard output, with one line per
database field for the entry:
Line Field
==== =====
1 Description
2 MTA name
3 Override name
4 DO NOT USE
5 MTA password
6 Override password
7 Dialogue mode
8 MTA type
9 Flags
10 Document types
11 Country
12 ADMD name
13 PRMD name
14 Organization name
15 Organizational unit 1
16 Organizational unit 2
17 Organizational unit 3
18 Organizational unit 4
19 Fixups
20 Naming domain
21 Nosend
Licensed material--property of Data General Corporation Page 3
admwarpmta(1m) admwarpmta(1m)
22 Maximum recipients
23 APIA Client INQ
24 APIA Client OUTQ
25 Maximum messages
26 Maximum disk
27 GDI Country
28 GDI ADMD name
29 GDI PRMD identifier
30 X.121 address
31 Unique UA identifier
list List, on standard output, some or all of the MTAs in an
MTA database file. The list is separated by newline
character.
print
Print, on standard output, the entries for some or all
of the MTAs in an MTA database file, in a report format
suitable for display to a user.
not_present
Check whether or not there is an entry for a specified
MTA in an MTA database file.
build
Build command compiles and installs the specified MTA
database file and finally invokes X.400 MTA to reload
the compiled MTA database file.
compile
Compile an MTA database file.
install
Install a compiled MTA database file.
deinstall
Deinstall the currently installed local MTA database
file. After running this operation, issue the reload
operation to make the MTA use only the global MTA
database file.
reload
Causes the X.400 MTA to reload the currently installed
global and/or local MTA database files
modify_gdi
Changes the Private Domain Identifier part of the
Global Domain Identifier to the specified value "-p
prmd_id". The operation also changes the gateway.dat
file to reflect the change in GDI in case of APIA
Client. After the entry is written back to the MTA
Licensed material--property of Data General Corporation Page 4
admwarpmta(1m) admwarpmta(1m)
database, the MTA database is compiled, installed and
X.400 MTA is invoked to reload the compiled MTA
database.
Options
The following options may be used:
-f <file>
Identifies the MTA database file that is the subject of
the operation. In the form local/<name>.iwc for a
local MTA database file, and global/<name>.iwc for a
global MTA database file. <name> identifies the
particular file. If you also use sysadm(1m) to manage
the local database, then you should always use the
<name> local for the local database file.
-f <dir>
Identifies the directory from which files are to be
listed. <dir> can be either local or global.
-m <MTA>
The MTA tag of the MTA entry to be accessed. The MTA
tag is a string that identifies an MTA.
MTA tags are restricted to the Printable String
character set, and must start with an alpha character.
Moreover, MTA tags are case-sensitive. Thus MTA1 is
not the same tag as mta1.
In case of APIA Clients the MTA tag can contain '@'
character. The APIA client name is of the form
"<name>@<Local MTA tag>".
In addition, MTA tags must not contain the characters
space and =, and the value none is not allowed.
To add the default entry, use the tag default_entry.
The MTA default_entry contains default information;
each field in the default information entry applies to
an MTA in the database file unless the MTA has a value
specified for the field.
-m <regexp>
A regular expression, conforming to the syntax of
regcmp(3) that identifies the MTA tags of the MTAs that
are the subject of the operation.
-apply_default
When printing an MTA entry, adm_warp_mta inserts the
information from the default_entry of the file, for
Licensed material--property of Data General Corporation Page 5
admwarpmta(1m) admwarpmta(1m)
fields that do not have a value specified in the MTA
entry. If you omit this option, adm_warp_mta prints
only the information in the MTA entry.
-t <out_file>
The name of the compiler output file. In the form
local/<name>.owc for a local MTA database file, and
global/<name>.owc for a global MTA database file.
<name> identifies the particular file.
For the compile operation, <out_file> must be in the
form local/<name>.owc for a local file, or
global/<name>.owc for a global file . If you also use
sysadm(1m) to manage the local MTA database, then
you should use the <name> local.
For the install operation, <out_file> must be in the
form local/<name>.owc for a local file, or
global/<name>.owc for a global file.
-p <prmd_id>
The Private Domain Identifier, this is used in
conjuction with the Country name and the Administration
Domain name to form Global Domain Identifier. The value
of the Private Domain Identifier could be a Numeric
String or a Printable String.
Refer to the X.400 standards for the details on GDI or
PRMD_ID.
<mta_data>
You represent the data in an MTA entry by using zero or
all of the remaining options. Unless otherwise
specified, you cannot duplicate the <mta_data> options.
-ds <description>
A textual description of the MTA. This is for
information only.
-mn <MTA name>
The MTA name of the MTA. Enter IA5 string containing 1
to 32 characters.
If you do not specify a name, it defaults to the MTA
tag.
For X.400 MTAs that are part of your MTA network, we
recommend that you omit the MTA name and let it default
to the MTA tag. However, if you want to specify a
different name from the tag, then you must restrict its
length to 26 characters. The 32 character limit allows
Licensed material--property of Data General Corporation Page 6
admwarpmta(1m) admwarpmta(1m)
you to enter maximum length MTA names for MTAs that are
not part of your network.
MTA name must be same as MTA tag for the APIA Clients.
-on <override name>
The name to be used by the local MTA when connecting to
this MTA. Specify a value for this field only if the
MTA Name in the entry for the local MTA cannot be used
when connecting to this MTA.
The override name is an IA5 string containing 1 to 32
characters.
Override name is not used for APIA Clients.
-mp <MTA password>
The password for this MTA. The password is a string of
1 to 62 bytes.
The password can be either in plain text, or in the
form 0x1234abcd, representing the password in
hexadecimal.
MTA password is not required for the APIA Clients.
-op <override password>
The password to be used by the local MTA when
connecting to this MTA. Specify a value for this field
only if the MTA password in the entry for the local MTA
cannot be used when connecting to this MTA.
The override password is a string of 1 to 62 bytes. It
can be either plain text, or in the form 0x1234abcd,
representing the password in hexadecimal.
Override password is not required for the APIA Clients.
-dt <doc type list>
The <doc type list> is a single argument specifying the
document type(s) that are acceptable to this MTA,
separated by spaces.
To obtain a list of document types, execute the
following command:
$X400USER/sbin/warpc -xdh
-dm <dialogue mode>
The dialogue mode of this MTA.
Licensed material--property of Data General Corporation Page 7
admwarpmta(1m) admwarpmta(1m)
Specify either twa (Two Way Alternate) or mono
(Monologue).
If you do not specify a value, then the value of the
dialogue mode will be either the value in the
default_entry, or if there is no value in the
default_entry, it will default to twa.
Dialogue mode is not required for the APIA Clients.
-mt <mta type>
The mta type of this MTA.
Enter one of
g1984 A standard X.400 (1984) MTA. Either
a DG X.400 MTA or some other 1984
MTA
cs A DG X.400 MTA that is being used
to form a DG backbone. DG X.400 MTA uses
the unidentified content type to
exchange messages with such an MTA
g1988 A standard X.400 (1988) MTA. Either
a DG X.400 MTA or some other 1988
MTA
MTA type of "g1988" is not allowed for the regular
MTAs.
MTA type of "cs" is not allowed for the APIA Clients.
If you do not specify a value, then the value of the
MTA type will be either the value in the default_entry,
or if there is no value in the default_entry, it will
default to g1984.
-fl <flags>
<flags> is a single argument specifying the flags that
apply to this MTA, separated by spaces. The flags
define special characteristics of the MTA.
Flags argument is not required for the APIA Clients.
To obtain a list of flags execute, the following
command:
$X400USER/sbin/warpc -xfh
Licensed material--property of Data General Corporation Page 8
admwarpmta(1m) admwarpmta(1m)
-fx <fixups>
<fixups> is a single argument specifying the fixups
that apply to this MTA, separated by spaces. The
fixups define protocol fixups to be applied when
communicating with this MTA.
To obtain a list of fixups execute, the following
command:
$X400USER/sbin/warpc -xxh
-nd <naming domain>
The naming domain for this MTA.
A naming domain is required only if address mapping is
required when originating messages to this MTA. It
must correspond to the naming domain used in an address
fixup entry in the routing prefix file (see
adm_warp_rpf(1m)).
It must contain between 1 and 64 characters.
Naming domain argument is not required for the APIA
Clients.
-ns <nosend>
Determine whether or not files are to be distributed to
this MTA(see adm_warpd.1m). The value TRUE means the
files are not to be distributed to this MTA. The value
FALSE means the files can be distributed.
If you do not specify a value, then the value defaults
to the value in the default_entry, or if there is no
value in the default_entry, FALSE.
Specify TRUE for the APIA Clients.
-mr <max recips>
The maximum number of recipients that the MTA can
process in a single envelope.
If you do not specify a value, then the value defaults
to the value in the default_entry, or if there is no
value in the default_entry, 100.
A value of zero maps to 100.
-inq <IN queue>
Supply full path of the IN queue in which to store APIA
Server received messages for the client.
Licensed material--property of Data General Corporation Page 9
admwarpmta(1m) admwarpmta(1m)
This argument is not required for the regular MTA.
-outq <OUT queue>
Supply full path of the APIA Client OUT queue from
which APIA Server will pickup APIA Client generated
messages.
This argument is not required for the regular MTA.
-uid <User name>
Supply User name assigned by the system manager to the
APIA Client, this will be used to set permissions on
the APIA Client's IN/OUT directories.
This argument is not required for the regular MTA.
-gid <Group name>
Supply Group name assigned by the system manager to the
APIA Client, this will be used in conjuction with the
Share OUTQ flag to set permissions on the APIA Client's
INQ/OUTQ directories and the configuration files.
This argument is not required for the regular MTA.
-shf <Share OUTQ flag>
Supply TRUE, if the APIA Client wants to share the OUT
queue with someone else. Supply FALSE, if APIA Client
does not want to share OUT queue.
This flag will be used to set appropriate permissions
on the APIA Client's IN/OUT directories and the
configuration files.
This argument is not required for the regular MTA.
-maxm <Maxumum messages>
Supply the number of messages the APIA Client can have
outstanding in the IN queue. The number supplied
represents maximum number of messages APIA server can
put in APIA Client's IN queue at a time.
This argument is not required for the regular MTA.
-maxd <Maximum disk>
Supply number of disk blocks to be used to store
messages in the APIA Client's IN queue. The number
represents the maximum nuber of blocks, that APIA
Server can use to store messages in APIA Client's IN
queue.
One disk block corresponds to 512 bytes.
Licensed material--property of Data General Corporation Page 10
admwarpmta(1m) admwarpmta(1m)
This argument is not required for the regular MTA.
-cdir <Create Directory flag>
When the IN/OUT queues are not default directories,
user can select to create them himself. If the flag is
set to "yes", the script will try to create IN/OUT
queues and set permissions on it.
If the flag is set to "no", the script will not create
the IN/OUT queues, user can create them himself. This
is useful when the IN/OUT queues require Network File
System(NFS) access, as the directory creation may fail
through script due to access problems resulting from
password mismatch.
-ddir <Delete Directory flag>
When the IN/OUT queues are not default directories,
user can select to not delete them when deleting the
APIA Client entry.
If the flag is set to "yes", the script will try to
delete the IN/OUT queues.
If the flag is set to "no", the script will not try to
delete the IN/OUT queues. This is useful when the
IN/OUT queues require NFS access, as the directory
deletion may fail due to access problems.
-gdic <GDI Country>
Country name component of the Global Domain
Identifier(GDI) for the APIA Client.
This argument is not required for the regular MTA.
-gdia <GDI ADMD>
Supply Administration Domain(ADMD) component of the GDI
for the APIA Client.
This argument is not required for the regular MTA.
-gdip <GDI PRMD identifier>
Supply Private Domain identifier(PRMD-ID) component of
the GDI for the APIA Client.
This argument is not required for the regular MTA.
-osc <country>
The country name component of the ORName stem for this
MTA.
Licensed material--property of Data General Corporation Page 11
admwarpmta(1m) admwarpmta(1m)
Enter either 2 alpha characters or 3 numeric
characters.
You normally assign the ORName stem to be one of the
partial ORNames for which the MTA is responsible.
-osa <admd>
The ADMD (Administration Domain) Name component of the
ORName stem for this MTA.
From 1 to 16 Printable String characters.
-osp <prmd>
The PRMD (Private Domain) Name component of the ORName
stem for this MTA.
From 1 to 16 Printable String characters.
-oso <organization>
The organization name component of the ORName stem for
this MTA.
From 1 to 64 Printable String characters.
-osou <org unit>
You can specify from zero to four -osou options,
representing the Organizational Unit components of the
ORName stem for this MTA. The order of the options
must correspond to the order of the organizational
units in the ORName.
Each organizational unit is from 1 to 32 Printable
String characters.
-osx <X121 address>
Supply X.121 address component of the X.121 network
address. The X.121 network address consists of Country,
ADMD and X.121 address.
X.121 address is a numeric value, from 1 to 15
characters which numerically identifies a user relative
to a specified ADMD and Country.
X.121 network address is not valid for a Local MTA. -
osui <UA identifier> Supply Unique User Agent(UA)
identifier address component of the UAID address. UAID
address consists of Country, ADMD and UA identifier.
UA identifier is a numeric value, from 1 to 32
characters.
UAID address is not valid for Local MTA. -aso <y or n>
Licensed material--property of Data General Corporation Page 12
admwarpmta(1m) admwarpmta(1m)
For X.400 MTA to route messages to the ORName formed
from the ORName stem of the MTA there must be an
appropriate routing prefix in the routing prefix file
(see adm_warp_rpf(1m)). When using the add operation,
you can request that adm_warp_mta invokes adm_warp_rpf
to add a routing prefix for the stem and the new MTA.
If you wish adm_warp_mta to invoke adm_warp_rpf, then
specify the value y for this option, and supply the
-asf option; otherwise, omit the -aso option or specify
the value n.
-asf <routing prefix file>
The routing prefix file, in the form local/<name>.rpf
or global/<name>.rpf, to which the routing prefix is to
be added. This option is relevant only if you specify
'-aso y'.
EXAMPLES
To create a file:
adm_warp_mta -o create_file -f global/database.iwc
To delete a file:
adm_warp_mta -o delete_file -f global/database.iwc
To list the files:
adm_warp_mta -o list_files -d global
To restore a backup file:
adm_warp_mta -o restore_backup_file -f global/~database.iwc
To add an entry:
adm_warp_mta -o add -f global/database.iwc -m MTA1 \
-ds "MTA description" -mn "MTA1_NAME" \
-on "MTA1_OVERRIDE_NAME" -mp "PASSWORD" \
-op 0x123456 -dt "g_txt g3_fax" \
-dm mono -mt g1984 -fl "noauth central" \
-fx "strip_int_trace api_nist" \
-nd "OTHER_DOMAIN" -ns TRUE -mr 1000 \
-osc GB -osa DG -osp DGC -oso CAMBRIDGE \
-osou OU1 -osou OU2 -aso y -asf global/global.rpf
To modify an entry:
adm_warp_mta -o modify -f global/database.iwc -m MTA1 \
-ds "Modified MTA description" -mn "MTA1_NAME" \
-on "MTA1_OVERRIDE_NAME" -mp "PASSWORD" \
-op 0x123456 -dt "g_txt g3_fax" \
Licensed material--property of Data General Corporation Page 13
admwarpmta(1m) admwarpmta(1m)
-dm mono -mt g1984 -fl "noauth central" \
-fx "strip_int_trace api_nist" \
-nd "OTHER_DOMAIN" -ns TRUE -mr 1000 \
-osc GB -osa DG -osp DGC -oso CAMBRIDGE \
-osou OU1 -osou OU2 -aso y -asf global/global.rpf
To delete an entry:
adm_warp_mta -o delete -f global/database.iwc -m MTA1
To list entries:
adm_warp_mta -o list -f global/database.iwc -m '^MTA1$'
To print entries:
adm_warp_mta -o print -f global/database.iwc -m '^MTA.*$' \
-apply_default
To check for the presence of an entry:
adm_warp_mta -o not_present -f global/database.iwc -m MTA1
if [ $? = 0]
then
...
else
echo "MTA already present in file"
fi
To compile a file:
adm_warp_mta -o compile -f global/database.iwc -t global/database.owc
To install a file:
adm_warp_mta -o install -t global/database.owc
To deinstall the local file:
adm_warp_mta -o deinstall
To reload the currently installed database(s):
adm_warp_mta -o reload
DIAGNOSTICS
Exit Codes
0 The operation was performed successfully.
1 An error occurred during the execution of the
operation.
Licensed material--property of Data General Corporation Page 14
admwarpmta(1m) admwarpmta(1m)
3 There was an error in the command line.
ENVIRONMENT
The following environment variables are used:
X400USER
The directory in which the X.400 MTA to be managed is
installed. If this variable is not set, then the
directory defaults to /usr/opt/x400.
SEE ALSO
adm_warpd(1m), adm_warp_rpf(1m).
NOTES
The options on the command line must occur in the order
specified in the SYNTAX section. The <mta data> options can
occur within themselves in any order, except for the -osou
options, the order of which determines the order of the
organizational units in the ORName stem.
adm_warp_mta uses admlock(1m) to prevent undesirable
interactions between multiple concurrent invocations of
itself.
Licensed material--property of Data General Corporation Page 15