DTN2ADMIN(1) BP executables DTN2ADMIN(1)NAME
dtn2admin - baseline "dtn" scheme administration interface
SYNOPSIS
dtn2admin [ commands_filename ]
DESCRIPTION
dtn2admin configures the local ION node's routing of bundles to endpoints whose IDs conform to the dtn endpoint ID scheme. dtn is a non-
CBHE-conformant scheme. The structure of dtn endpoint IDs remains somewhat in flux at the time of this writing, but endpoint IDs in the
dtn scheme historically have been strings of the form "dtn://node_name[/demux_token]", where node_name normally identifies a computer
somewhere on the network and demux_token normally identifies a specific application processing point. Although the dtn endpoint ID scheme
imposes more transmission overhead than the ipn scheme, ION provides support for dtn endpoint IDs to enable interoperation with other
implementations of Bundle Protocol.
dtn2admin operates in response to "dtn" scheme configuration commands found in the file commands_filename, if provided; if not, dtn2admin
prints a simple prompt (:) so that the user may type commands directly into standard input.
The format of commands for commands_filename can be queried from dtn2admin with the 'h' or '?' commands at the prompt. The commands are
documented in dtn2rc(5).
EXIT STATUS
0 Successful completion of "dtn" scheme administration.
1 Unsuccessful completion of "dtn" scheme administration, due to inability to attach to the Bundle Protocol system or to initialize the
"dtn" scheme.
EXAMPLES
dtn2admin
Enter interactive "dtn" scheme configuration command entry mode.
dtn2admin host1.dtn2rc
Execute all configuration commands in host1.dtn2rc, then terminate immediately.
FILES
See dtn2rc(5) for details of the DTN scheme configuration commands.
ENVIRONMENT
No environment variables apply.
DIAGNOSTICS
Note: all ION administration utilities expect source file input to be lines of ASCII text that are NL-delimited. If you edit the dtn2rc
file on a Windows machine, be sure to use dos2unix to convert it to Unix text format before presenting it to dtn2admin. Otherwise
dtn2admin will detect syntax errors and will not function satisfactorily.
The following diagnostics may be issued to the logfile ion.log:
dtn2admin can't attach to BP.
Bundle Protocol has not been initialized on this computer. You need to run bpadmin(1) first.
dtn2admin can't initialize routing database.
There is no SDR data store for dtn2admin to use. Please run ionadmin(1) to start the local ION node.
Can't open command file...
The commands_filename specified in the command line doesn't exist.
Various errors that don't cause dtn2admin to fail but are noted in the ion.log log file may be caused by improperly formatted commands
given at the prompt or in the commands_filename file. Please see dtn2rc(5) for details.
BUGS
Report bugs to <ion-bugs@korgano.eecs.ohiou.edu>
SEE ALSO dtn2rc(5)perl v5.14.2 2012-05-25 DTN2ADMIN(1)
Check Out this Related Man Page
DTN2RC(5) BP configuration files DTN2RC(5)NAME
dtn2rc - "dtn" scheme configuration commands file
DESCRIPTION
"dtn" scheme configuration commands are passed to dtn2admin either in a file of text lines or interactively at dtn2admin's command prompt
(:). Commands are interpreted line-by line, with exactly one command per line.
"dtn" scheme configuration commands mainly establish static routing rules for forwarding bundles to "dtn"-scheme destination endpoints,
identified by node names and demux names.
Static routes are expressed as plans in the "dtn"-scheme routing database. A plan that is established for a given node name associates a
default routing directive with the named node, and that default directive may be overridden by more narrowly scoped rules in specific
circumstances: a different directive may apply when the destination endpoint ID specifies a particular demux name.
Each directive is a string of one of two possible forms:
f endpoint_ID
...or...
x protocol_name/outduct_name[,destination_induct_name],
The former form signifies that the bundle is to be forwarded to the indicated endpoint, requiring that it be re-queued for processing by
the forwarder for that endpoint (which might, but need not, be identified by another "dtn"-scheme endpoint ID). The latter form signifies
that the bundle is to be queued for transmission via the indicated convergence layer protocol outduct. destination_induct_name must be
provided when the indicated outduct is "promiscuous", i.e., not configured for transmission only to a single neighboring node; this is
protocol-specific.
The node names and demux names cited in dtn2rc plans and overriding rules may be "wild-carded". That is, when the last character of a node
name is either '*' or '~' (these two wild-card characters are equivalent for this purpose), the plan or rule applies to all nodes whose
names are identical to the wild-carded node name up to the wild-card character; wild-carded demux names function in the same way. For
example, a bundle whose destination EID's node name is "//foghorn" would be routed by plans citing the following node names: "//foghorn",
"//fogh*", "//fog~", "//*". When multiple plans are all applicable to the same destination EID, the one citing the longest (i.e., most
narrowly targeted) node name will be applied; when multiple rules overriding the same plan are all applicable to the same destination EID,
the one citing the longest demux name will be applied.
The formats and effects of the DTN scheme configuration commands are described below.
GENERAL COMMANDS
? The help command. This will display a listing of the commands and their formats. It is the same as the h command.
# Comment line. Lines beginning with # are not interpreted.
e { 1 | 0 }
Echo control. Setting echo to 1 causes all output printed by dtn2admin to be logged as well as sent to stdout. Setting echo to 0
disables this behavior.
h The help command. This will display a listing of the commands and their formats. It is the same as the ? command.
PLAN COMMANDS
a plan node_name default_directive
The add plan command. This command establishes a static route for the bundles destined for the node identified by node_name. A
general plan must be in place for a node before any more specific routing rules are declared.
d plan node_name
The delete plan command. This command deletes the static route for the node identified by node_name, including all associated rules.
i plan node_name
This command will print information (the default directive and all specific rules) about the static route for the node identified by
node_name.
l plan
This command lists all static routes established in the DTN database for the local node.
RULE COMMANDS
a rule node_name demux_name directive
The add rule command. This command establishes a rule, i.e., a directive that overrides the default directive of the plan for the node
identified by node_name in the event that the demux name of the subject bundle's destination endpoint ID matches demux_name.
c rule node_name demux_name directive
The change rule command. This command changes the directive for the indicated rule.
d rule node_name demux_name
The delete rule command. This command deletes the rule identified by node_name and demux_name.
i rule node_name demux_name
This command will print information (the directive) about the rule identified by node_name and demux_name.
l rule node_name
This command lists all rules in the plan for the indicated node.
EXAMPLES
a plan //bbn2 f ipn:8.41
Declares a static route from the local node to node "//bbn2". By default, any bundle destined for any endpoint whose node name is
"//bbn2" will be forwarded to endpoint "ipn:8.41".
a plan //mitre1 x ltp/6
Declares a static route from the local node to node "//mitre1". By default, any bundle destined for any endpoint whose node name is
"mitre1" will be queued for transmission on LTP outduct 6.
a rule //mitre1 fwd x ltp/18
Declares an overriding static routing rule for any bundle destined for node "//mitre1" whose destination demux name is "fwd". Each
such bundle must be queued for transmission on LTP outduct 18 rather than the default (LTP outduct 6).
SEE ALSO dtn2admin(1)perl v5.14.2 2012-05-25 DTN2RC(5)