< draft-birrane-dtn-adm-ion-bpadmin-00.txt   draft-birrane-dtn-adm-ion-bpadmin-01.txt >
Delay-Tolerant Networking E. Birrane Delay-Tolerant Networking E. Birrane
Internet-Draft E. DiPietro Internet-Draft E. DiPietro
Intended status: Experimental D. Linko Intended status: Experimental D. Linko
Expires: January 3, 2019 Johns Hopkins Applied Physics Laboratory Expires: September 12, 2019 Johns Hopkins Applied Physics Laboratory
July 2, 2018 March 11, 2019
Bundle Protocol Agent Application Data Model Bundle Protocol Agent Application Data Model
draft-birrane-dtn-adm-ion-bpadmin-00 draft-birrane-dtn-adm-ion-bpadmin-01
Abstract Abstract
This document describes the Application Data Model (ADM) for the This document describes the Application Data Model (ADM) for the
administration of Bundle Protocol (BP) ION in compliance with the administration of Bundle Protocol (BP) ION in compliance with the
template provided by [I-D.birrane-dtn-adm]. template provided by [I-D.birrane-dtn-adm].
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
skipping to change at page 1, line 33 skipping to change at page 1, line 33
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on January 3, 2019. This Internet-Draft will expire on September 12, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
skipping to change at page 2, line 15 skipping to change at page 2, line 15
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Technical Notes . . . . . . . . . . . . . . . . . . . . . 2 1.1. Technical Notes . . . . . . . . . . . . . . . . . . . . . 2
1.2. Scope . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Scope . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3. Requirements Language . . . . . . . . . . . . . . . . . . 3 1.3. Requirements Language . . . . . . . . . . . . . . . . . . 3
2. Structure and Design of this ADM . . . . . . . . . . . . . . 3 2. Structure and Design of this ADM . . . . . . . . . . . . . . 3
3. Naming and Identification . . . . . . . . . . . . . . . . . . 4 3. Naming and Identification . . . . . . . . . . . . . . . . . . 4
3.1. Namespace and Nicknames . . . . . . . . . . . . . . . . . 4 3.1. Namespace and Nicknames . . . . . . . . . . . . . . . . . 4
4. ION BP Admin ADM JSON Encoding . . . . . . . . . . . . . . . 5 4. ION BP Admin ADM JSON Encoding . . . . . . . . . . . . . . . 5
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 14 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 14 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.1. Informative References . . . . . . . . . . . . . . . . . 14 6.1. Informative References . . . . . . . . . . . . . . . . . 17
6.2. Normative References . . . . . . . . . . . . . . . . . . 14 6.2. Normative References . . . . . . . . . . . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 18
1. Introduction 1. Introduction
An Application Data Model (ADM) provides a guaranteed interface for An Application Data Model (ADM) provides a guaranteed interface for
the management of an application or protocol in accordance with the the management of an application or protocol in accordance with the
Asynchronous Management Architecture (AMA) defined in Asynchronous Management Architecture (AMA) defined in
[I-D.birrane-dtn-ama]. The ADM described in this document complies [I-D.birrane-dtn-ama]. The ADM described in this document complies
with the ADM Template provided in [I-D.birrane-dtn-adm] as encoded with the ADM Template provided in [I-D.birrane-dtn-adm] as encoded
using the JSON syntax. using the JSON syntax.
skipping to change at page 5, line 36 skipping to change at page 5, line 36
| 111-119 | DTN/ION/bpadmin/Reserved | | 111-119 | DTN/ION/bpadmin/Reserved |
+----------+------------------------------+ +----------+------------------------------+
Table 2: ION BP ADM Nicknames Table 2: ION BP ADM Nicknames
4. ION BP Admin ADM JSON Encoding 4. ION BP Admin ADM JSON Encoding
The following is the JSON encoding of the Bundle Protocol Admin The following is the JSON encoding of the Bundle Protocol Admin
Application Data Model: Application Data Model:
{ {
"Mdat": [ "Mdat": [{
{ "name": "name",
"name": "name", "type": "STR",
"type": "STR", "value": "ion_bp_admin",
"value": "ion_bp_admin", "description": "The human-readable name of the ADM."
"description": "The human-readable name of the ADM." },
}, {
{ "name": "namespace",
"name": "namespace", "type": "STR",
"type": "STR", "value": "DTN/ION/bpadmin",
"value": "DTN/ION/bpadmin", "description": "The namespace of the ADM"
"description": "The namespace of the ADM" },
}, {
{ "name": "version",
"name": "version", "type": "STR",
"type": "STR", "value": "v0.0",
"value": "v0.0", "description": "The version of the ADM"
"description": "The version of the ADM" },
}, {
{ "name": "organization",
"name": "organization", "type": "STR",
"type": "STR", "value": "JHUAPL",
"value": "JHUAPL", "description": "The name of the issuing organization of the ADM"
"description": "The name of the issuing organization of the ADM" }
} ],
], "Edd": [{
"Edd": [ "name": "bp_version",
{ "type": "STR",
"name": "bp_version", "description": "Version of installed ION BP Admin utility."
"type": "STR", }],
"description": "Version of installed ION BP Admin utility." "Tblt": [{
} "name": "endpoints",
], "columns": [{
"Tblt": [ "type": "STR",
{ "name": "scheme_name"
"name": "endpoints", }, {
"columns": [ "type": "STR",
{"type":"STR","name":"scheme_name"}, "name": "endpoint_nss"
{"type":"STR","name":"endpoint_nss"}, }, {
{"type":"UINT","name":"app_pid"}, "type": "UINT",
{"type":"STR","name":"recv_rule"}, "name": "app_pid"
{"type":"STR","name":"rcv_script"} }, {
], "type": "STR",
"description": "Local endpoints, regardless of scheme name." "name": "recv_rule"
}, }, {
{ "type": "STR",
"name": "inducts", "name": "rcv_script"
"columns": [ }],
{"type":"STR","name":"protocol_name"}, "description": "Local endpoints, regardless of scheme name."
{"type":"STR","name":"duct_name"}, },
{"type":"STR","name":"cli_control"} {
], "name": "inducts",
"description": "Inducts established locally for the indicated CL "columns": [{
protocol." "type": "STR",
}, "name": "protocol_name"
{ }, {
"name": "outducts", "type": "STR",
"columns": [ "name": "duct_name"
{"type":"STR","name":"protocol_name"}, }, {
{"type":"STR","name":"duct_name"}, "type": "STR",
{"type":"UINT","name":"clo_pid"}, "name": "cli_control"
{"type":"STR","name":"clo_control"}, }],
{"type":"STR","name":"max_payload_length"} "description": "Inducts established locally for the indicated
], CL protocol."
"description": "If protocolName is specified, this table lists all
outducts established locally for the indicated CL protocol. },
Otherwise, it lists all locally established outducts, regardless {
of their protocol." "name": "outducts",
}, "columns": [{
{ "type": "STR",
"name": "protocols", "name": "protocol_name"
"columns": [ }, {
{"type":"STR","name":"name"}, "type": "STR",
{"type":"UINT","name":"payload_bpf"}, "name": "duct_name"
{"type":"UINT","name":"overhead_bpf"}, }, {
{"type":"UINT","name":"nominal_data_rate"} "type": "UINT",
], "name": "clo_pid"
"description": "Convergence layer protocols that can currently be }, {
utilized at the local node." "type": "STR",
}, "name": "clo_control"
{ }, {
"name": "schemes", "type": "UINT",
"columns": [ "name": "max_payload_length"
{"type":"STR","name":"scheme_name"}, }],
{"type":"UINT","name":"fwd_pid"}, "description": "If protocolName is specified, this table lists
{"type":"STR","name":"fwd_cmd"}, all outducts established locally for the
{"type":"UINT","name":"admin_app_pid"}, indicated CL protocol. Otherwise, it lists all
{"type":"STR","name":"admin_app_cmd"} locally established outducts, regardless of
], their protocol."
"description": "Declared endpoint naming schemes." },
}, {
{ "name": "protocols",
"name": "egress_plans", "columns": [{
"columns": [ "type": "STR",
{"type":"STR","name":"scheme_name"}, "name": "name"
{"type":"UINT","name":"fwd_pid"}, }, {
{"type":"STR","name":"fwd_cmd"}, "type": "UINT",
{"type":"UINT","name":"admin_app_pid"}, "name": "payload_bpf"
{"type":"STR","name":"admin_app_cmd"} }, {
], "type": "UINT",
"description": "Declared endpoint naming schemes." "name": "overhead_bpf"
} }, {
], "type": "UINT",
"Ctrl": [ "name": "protocol class"
{ }],
"name": "endpoint_add", "description": "Convergence layer protocols that can currently
"parmspec": [ be utilized at the local node."
{"type":"STR","name":"endpoint_id"}, },
{"type":"UINT","name":"type"}, {
{"type":"STR","name":"rcv_script"} "name": "schemes",
], "columns": [{
"description": "Establish DTN endpoint named endpointId on the local "type": "STR",
node. The remaining parameters indicate what is to be done when "name": "scheme_name"
bundles destined for this endpoint arrive at a time when no
application has the endpoint open for bundle reception. If type is }, {
'x', then such bundles are to be discarded silently and immediately. "type": "UINT",
If type is 'q', then such bundles are to be enqueued for later "name": "fwd_pid"
delivery and, if recvScript is provided, recvScript is to be }, {
executed." "type": "STR",
}, "name": "fwd_cmd"
{ }, {
"name": "endpoint_change", "type": "UINT",
"parmspec": [ "name": "admin_app_pid"
{"type":"STR","name":"endpoint_id"}, }, {
{"type":"UINT","name":"type"}, "type": "STR",
{"type":"STR","name":"rcv_script"} "name": "admin_app_cmd"
], }],
"description": "Change the action taken when bundles destined for this "description": "Declared endpoint naming schemes."
endpoint arrive at a time when no application has the endpoint open },
for bundle reception." {
}, "name": "egress_plans",
{ "columns": [{
"name": "endpoint_del", "type": "STR",
"parmspec": [{"type":"STR","name":"endpoint_id"}], "name": "neighbor_eid"
"description": "Delete the endpoint identified by endpointId. The }, {
control will fail if any bundles are currently pending delivery to "type": "UINT",
this endpoint." "name": "clm_pid"
}, }, {
{ "type": "UINT",
"name": "induct_add", "name": "nominal_rate"
"parmspec": [ }],
{"type":"STR","name":"protocol_name"}, "description": "Egress plans."
{"type":"STR","name":"duct_name"}, }
{"type":"STR","name":"cli_control"} ],
], "Ctrl": [{
"description": "Establish a duct for reception of bundles via the "name": "endpoint_add",
indicated CL protocol. The duct's data acquisition structure is "parmspec": [{
used and populated by the induct task whose operation is initiated "type": "STR",
by cliControl at the time the duct is started." "name": "endpoint_id"
}, }, {
{ "type": "UINT",
"name": "induct_change", "name": "type"
"parmspec": [ }, {
{"type":"STR","name":"protocol_name"}, "type": "STR",
{"type":"STR","name":"duct_name"}, "name": "rcv_script"
{"type":"STR","name":"cli_control"} }],
], "description": "Establish DTN endpoint named endpointId on the
"description": "Change the control used to initiate operation of the local node. The remaining parameters indicate
induct task for the indicated duct." what is to be done when bundles destined for
}, this endpoint arrive at a time when no
{ application has the endpoint open for bundle
"name": "induct_del", reception. If type is 'x', then such bundles
"parmspec": [ are to be discarded silently and immediately.
{"type":"STR","name":"protocol_name"}, If type is 'q', then such bundles are to be
{"type":"STR","name":"duct_name"} enqueued for later delivery and, if recvScript
], is provided, recvScript is to be executed."
"description": "Delete the induct identified by protocolName and },
ductName. The control will fail if any bundles are currently {
pending acquisition via this induct." "name": "endpoint_change",
}, "parmspec": [{
{ "type": "STR",
"name": "induct_start", "name": "endpoint_id"
"parmspec":[ }, {
{"type":"STR","name":"protocol_name"}, "type": "UINT",
{"type":"STR","name":"duct_name"} "name": "type"
], }, {
"description": "Start the indicated induct task as defined for the "type": "STR",
indicated CL protocol on the local node." "name": "rcv_script"
}, }],
{ "description": "Change the action taken when bundles destined
"name": "induct_stop", for this endpoint arrive at a time when no
"parmspec":[ application has the endpoint open for bundle
{"type":"STR","name":"protocol_name"}, reception."
{"type":"STR","name":"duct_name"} },
], {
"description": "Stop the indicated induct task as defined for the "name": "endpoint_del",
indicated CL protocol on the local node." "parmspec": [{
}, "type": "STR",
{ "name": "endpoint_id"
"name": "init", }],
"description": "Until this control is executed, Bundle Protocol is not "description": "Delete the endpoint identified by endpointId.
in operation on the local ION node and most bpadmin controls will The control will fail if any bundles are
fail." currently pending delivery to this endpoint."
}, },
{ {
"name": "manage_heap_max", "name": "induct_add",
"parmspec": [ "parmspec": [{
{"type":"UINT","name":"max_database_heap_per_acquisition"} "type": "STR",
], "name": "protocol_name"
"description": "Declare the maximum number of bytes of SDR heap space }, {
that will be occupied by any single bundle acquisition activity "type": "STR",
(nominally the acquisition of a single bundle, but this is at the "name": "duct_name"
discretion of the convergence-layer input task). All data acquired }, {
in excess of this limit will be written to a temporary file pending "type": "STR",
extraction and dispatching of the acquired bundle or bundles. The "name": "cli_control"
default is the minimum allowed value (560 bytes), which is the }],
approximate size of a ZCO file reference object; this is the minimum "description": "Establish a duct for reception of bundles via
SDR heap space occupancy in the event that all acquisition is into the indicated CL protocol. The duct's data
a file." acquisition structure is used and populated by
}, the induct task whose operation is initiated by
{ cliControl at the time the duct is started."
"name": "outduct_add", },
"parmspec": [ {
{"type":"STR","name":"protocol_name"}, "name": "induct_change",
{"type":"STR","name":"duct_name"}, "parmspec": [{
{"type":"STR","name":"clo_command"}, "type": "STR",
{"type":"UINT","name":"max_payload_length"} "name": "protocol_name"
], }, {
"description": "Establish a duct for transmission of bundles via the "type": "STR",
indicated CL protocol. the duct's data transmission structure is "name": "duct_name"
serviced by the outduct task whose operation is initiated by }, {
CLOcommand at the time the duct is started. A value of zero for "type": "STR",
maxPayloadLength indicates that bundles of any size can be "name": "cli_control"
accomodated; this is the default." }],
}, "description": "Change the control used to initiate operation
{ of the induct task for the indicated duct."
"name": "outduct_change", },
"parmspec": [ {
{"type":"STR","name":"protocol_name"}, "name": "induct_del",
{"type":"STR","name":"duct_name"}, "parmspec": [{
{"type":"STR","name":"clo_control"}, "type": "STR",
{"type":"UINT","name":"max_payload_length"} "name": "protocol_name"
], }, {
"description": "Set new values for the indicated duct's payload size "type": "STR",
limit and the control that is used to initiate operation of the "name": "duct_name"
outduct task for this duct." }],
}, "description": "Delete the induct identified by protocolName and
{ ductName. The control will fail if any bundles
"name": "outduct_del", are currently pending acquisition via this
"parmspec":[ induct."
{"type":"STR","name":"protocol_name"}, },
{"type":"STR","name":"duct_name"} {
], "name": "induct_start",
"description": "Delete the outduct identified by protocolName and "parmspec": [{
ductName. The control will fail if any bundles are currently "type": "STR",
pending transmission via this outduct." "name": "protocol_name"
}, }, {
{ "type": "STR",
"name": "outduct_start", "name": "duct_name"
"parmspec":[ }],
{"type":"STR","name":"protocol_name"}, "description": "Start the indicated induct task as defined for
{"type":"STR","name":"duct_name"} the indicated CL protocol on the local node."
], },
"description": "Start the indicated outduct task as defined for the {
indicated CL protocol on the local node." "name": "induct_stop",
}, "parmspec": [{
{ "type": "STR",
"name": "egress_plan_block", "name": "protocol_name"
"parmspec": [{"type":"STR","name":"plan_name"}],
"description": "Disable transmission of bundles queued for }, {
transmission to the indicated node and reforwards all non-critical "type": "STR",
bundles currently queued for transmission to this node. This may "name": "duct_name"
result in some or all of these bundles being enqueued for }],
transmission to the psuedo-node limbo." "description": "Stop the indicated induct task as defined for
}, the indicated CL protocol on the local node."
{ },
"name": "egress_plan_unblock", {
"parmspec": [{"type":"STR","name":"plan_name"}], "name": "manage_heap_max",
"description": "Re-enable transmission of bundles to the indicated "parmspec": [{
node and reforwards all bundles in limbo in the hope that the "type": "UINT",
unblocking of this egress plan will enable some of them to be "name": "max_database_heap_per_acquisition"
transmitted." }],
}, "description": "Declare the maximum number of bytes of SDR heap
{ space that will be occupied by any single bundle
"name": "outduct_stop", acquisition activity (nominally the acquisition
"parmspec":[ of a single bundle, but this is at the
{"type":"STR","name":"protocol_name"}, discretion of the convergence-layer input task).
{"type":"STR","name":"duct_name"} All data acquired in excess of this limit will
], be written to a temporary file pending extraction
"description": "Stop the indicated outduct task as defined for the and dispatching of the acquired bundle or
indicated CL protocol on the local node." bundles. The default is the minimum allowed
}, value (560 bytes), which is the approximate size
{ of a ZCO file reference object; this is the
"name": "protocol_add", minimum SDR heap space occupancy in the event
"parmspec": [ that all acquisition is into a file."
{"type":"STR","name":"protocol_name"}, },
{"type":"UINT","name":"payload_bytes_per_frame"}, {
{"type":"UINT","name":"overhead_bytes_per_frame"}, "name": "outduct_add",
{"type":"UINT","name":"nominal_data_rate"} "parmspec": [{
], "type": "STR",
"description": "Establish access to the named convergence layer "name": "protocol_name"
protocol at the local node. The payloadBytesPerFrame and }, {
overheadBytesPerFrame arguments are used in calculating the "type": "STR",
estimated transmission capacity consumption of each bundle, to "name": "duct_name"
aid in route computation and congesting forecasting. The }, {
optional nominalDataRate argument overrides the hard coded "type": "STR",
default continuous data rate for the indicated protocol for "name": "clo_command"
purposes of rate control. For all promiscuous prototocols-that }, {
is, protocols whose outducts are not specifically dedicated to "type": "UINT",
transmission to a single identified convergence-layer protocol "name": "max_payload_length"
endpoint- the protocol's applicable nominal continuous data }],
rate is the data rate that is always used for rate control over "description": "Establish a duct for transmission of bundles via
links served by that protocol; data rates are not extracted the indicated CL protocol. the duct's data
from contact graph information. This is because only the induct transmission structure is serviced by the outduct
and outduct throttles for non-promiscuous protocols (LTP, TCP) task whose operation is initiated by
can be dynamically adjusted in response to changes in data rate CLOcommand at the time the duct is started. A
between the local node and its neighbors, as enacted per the value of zero for maxPayloadLength indicates
contact plan. Even for an outduct of a non-promiscuous protocol that bundles of any size can be accommodated;
the nominal data rate may be the authority for rate control, this is the default."
in the event that the contact plan lacks identified contacts },
with the node to which the outduct is mapped." {
}, "name": "outduct_change",
{ "parmspec": [{
"name": "protocol_del", "type": "STR",
"parmspec": [{"type":"STR","name":"protocol_name"}], "name": "protocol_name"
"description": "Delete the convergence layer protocol identified by }, {
protocolName. The control will fail if any ducts are still locally "type": "STR",
declared for this protocol." "name": "duct_name"
}, }, {
{ "type": "STR",
"name": "protocol_start", "name": "clo_control"
"parmspec": [{"type":"STR","name":"protocol_name"}], }, {
"description": "Start all induct and outduct tasks for inducts and "type": "UINT",
outducts that have been defined for the indicated CL protocol on "name": "max_payload_length"
the local node." }],
}, "description": "Set new values for the indicated duct's payload
{ size limit and the control that is used to
"name": "protocol_stop", initiate operation of the outduct task for this
"parmspec": [{"type":"STR","name":"protocol_name"}], duct."
"description": "Stop all induct and outduct tasks for inducts and },
outducts that have been defined for the indicated CL protocol on {
the local node." "name": "outduct_del",
}, "parmspec": [{
{ "type": "STR",
"name": "scheme_add", "name": "protocol_name"
"parmspec": [ }, {
{"type":"STR","name":"scheme_name"}, "type": "STR",
{"type":"STR","name":"forwarder_control"}, "name": "duct_name"
{"type":"STR","name":"admin_app_control"} }],
], "description": "Delete the outduct identified by protocolName
"description": "Declares an endpoint naming scheme for use in endpoint and ductName. The control will fail if any
IDs, which are structured as URIs: schemeName:schemeSpecificPart. bundles are currently pending transmission
forwarderControl will be executed when the scheme is started on this via this outduct."
node, to initiate operation of a forwarding daemon for this scheme. },
adminAppControl will also be executed when the scheme is started on {
this node, to initiate operation of a daemon that opens a custodian "name": "outduct_start",
endpoint identified within this scheme so that it can recieve and "parmspec": [{
process custody signals and bundle status reports." "type": "STR",
}, "name": "protocol_name"
{ }, {
"name": "scheme_change", "type": "STR",
"parmspec": [ "name": "duct_name"
{"type":"STR","name":"scheme_name"}, }],
{"type":"STR","name":"forwarder_control"}, "description": "Start the indicated outduct task as defined for
{"type":"STR","name":"admin_app_control"} the indicated CL protocol on the local node."
],
"description": "Set the indicated scheme's forwarderControl and },
adminAppControl to the strings provided as arguments." {
}, "name": "egress_plan_block",
{ "parmspec": [{
"name": "scheme_del", "type": "STR",
"parmspec": [{"type":"STR","name":"scheme_name"}], "name": "plan_name"
"description": "Delete the scheme identified by schemeName. The }],
control will fail if any bundles identified in this scheme are "description": "Disable transmission of bundles queued for
pending forwarding, transmission, or delivery." transmission to the indicated node and
}, reforwards all non-critical bundles currently
{ queued for transmission to this node. This may
"name": "scheme_start", result in some or all of these bundles being
"parmspec": [{"type":"STR","name":"scheme_name"}], enqueued for transmission to the psuedo-node
"description": "Start the forwarder and administrative endpoint tasks limbo."
for the indicated scheme task on the local node." },
}, {
{ "name": "egress_plan_unblock",
"name": "scheme_stop", "parmspec": [{
"parmspec": [{"type":"STR","name":"scheme_name"}], "type": "STR",
"description": "Stop the forwarder and administrative endpoint tasks "name": "plan_name"
for the indicated scheme task on the local node." }],
}, "description": "Re-enable transmission of bundles to the
{ indicated node and reforwards all bundles in
"name": "start", limbo in the hope that the unblocking of this
"description": "Start all schemes and all protocols on the local egress plan will enable some of them to be
node." transmitted."
}, },
{ {
"name": "stop", "name": "outduct_stop",
"description": "Stop all schemes and all protocols on the local node." "parmspec": [{
}, "type": "STR",
{ "name": "protocol_name"
"name": "watch", }, {
"parmspec":[ "type": "STR",
{"type":"UINT","name":"status"}, "name": "duct_name"
{"type":"UINT","name":"activity_spec"} }],
], "description": "Stop the indicated outduct task as defined for
"description": "Enable/Disable production of a continuous stream of the indicated CL protocol on the local node."
user selected Bundle Protocol activity indication characters. A },
watch parameter of 1 selects all BP activity indication characters, {
0 deselects allBP activity indication characters; any other "name": "protocol_add",
activitySpec such as acz~ selects all activity indication characters "parmspec": [{
in the string, deselecting all others. BP will print each selected "type": "STR",
activity indication character to stdout every time a processing "name": "protocol_name"
event of the associated type occurs: a new bundle is queued for }, {
forwarding, b bundle is queued for transmission, c bundle is popped "type": "UINT",
from its transmission queue, m custody acceptance signal is "name": "payload_bytes_per_frame"
recieved, w custody of bundle is accepted, x custody of bundle is }, {
refused, y bundle is accepted upon arrival, z bundle is queued for "type": "UINT",
delivery to an application, ~ bundle is abandoned (discarded) on "name": "overhead_bytes_per_frame"
attempt to forward it, ! bundle is destroyed due to TTL expiration, }, {
& custody refusal signal is recieved, # bundle is queued for "type": "UINT",
re-forwarding due to CL protocol failures, j bundle is placed in "name": "nominal_data_rate"
'limbo' for possible future reforwarding, k bundle is removed from }],
'limbo' and queued for reforwarding, $ bundle's custodial "description": "Establish access to the named convergence layer
retransmission timeout interval expired." protocol at the local node. The
} payloadBytesPerFrame and overheadBytesPerFrame
] arguments are used in calculating the estimated
} transmission capacity consumption of each
bundle, to aid in route computation and
congesting forecasting. The optional
nominalDataRate argument overrides the hard
coded default continuous data rate for the
indicated protocol for purposes of rate control.
For all promiscuous prototocols-that is,
protocols whose outducts are not specifically
dedicated to transmission to a single identified
convergence-layer protocol endpoint- the
protocol's applicable nominal continuous data
rate is the data rate that is always used for
rate control over links served by that protocol;
data rates are not extracted from contact graph
information. This is because only the induct and
outduct throttles for non-promiscuous protocols
(LTP, TCP) can be dynamically adjusted in
response to changes in data rate between the
local node and its neighbors, as enacted per the
contact plan. Even for an outduct of a
non-promiscuous protocol the nominal data rate
may be the authority for rate control, in the
event that the contact plan lacks identified
contacts with the node to which the outduct is
mapped."
},
{
"name": "protocol_del",
"parmspec": [{
"type": "STR",
"name": "protocol_name"
}],
"description": "Delete the convergence layer protocol identified
by protocolName. The control will fail if any
ducts are still locally declared for this
protocol."
},
{
"name": "protocol_start",
"parmspec": [{
"type": "STR",
"name": "protocol_name"
}],
"description": "Start all induct and outduct tasks for inducts
and outducts that have been defined for the
indicated CL protocol on the local node."
},
{
"name": "protocol_stop",
"parmspec": [{
"type": "STR",
"name": "protocol_name"
}],
"description": "Stop all induct and outduct tasks for inducts
and outducts that have been defined for the
indicated CL protocol on the local node."
},
{
"name": "scheme_add",
"parmspec": [{
"type": "STR",
"name": "scheme_name"
}, {
"type": "STR",
"name": "forwarder_control"
}, {
"type": "STR",
"name": "admin_app_control"
}],
"description": "Declares an endpoint naming scheme for use in
endpoint IDs, which are structured as URIs:
schemeName:schemeSpecificPart. forwarderControl
will be executed when the scheme is started on
this node, to initiate operation of a forwarding
daemon for this scheme. adminAppControl will
also be executed when the scheme is started on
this node, to initiate operation of a daemon
that opens a custodian endpoint identified within
this scheme so that it can receive and process
custody signals and bundle status reports."
},
{
"name": "scheme_change",
"parmspec": [{
"type": "STR",
"name": "scheme_name"
}, {
"type": "STR",
"name": "forwarder_control"
}, {
"type": "STR",
"name": "admin_app_control"
}],
"description": "Set the indicated scheme's forwarderControl and
adminAppControl to the strings provided as
arguments."
},
{
"name": "scheme_del",
"parmspec": [{
"type": "STR",
"name": "scheme_name"
}],
"description": "Delete the scheme identified by schemeName. The
control will fail if any bundles identified in
this scheme are pending forwarding,
transmission, or delivery."
},
{
"name": "scheme_start",
"parmspec": [{
"type": "STR",
"name": "scheme_name"
}],
"description": "Start the forwarder and administrative endpoint
tasks for the indicated scheme task on the local
node."
},
{
"name": "scheme_stop",
"parmspec": [{
"type": "STR",
"name": "scheme_name"
}],
"description": "Stop the forwarder and administrative endpoint
tasks for the indicated scheme task on the
local node."
},
{
"name": "watch",
"parmspec": [{
"type": "UINT",
"name": "status"
}, {
"type": "STR",
"name": "activity_spec"
}],
"description": "Enable/Disable production of a continuous stream
of user selected Bundle Protocol activity
indication characters. A watch parameter of 1
selects all BP activity indication characters, 0
deselects allBP activity indication characters;
any other activitySpec such as acz~ selects all
activity indication characters in the string,
deselecting all others. BP will print each
selected activity indication character to stdout
every time a processing event of the associated
type occurs: a new bundle is queued for
forwarding, b bundle is queued for transmission,
c bundle is popped from its transmission queue,
m custody acceptance signal is received, w
custody of bundle is accepted, x custody of
bundle is refused, y bundle is accepted upon
arrival, z bundle is queued for delivery to an
application, ~ bundle is abandoned (discarded)
on attempt to forward it, ! bundle is destroyed
due to TTL expiration, & custody refusal
signal is recieved, # bundle is queued for
re-forwarding due to CL protocol failures,
j bundle is placed in 'limbo' for possible
future reforwarding, k bundle is removed from
'limbo' and queued for reforwarding, $ bundle's
custodial retransmission timeout interval
expired."
}
]
}
5. IANA Considerations 5. IANA Considerations
At this time, this protocol has no fields registered by IANA. At this time, this protocol has no fields registered by IANA.
6. References 6. References
6.1. Informative References 6.1. Informative References
[I-D.birrane-dtn-ama] [I-D.birrane-dtn-ama]
 End of changes. 6 change blocks. 
426 lines changed or deleted 593 lines changed or added

This html diff was produced by rfcdiff 1.47. The latest version is available from http://tools.ietf.org/tools/rfcdiff/