.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "AMSRC 5" .TH AMSRC 5 "2016-07-07" "perl v5.24.1" "AMS configuration files" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" amsrc \- CCSDS Asynchronous Message Service MIB initialization file .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Management Information Base (\s-1MIB\s0) for an \s-1AMS\s0 communicating entity (either \&\fBamsd\fR or an \s-1AMS\s0 application module) must contain enough information to enable the entity to initiate participation in \s-1AMS\s0 message exchange, such as the network location of the configuration server and the roles and message subjects defined for some venture. .PP \&\s-1AMS\s0 entities automatically load their MIBs from initialization files at startup. When \s-1AMS\s0 is built with the \-DNOEXPAT compiler option set, the \&\s-1MIB\s0 initialization file must conform to the \fIamsrc\fR syntax described below; otherwise the \fIexpat\fR \s-1XML\s0 parsing library must be linked into the \s-1AMS\s0 executable and the \s-1MIB\s0 initialization file must conform to the \&\fIamsxml\fR syntax described in \fIamsxml\fR\|(5). .PP The \s-1MIB\s0 initialization file lists \fIelements\fR of \s-1MIB\s0 update information, each of which may have one or more \fIattributes\fR. An element may also have sub-elements that are listed within the declaration of the parent element, and so on. .PP The declaration of an element may occupy a single line of text in the \&\s-1MIB\s0 initialization file or may extend across multiple files. A single-line element declaration is indicated by a '*' in the first character of the line. The beginning of a multi-line element declaration is indicated by a '+' in the first character of the line, while the end of that declaration is indicated by a '\-' in the first character of the line. In every case, the type of element must be indicated by an element-type name beginning in the second character of the line and terminated by whitespace. Every start-of-element line \fBmust\fR be matched by a subsequent end-of-element line that precedes the start of any other element that is not a nested sub-element of this element. .PP Attributes are represented by whitespace-terminated = expressions immediately following the element-type name on a '*' or \&'+' line. An attribute value that contains whitespace must be enclosed within a pair of single-quote (') characters. .PP Two types of elements are recognized in the \s-1MIB\s0 initialization file: control elements and configuration elements. A control element establishes the update context within which the configuration elements nested within it are processed, while a configuration element declares values for one or more items of \s-1AMS\s0 configuration information in the \s-1MIB.\s0 .PP Note that an aggregate configuration element (i.e., one which may contain other interior configuration elements; venture, for example) may be presented outside of any control element, simply to establish the context in which subsequent control elements are to be interpreted. .SH "CONTROL ELEMENTS" .IX Header "CONTROL ELEMENTS" .IP "\fBams_mib_init\fR" 4 .IX Item "ams_mib_init" Initializes an empty \s-1MIB. \s0 This element must be declared prior to the declaration of any other element. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "continuum_nbr" 4 .IX Item "continuum_nbr" Identifies the local continuum. .IP "ptsname" 4 .IX Item "ptsname" Identifies the primary transport service for the continuum. Valid values include \*(L"dgr\*(R" and \*(L"udp\*(R". .IP "pubkey" 4 .IX Item "pubkey" This is the name of the public key used for validating the digital signatures of meta-AMS messages received from the configuration server for this continuum. The value of this attribute (if present) must identify a key that has been loaded into the \s-1ION\s0 security database, nominally by \fIionsecadmin\fR\|(1). .IP "privkey" 4 .IX Item "privkey" This is the name of the private key used for constructing the digital signatures of meta-AMS messages sent by the configuration server for this continuum. This attribute should \fBonly\fR be present in the \s-1MIB\s0 initialization file for \fIamsd()\fR. The value of this attribute (if present) must identify a key that has been loaded into the \s-1ION\s0 security database, nominally by \fIionsecadmin\fR\|(1). .RE .RS 4 .RE .IP "\fBams_mib_add\fR" 4 .IX Item "ams_mib_add" This element contains a list of configuration items that are to be added to the \s-1MIB.\s0 .IP "\fBams_mib_change\fR" 4 .IX Item "ams_mib_change" This element contains a list of configuration items that are to be revised in the \s-1MIB.\s0 .IP "\fBams_mib_delete\fR" 4 .IX Item "ams_mib_delete" This element contains a list of configuration items that are to be deleted from the \s-1MIB.\s0 .SH "CONFIGURATION ELEMENTS" .IX Header "CONFIGURATION ELEMENTS" .IP "\fBcontinuum\fR" 4 .IX Item "continuum" Identifies a known remote continuum. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "nbr" 4 .IX Item "nbr" Identifies the local continuum. .IP "name" 4 .IX Item "name" Identifies the local continuum. .IP "neighbor" 4 .IX Item "neighbor" 1 if the continuum is a neighbor of the local continuum, zero otherwise. .IP "desc" 4 .IX Item "desc" A textual description of this continuum. .RE .RS 4 .RE .IP "\fBcsendpoint\fR" 4 .IX Item "csendpoint" Identifies one of the network locations at which the configuration server may be reachable. If the configuration server might be running at any one of several locations, the number of other locations that are preferred to this one is noted; in this case, csendpoints must be listed within the ams_mib_add element in descending order of preference, i.e., with the most preferred network location listed first. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "epspec" 4 .IX Item "epspec" Identifies the endpoint at which the configuration server may be reachable. The endpoint specification must conform the endpoint specification syntax defined for the continuum's primary transport service; see the \s-1AMS\s0 Blue Book for details. .IP "after" 4 .IX Item "after" If present, indicates the number of other configuration server network locations that are considered preferable to this one. This attribute is used to ensure that csendpoints are listed in descending order of preference. .RE .RS 4 .RE .IP "\fBamsendpoint\fR" 4 .IX Item "amsendpoint" Normally the specifications of the transport service endpoints at which an \s-1AMS\s0 application module can receive messages are computed automatically using standard transport-service-specific rules. However, in some cases it might be necessary for a module to receive messages at one or more non-standard endpoints; in these cases, amsendpoint elements can be declared in order to override the standard endpoint specification rules. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "tsname" 4 .IX Item "tsname" Identifies the transport service for which a non-standard endpoint specification is being supplied. .IP "epspec" 4 .IX Item "epspec" Identifies an endpoint at which the application module will be reachable, in the context of the named transport service. The endpoint specification must conform the endpoint specification syntax defined for the named transport service; see the \s-1AMS\s0 Blue Book for details. .RE .RS 4 .RE .IP "\fBapplication\fR" 4 .IX Item "application" Identifies one of the applications supported within this continuum. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "name" 4 .IX Item "name" Identifies the application. .IP "pubkey" 4 .IX Item "pubkey" This is the name of the public key used for validating the digital signatures of meta-AMS messages received from the registrars for all cells of any message space in this continuum that is characterized by this application name. The value of this attribute (if present) must identify a key that has been loaded into the \s-1ION\s0 security database, nominally by \fIionsecadmin\fR\|(1). .IP "privkey" 4 .IX Item "privkey" This is the name of the private key used for constructing the digital signatures of meta-AMS messages sent by the registrars for all cells of any message space in this continuum that is characterized by this application name. This attribute should \fBonly\fR be present in the \s-1MIB\s0 initialization file for \fIamsd()\fR. The value of this attribute (if present) must identify a key that has been loaded into the \s-1ION\s0 security database, nominally by \fIionsecadmin\fR\|(1). .RE .RS 4 .RE .IP "\fBventure\fR" 4 .IX Item "venture" Identifies one of the ventures operating within the local continuum. .Sp Sub-elements: role, subject, unit, msgspace .Sp Attributes: .RS 4 .IP "nbr" 4 .IX Item "nbr" Identifies the venture. .IP "appname" 4 .IX Item "appname" Identifies the application addressed by this venture. .IP "authname" 4 .IX Item "authname" Identifies the authority under which the venture operates, distinguishing this venture from all other ventures that address the same application. .IP "gweid" 4 .IX Item "gweid" Identifies the \s-1RAMS\s0 network endpoint \s-1ID\s0 of the \s-1RAMS\s0 gateway module for this venture's message space in the local continuum. Gateway endpoint \&\s-1ID\s0 is expressed as @ where \fIprotocol_name\fR is either \*(L"bp\*(R" or \*(L"udp\*(R". If protocol name is \*(L"bp\*(R" then \fIeid_string\fR must be a valid Bundle Protocol endpoint \s-1ID\s0; otherwise, \fIeid_string\fR must be of the form :. If the gweid attribute is omitted, the \s-1RAMS\s0 gateway module's \s-1RAMS\s0 network endpoint \s-1ID\s0 defaults to \*(L"bp@ipn:.\*(R". .IP "net_config" 4 .IX Item "net_config" Has the value \*(L"tree\*(R" if the \s-1RAMS\s0 network supporting this venture is configured as a tree; otherwise \*(L"mesh\*(R", indicating that the \s-1RAMS\s0 network supporting this venture is configured as a mesh. .IP "root_cell_resync_period" 4 .IX Item "root_cell_resync_period" Indicates the number of seconds in the period on which resynchronization is performed for the root cell of this venture's message space in the local continuum. If this attribute is omitted, resynchronization in that cell is disabled. .RE .RS 4 .RE .IP "\fBrole\fR" 4 .IX Item "role" Identifies one of the functional roles in the venture that is the element that's currently being configured. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "nbr" 4 .IX Item "nbr" Identifies the role. .IP "name" 4 .IX Item "name" Identifies the role. .IP "authname" 4 .IX Item "authname" Identifies the authority under which the venture operates, distinguishing this venture from all other ventures that address the same application. .IP "pubkey" 4 .IX Item "pubkey" This is the name of the public key used for validating the digital signatures of meta-AMS messages received from all application modules that register in this functional role. The value of this attribute (if present) must identify a key that has been loaded into the \s-1ION\s0 security database, nominally by \fIionsecadmin\fR\|(1). .IP "privkey" 4 .IX Item "privkey" This is the name of the private key used for constructing the digital signatures of meta-AMS messages sent by all application modules that register in this functional role. This attribute should \fBonly\fR be present in the \s-1MIB\s0 initialization file for application modules that register in this role. The value of this attribute (if present) must identify a key that has been loaded into the \s-1ION\s0 security database, nominally by \fIionsecadmin\fR\|(1). .RE .RS 4 .RE .IP "\fBsubject\fR" 4 .IX Item "subject" Identifies one of the subjects on which messages may be sent, within the venture that is the element that's currently being configured. .Sp Sub-elements: sender, receiver .Sp Attributes: .RS 4 .IP "nbr" 4 .IX Item "nbr" Identifies the subject. .IP "name" 4 .IX Item "name" Identifies the subject. .IP "desc" 4 .IX Item "desc" A textual description of this message subject. .IP "symkey" 4 .IX Item "symkey" This is the name of the symmetric key used for both encrypting and decrypting the content of messages on this subject; if omitted, messages on this subject are not encrypted by \s-1AMS. \s0 If authorized senders and receivers are defined for this subject, then this attribute should \&\fBonly\fR be present in the \s-1MIB\s0 initialization file for application modules that register in roles that appear in the subject's lists of authorized senders and/or receivers. The value of this attribute (if present) must identify a key that has been loaded into the \s-1ION\s0 security database, nominally by \fIionsecadmin\fR\|(1). .IP "marshal" 4 .IX Item "marshal" This is the name associated with the content marshaling function defined for this message subject. If present, whenever a message on this subject is issued the associated function is automatically called to convert the supplied content data to a platform-independent representation for transmission; this conversion occurs before any applicable content encryption is performed. If omitted, content data are transmitted without conversion to a platform-independent representation. Marshaling functions are defined in the marshalRules table in the marshal.c source file. .IP "unmarshal" 4 .IX Item "unmarshal" This is the name associated with the content unmarshaling function defined for this message subject. If present, whenever a message on this subject is received the associated function is automatically called to convert the transmitted content to local platform-specific representation; this conversion occurs after any applicable content decryption is performed. If omitted, received content data are delivered without conversion to a local platform-specific representation. Unmarshaling functions are defined in the unmarshalRules table in the marshal.c source file. .RE .RS 4 .RE .IP "\fBsender\fR" 4 .IX Item "sender" Identifies one of the roles in which application modules must register in order to be authorized senders of messages on the subject that is the element that's currently being configured. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "name" 4 .IX Item "name" Identifies the sender. The value of this attribute must be the name of a role that has been defined for the venture that is currently being configured. .RE .RS 4 .RE .IP "\fBreceiver\fR" 4 .IX Item "receiver" Identifies one of the roles in which application modules must register in order to be authorized receivers of messages on the subject that is the element that's currently being configured. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "name" 4 .IX Item "name" Identifies the receiver. The value of this attribute must be the name of a role that has been defined for the venture that is currently being configured. .RE .RS 4 .RE .IP "\fBunit\fR" 4 .IX Item "unit" Identifies one of the organizational units within the venture that is the element that's currently being configured. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "nbr" 4 .IX Item "nbr" Identifies the venture. .IP "name" 4 .IX Item "name" Identifies the venture. .IP "resync_period" 4 .IX Item "resync_period" Indicates the number of seconds in the period on which resynchronization is performed, for the cell of this venture's message space that is the portion of the indicated unit which resides in the local continuum. If this attribute is omitted, resynchronization in that cell is disabled. .RE .RS 4 .RE .IP "\fBmsgspace\fR" 4 .IX Item "msgspace" Identifies one of the message spaces in remote continua that are encompassed by the venture that is the element that's currently being configured. .Sp Sub-elements: none .Sp Attributes: .RS 4 .IP "nbr" 4 .IX Item "nbr" Identifies the remote continuum within which the message space operates. .IP "gweid" 4 .IX Item "gweid" Identifies the \s-1RAMS\s0 network endpoint \s-1ID\s0 of the \s-1RAMS\s0 gateway module for this message space. Gateway endpoint \s-1ID\s0 is expressed as @ where \fIprotocol_name\fR is either \*(L"bp\*(R" or \*(L"udp\*(R". If protocol name is \*(L"bp\*(R" then \fIeid_string\fR must be a valid Bundle Protocol endpoint \s-1ID\s0; otherwise, \fIeid_string\fR must be of the form :. If the gweid attribute is omitted, the \s-1RAMS\s0 network endpoint \s-1ID\s0 of the message space's \s-1RAMS\s0 gateway module defaults to \*(L"bp@ipn:.\*(R". .IP "symkey" 4 .IX Item "symkey" This is the name of the symmetric key used for both encrypting and decrypting all messages to and from modules in the remote message space that are forwarded between the local \s-1RAMS\s0 gateway server and modules in the local message space; if omitted, these messages are not encrypted. The value of this attribute (if present) must identify a key that has been loaded into the \s-1ION\s0 security database, nominally by \fIionsecadmin\fR\|(1). .RE .RS 4 .RE .SH "EXAMPLE" .IX Header "EXAMPLE" *ams_mib_init continuum_nbr=2 ptsname=dgr .PP +ams_mib_add .PP *continuum nbr=1 name=apl desc=APL .PP *csendpoint epspec=beaumont.stepsoncats.com:2357 .PP *application name=amsdemo .PP +venture nbr=1 appname=amsdemo authname=test .PP *role nbr=2 name=shell .PP *role nbr=3 name=log .PP *role nbr=4 name=pitch .PP *role nbr=5 name=catch .PP *role nbr=6 name=benchs .PP *role nbr=7 name=benchr .PP *role nbr=96 name=amsd .PP *role nbr=97 name=amsmib .PP *role nbr=98 name=amsstop .PP *subject nbr=1 name=text desc='\s-1ASCII\s0 text' .PP *subject nbr=2 name=noise desc='more \s-1ASCII\s0 text' .PP *subject nbr=3 name=bench desc='numbered msgs' .PP *subject nbr=97 name=amsmib desc='\s-1MIB\s0 updates' .PP *subject nbr=98 name=amsstop desc='shutdown' .PP *unit nbr=1 name=orbiters .PP *unit nbr=2 name=orbiters.near .PP *unit nbr=3 name=orbiters.far .PP *msgspace nbr=2 .PP \&\-venture .PP \&\-ams_mib_add .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIamsxml\fR\|(5)