admwarprpf(1m) admwarprpf(1m)
NAME
adm_warp_rpf - manage routing prefix files
SYNTAX
adm_warp_rpf -o create_file -f <file>
adm_warp_rpf -o delete_file -f <file>
adm_warp_rpf -o list_files -f <dir>
adm_warp_rpf -o restore_backup_file -f <file>
adm_warp_rpf -o add -f <file> <rp or fx> <id> <data>
adm_warp_rpf -o modify -f <file> <rp or fx> <id> <data>
adm_warp_rpf -o delete -f <file> <rp or fx> <id>
adm_warp_rpf -o get -f <file> <rp or fx> <id>
adm_warp_rpf -o list -f <file> <rp or fx> <id>
adm_warp_rpf -o print -f <file> <rp or fx> <id>
adm_warp_rpf -o not_present -f <file> <rp or fx> <id>
adm_warp_rpf -o build -f <file>
adm_warp_rpf -o install -f <file>
adm_warp_rpf -o compile
adm_warp_rpf -o reload
adm_warp_rpf -o export_private
adm_warp_rpf -o export_shared
adm_warp_rpf -o deinstall
<rp or fx>: -rp (routing prefix) or -fx (address fixup entry)
<id>: <ORName> (no CND)
<data>:
for -rp: -mta MTA # 1 to 10
OR for -fx: -pa <ORName> # 1 to 5
<ORName>: ">CND=...>C=...>ADMD=...>PRMD=...>O=...>OU=...>OU=..."
">S=...>G=...>I=...>GQ=...
# CND only for address fixup entries
# S, G, I and GQ only for RP entries
DESCRIPTION
adm_warp_rpf manages the routing prefix files of the X.400
MTA.
A routing prefix file contains the following:
Routing Prefixes
A routing prefix is a form 1 variant 1 ORName (either
partial or full), with an associated list of 1-10 MTA
tags (see adm_warp_mta(1m)). The X.400 MTA performs
routing by doing a best match of the ORName to be
routed against the prefixes in the currently compiled
Licensed material--property of Data General Corporation Page 1
admwarprpf(1m) admwarprpf(1m)
files (see later for a description of compilation).
The X.400 MTA sends the message to one of the MTAs
associated with the prefix that was the best match.
Address Fixups
An address fixup enables the X.400 MTA to map the
originator ORName from the form used in one ADMD into
the form required by another ADMD, when originating the
message into the other ADMD. X.400 only performs such
a mapping if there is a naming domain field in the MTA
database entry for the destination MTA (see
adm_warp_mta(1m)). To perform the mapping, the MTA
does a best match of the ORName against the <ids> of
address fixup entries that specify the required naming
domain (CND). It then replaces the components of the
ORName that matched with the ORName components
specified in the fixup data for the required naming
domain.
There are 4 types of routing prefix file.
First we describe the local and global routing prefix files.
These are similar in purpose to the local and global MTA
database files maintained by adm_warp_mta(1m).
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 a single local file, called local.rpf.
adm_warp_rpf provides operations that let you manipulate the
routing prefix database. You can create the database; edit
the database by adding a prefix and so on. You can also
process the database for example , you can compile it.
Once you have edited a file, you must install it and then
run the compile operation before the X.400 MTA can use it.
After running the compile operation, 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 routing prefix file,
then the destination MTA(s) install the file as soon as it
arrives. They do not, however, compile it. A cron job
normally runs once a day to compile, and then reload (see
adm_warpd(1m)).
In addition to the local and global routing prefix files,
there are two other types of routing prefix file that enable
you to integrate automatically generated routing information
Licensed material--property of Data General Corporation Page 2
admwarprpf(1m) admwarprpf(1m)
with the other files. For example, you might want to
generate routing information automatically from your own
proprietary directory service.
The other files are:
shared routing information
The shared routing information is information that
enables the MTAs sharing a routing prefix to make the
correct routing decision. For example a routing prefix
might "belong" to 2 MTAs. When the message arrives at
one of these MTAs, the shared routing information
enables the MTA to decide if the message is destined to
it, or to the other MTA. Each MTA sharing the routing
prefix needs to generate shared routing information and
send it to the other MTAs sharing the routing prefix.
The export_shared operation generates the shared
routing information. adm_warpd(1m) normally runs a
cron job once a day to invoke the export_shared
operation, and then initiate the transfer of the
information to other MTAs sharing the same routing
prefix(es).
Private routing information
The private routing information is automatically
generated routing information private to the MTA. The
export_private operation generates the private routing
information. adm_warpd(1m) normally runs a cron job
once a day to invoke the export_private operation.
When you compile the routing files, adm_warp_rpf compiles
the most recently installed global file, the most recently
received shared routing information files from MTAs sharing
prefixes with the local MTA, the most recently generated
private routing information file, and the most recently
installed local file. Information in later files in the
preceding list overrides information in the former.
There does not need to be a file of each type present.
However, there must be at least one routing prefix file.
Operations
create_file
Create a new routing prefix file.
delete_file
Delete an existing routing prefix file.
list_files
List, to standard output, the names of the routing
prefix files.
Licensed material--property of Data General Corporation Page 3
admwarprpf(1m) admwarprpf(1m)
restore_backup_file
Restore a backup routing prefix 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 file may
be lost. This operation restores it from the backup
file.
add Add a new routing prefix or address fixup to a routing
prefix file.
modify
Modify an existing routing prefix or address fixup in a
routing prefix file.
delete
Delete an existing routing prefix or address fixup from
a routing prefix file.
get Get the entry for an existing routing prefix or address
fixup from a routing prefix 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.
For a routing prefix, the entry is displayed as a blank
first line followed by the MTA tags on the second line,
separated by the character '~'.
For an address fixup, the entry is displayed as
follows:
First line: count of fixups
For each fixup: The country, admd, prmd, organization
and ous printed on separate lines.
list List, on standard output, some or all of the routing
prefixes or address fixups in a routing prefix file.
The list operation displays all of the routing prefixes
or address fixups that match the <id> option.
print
Print, on standard output, some or all of the routing
prefixes or address fixups in a routing prefix file, in
a report format suitable for displaying to a user.
The print operation displays all of the routing
prefixes or address fixups that match the <id> option.
Licensed material--property of Data General Corporation Page 4
admwarprpf(1m) admwarprpf(1m)
not_present
Check whether or not there is an entry for a routing
prefix or address fixup in a routing prefix file.
all the
Build command installs specified routing prefix file, compiles
routing prefix files and finally invokes X.400 MTA to
reload the compiled routing prefix files.
install
Install a routing prefix file.
compile
Compile the currently installed routing prefix file(s).
reload
Causes the X.400 MTA to reload the most recently
compiled routing prefix file(s).
deinstall
Deinstall the currently installed local routing prefix
file. After running this operation, run the compile
and reload operations to make the change take effect.
export_shared
Export the shared routing information from the local
system to the X.400 MTA.
export_private
Export the private routing information from the local
system to the X.400 MTA.
Options
The following options may be used:
-f <file>
Identifies the routing prefix file that is the subject
of the operation. In the form local/<name>.rpf for a
local MTA database file, and global/<name>.rpf for a
global MTA database file. <name> identifies the
specific file. If you also use sysadm(1m) to manage
the local database, then you should always use the
<name> of the local database file.
-f <dir>
Identifies the directory from which files are to be
listed. <dir> can be either local or global.
<rp or fx>
-rp indicates that the operation is to manipulate a
Licensed material--property of Data General Corporation Page 5
admwarprpf(1m) admwarprpf(1m)
routing prefix entry. -fx indicates that the operation
is to manipulate an address fixup entry.
<id> The ORName for the routing prefix or address fixup
entry. Specify this in the following form:
>C=..>ADMD=..>PRMD=..>O=..>OU=..>OU=..>S=..>G=..>I=..>GQ=..
where
Mnemonic Means
======== =====
C country
ADMD Administration Domain Name
PRMD Private Domain Name
O Organization
OU Organizational Unit
S Surname
G Given Name
I Initials
GQ Generation Qualifier
Each <id> must have at least a country. The other
fields are optional provided that they form a valid
partial ORName. For example you cannot specify just a
country and a surname.
Example id:
>C=gb>ADMD=gold 400>PRMD=dgc
The <id> for an address fixup cannot contain the
personal name fields.
<data>
The data for the routing prefix or address fixup entry.
For a routing prefix, specify from one to ten MTA tags
(see adm_warp_mta(1m)) in the following form:
-mta <MTA tag>
For an address fixup entry, specify from one to five
fixups, in the following form
-pa <ORName>
where <ORName> has the same syntax as an address fixup
<id>, with the addition of the Naming Domain in the
form >CND=... at the start of the <id>, for example
>CND=mercury>C=gb...
Licensed material--property of Data General Corporation Page 6
admwarprpf(1m) admwarprpf(1m)
EXAMPLES
To create a file:
adm_warp_rpf -o create_file -f global/database.rpf
To delete a file:
adm_warp_rpf -o delete_file -f global/database.rpf
To list the files:
adm_warp_rpf -o list_files -d global
To restore a backup file:
adm_warp_rpf -o restore_backup_file -f global/~database.rpf
To add a routing prefix:
adm_warp_rpf -o add -f global/database.rpf \
-rp ">C=gb>ADMD=gold 400>PRMD=dgc>O=cambridge" \
-mta MTA1 -mta MTA2
To modify a routing prefix:
adm_warp_rpf -o modify -f global/database.rpf \
-rp ">C=gb>ADMD=gold 400>PRMD=dgc>O=cambridge" \
-mta MTA1 -mta MTA2 -mta MTA3
To delete a routing prefix:
adm_warp_rpf -o delete -f global/database.rpf \
-rp ">C=gb>ADMD=gold 400>PRMD=dgc>O=cambridge"
To list routing prefixes:
adm_warp_rpf -o list -f global/database.rpf \
-rp ">C=gb"
To print routing prefixes:
adm_warp_rpf -o print -f global/database.rpf \
-rp ">C=gb>ADMD=gold 400"
To check for the presence of a routing prefix:
adm_warp_rpf -o not_present -f global/database.rpf \
-rp ">C=gb>ADMD=gold 400"
if [ $? = 0 ]
then
...
else
Licensed material--property of Data General Corporation Page 7
admwarprpf(1m) admwarprpf(1m)
echo "Prefix already present in file"
fi
To add an address fixup:
adm_warp_rpf -o add -f global/database.rpf \
-fx ">C=gb>ADMD=gold 400" \
-pa ">CND=mercury>C=gb>ADMD=mercury"
To modify an address fixup:
adm_warp_rpf -o add -f global/database.rpf \
-fx ">C=gb>ADMD=gold 400" \
-pa ">CND=mercury>C=123>ADMD=mercury"
To delete an address fixup:
adm_warp_rpf -o delete -f global/database.rpf \
-fx ">C=gb>ADMD=gold 400"
To list address fixups:
adm_warp_rpf -o list -f global/database.rpf \
-fx ">C=gb"
To print address fixups:
adm_warp_rpf -o print -f global/database.rpf \
-fx ">C=gb>ADMD=gold 400"
To check for the presence of an address fixup:
adm_warp_rpf -o not_present -f global/database.rpf \
-fx ">C=gb>ADMD=gold 400"
if [ $? = 0 ]
then
...
else
echo "Fixup already present in file"
fi
To install a file:
adm_warp_rpf -o install -f global/database.rpf
To compile the currently installed files:
adm_warp_rpf -o compile
To reload the the most recently compiled files:
adm_warp_rpf -o reload
Licensed material--property of Data General Corporation Page 8
admwarprpf(1m) admwarprpf(1m)
To export the shared routing information:
adm_warp_rpf -o export_shared
To export the private routing information:
adm_warp_rpf -o export_private
To deinstall the local file:
adm_warp_rpf -o deinstall
DIAGNOSTICS
Exit Codes
0 The operation was performed successfully.
1 An error occurred during the execution of the
operation.
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_mta(1m).
NOTES
The options on the command line must occur in the order
specified in the SYNTAX section.
adm_warp_rpf uses admlock(1m) to prevent undesirable
interactions between multiple concurrent invocations of
itself.
Licensed material--property of Data General Corporation Page 9