lgfile(5) [debian man page]

LGFILE(5)						      BP configuration files							 LGFILE(5)

NAME

       lgfile - ION Load/Go source file

DESCRIPTION

       The ION Load/Go system enables the execution of ION administrative programs at remote nodes:

	   The lgsend program reads a Load/Go source file from a local file system, encapsulates the text of that source file in a bundle, and
	   sends the bundle to a designated DTN endpoint on the remote node.

	   An lgagent task running on the remote node, which has opened that DTN endpoint for bundle reception, receives the extracted payload of
	   the bundle -- the text of the Load/Go source file -- and processes it.

       Load/Go source file content is limited to newline-terminated lines of ASCII characters.	More specifically, the text of any Load/Go source
       file is a sequence of line sets of two types: file capsules and directives.  Any Load/Go source file may contain any number of file
       capsules and any number of directives, freely intermingled in any order, but the typical structure of a Load/Go source file is simply a
       single file capsule followed by a single directive.

       Each file capsule is structured as a single start-of-capsule line, followed by zero or more capsule text lines, followed by a single end-
       of-capsule line.  Each start-of-capsule line is of this form:

	   [file_name

       Each capsule text line can be any line of ASCII text that does not begin with an opening ([) or closing (]) bracket character.

       A text line that begins with a closing bracket character (]) is interpreted as an end-of-capsule line.

       A directive is any line of text that is not one of the lines of a file capsule and that is of this form:

	   !directive_text

       When lgagent identifies a file capsule, it copies all of the capsule's text lines to a new file named file_name that it creates in the
       current working directory.  When lgagent identifies a directive, it executes the directive by passing directive_text to the pseudoshell()
       function (see platform(3)).  lgagent processes the line sets of a Load/Go source file in the order in which they appear in the file, so the
       directive_text of a directive may reference a file that was created as the result of processing a prior file capsule line set in the same
       source file.

       Note that lgfile directives are passed to pseudoshell(), which on a VxWorks platform will always spawn a new task; the first argument in
       directive_text must be a symbol that VxWorks can resolve to a function, not a shell command.  Also note that the arguments in
       directive_text will be actual task arguments, not shell command-line arguments, so they should never be enclosed in double-quote characters
       (").  However, any argument that contains embedded whitespace must be enclosed in single-quote characters (') so that pseudoshell() can
       parse it correctly.

EXAMPLES

       Presenting the following lines of source file text to lgsend:

	   [cmd33.bprc

	   x protocol ltp

	   ]

	   !bpadmin cmd33.bprc

       should cause the receiving node to halt the operation of the LTP convergence-layer protocol.

SEE ALSO

       lgsend(1), lgagent(1), platform(3)

perl v5.14.2							    2012-05-25								 LGFILE(5)

IONADMIN(1)							  ICI executables						       IONADMIN(1)

NAME

       ionadmin - ION node administration interface

SYNOPSIS

       ionadmin [ commands_filename | . ]

DESCRIPTION

       ionadmin configures, starts, manages, and stops the ION node on the local computer.

       It configures the node and sets (and reports on) global operational settings for the DTN protocol stack on the local computer in response
       to ION configuration commands found in commands_filename, if provided; if not, ionadmin prints a simple prompt (:) so that the user may
       type commands directly into standard input.  If commands_filename is a period (.), the effect is the same as if a command file containing
       the single command 'x' were passed to ionadmin -- that is, the ION node's rfxclock task is stopped.

       The format of commands for commands_filename can be queried from ionadmin by entering the command 'h' or '?' at the prompt.  The commands
       are documented in ionrc(5).

       Note that ionadmin always computes a congestion forecast immediately before exiting.  The result of this forecast -- maximum projected
       occupancy of the DTN protocol traffic allocation in ION's SDR database -- is retained for application flow control purposes: if maximum
       projected occupancy is the entire protocol traffic allocation, then a message to this effect is logged and no new bundle origination by any
       application will be accepted until a subsequent forecast that predicts no congestion is computed.  (Congestion forecasts are constrained by
       horizon times, which can be established by commands issued to ionadmin.	One way to re-enable data origination temporarily while long-term
       traffic imbalances are being addressed is to declare a congestion forecast horizon in the near future, before congestion would occur if no
       adjustments were made.)

EXIT STATUS

       0   Successful completion of ION node administration.

EXAMPLES

       ionadmin
	   Enter interactive ION configuration command entry mode.

       ionadmin host1.ion
	   Execute all configuration commands in host1.ion, then terminate immediately.

FILES

       Status and diagnostic messages from ionadmin and from other software that utilizes the ION node are nominally written to a log file in the
       current working directory within which ionadmin was run.  The log file is typically named ion.log.

       See also ionconfig(5) and ionrc(5).

ENVIRONMENT

       Environment variables ION_NODE_LIST_DIR and ION_NODE_WDNAME can be used to enable the operation of multiple ION nodes on a single
       workstation computer.  See section 2.1.3 of the ION Design and Operations Guide for details.

DIAGNOSTICS

       Note: all ION administration utilities expect source file input to be lines of ASCII text that are NL-delimited.  If you edit the ionrc
       file on a Windows machine, be sure to use dos2unix to convert it to Unix text format before presenting it to ionadmin.  Otherwise ionadmin
       will detect syntax errors and will not function satisfactorily.

       The following diagnostics may be issued to the log file:

       Can't open command file...
	   The commands_filename specified in the command line doesn't exist.

       ionadmin SDR definition failed.
	   A node initialization command was executed, but an SDR database already exists for the indicated node.  It is likely that an ION node
	   is already running on this computer or that destruction of a previously started the previous ION node was incomplete.  For most ION
	   installations, incomplete node destruction can be repaired by (a) killing all ION processes that are still running and then (b) using
	   ipcrm to remove all SVr4 IPC objects owned by ION.

       ionadmin can't get SDR parms.
	   A node initialization command was executed, but the ion_config_filename passed to that command contains improperly formatted commands.
	   Please see ionconfig(5) for further details.

       Various errors that don't cause ionadmin to fail but are noted in the log file may be caused by improperly formatted commands given at the
       prompt or in the commands_filename.  Please see ionrc(5) for details.

BUGS

       If the ion_config_filename parameter passed to a node initialization command refers to a nonexistent filename, then ionadmin uses default
       values are used rather than reporting an error in the command line argument.

       Report bugs to <ion-bugs@korgano.eecs.ohiou.edu>

SEE ALSO

       ionrc(5), ionconfig(5)

perl v5.14.2							    2012-05-25							       IONADMIN(1)