NAME

       ipnrc - IPN scheme configuration commands file

DESCRIPTION

       IPN scheme configuration commands are passed to ipnadmin either in a file of text lines or
       interactively at ipnadmin's command prompt (:).  Commands are interpreted line-by line,
       with exactly one command per line.

       IPN scheme configuration commands (a) establish egress plans for direct transmission to
       neighboring nodes that are members of endpoints identified in the "ipn" URI scheme and (b)
       establish static default routing rules for forwarding bundles to specified destination
       nodes.

       The egress plan established for a given node associates a default egress duct expression
       with that node, and that default duct expression may be overridden by more narrowly scoped
       planrules in specific circumstances: a different egress duct expression may apply when the
       source endpoint for the subject bundle identifies a specific node, a specific service, or
       both.

       Each duct expression is a string of the form
       "protocol_name/outduct_name[,destination_induct_name]", signifying 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 circumstances that characterize a specific rule within a general plan are expressed in
       a qualifier, a string of the form "source_service_number source_node_number" where either
       source_service_number or source_node_number may be an asterisk character (*) signifying
       "all".

       Note that egress plans must be established for all neighboring nodes, regardless of
       whether or not contact graph routing is used for computing dynamic routes to distant
       nodes.  This is by definition: if there isn't an egress plan to a node, it can't be
       considered a neighbor.

       Static default routes are expressed as groups in the ipn-scheme routing database.  A group
       is a range of node numbers identifying a set of nodes for which defined default routing
       behavior is established.  Whenever a bundle is to be forwarded to a node whose number is
       in the group's node number range and it has not been possible to compute a dynamic route
       to that node from the contact schedules that have been provided to the local node and that
       node is not a neighbor to which the bundle can be directly transmitted, BP will forward
       the bundle to the gateway node associated with this group.  The gateway node for any group
       is identified by an endpoint ID, which might or might not be an ipn-scheme EID;
       regardless, directing a bundle to the gateway for a group causes the bundle to be re-
       forwarded to that intermediate destination endpoint.  Multiple groups may encompass the
       same node number, in which case the gateway associated with the most restrictive group
       (the one with the smallest range) is always selected.

       The formats and effects of the IPN 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 ipnadmin to be logged as
           well as sent to stdout.  Setting echo to 0 disables this behavior.

       v   Version number.  Prints out the version of ION currently installed.  HINT: combine
           with e 1 command to log the version number at startup.

       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_nbr default_duct_expression
           The add plan command.  This command establishes an egress plan for the bundles that
           must be transmitted to the neighboring node identified by node_nbr.  A general plan
           must be in place for a node before any more specific rules are declared.

       c plan node_nbr default_duct_expression
           The change plan command.  This command changes the default duct expression for the
           indicated plan.

       d plan node_nbr
           The delete plan command.  This command deletes the egress plan for the node identified
           by node_nbr, including all associated rules.

       i plan node_nbr
           This command will print information (the default duct expression and all specific
           rules) about the egress plan for the node identified by node_nbr.

       l plan
           This command lists all egress plans established in the IPN database for the local
           node.

PLANRULE COMMANDS

       a planrule node_nbr qualifier duct_expression
           The add planrule command.  This command establishes a planrule, i.e., a duct
           expression that overrides the default duct expression of the egress plan for the node
           identified by node_nbr in the event that the source endpoint ID of the subject bundle
           matches qualifier.

       c planrule node_nbr qualifier duct_expression
           The change planrule command.  This command changes the duct expression for the
           indicated planrule.

       d planrule node_nbr qualifier
           The delete planrule command.  This command deletes the planrule identified by node_nbr
           and qualifier.

       i planrule node_nbr qualifier
           This command will print information (the duct expression) about the planrule
           identified by node_nbr and qualifier.

       l planrule node_nbr
           This command lists all planrules in the plan for the indicated node.

GROUP COMMANDS

       a group first_node_nbr last_node_nbr gateway_endpoint_ID
           The add group command.  This command establishes a "group" for static default routing
           as described above.

       c group first_node_nbr last_node_nbr gateway_endpoint_ID
           The change group command.  This command changes the gateway node number for the group
           identified by first_node_nbr and last_node_nbr .

       d group first_node_nbr last_node_nbr
           The delete group command.  This command deletes the group identified by first_node_nbr
           and last_node_nbr.

       i group first_node_nbr last_node_nbr
           This command will print information (the gateway endpoint ID) about the group
           identified by first_node_nbr and last_node_nbr.

       l group
           This command lists all groups defined in the IPN database for the local node.

GROUPRULE COMMANDS

       a grouprule first_node_nbr last_node_nbr qualifier gateway_endpoint_ID
           The add grouprule command.  This command establishes a grouprule, i.e., a gateway
           endpoint ID that overrides the default gateway endpoint ID of the group identified by
           first_node_nbr and last_node_nbr in the event that the source endpoint ID of the
           subject bundle matches qualifier.

       c grouprule first_node_nbr last_node_nbr qualifier gateway_endpoint_ID
           The change grouprule command.  This command changes the gateway EID for the indicated
           grouprule.

       d grouprule first_node_nbr last_node_nbr qualifier
           The delete grouprule command.  This command deletes the grouprule identified by
           first_node_nbr, last_node_nbr, and qualifier.

       i grouprule first_node_nbr last_node_nbr qualifier
           This command will print information (the duct expression) about the grouprule
           identified by node_nbr, last_node_nbr, and qualifier.

       l grouprule first_node_nbr last_node_nbr
           This command lists all grouprules for the indicated group.

EXAMPLES

       a plan 18 ltp/18
           Declares the egress plan to use for transmission from the local node to neighboring
           node 18.  Any bundle for which the computed "next hop" node is node 18 will be queued
           for transmission on LTP outduct 18.

       a planrule 18 * 9 ltp/-18
           Declares an egress plan override that applies to transmission to node 18 of any bundle
           whose source is node 9, regardless of the service that was the source of the bundle.
           Each such bundle must be queued for unreliable transmission on LTP outduct 18 rather
           than the default (standard transmission on LTP outduct 18).

       a group 1 999 dtn://stargate
           Declares a default route for bundles destined for all nodes whose numbers are in the
           range 1 through 999 inclusive: absent any other routing decision, such bundles are to
           be forwarded to "dtn://stargate".

SEE ALSO

       ipnadmin(1)