Man pages sections > man5 > cfdprc

cfdprc - CCSDS File Delivery Protocol management commands file

CFDPRC(5) CFDP configuration files CFDPRC(5)

NAME

cfdprc - CCSDS File Delivery Protocol management commands file

DESCRIPTION

CFDP management commands are passed to cfdpadmin either in a file of text lines or interactively at cfdpadmin's command prompt (:). Commands are interpreted line-by line, with exactly one command per line. The formats and effects of the CFDP management commands are described below.

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 cfdpadmin 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.
1
The initialize command. Until this command is executed, CFDP is not in operation on the local ION node and most cfdpadmin commands will fail.
i
The info This command will print information about the current state of the local CFDP entity, including the current settings of all parameters that can be managed as described below.
s 'UTS command'
The start command. This command starts the UT-layer service task for the local CFDP entity.
m discard { 0 | 1 }
The manage discard command. This command enables or disables the discarding of partially received files upon cancellation of a file reception.
m requirecrc { 0 | 1 }
The manage CRC data integrity command. This command enables or disables the attachment of CRCs to all PDUs issued by the local CFDP entity.
m fillchar file_fill_character
The manage fill character command. This command establishes the fill character to use for the portions of an incoming file that have not yet been received. The fill character is normally expressed in hex, e.g., 0xaa.
m ckperiod check_cycle_period
The manage check interval command. This command establishes the number of seconds following reception of the EOF PDU -- or following expiration of a prior check cycle -- after which the local CFDP will check for completion of a file that is being received.
m maxtimeouts check_cycle_limit
The manage check limit command. This command establishes the number of check cycle expirations after which the local CFDP entity will invoke the check cycle expiration fault handler upon expiration of a check cycle.
m maxtrnbr max_transaction_number
The manage transaction numbers command. This command establishes the largest possible transaction number used by the local CFDP entity for file transmission transactions. After this number has been used, the transaction number assigned to the next transaction will be 1.
m segsize max_bytes_per_file_data_segment
The manage segment size command. This command establishes the number of bytes of file data in each file data PDU transmitted by the local CFDP entity in the absence of an application-supplied reader function.
m inactivity inactivity_period
The manage inactivity period command. This command establishes the number of seconds that a CFDP file transfer is allowed to go idle before being canceled for inactivity. The default is one day.
x
The stop command. This command stops the UT-layer service task for the local CFDP engine.
w { 0 | 1 | <activity_spec> }
The CFDP watch command. This command enables and disables production of a continuous stream of user-selected CFDP activity indication characters. A watch parameter of "1" selects all CFDP activity indication characters; "0" de-selects all CFDP activity indication characters; any other activity_spec such as "p" selects all activity indication characters in the string, de-selecting all others. CFDP will print each selected activity indication character to stdout every time a processing event of the associated type occurs:
 
p CFDP PDU transmitted
 
q CFDP PDU received
h
The help command. This will display a listing of the commands and their formats. It is the same as the ? command.

EXAMPLES

m requirecrc 1
Initiates attachment of CRCs to all subsequently issued CFDP PDUs.

SEE ALSO

cfdpadmin(1), bputa(1)
2016-07-07 perl v5.24.1