home *** CD-ROM | disk | FTP | other *** search
/ Internet Core Protocols / Oreilly-InternetCoreProtocols.iso / RFCs / rfc1987.txt < prev    next >
Encoding:
Text File  |  1999-10-14  |  105.8 KB  |  2,468 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Network Working Group                                P. Newman, Ipsilon
  8. Request for Comments: 1987                           W. Edwards, Sprint
  9. Category: Informational                              R. Hinden, Ipsilon
  10.                                                     E. Hoffman, Ipsilon
  11.                                                  F. Ching Liaw, Ipsilon
  12.                                                        T. Lyon, Ipsilon
  13.                                                    G. Minshall, Ipsilon
  14.                                                             August 1996
  15.  
  16.  
  17.  
  18.        Ipsilon's General Switch Management Protocol Specification
  19.                               Version 1.1
  20.  
  21.  
  22.  
  23.  
  24.  
  25. Status of this Memo
  26.  
  27.    This memo provides information for the Internet community.  This memo
  28.    does not specify an Internet standard of any kind.  Distribution of
  29.    this memo is unlimited.
  30.  
  31.  
  32. Abstract
  33.  
  34.    The General Switch Management Protocol (GSMP), is a general purpose
  35.    protocol to control an ATM switch. GSMP allows a controller to
  36.    establish and release connections across the switch; add and delete
  37.    leaves on a point-to-multipoint connection; manage switch ports;
  38.    request configuration information; and request statistics.
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58. Newman, et. al.              Informational                      [Page 1]
  59.  
  60. RFC 1987              GSMP Protocol Specification            August 1996
  61.  
  62.  
  63. Table of Contents
  64.  
  65.    1. Introduction....................................................3
  66.  
  67.    2. GSMP Packet Format..............................................4
  68.  
  69.    3. Connection Management Messages..................................7
  70.       3.1 Add Branch Message.........................................11
  71.       3.2 Delete Branch Message......................................12
  72.       3.3 Delete Tree Message........................................13
  73.       3.4 Verify Tree Message........................................13
  74.       3.5 Delete All Message.........................................14
  75.       3.6 Move Branch Message........................................14
  76.  
  77.    4. Port Management Message........................................16
  78.  
  79.    5. Statistics Messages............................................20
  80.       5.1 VC Activity Message........................................20
  81.       5.2 Port and VC Statistics Messages............................23
  82.           5.2.1 Port Statistics Message..............................26
  83.           5.2.2 VC Statistics Message................................26
  84.  
  85.    6. Configuration..................................................26
  86.       6.1 Switch Configuration Message...............................27
  87.       6.2 Port Configuration Message.................................28
  88.       6.3 All Ports Configuration Message............................32
  89.  
  90.    7. Event Messages.................................................33
  91.       7.1 Port Up Message............................................35
  92.       7.2 Port Down Message..........................................35
  93.       7.3 Invalid VPI/VCI Message....................................35
  94.       7.4 New Port Message...........................................35
  95.       7.5 Dead Port Message..........................................36
  96.  
  97.    8. Adjacency Protocol.............................................36
  98.       8.1 Packet Format..............................................36
  99.       8.2 Procedure..................................................39
  100.  
  101.    9. Failure Response Messages......................................41
  102.  
  103.    References........................................................43
  104.    Security Considerations...........................................43
  105.    Authors' Addresses................................................43
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114. Newman, et. al.              Informational                      [Page 2]
  115.  
  116. RFC 1987              GSMP Protocol Specification            August 1996
  117.  
  118.  
  119. 1. Introduction
  120.  
  121.    The General Switch Management Protocol (GSMP), is a general purpose
  122.    protocol to control an ATM switch. GSMP allows a controller to
  123.    establish and release connections across the switch; add and delete
  124.    leaves on a point-to-multipoint connection; manage switch ports;
  125.    request configuration information; and request statistics. It also
  126.    allows the switch to inform the controller of asynchronous events
  127.    such as a link going down. GSMP runs across an ATM link connecting
  128.    the controller to the switch, on a control connection (virtual
  129.    channel) established at initialization. The GSMP protocol is
  130.    asymmetric, the controller being the master and the switch being the
  131.    slave. Multiple switches may be controlled by a single controller
  132.    using multiple instantiations of the protocol over separate control
  133.    connections.
  134.  
  135.    A switch is assumed to contain multiple "ports". Each port is a
  136.    combination of one "input port" and one "output port". Some GSMP
  137.    requests refer to the port as a whole whereas other requests are
  138.    specific to the input port or the output port.  ATM cells arrive at
  139.    the switch from an external communication link on incoming virtual
  140.    channels at an input port. ATM cells depart from the switch to an
  141.    external communication link on outgoing virtual channels from an
  142.    output port. Virtual channels on a port or link are referenced by
  143.    their virtual path and virtual channel identifiers (VPI/VCI). A
  144.    virtual channel connection across a switch is formed by connecting an
  145.    incoming virtual channel to one or more outgoing virtual channels.
  146.    Virtual channel connections are referenced by the input port on which
  147.    they arrive and the virtual path and virtual channel identifiers
  148.    (VPI/VCI) of their incoming virtual channel.
  149.  
  150.    In general a virtual channel is established with a certain quality of
  151.    service (QOS). Unfortunately this is an ill defined and changing
  152.    concept as new ideas make their way into hardware. For this version
  153.    of the GSMP protocol it is assumed that each virtual channel
  154.    connection may be assigned a priority when it is established. It may
  155.    be assumed that for virtual channel connections that share the same
  156.    output port, an ATM cell on a connection with a higher priority is
  157.    much more likely to exit the switch before an ATM cell on a
  158.    connection with a lower priority if they are both in the switch at
  159.    the same time. The number of priorities that each port of the switch
  160.    supports may be obtained from the port configuration message.
  161.  
  162.    Switch ports are described by a 32 bit port number. The switch
  163.    assigns port numbers and it may typically choose to structure the 32
  164.    bits into sub-fields that have meaning to the physical structure of
  165.    the switch (e.g. shelf, slot, port). In general, a port in the same
  166.    physical location on the switch will always have the same port
  167.  
  168.  
  169.  
  170. Newman, et. al.              Informational                      [Page 3]
  171.  
  172. RFC 1987              GSMP Protocol Specification            August 1996
  173.  
  174.  
  175.    number, even across power cycles. The internal structure of the port
  176.    number is opaque to the GSMP protocol. However, by looking up the
  177.    product identity in a database, network management tools may discover
  178.    the partitioning of the port number and the physical meaning of the
  179.    sub-fields.
  180.  
  181.    Each switch port also maintains a port session number assigned by the
  182.    switch. A connection management message or a port management message
  183.    with an incorrect port session number must be rejected.  This allows
  184.    the controller to detect a link failure and to keep state
  185.    synchronized. The port session number of a port remains unchanged
  186.    while the port is continuously in the available state and the link
  187.    status is continuously up. When a port returns to the available state
  188.    after it has been unavailable or in any of the loopback states, or
  189.    when the line status returns to the up state after it has been down
  190.    or in test, or after a power cycle, its port session number will have
  191.    changed.  Port session numbers should be assigned using some form of
  192.    random number.
  193.  
  194.    GSMP also contains an adjacency protocol. The adjacency protocol is
  195.    used to synchronize state across the link, to discover the identity
  196.    of the entity at the other end of a link, and to detect when it
  197.    changes.
  198.  
  199.  
  200. 2. GSMP Packet Format
  201.  
  202.    GSMP packets are variable length and are encapsulated directly in an
  203.    AAL-5 CPCS-PDU [I.363] with an LLC/SNAP header as illustrated:
  204.  
  205.     0                   1                   2                   3
  206.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  207.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  208.    |               LLC (0xAA-AA-03)                |               |
  209.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+               +
  210.    |                   SNAP (0x00-00-00-88-0C)                     |
  211.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  212.    |                                                               |
  213.    ~                         GSMP Message                          ~
  214.    |                                                               |
  215.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  216.    |                   Pad (0 - 47 octets)                         |
  217.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  218.    |                                                               |
  219.    +               AAL-5 CPCS-PDU Trailer (8 octets)               +
  220.    |                                                               |
  221.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  222.  
  223.  
  224.  
  225.  
  226. Newman, et. al.              Informational                      [Page 4]
  227.  
  228. RFC 1987              GSMP Protocol Specification            August 1996
  229.  
  230.  
  231.    (The convention in the documentation of Internet Protocols [rfc1700]
  232.    is to express numbers in decimal and to picture data in "big-endian"
  233.    order. That is, fields are described left to right, with the most
  234.    significant octet on the left and the least significant octet on the
  235.    right. Whenever a diagram shows a group of octets, the order of
  236.    transmission of those octets is the normal order in which they are
  237.    read in English. Whenever an octet represents a numeric quantity the
  238.    left most bit in the diagram is the high order or most significant
  239.    bit. That is, the bit labeled 0 is the most significant bit.
  240.    Similarly, whenever a multi-octet field represents a numeric quantity
  241.    the left most bit of the whole field is the most significant bit.
  242.    When a multi-octet quantity is transmitted, the most significant
  243.    octet is transmitted first. This is the same coding convention as is
  244.    used in the ATM layer [I.361] and AAL-5 [I.363].)
  245.  
  246.    The LLC/SNAP header contains the octets: 0xAA 0xAA 0x03 0x00 0x00
  247.    0x00 0x88 0x0C.
  248.  
  249.    The maximum transmission unit (MTU) of the GSMP message is 1500
  250.    octets.
  251.  
  252.    The default virtual channel for LLC/SNAP encapsulated messages is:
  253.  
  254.       VPI = 0
  255.       VCI = 15.
  256.  
  257.    GSMP is a master-slave protocol. The controller issues request
  258.    messages to the switch. Each request message indicates whether a
  259.    response is required from the switch and contains a transaction
  260.    identifier to enable the response to be associated with the request.
  261.    The switch replies with a response message indicating either a
  262.    successful result or a failure. There are four classes of GSMP
  263.    request-response message: Connection Management, Port Management,
  264.    Statistics, and Configuration. The switch may also generate
  265.    asynchronous Event messages to inform the controller of asynchronous
  266.    events.  Event messages are not acknowledged by the controller. There
  267.    is also an adjacency protocol message used to establish
  268.    synchronization across the link and maintain a handshake.
  269.  
  270.    For the request-response messages each message type has a format for
  271.    the request message and a format for the success response.  Unless
  272.    otherwise specified a failure response message is identical to the
  273.    request message that caused the failure, with the Code field
  274.    indicating the nature of the failure. Event messages have only a
  275.    single format defined as they are not acknowledged by the controller.
  276.  
  277.    Except for the adjacency protocol message, no GSMP messages may be
  278.    sent across the link until the adjacency protocol has achieved
  279.  
  280.  
  281.  
  282. Newman, et. al.              Informational                      [Page 5]
  283.  
  284. RFC 1987              GSMP Protocol Specification            August 1996
  285.  
  286.  
  287.    synchronization, and all GSMP messages received on a link that does
  288.    not currently have state synchronization must be discarded.
  289.  
  290.    All GSMP messages, except the adjacency protocol message, have the
  291.    following format:
  292.  
  293.     0                   1                   2                   3
  294.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  295.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  296.    |    Version    | Message Type  |    Result     |     Code      |
  297.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  298.    |                    Transaction Identifier                     |
  299.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  300.    |                                                               |
  301.    ~                          Message Body                         ~
  302.    |                                                               |
  303.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  304.  
  305.    Version
  306.              The GSMP protocol version number, currently Version = 1. It
  307.              should be set by the sender of the message to the GSMP
  308.              protocol version that the sender is currently running.
  309.  
  310.    Message Type
  311.              The GSMP message type. GSMP messages fall into five
  312.              classes: Connection Management, Port Management,
  313.              Statistics, Configuration, and Events. Each class, except
  314.              for port management, has a number of different message
  315.              types. In addition, one Message Type is allocated to the
  316.              adjacency protocol.
  317.  
  318.    Result
  319.              Field in a connection management request message or a port
  320.              management request message, is used to indicate whether a
  321.              response is required to the request message if the outcome
  322.              is successful. A value of "NoSuccessAck" indicates that the
  323.              request message does not expect a response if the outcome
  324.              is successful, and a value of "AckAll" indicates that a
  325.              response is expected if the outcome is successful.  In both
  326.              cases a failure response will be generated if the request
  327.              fails. This facility reduces the traffic in the case where
  328.              the controller is simply checking that the state in the
  329.              switch is correct. For all other request messages a value
  330.              of "NoSuccessAck" in the request message is ignored and the
  331.              request message is handled as if the field were set to
  332.              "AckAll".  In a response message the result field can have
  333.              two values: "Success" and "Failure".
  334.  
  335.  
  336.  
  337.  
  338. Newman, et. al.              Informational                      [Page 6]
  339.  
  340. RFC 1987              GSMP Protocol Specification            August 1996
  341.  
  342.  
  343.              The encoding of the result field is:
  344.  
  345.                   NoSuccessAck:  Result = 1
  346.                   AckAll:        Result = 2
  347.                   Success:       Result = 3
  348.                   Failure:       Result = 4.
  349.  
  350.  
  351.              The Result field is not used in an adjacency protocol
  352.              message and should be set to zero by the sender and ignored
  353.              by the receiver.
  354.  
  355.    Code
  356.              Field gives further information concerning the result in a
  357.              response message. It is mostly used to pass an error code
  358.              in a failure response but can also be used to give further
  359.              information in a success response message or an event
  360.              message. In a request message the code field is not used
  361.              and is set to zero. In an adjacency protocol message the
  362.              Code field is used to determine the function of the
  363.              message.
  364.  
  365.    Transaction Identifier
  366.              Used to associate a request message with its response
  367.              message. For request messages the controller may select any
  368.              transaction identifier. For response messages the
  369.              transaction identifier is set to the value of the
  370.              transaction identifier from the message to which it is a
  371.              response.  For event messages the transaction identifier
  372.              should be set to zero. In the adjacency protocol the
  373.              Transaction Identifier is not used. This field is not
  374.              present in the adjacency protocol message.
  375.  
  376.  
  377. 3. Connection Management Messages
  378.  
  379.    Connection management messages are used by the controller to
  380.    establish, delete, modify and verify connections across the switch.
  381.    The Add Branch, Delete Branch, Delete Tree, Verify Tree, and Delete
  382.    All connection management messages have the following format for both
  383.    request and response messages:
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394. Newman, et. al.              Informational                      [Page 7]
  395.  
  396. RFC 1987              GSMP Protocol Specification            August 1996
  397.  
  398.  
  399.     0                   1                   2                   3
  400.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  401.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  402.    |    Version    | Message Type  |    Result     |     Code      |
  403.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  404.    |                    Transaction Identifier                     |
  405.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  406.    |                      Port Session Number                      |
  407.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  408.    |                          Input Port                           |
  409.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  410.    | zero  |      Input VPI        |          Input VCI            |
  411.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  412.    |                          Output Port                          |
  413.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  414.    | zero  |      Output VPI       |          Output VCI           |
  415.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  416.    |      Number of Branches       |   Reserved    |   Priority    |
  417.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  418.  
  419.    Port Session Number
  420.              Field gives the session number of the input port. Each
  421.              switch port maintains a Port Session Number assigned by the
  422.              switch. The port session number of a port remains unchanged
  423.              while the port is continuously in the Available state and
  424.              the link status is continuously Up. When a port returns to
  425.              the Available state after it has been Unavailable or in any
  426.              of the Loopback states, or when the line status returns to
  427.              the Up state after it has been Down or in Test, or after a
  428.              power cycle, a new Port Session Number must be generated.
  429.              Port session numbers should be assigned using some form of
  430.              random number.  The switch must reject any connection
  431.              management request message that has an invalid Port Session
  432.              Number for the port specified in the Input Port field by
  433.              returning a failure response message with the Code field
  434.              indicating, "Invalid port session number." The current port
  435.              session number may be obtained using a configuration
  436.              message.
  437.  
  438.    Input Port
  439.              Indicates a switch input port.  Switch ports are referenced
  440.              by a 32 bit value assigned by the switch.
  441.  
  442.    Input VPI
  443.              Identifies an ATM virtual path arriving at the switch input
  444.              port indicated by the Input Port field.
  445.  
  446.  
  447.  
  448.  
  449.  
  450. Newman, et. al.              Informational                      [Page 8]
  451.  
  452. RFC 1987              GSMP Protocol Specification            August 1996
  453.  
  454.  
  455.    Input VCI
  456.              Identifies an ATM virtual channel arriving on the virtual
  457.              path indicated by the Input VPI field at the switch input
  458.              port indicated by the Input Port field.
  459.  
  460.    Output Port
  461.              Indicates a switch output port.  Switch ports are
  462.              referenced by a 32 bit value assigned by the switch.
  463.  
  464.    Output VPI
  465.              Identifies an outgoing virtual path departing from the
  466.              switch output port indicated in the Output Port field.
  467.  
  468.    Output VCI
  469.              Identifies an outgoing virtual channel departing on the
  470.              virtual path indicated by the Output VPI field from the
  471.              switch output port indicated in the Output Port field.
  472.  
  473.    Number of Branches
  474.              Gives the number of output branches on a virtual channel
  475.              connection. (A unicast connection will have one branch, a
  476.              multicast connection will have two or more branches.) This
  477.              field is only used in the Verify Tree message.  In all
  478.              other connection management messages this field should be
  479.              set to zero by the sender and ignored by the receiver.
  480.  
  481.    Reserved
  482.              This field is not used. It is set to zero by the sender and
  483.              ignored by the receiver.
  484.  
  485.    Priority
  486.              Gives the priority of the connection.  The highest priority
  487.              is numbered zero and the lowest priority is numbered "Q-1"
  488.              where "Q" is the number of priorities that the output port
  489.              can support. The ability to offer different qualities of
  490.              service to different connections based upon their priority
  491.              is assumed to be a property of the output port of the
  492.              switch. It is assumed that for virtual channel connections
  493.              that share the same output port, an ATM cell on a
  494.              connection with a higher priority is much more likely to
  495.              exit the switch before an ATM cell on a connection with a
  496.              lower priority if they are both in the switch at the same
  497.              time. The number of priorities that each output port can
  498.              support is given in the Port Configuration message. If a
  499.              connection request is received with a value in the priority
  500.              field that the switch cannot support, the switch will
  501.              assign the closest priority that it is capable of
  502.              supporting.  This field is only used in the Add Branch and
  503.  
  504.  
  505.  
  506. Newman, et. al.              Informational                      [Page 9]
  507.  
  508. RFC 1987              GSMP Protocol Specification            August 1996
  509.  
  510.  
  511.              Move Branch messages.  In all other connection management
  512.              messages this field should be set to zero by the sender and
  513.              ignored by the receiver.
  514.  
  515.    If the result field of the request message is "AckAll" the switch
  516.    must reply to all connection management request messages with a
  517.    success response message or a failure response message.  If the
  518.    result field of the request message is "NoSuccessAck" the switch must
  519.    only reply in the case of a failure.
  520.  
  521.    A success response message must not be sent until the operation has
  522.    been successfully completed. For connection management messages the
  523.    success response message is a copy of the request message returned
  524.    with a Result field indicating success. The Code field is not used in
  525.    a connection management success response message and should be set to
  526.    zero. The failure response message is a copy of the request message
  527.    returned with a Result field indicating failure. The Code field is
  528.    used to pass the Failure Code in a connection management failure
  529.    response message. If the switch issues a failure response the
  530.    connection state within the switch must not be modified by the
  531.    request message that resulted in the failure.
  532.  
  533.    No distinction is made between unicast connections and multicast
  534.    connections. The first Add Branch message for a particular Input
  535.    Port, Input VPI, and Input VCI will establish a unicast connection.
  536.    The second Add Branch message with the same Input Port, Input VPI,
  537.    and Input VCI fields will convert the connection to a multicast
  538.    connection with two branches. Subsequent Add Branch messages with the
  539.    same Input Port, Input VPI, and Input VCI fields will add further
  540.    branches to the multicast connection. Use of the Delete Branch
  541.    message on a multicast connection with two branches will result in a
  542.    unicast connection. Use of the Delete Branch message on a unicast
  543.    connection will delete the unicast connection. There is no concept of
  544.    a connection with zero output branches. All connections are
  545.    unidirectional, one input virtual channel to one or more output
  546.    virtual channels.
  547.  
  548.    The connection management messages may be issued regardless of the
  549.    Port Status of the switch port. Connections may be established or
  550.    deleted when a switch port is in the Available, Unavailable, or any
  551.    of the Loopback states. However, all connection state on an input
  552.    port will be deleted when the port returns to the Available state
  553.    from any other state, i.e. when a Port Management message is received
  554.    for that port with the Function field indicating either Bring Up, or
  555.    Reset Input Port.
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562. Newman, et. al.              Informational                     [Page 10]
  563.  
  564. RFC 1987              GSMP Protocol Specification            August 1996
  565.  
  566.  
  567. 3.1 Add Branch Message
  568.  
  569.    The Add Branch message is a connection management message used to
  570.    establish a virtual channel connection or to add an additional branch
  571.    to an existing virtual channel connection. It may also be used to
  572.    check the connection state stored in the switch. The connection is
  573.    specified by the Input Port, Input VPI, and Input VCI fields. The
  574.    output branch is specified by the Output Port, Output VPI, and Output
  575.    VCI fields. The priority of the connection is specified by the
  576.    Priority field. The Add Branch message is:
  577.  
  578.       Message Type = 16
  579.  
  580.    If the virtual channel connection specified by the Input Port, Input
  581.    VPI, and Input VCI fields does not already exist, it must be
  582.    established with the single output branch specified in the request
  583.    message. The output branch should have the priority specified by the
  584.    Priority field. If the Result field of the request message is
  585.    "AckAll" a success response message must be sent upon successful
  586.    establishment of the specified branch.  The success response message
  587.    must not be sent until the Add Branch operation has been completed.
  588.  
  589.    If the virtual channel connection specified by the Input Port, Input
  590.    VPI, and Input VCI fields already exists, but the specified output
  591.    branch does not, the new output branch must be added. The new output
  592.    branch should have the priority specified by the Priority field. If
  593.    the Result field of the request message is "AckAll" a success
  594.    response message must be sent upon successful establishment of the
  595.    specified branch. The success response message must not be sent until
  596.    the Add Branch operation has been completed.
  597.  
  598.    If the virtual channel connection specified by the Input Port, Input
  599.    VPI, and Input VCI fields already exists and the specified output
  600.    branch also already exists, the priority of the connection, if
  601.    different from the request message, should be changed to that in the
  602.    request message. A success response message must be sent if the
  603.    Result field of the request message is "AckAll".  This allows the
  604.    controller to periodically reassert the state of a connection or to
  605.    change its priority. If the result field of the request message is
  606.    "NoSuccessAck" a success response message should not be returned.
  607.    This may be used to reduce the traffic on the control link for
  608.    messages that are reasserting previously established state. For
  609.    messages that are reasserting previously established state, the
  610.    switch must always check that this state is correctly established in
  611.    the switch hardware (i.e. the actual connection tables used to
  612.    forward cells).
  613.  
  614.  
  615.  
  616.  
  617.  
  618. Newman, et. al.              Informational                     [Page 11]
  619.  
  620. RFC 1987              GSMP Protocol Specification            August 1996
  621.  
  622.  
  623.    The behavior is undefined if the output virtual channel specified by
  624.    the Output Port, Output VPI, and Output VCI fields is already in use
  625.    by any connection other than that specified by the Input Port, Input
  626.    VPI, and Input VCI fields.
  627.  
  628.    A failure response must be returned if the switch is unable to
  629.    establish the specified branch or if there is an error in any of the
  630.    fields of the request message. If a failure message is returned the
  631.    state of the switch must not have been modified by the request
  632.    message.
  633.  
  634.    It should be noted that different switches support multicast in
  635.    different ways. There will be a limit to the total number of
  636.    multicast connections any switch can support, and possibly a limit on
  637.    the maximum number of branches that a multicast connection may
  638.    specify.  Some switches also impose a limit on the number of
  639.    different VPI/VCI values that may be assigned to the output branches
  640.    of a multicast connection. Many switches are incapable of supporting
  641.    more than a single branch of any particular multicast connection on
  642.    the same output port. Specific failure codes are defined for some of
  643.    these conditions. If a switch sends a failure response to an Add
  644.    Branch message it must choose the most specific failure code.
  645.  
  646. 3.2 Delete Branch Message
  647.  
  648.    The Delete Branch message is a connection management message used to
  649.    delete a single branch of a virtual channel connection, or in the
  650.    case of the last branch, to delete the connection. The virtual
  651.    channel connection is specified by the Input Port, Input VPI, and
  652.    Input VCI fields. The specific branch is indicated by the Output
  653.    Port, Output VPI, and Output VCI fields. The Delete Branch message
  654.    is:
  655.  
  656.       Message Type = 17
  657.  
  658.    If the Result field of the request message is "AckAll" a success
  659.    response message must be sent upon successful deletion of the
  660.    specified branch. The success response message must not be sent until
  661.    the delete branch operation has been completed and if possible, not
  662.    until all data on that branch, queued for transmission, has been
  663.    transmitted. A failure message indicating, "The specified connection
  664.    does not exist," must be sent if the connection specified by the
  665.    Input Port, Input VPI, and Input VCI fields does not exist. A failure
  666.    message indicating, "The specified branch does not exist," must be
  667.    sent if the connection specified by the Input Port, Input VPI, and
  668.    Input VCI fields exists but the branch specified by the Output Port,
  669.    Output VPI, and Output VCI fields does not exist.
  670.  
  671.  
  672.  
  673.  
  674. Newman, et. al.              Informational                     [Page 12]
  675.  
  676. RFC 1987              GSMP Protocol Specification            August 1996
  677.  
  678.  
  679. 3.3 Delete Tree Message
  680.  
  681.    The Delete Tree message is a connection management message used to
  682.    delete an entire virtual channel connection. All remaining branches
  683.    of the connection are deleted. The virtual channel connection is
  684.    specified by the Input Port, Input VPI, and Input VCI fields.  The
  685.    Output Port, Output VPI, and Output VCI fields are not used in this
  686.    message and their contents should be set to zero by the sender and
  687.    ignored by the receiver. The Delete Tree message is:
  688.  
  689.       Message Type = 18
  690.  
  691.    If the Result field of the request message is "AckAll" a success
  692.    response message must be sent upon successful deletion of the
  693.    specified connection. The success message must not be sent until the
  694.    delete operation has been completed and if possible, not until all
  695.    data on the connection, queued for transmission, has been
  696.    transmitted. A failure message indicating, "The specified connection
  697.    does not exist," must be sent if the connection specified by the
  698.    Input Port, Input VPI, and Input VCI fields does not exist.
  699.  
  700. 3.4 Verify Tree Message
  701.  
  702.    The Verify Tree message is a connection management message used to
  703.    verify the number of branches on a virtual channel connection.  The
  704.    virtual channel connection is specified by the Input Port, Input VPI,
  705.    and Input VCI fields. The Output Port, Output VPI, and Output VCI
  706.    fields are not used in this message and their contents should be set
  707.    to zero by the sender and ignored by the receiver.  The number of
  708.    branches that the sender believes that this virtual channel
  709.    connection should contain is given by the Number of Branches field.
  710.    The Verify Tree message is:
  711.  
  712.       Message Type = 19
  713.  
  714.    If the Result field of the request message is "AckAll" a success
  715.    response message must be sent if the receiver agrees that the actual
  716.    number of branches of the specified virtual channel connection
  717.    matches the number contained in the Number of Branches field of the
  718.    request message. The failure response message, with the code field
  719.    set to "Failure specific to the particular message type," must be
  720.    sent if the actual number of branches of the specified virtual
  721.    channel connection does not match the number contained in the Number
  722.    of Branches field of the request message. In this failure response
  723.    message the Number of Branches field must be changed to contain the
  724.    actual number of branches of the specified virtual channel
  725.    connection. A failure response message with the code field set to a
  726.    different value must be used to indicate some other failure such as,
  727.  
  728.  
  729.  
  730. Newman, et. al.              Informational                     [Page 13]
  731.  
  732. RFC 1987              GSMP Protocol Specification            August 1996
  733.  
  734.  
  735.    "The specified connection does not exist." In this case the Number of
  736.    Branches field will be the same as that of the request message.
  737.  
  738.    The Verify Tree message can only be guaranteed to yield a correct
  739.    response when there are no other connection request messages or their
  740.    response messages pending for the specified connection.  If this is
  741.    not the case the result of the Verify Tree message is undefined.
  742.  
  743. 3.5 Delete All Message
  744.  
  745.    The Delete All message is a connection management message used to
  746.    delete all connections on a switch input port. All connections that
  747.    arrive at the specified input port must be deleted. On completion of
  748.    the operation all dynamically assigned VPI/VCI values for the
  749.    specified port must be unassigned, i.e. there must be no virtual
  750.    connections established in the VPI/VCI space that GSMP controls on
  751.    this port. The Input VPI, Input VCI, Output Port, Output VPI, and
  752.    Output VCI fields are not used in this message and their contents are
  753.    ignored and unspecified. The Delete All message is"
  754.  
  755.       Message Type = 20
  756.  
  757.    If the Result field of the request message is "AckAll" a success
  758.    response message must be sent upon completion of the operation. The
  759.    success response message must not be sent until the operation has
  760.    been completed.
  761.  
  762.  
  763. 3.6 Move Branch Message
  764.  
  765.    The Move Branch connection management message has the following
  766.    format for both request and response messages:
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786. Newman, et. al.              Informational                     [Page 14]
  787.  
  788. RFC 1987              GSMP Protocol Specification            August 1996
  789.  
  790.  
  791.     0                   1                   2                   3
  792.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  793.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  794.    |    Version    | Message Type  |    Result     |     Code      |
  795.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  796.    |                    Transaction Identifier                     |
  797.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  798.    |                      Port Session Number                      |
  799.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  800.    |                           Input Port                          |
  801.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  802.    | zero  |        Input VPI      |           Input VCI           |
  803.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  804.    |                        Old Output Port                        |
  805.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  806.    | zero  |    Old Output VPI     |        Old Output VCI         |
  807.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  808.    |                        New Output Port                        |
  809.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  810.    | zero  |    New Output VPI     |        New Output VCI         |
  811.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  812.    |                    Reserved                   |   Priority    |
  813.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  814.  
  815.    The Move Branch message is a connection management message used to
  816.    move a single output branch of a virtual channel connection from its
  817.    current output port, output VPI, and output VCI, to a new output
  818.    port, output VPI, and output VCI on the same virtual channel
  819.    connection. None of the other output branches are modified.  When the
  820.    operation is complete the original output VPI/VCI on the original
  821.    output port will be deleted from the connection.  The Move Branch
  822.    message is:
  823.  
  824.       Message Type = 22
  825.  
  826.    If the virtual channel connection specified by the Input Port, Input
  827.    VPI, and Input VCI fields already exists, and the output branch
  828.    specified by the Old Output Port, Old Output VPI, and Old Output VCI
  829.    fields exists as a branch on that connection, the output branch
  830.    specified by the New Output Port, New Output VPI, and New Output VCI
  831.    fields is added to the connection and the branch specified by the Old
  832.    Output Port, Old Output VPI, and Old Output VCI fields is deleted. If
  833.    the Result field of the request message is "AckAll" a success
  834.    response message must be sent upon successful completion of the
  835.    operation. The success response message must not be sent until the
  836.    Move Branch operation has been completed.
  837.  
  838.  
  839.  
  840.  
  841.  
  842. Newman, et. al.              Informational                     [Page 15]
  843.  
  844. RFC 1987              GSMP Protocol Specification            August 1996
  845.  
  846.  
  847.    If the virtual channel connection specified by the Input Port, Input
  848.    VPI, and Input VCI fields already exists, but the output branch
  849.    specified by the Old Output Port, Old Output VPI, and Old Output VCI
  850.    fields does not exist as a branch on that connection, a failure
  851.    response must be returned with the Code field indicating, "The
  852.    specified branch does not exist." The connection state of the switch
  853.    must not be modified in this case.
  854.  
  855.    If the virtual channel connection specified by the Input Port, Input
  856.    VPI, and Input VCI fields does not exist, a failure response must be
  857.    returned with the Code field indicating, "The specified connection
  858.    does not exist." The connection state of the switch must not be
  859.    modified in this case.
  860.  
  861.    The behavior is undefined if the output virtual channel specified by
  862.    the New Output Port, New Output VPI, and New Output VCI fields is
  863.    already in use by any connection.
  864.  
  865.    A failure response will be returned if the switch is unable to
  866.    establish the specified branch or if there is an error in any of the
  867.    fields of the request message. If a failure message is returned the
  868.    state of the switch must not have been modified by the request
  869.    message.
  870.  
  871. 4. Port Management Message
  872.  
  873.    The Port Management message allows a port to be brought into service,
  874.    taken out of service, looped back, or reset. Only the Bring Up and
  875.    the Reset Input Port functions change the connection state
  876.    (established connections) on the input port. Only the Bring Up
  877.    function changes the value of the Port Session Number. If the Result
  878.    field of the request message is "AckAll" a success response message
  879.    must be sent upon successful completion of the operation. The success
  880.    response message must not be sent until the operation has been
  881.    completed. The Port Management Message is:
  882.  
  883.       Message Type = 32
  884.  
  885.    The Port Management message has the following format for the request
  886.    and success response messages:
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.  
  897.  
  898. Newman, et. al.              Informational                     [Page 16]
  899.  
  900. RFC 1987              GSMP Protocol Specification            August 1996
  901.  
  902.  
  903.     0                   1                   2                   3
  904.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  905.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  906.    |    Version    | Message Type  |    Result     |     Code      |
  907.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  908.    |                    Transaction Identifier                     |
  909.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  910.    |                             Port                              |
  911.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  912.    |                      Port Session Number                      |
  913.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  914.    |                     Event Sequence Number                     |
  915.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  916.    |  Event Flags  |   Duration    |          Function             |
  917.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  918.  
  919.    Port
  920.              Gives the port number of the port to which the message
  921.              applies.
  922.  
  923.    Port Session Number
  924.              Gives the current port session number for the port. If the
  925.              Port Session Number in the request message does not match
  926.              the current port session number of the port indicated by
  927.              the Port field of the request message, a failure response
  928.              must be returned with, "Invalid port session number,"
  929.              indicated in the Code field. If the specified function
  930.              requires a new Port Session Number to be generated the new
  931.              Port Session Number must be given in the success response
  932.              message.  The Port Session Number must be generated using
  933.              some form of random number.
  934.  
  935.    Event Sequence Number
  936.              In the success response message gives the current value of
  937.              the Event Sequence Number of the switch port indicated by
  938.              the Port field. The Event Sequence Number is set to zero
  939.              when the port is initialized and is incremented by one each
  940.              time an asynchronous event is detected on that port that
  941.              the switch would normally report via an Event message. If
  942.              the Event Sequence Number in the success response differs
  943.              from the Event Sequence Number of the most recent Event
  944.              message received for that port, events have occurred that
  945.              were not reported via an Event message. This is most likely
  946.              to be due to the flow control that restricts the rate at
  947.              which a switch can send Event messages for each port. In
  948.              the request message this field is not used and should be
  949.              set to zero by the sender and ignored by the receiver.
  950.  
  951.  
  952.  
  953.  
  954. Newman, et. al.              Informational                     [Page 17]
  955.  
  956. RFC 1987              GSMP Protocol Specification            August 1996
  957.  
  958.  
  959.    Event Flags
  960.              Field in the request message is used to reset the Event
  961.              Flags in the switch port indicated by the Port field. Each
  962.              Event Flag in a switch port corresponds to a type of Event
  963.              message. When a switch port sends an Event message it sets
  964.              the corresponding Event Flag on that port. The port is not
  965.              permitted to send another Event message of the same type
  966.              until the Event Flag has been reset. If the Function field
  967.              in the request message is set to "Reset Event Flags," for
  968.              each bit that is set in the Event Flags field, the
  969.              corresponding Event Flag in the switch port is reset.
  970.  
  971.              The Event Flags field is only used in a request message
  972.              with the Function field set to "Reset Event Flags." For all
  973.              other values of the Function field, the Event Flags field
  974.              should be set to zero in the request message and must be
  975.              ignored by the receiver. In the success response message
  976.              the Event Flags field must be set to the current value of
  977.              the Event Flags for the port, after the completion of the
  978.              operation specified by the request message, for all values
  979.              of the Function field. Setting the Event Flags field to all
  980.              zeros in a "Reset Event Flags" request message allows the
  981.              controller to obtain the current state of the Event Flags
  982.              and the current Event Sequence Number of the port without
  983.              changing the state of the Event Flags.
  984.  
  985.              The correspondence between the types of Event message and
  986.              the bits of the Event Flags field is as follows:
  987.  
  988.                 Port Up:          Bit 0, (most significant bit)
  989.                 Port Down:        Bit 1,
  990.                 Invalid VPI/VCI:  Bit 2,
  991.                 New Port:         Bit 3,
  992.                 Dead Port:        Bit 4.
  993.  
  994.    Duration
  995.              Is the length of time, in seconds, that any of the loopback
  996.              states remain in operation. When the duration has expired
  997.              the port will automatically be returned to service.  If
  998.              another Port Management message is received for the same
  999.              port before the duration has expired, the loopback will
  1000.              continue to remain in operation for the length of time
  1001.              specified by the Duration field in the new message. The
  1002.              Duration field is only used in request messages with the
  1003.              Function field set to Internal Loopback, External Loopback,
  1004.              or Bothway Loopback. In all other request messages it
  1005.              should be set to zero by the sender and ignored by the
  1006.              receiver.
  1007.  
  1008.  
  1009.  
  1010. Newman, et. al.              Informational                     [Page 18]
  1011.  
  1012. RFC 1987              GSMP Protocol Specification            August 1996
  1013.  
  1014.  
  1015.    Function
  1016.              Specifies the action to be taken. The specified action will
  1017.              be taken regardless of the current status of the port
  1018.              (Available, Unavailable, or any Loopback state). The
  1019.              defined values of the Function field are:
  1020.  
  1021.              Bring Up:
  1022.                   Function = 1. Bring the port into service. All
  1023.                   connections that arrive at the specified input port
  1024.                   must be deleted and a new Port Session Number must be
  1025.                   selected using some form of random number. On
  1026.                   completion of the operation all dynamically assigned
  1027.                   VPI/VCI values for the specified input port must be
  1028.                   unassigned, i.e. no virtual connections will be
  1029.                   established in the VPI/VCI space that GSMP controls on
  1030.                   this input port. The Port Status of the port
  1031.                   afterwards will be Available.
  1032.  
  1033.              Take Down:
  1034.                   Function = 2. Take the port out of service. Any cells
  1035.                   received at this port will be discarded. No cells will
  1036.                   be transmitted from this port. The Port Status of the
  1037.                   port afterwards will be Unavailable. The behavior is
  1038.                   undefined if the port over which the GSMP protocol is
  1039.                   running is taken down.
  1040.  
  1041.              Internal Loopback:
  1042.                   Function = 3. Cells arriving at the output port from
  1043.                   the switch fabric are looped through to the input port
  1044.                   to return to the switch fabric. All of the ATM
  1045.                   functions of the input port above the PHY layer, e.g.
  1046.                   header translation, are performed upon the looped back
  1047.                   cells. The Port Status of the port afterwards will be
  1048.                   Internal Loopback.
  1049.  
  1050.              External Loopback:
  1051.                   Function = 4. Cells arriving at the input port from
  1052.                   the external communications link are immediately
  1053.                   looped back to the communications link at the physical
  1054.                   layer without entering the input port. None of the ATM
  1055.                   functions of the input port above the PHY layer are
  1056.                   performed upon the looped back cells. The Port Status
  1057.                   of the port afterwards will be External Loopback.
  1058.  
  1059.              Bothway Loopback:
  1060.                   Function = 5. Both internal and external loopback are
  1061.                   performed. The Port Status of the port afterwards will
  1062.                   be Bothway Loopback.
  1063.  
  1064.  
  1065.  
  1066. Newman, et. al.              Informational                     [Page 19]
  1067.  
  1068. RFC 1987              GSMP Protocol Specification            August 1996
  1069.  
  1070.  
  1071.              Reset Input Port:
  1072.                   Function = 6. All connections that arrive at the
  1073.                   specified input port must be deleted and the input and
  1074.                   output port hardware re-initialized. On completion of
  1075.                   the operation all dynamically assigned VPI/VCI values
  1076.                   for the specified input port must be unassigned, i.e.
  1077.                   no virtual connections will be established in the
  1078.                   VPI/VCI space that GSMP controls on this input port.
  1079.                   The Port Session Number is not changed by the Reset
  1080.                   Input Port function.  The Port Status of the port
  1081.                   afterwards will be Unavailable.
  1082.  
  1083.              Reset Event Flags:
  1084.                   Function = 7. For each bit that is set in the Event
  1085.                   Flags field, the corresponding Event Flag in the
  1086.                   switch port must be reset. The Port Status of the port
  1087.                   is not changed by this function.
  1088.  
  1089.  
  1090. 5. Statistics Messages
  1091.  
  1092.    The statistics messages permit the controller to request the values
  1093.    of various hardware counters associated with the switch input and
  1094.    output ports, and virtual channels. Two classes of statistics message
  1095.    are defined: the VC Activity Message, and the Port and VC Statistics
  1096.    Messages. The VC Activity message is used to determine whether one or
  1097.    more specific VCs have recently been carrying traffic.  The Port and
  1098.    VC Statistics message is used to query the various port and VC
  1099.    specific traffic and error counters.
  1100.  
  1101. 5.1 VC Activity Message
  1102.  
  1103.    The VC Activity message is used to determine whether one or more
  1104.    specific VCs have recently been carrying traffic. The VC Activity
  1105.    message contains one or more VC Activity records. Each VC Activity
  1106.    record is used to request and return activity information concerning
  1107.    a single virtual connection. Each VC is specified by its input port,
  1108.    input VPI, and input VCI. These are specified in the Input Port,
  1109.    Input VPI, and Input VCI fields of each VC Activity record.  Two
  1110.    forms of activity detection are supported. If the switch supports per
  1111.    VC traffic accounting the current value of the traffic counter for
  1112.    each specified VC must be returned. The units of traffic counted are
  1113.    not specified but will typically be either cells or frames.  The
  1114.    controller must compare the traffic counts returned in the message
  1115.    with previous values for each of the specified VCs to determine
  1116.    whether each VC has been active in the intervening period.  If the
  1117.    switch does not support per VC traffic accounting, but is capable of
  1118.    detecting per-VC activity by some other unspecified means, the result
  1119.  
  1120.  
  1121.  
  1122. Newman, et. al.              Informational                     [Page 20]
  1123.  
  1124. RFC 1987              GSMP Protocol Specification            August 1996
  1125.  
  1126.  
  1127.    may be indicated for each VC using the Flags field. The VC Activity
  1128.    message is:
  1129.  
  1130.       Message Type = 48
  1131.  
  1132.    The VC Activity request and success response messages have the
  1133.    following format:
  1134.  
  1135.     0                   1                   2                   3
  1136.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  1137.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1138.    |    Version    | Message Type  |    Result     |     Code      |
  1139.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1140.    |                    Transaction Identifier                     |
  1141.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1142.    |       Number of Records       |           Reserved            |
  1143.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1144.    |                                                               |
  1145.    ~                       VC Activity Records                     ~
  1146.    |                                                               |
  1147.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1148.  
  1149.    Number of Records
  1150.              Field specifies the number of VC Activity records to
  1151.              follow. The maximum number of VC Activity records permitted
  1152.              in a single VC Activity message is 120.
  1153.  
  1154.    Reserved
  1155.              Field is not used. It is set to zero by the sender and
  1156.              ignored by the receiver.
  1157.  
  1158.    Each VC Activity Record has the following format:
  1159.  
  1160.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1161.    |                          Input Port                           |
  1162.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1163.    | Flags |      Input VPI        |          Input VCI            |
  1164.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1165.    |                                                               |
  1166.    +                        VC Traffic Count                       +
  1167.    |                                                               |
  1168.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1169.  
  1170.    Input Port
  1171.              Identifies the port number of the input port on which the
  1172.              VC of interest arrives in order to identify the VC
  1173.              (regardless of whether the traffic count for the VC is
  1174.              maintained on the input port or the output port).
  1175.  
  1176.  
  1177.  
  1178. Newman, et. al.              Informational                     [Page 21]
  1179.  
  1180. RFC 1987              GSMP Protocol Specification            August 1996
  1181.  
  1182.  
  1183.    Input VPI
  1184.    Input VCI
  1185.              Fields identify the specific virtual channel for which
  1186.              statistics are being requested.
  1187.  
  1188.    Flags
  1189.              In the request message this field is unused, it should be
  1190.              set to zero by the sender and ignored by the receiver.  In
  1191.              the success response message bit 0 (msb) of the Flags field
  1192.              is used to indicate an invalid VC Activity record. This bit
  1193.              must be zero if any of the fields in this VC Activity
  1194.              record are invalid, if the input port specified by the
  1195.              Input Port field does not exist, or if the specified
  1196.              connection does not exist. If this bit is zero in a success
  1197.              response message bits 1 and 2 of the Flags field and the VC
  1198.              Traffic Count field are undefined. If bit 0 of the flags
  1199.              field is set, the VC Activity record is valid, and bits 1
  1200.              and 2 of the Flags field in the VC Activity record are used
  1201.              as follows:
  1202.  
  1203.                 Bit 1 of the Flags field: if set, indicates that the
  1204.                 value in bit 2 of the Flags field is valid; if zero,
  1205.                 indicates that the value in the VC Traffic Count field
  1206.                 is valid.
  1207.  
  1208.                 If bit 1 of the Flags field is set, bit 2 of the Flags
  1209.                 field, if set, indicates that there has been some
  1210.                 activity on this virtual channel since the last VC
  1211.                 Activity message for this virtual channel.
  1212.  
  1213.                 If bit 1 of the Flags field is set, bit 2 of the Flags
  1214.                 field, if zero, indicates that there has been no
  1215.                 activity on this virtual channel since the last VC
  1216.                 Activity message for this virtual channel.
  1217.  
  1218.                 Bit 3 of the Flags field is not used, it should be set
  1219.                 to zero by the sender and ignored by the receiver.
  1220.  
  1221.    VC Traffic Count
  1222.              Field is unused in the request message, it should be set to
  1223.              zero by the sender and ignored by the receiver. In the
  1224.              success response message, if the switch supports per-VC
  1225.              traffic counting, the VC Traffic Count field must be set to
  1226.              the value of a free running, VC specific, 64 bit traffic
  1227.              counter counting traffic flowing across the specified
  1228.              virtual channel.  The value of the traffic counter is not
  1229.              modified by reading it.  If per-VC traffic counting is
  1230.              supported, the switch must report the VC Activity result
  1231.  
  1232.  
  1233.  
  1234. Newman, et. al.              Informational                     [Page 22]
  1235.  
  1236. RFC 1987              GSMP Protocol Specification            August 1996
  1237.  
  1238.  
  1239.              using the traffic count rather than using bit 2 of the
  1240.              Flags field.
  1241.  
  1242.    The format of the failure response is the same as the request message
  1243.    with the Number of Records field set to zero and no VC Activity
  1244.    records returned in the message. If the switch is incapable of
  1245.    detecting per-VC activity, a failure response must be returned
  1246.    indicating, "The specified request is not implemented on this
  1247.    switch."
  1248.  
  1249. 5.2 Port and VC Statistics Messages
  1250.  
  1251.    The Port and VC Statistics messages are used to query the various
  1252.    port and VC specific traffic and error counters.
  1253.  
  1254.    The Port and VC Statistics request messages have the following
  1255.    format:
  1256.  
  1257.     0                   1                   2                   3
  1258.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  1259.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1260.    |    Version    | Message Type  |    Result     |     Code      |
  1261.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1262.    |                    Transaction Identifier                     |
  1263.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1264.    |                             Port                              |
  1265.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1266.    | zero  |          VPI          |              VCI              |
  1267.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1268.  
  1269.    Port
  1270.              Identifies the port number of the port for which statistics
  1271.              are being requested.
  1272.  
  1273.    VPI
  1274.    VCI
  1275.              Fields identify the specific virtual channel for which
  1276.              statistics are being requested.  For requests that do not
  1277.              require a virtual channel to be specified these fields
  1278.              should be set to zero in the request and ignored by the
  1279.              receiver.
  1280.  
  1281.    The success response messages for the port and VC statistics group
  1282.    have the following format:
  1283.  
  1284.  
  1285.  
  1286.  
  1287.  
  1288.  
  1289.  
  1290. Newman, et. al.              Informational                     [Page 23]
  1291.  
  1292. RFC 1987              GSMP Protocol Specification            August 1996
  1293.  
  1294.  
  1295.     0                   1                   2                   3
  1296.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  1297.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1298.    |    Version    | Message Type  |    Result     |     Code      |
  1299.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1300.    |                    Transaction Identifier                     |
  1301.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1302.    |                             Port                              |
  1303.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1304.    | zero  |          VPI          |              VCI              |
  1305.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1306.    |                                                               |
  1307.    +                       Input Cell Count                        +
  1308.    |                                                               |
  1309.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1310.    |                                                               |
  1311.    +                       Input Frame Count                       +
  1312.    |                                                               |
  1313.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1314.    |                                                               |
  1315.    +                    Input Cell Discard Count                   +
  1316.    |                                                               |
  1317.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1318.    |                                                               |
  1319.    +                   Input Frame Discard Count                   +
  1320.    |                                                               |
  1321.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1322.    |                                                               |
  1323.    +                     Input HEC Error Count                     +
  1324.    |                                                               |
  1325.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1326.    |                                                               |
  1327.    +                  Input Invalid VPI/VCI Count                  +
  1328.    |                                                               |
  1329.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1330.    |                                                               |
  1331.    +                       Output Cell Count                       +
  1332.    |                                                               |
  1333.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1334.    |                                                               |
  1335.    +                      Output Frame Count                       +
  1336.    |                                                               |
  1337.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1338.    |                                                               |
  1339.    +                   Output Cell Discard Count                   +
  1340.    |                                                               |
  1341.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1342.    |                                                               |
  1343.  
  1344.  
  1345.  
  1346. Newman, et. al.              Informational                     [Page 24]
  1347.  
  1348. RFC 1987              GSMP Protocol Specification            August 1996
  1349.  
  1350.  
  1351.    +                  Output Frame Discard Count                   +
  1352.    |                                                               |
  1353.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1354.  
  1355.    Port
  1356.    VPI/VCI
  1357.              Fields are the same as those of the request message.
  1358.  
  1359.    Input Cell Count
  1360.    Output Cell Count
  1361.              Each gives the value of a free running 64 bit counter
  1362.              counting cells arriving at the input or departing from the
  1363.              output respectively. In response to a Port Statistics
  1364.              message the count will be on a per port basis and in
  1365.              response to a VC Statistics message the count will be on a
  1366.              per VC basis.
  1367.  
  1368.    Input Frame Count
  1369.    Output Frame Count
  1370.              Each gives the value of a free running 64 bit counter
  1371.              counting frames (packets) arriving at the input or
  1372.              departing from the output respectively. In response to a
  1373.              Port Statistics message the count will be on a per port
  1374.              basis and in response to a VC Statistics message the count
  1375.              will be on a per VC basis.
  1376.  
  1377.    Input Cell Discard Count
  1378.    Output Cell Discard Count
  1379.              Each gives the value of a free running 64 bit counter
  1380.              counting cells discarded due to queue overflow on an input
  1381.              port or on an output port respectively. In response to a
  1382.              Port Statistics message the count will be on a per port
  1383.              basis and in response to a VC Statistics message the count
  1384.              will be on a per VC basis.
  1385.  
  1386.    Input Frame Discard Count
  1387.    Output Frame Discard Count
  1388.              Each gives the value of a free running 64 bit counter
  1389.              counting frames discarded due to queue overflow on an input
  1390.              port or on an output port respectively. In response to a
  1391.              Port Statistics message the count will be on a per port
  1392.              basis and in response to a VC Statistics message the count
  1393.              will be on a per VC basis.
  1394.  
  1395.    HEC Error Count
  1396.              Gives the value of a free running 64 bit counter counting
  1397.              cells discarded due to header checksum errors on arrival at
  1398.              an input port.
  1399.  
  1400.  
  1401.  
  1402. Newman, et. al.              Informational                     [Page 25]
  1403.  
  1404. RFC 1987              GSMP Protocol Specification            August 1996
  1405.  
  1406.  
  1407.    Invalid VPI/VCI Count
  1408.              Gives the value of a free running 64 bit counter counting
  1409.              cells discarded because their VPI/VCI is invalid on arrival
  1410.              at an input port. An incoming VPI/VCI is invalid if no
  1411.              connection is currently established having that value of
  1412.              VPI/VCI.
  1413.  
  1414. 5.2.1 Port Statistics Message
  1415.  
  1416.    The Port Statistics message requests the statistics for the switch
  1417.    port specified in the Port field. The contents of the VPI/VCI field
  1418.    in the Port Statistics request message are ignored. All of the count
  1419.    fields in the success response message refer to per-port counts
  1420.    regardless of the virtual channels to which the cells belong.  Any of
  1421.    the count fields in the success response message not supported by the
  1422.    port will be set to zero. The Port Statistics message is:
  1423.  
  1424.       Message Type = 49
  1425.  
  1426. 5.2.2 VC Statistics Message
  1427.  
  1428.    The VC Statistics message requests the statistics for the virtual
  1429.    channel specified in the VPI/VCI field that arrives on the switch
  1430.    input port specified in the Port field. All of the count fields in
  1431.    the success response message refer only to the specified virtual
  1432.    channel. The HEC Error Count and Invalid VPI/VCI Count fields are not
  1433.    VC specific and are set to zero. Any of the other count fields not
  1434.    supported on a per virtual channel basis will be set to zero in the
  1435.    success response message. The VC Statistics message is:
  1436.  
  1437.       Message Type = 50
  1438.  
  1439. 6. Configuration
  1440.  
  1441.    The configuration messages permit the controller to discover the
  1442.    capabilities of the switch. Three configuration request messages have
  1443.    been defined: Switch, Port, and All Ports.
  1444.  
  1445.  
  1446.  
  1447.  
  1448.  
  1449.  
  1450.  
  1451.  
  1452.  
  1453.  
  1454.  
  1455.  
  1456.  
  1457.  
  1458. Newman, et. al.              Informational                     [Page 26]
  1459.  
  1460. RFC 1987              GSMP Protocol Specification            August 1996
  1461.  
  1462.  
  1463.    All configuration request messages have the following format:
  1464.  
  1465.     0                   1                   2                   3
  1466.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  1467.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1468.    |    Version    | Message Type  |    Result     |     Code      |
  1469.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1470.    |                    Transaction Identifier                     |
  1471.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1472.    |                             Port                              |
  1473.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1474.  
  1475.    Port
  1476.              Identifies the port number for which configuration
  1477.              information is being requested. If the Port field is not
  1478.              required by the message it is set to zero by the sender and
  1479.              ignored by the receiver.
  1480.  
  1481. 6.1 Switch Configuration Message
  1482.  
  1483.    The Switch Configuration message requests the global (non port-
  1484.    specific) configuration for the switch. The Switch Configuration
  1485.    message is:
  1486.  
  1487.       Message Type = 64
  1488.  
  1489.    The Port field is not used in the request message and is set to zero.
  1490.  
  1491.    The Switch Configuration success response message has the following
  1492.    format:
  1493.  
  1494.     0                   1                   2                   3
  1495.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  1496.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1497.    |    Version    | Message Type  |    Result     |     Code      |
  1498.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1499.    |                    Transaction Identifier                     |
  1500.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1501.    |    Firmware Version Number    |           Reserved            |
  1502.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1503.    |          Switch Type          |                               |
  1504.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
  1505.    |                          Switch Name                          |
  1506.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1507.  
  1508.    Firmware Version Number
  1509.              The version number of the switch control firmware
  1510.              installed.
  1511.  
  1512.  
  1513.  
  1514. Newman, et. al.              Informational                     [Page 27]
  1515.  
  1516. RFC 1987              GSMP Protocol Specification            August 1996
  1517.  
  1518.  
  1519.    Reserved
  1520.              Field is not used. It is set to zero by the sender and
  1521.              ignored by the receiver.
  1522.  
  1523.    Switch Type
  1524.              A 16 bit field allocated by the manufacturer of the switch.
  1525.              (For these purposes the manufacturer of the switch is
  1526.              assumed to be the organization identified by the OUI in the
  1527.              Switch Name field.) The Switch Type identifies the product.
  1528.              When the Switch Type is combined with the OUI from the
  1529.              Switch Name the product is uniquely identified. Network
  1530.              Management may use this identification to obtain product
  1531.              related information from a database.
  1532.  
  1533.    Switch Name
  1534.              A 48 bit quantity that is unique within the operational
  1535.              context of the device. A 48 bit IEEE 802 MAC address, if
  1536.              available, may be used as the Switch Name. The most
  1537.              significant 24 bits of the Switch Name must be an
  1538.              Organizationally Unique Identifier (OUI) that identifies
  1539.              the manufacturer of the switch.
  1540.  
  1541. 6.2 Port Configuration Message
  1542.  
  1543.    The Port Configuration message requests the switch for the
  1544.    configuration information of a single switch port. The Port field in
  1545.    the request message specifies the port for which the configuration is
  1546.    requested.  The Port Configuration message is:
  1547.  
  1548.       Message Type = 65.
  1549.  
  1550.    The Port Configuration success response message has the following
  1551.    format:
  1552.  
  1553.  
  1554.  
  1555.  
  1556.  
  1557.  
  1558.  
  1559.  
  1560.  
  1561.  
  1562.  
  1563.  
  1564.  
  1565.  
  1566.  
  1567.  
  1568.  
  1569.  
  1570. Newman, et. al.              Informational                     [Page 28]
  1571.  
  1572. RFC 1987              GSMP Protocol Specification            August 1996
  1573.  
  1574.  
  1575.     0                   1                   2                   3
  1576.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  1577.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1578.    |    Version    | Message Type  |    Result     |     Code      |
  1579.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1580.    |                    Transaction Identifier                     |
  1581.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1582.    |                             Port                              |
  1583.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1584.    |                       Port Session Number                     |
  1585.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1586.    |  zero |      Min VPI          |  zero |       Max VPI         |
  1587.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1588.    |            Min VCI            |           Max VCI             |
  1589.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1590.    |                           Cell Rate                           |
  1591.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1592.    |  Port Status  |   Port Type   |  Line Status  |  Priorities   |
  1593.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1594.  
  1595.    Port
  1596.              The switch port to which the configuration information
  1597.              refers. Configuration information relating to both the
  1598.              input and the output sides of the switch port is given.
  1599.              Port numbers are 32 bits wide and allocated by the switch.
  1600.              The switch may choose to structure the 32 bits into sub
  1601.              fields that have meaning to the physical structure of the
  1602.              switch hardware (e.g.  shelf, slot, interface).
  1603.  
  1604.    Port Session Number
  1605.              The current Port Session Number for the specified port.
  1606.              Each switch port maintains a Port Session Number assigned
  1607.              by the switch. The Port Session Number of a port remains
  1608.              unchanged while the port is continuously in the Available
  1609.              state. When a port returns to the Available state after it
  1610.              has been Unavailable, or after a power cycle, its Port
  1611.              Session Number must be changed, preferably using some form
  1612.              of random number.
  1613.  
  1614.    Min VPI
  1615.              The minimum value of dynamically assigned incoming VPI that
  1616.              the connection table on the input port can support and may
  1617.              be controlled by GSMP.
  1618.  
  1619.    Max VPI
  1620.              The maximum value of dynamically assigned incoming VPI that
  1621.              the connection table on the input port can support and may
  1622.              be controlled by GSMP. It is assumed that the input port
  1623.  
  1624.  
  1625.  
  1626. Newman, et. al.              Informational                     [Page 29]
  1627.  
  1628. RFC 1987              GSMP Protocol Specification            August 1996
  1629.  
  1630.  
  1631.              can handle all values of VPI within the range Min VPI to
  1632.              Max VPI inclusive and that GSMP may control all values
  1633.              within this range.  If the switch does not support virtual
  1634.              paths it is acceptable for both Min VPI and Max VPI to
  1635.              specify the same value, most likely zero.
  1636.  
  1637.    Min VCI
  1638.              The minimum value of dynamically assigned incoming VCI that
  1639.              the connection table on the input port can support and may
  1640.              be controlled by GSMP.
  1641.  
  1642.    Max VCI
  1643.              The maximum value of dynamically assigned incoming VCI that
  1644.              the connection table on the input port can support and may
  1645.              be controlled by GSMP. It is assumed that the input port
  1646.              can handle all values of VCI within the range Min VCI to
  1647.              Max VCI inclusive for each of the virtual paths in the
  1648.              range Min VPI to Max VPI inclusive and that GSMP may
  1649.              control all values within this range.
  1650.  
  1651.    Cell Rate
  1652.              A measure of the bandwidth of the port. It is the rate of
  1653.              cells arriving at or departing from the port in cells/s. It
  1654.              is assumed that both input port and output port have the
  1655.              same cell rate.
  1656.  
  1657.    Port Status
  1658.              Gives the administrative state of the port. The defined
  1659.              values of the Port Status field are:
  1660.  
  1661.              Available:
  1662.                   Port Status = 1. The port is available to both send
  1663.                   and receive cells. When a port changes to the
  1664.                   Available state from any other administrative state,
  1665.                   all dynamically assigned virtual connections must be
  1666.                   cleared and a new Port Session Number must be
  1667.                   generated.
  1668.  
  1669.              Unavailable:
  1670.                   Port Status = 2. The port has intentionally been taken
  1671.                   out of service. No cells will be transmitted from this
  1672.                   port.  No cells will be received by this port.
  1673.  
  1674.              Internal Loopback:
  1675.                   Port Status = 3. The port has intentionally been taken
  1676.                   out of service and is in internal loopback: cells
  1677.                   arriving at the output port from the switch fabric are
  1678.                   looped through to the input port to return to the
  1679.  
  1680.  
  1681.  
  1682. Newman, et. al.              Informational                     [Page 30]
  1683.  
  1684. RFC 1987              GSMP Protocol Specification            August 1996
  1685.  
  1686.  
  1687.                   switch fabric. All of the ATM functions of the input
  1688.                   port above the PHY layer, e.g. header translation, are
  1689.                   performed upon the looped back cells.
  1690.  
  1691.              External Loopback:
  1692.                   Port Status = 4. The port has intentionally been taken
  1693.                   out of service and is in external loopback: cells
  1694.                   arriving at the input port from the external
  1695.                   communications link are immediately looped back to the
  1696.                   communications link at the physical layer without
  1697.                   entering the input port. None of the ATM functions of
  1698.                   the input port above the PHY layer are performed upon
  1699.                   the looped back cells.
  1700.  
  1701.              Bothway Loopback:
  1702.                   Port Status = 5. The port has intentionally been taken
  1703.                   out of service and is in both internal and external
  1704.                   loopback.
  1705.  
  1706.    Port Type
  1707.              The type of physical transmission interface for this port.
  1708.              The values for this field are given by the IANAifTYPE
  1709.              object from the MIB defined for the IANAifTYPE-MIB
  1710.              specified in RFC 1573 [rfc1573]. Example values are: SONET
  1711.              or SDH (39), DS-3 (30).
  1712.  
  1713.    Line Status
  1714.              The status of the physical transmission medium connected to
  1715.              the port. The defined values of the Line Status field are:
  1716.  
  1717.              Up:
  1718.                   Line Status = 1. The line is able to both send and
  1719.                   receive cells.  When the Line Status changes to Up
  1720.                   from either the Down or Test states, a new Port
  1721.                   Session Number must be generated.
  1722.  
  1723.              Down:
  1724.                   Line Status = 2. The line is unable either to send or
  1725.                   receive cells or both.
  1726.  
  1727.              Test:
  1728.                   Line Status = 3. The port or line is in a test mode,
  1729.                   for example, power-on test.
  1730.  
  1731.    Priorities
  1732.              The number of different priorities that this output port
  1733.              can assign to virtual channel connections.  Zero is invalid
  1734.              in this field. If an output port is able to support "Q"
  1735.  
  1736.  
  1737.  
  1738. Newman, et. al.              Informational                     [Page 31]
  1739.  
  1740. RFC 1987              GSMP Protocol Specification            August 1996
  1741.  
  1742.  
  1743.              priorities, the highest priority is numbered zero and the
  1744.              lowest priority is numbered "Q-1". The ability to offer
  1745.              different qualities of service to different connections
  1746.              based upon their priority is assumed to be a property of
  1747.              the output port of the switch. It may be assumed that for
  1748.              virtual channel connections that share the same output
  1749.              port, an ATM cell on a connection with a higher priority is
  1750.              much more likely to exit the switch before an ATM cell on a
  1751.              connection with a lower priority if they are both in the
  1752.              switch at the same time.
  1753.  
  1754. 6.3 All Ports Configuration Message
  1755.  
  1756.    The All Ports Configuration message requests the switch for the
  1757.    configuration information of all of its ports. The All Ports
  1758.    Configuration message is:
  1759.  
  1760.       Message Type = 66
  1761.  
  1762.    The Port field is not used in the request message and is set to zero.
  1763.  
  1764.    The All Ports Configuration success response message has the
  1765.    following format:
  1766.  
  1767.     0                   1                   2                   3
  1768.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  1769.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1770.    |    Version    | Message Type  |    Result     |     Code      |
  1771.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1772.    |                    Transaction Identifier                     |
  1773.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1774.    |       Number of Records       |      Port Record Length       |
  1775.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1776.    |                                                               |
  1777.    ~                          Port Records                         ~
  1778.    |                                                               |
  1779.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1780.  
  1781.    Number of Records
  1782.              Field gives the number of Port Records to follow in the
  1783.              message. The maximum number of port records allowed in a
  1784.              single All Ports Configuration success response is 64. If a
  1785.              switch has more than 64 ports it must send them in multiple
  1786.              success response messages.
  1787.  
  1788.    Port Record Length
  1789.              Field gives the length of each port record in bytes. This
  1790.              is currently 24 but the Port Record Length field allows for
  1791.  
  1792.  
  1793.  
  1794. Newman, et. al.              Informational                     [Page 32]
  1795.  
  1796. RFC 1987              GSMP Protocol Specification            August 1996
  1797.  
  1798.  
  1799.              the future definition of further fields at the end of the
  1800.              port record while preserving compatibility with earlier
  1801.              versions of the protocol.
  1802.  
  1803.    Port Records follow in the remainder of the message. Each port record
  1804.    has the following format:
  1805.  
  1806.     0                   1                   2                   3
  1807.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  1808.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1809.    |                             Port                              |
  1810.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1811.    |                       Port Session Number                     |
  1812.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1813.    |  zero |      Min VPI          |  zero |       Max VPI         |
  1814.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1815.    |            Min VCI            |           Max VCI             |
  1816.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1817.    |                           Cell Rate                           |
  1818.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1819.    |  Port Status  |   Port Type   |  Line Status  |  Priorities   |
  1820.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1821.  
  1822.    The definition of the fields in the port record is exactly the same
  1823.    as that of the Port Configuration message.
  1824.  
  1825. 7. Event Messages
  1826.  
  1827.    Event messages allow the switch to inform the controller of certain
  1828.    asynchronous events. Event messages are not acknowledged. The Result
  1829.    field and the Code field in the message header are not used and
  1830.    should be set to zero. Event messages are not sent during
  1831.    initialization. Event messages have the following format:
  1832.  
  1833.  
  1834.  
  1835.  
  1836.  
  1837.  
  1838.  
  1839.  
  1840.  
  1841.  
  1842.  
  1843.  
  1844.  
  1845.  
  1846.  
  1847.  
  1848.  
  1849.  
  1850. Newman, et. al.              Informational                     [Page 33]
  1851.  
  1852. RFC 1987              GSMP Protocol Specification            August 1996
  1853.  
  1854.  
  1855.     0                   1                   2                   3
  1856.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  1857.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1858.    |    Version    | Message Type  |    Result     |     Code      |
  1859.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1860.    |                    Transaction Identifier                     |
  1861.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1862.    |                             Port                              |
  1863.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1864.    |                      Port Session Number                      |
  1865.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1866.    |                     Event Sequence Number                     |
  1867.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1868.    | zero  |          VPI          |              VCI              |
  1869.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1870.  
  1871.    Port
  1872.              Field gives the switch port to which the event message
  1873.              refers.
  1874.  
  1875.    Port Session Number
  1876.              The current Port Session Number for the specified port.
  1877.  
  1878.    Event Sequence Number
  1879.              The current value of the Event Sequence Number for the
  1880.              specified port. The Event Sequence Number is set to zero
  1881.              when the port is initialized and is incremented by one each
  1882.              time an asynchronous event is detected on that port that
  1883.              the switch would normally report via an Event message. The
  1884.              Event Sequence Number must be incremented each time an
  1885.              event occurs even if the switch is prevented from sending
  1886.              an Event message due to the action of the flow control.
  1887.  
  1888.    VPI/VCI
  1889.              Field gives the VPI/VCI to which the event message refers.
  1890.              If this field is not required by the event message it is
  1891.              set to zero.
  1892.  
  1893.    Each switch port must maintain an Event Sequence Number and a set of
  1894.    Event Flags, one Event Flag for each type of Event message.  When a
  1895.    switch port sends an Event message it must set the Event Flag on that
  1896.    port corresponding to the type of the event. The port is not
  1897.    permitted to send another Event message of the same type until the
  1898.    Event Flag has been reset. Event Flags are reset by the "Reset Event
  1899.    Flags" function of the Port Management message. This is a simple flow
  1900.    control preventing the switch from flooding the controller with event
  1901.    messages. The Event Sequence Number of the port must be incremented
  1902.    every time an event is detected on that port even if the port is
  1903.  
  1904.  
  1905.  
  1906. Newman, et. al.              Informational                     [Page 34]
  1907.  
  1908. RFC 1987              GSMP Protocol Specification            August 1996
  1909.  
  1910.  
  1911.    prevented from reporting the event due to the action of the flow
  1912.    control. This allows the controller to detect that it has not been
  1913.    informed of some events that have occurred on the port due to the
  1914.    action of the flow control.
  1915.  
  1916. 7.1 Port Up Message
  1917.  
  1918.    The Port Up message informs the controller that the Line Status of a
  1919.    port has changed from either the Down or Test state to the Up state.
  1920.    When the Line Status of a switch port changes to the Up state from
  1921.    either the Down or Test state a new Port Session Number must be
  1922.    generated, preferably using some form of random number. The new Port
  1923.    Session Number is given in the Port Session Number field. The VPI/VCI
  1924.    field is not used and is set to zero.  The Port Up message is:
  1925.  
  1926.       Message Type = 80
  1927.  
  1928. 7.2 Port Down Message
  1929.  
  1930.    The Port Down message informs the controller that the Line Status of
  1931.    a port has changed from the Up state to the Down state. This message
  1932.    will be sent to report link failure if the switch is capable of
  1933.    detecting link failure. The port session number that was valid before
  1934.    the port went down is reported in the Port Session Number field. The
  1935.    VPI/VCI field is not used and is set to zero. The Port Down message
  1936.    is:
  1937.  
  1938.       Message Type = 81
  1939.  
  1940. 7.3 Invalid VPI/VCI Message
  1941.  
  1942.    The Invalid VPI/VCI message is sent to inform the controller that one
  1943.    or more cells have arrived at an input port with a VPI/ VCI that is
  1944.    currently not allocated to an assigned connection. The input port is
  1945.    indicated in the Port field, and the VPI/VCI in the VPI/VCI field.
  1946.    The Invalid VPI/VCI message is:
  1947.  
  1948.       Message Type = 82
  1949.  
  1950. 7.4 New Port Message
  1951.  
  1952.    The New Port message informs the controller that a new port has been
  1953.    added to the switch. The port number of the new port is given in the
  1954.    Port field. A new Port Session Number must be assigned, preferably
  1955.    using some form of random number.  The new Port Session Number is
  1956.    given in the Port Session Number field.  The state of the new port is
  1957.    undefined so the VPI/VCI field is not used and is set to zero.  The
  1958.    New Port message is:
  1959.  
  1960.  
  1961.  
  1962. Newman, et. al.              Informational                     [Page 35]
  1963.  
  1964. RFC 1987              GSMP Protocol Specification            August 1996
  1965.  
  1966.  
  1967.       Message Type = 83
  1968.  
  1969. 7.5 Dead Port Message
  1970.  
  1971.    The Dead Port message informs the controller that a port has been
  1972.    removed from the switch. The port number of the port is given in the
  1973.    Port field. The Port Session Number that was valid before the port
  1974.    was removed is reported in the Port Session Number field.  The
  1975.    VPI/VCI fields are not used and are set to zero. The Dead Port
  1976.    message is:
  1977.  
  1978.       Message Type = 84
  1979.  
  1980. 8. Adjacency Protocol
  1981.  
  1982.    The adjacency protocol is used to synchronize state across the link,
  1983.    to discover the identity of the entity at the other end of a link,
  1984.    and to detect when it changes. No GSMP messages other than those of
  1985.    the adjacency protocol may be sent across the link until the
  1986.    adjacency protocol has achieved synchronization.
  1987.  
  1988. 8.1 Packet Format
  1989.  
  1990.    The adjacency protocol is:
  1991.  
  1992.       Message Type = 10
  1993.  
  1994.    All GSMP messages belonging to the adjacency protocol have the
  1995.    following structure:
  1996.  
  1997.  
  1998.  
  1999.  
  2000.  
  2001.  
  2002.  
  2003.  
  2004.  
  2005.  
  2006.  
  2007.  
  2008.  
  2009.  
  2010.  
  2011.  
  2012.  
  2013.  
  2014.  
  2015.  
  2016.  
  2017.  
  2018. Newman, et. al.              Informational                     [Page 36]
  2019.  
  2020. RFC 1987              GSMP Protocol Specification            August 1996
  2021.  
  2022.  
  2023.     0                   1                   2                   3
  2024.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  2025.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2026.    |    Version    | Message Type  |    Result     |     Code      |
  2027.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2028.    |                          Sender Name                          |
  2029.    +                               +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2030.    |                               |                               |
  2031.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
  2032.    |                         Receiver Name                         |
  2033.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2034.    |                          Sender Port                          |
  2035.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2036.    |                         Receiver Port                         |
  2037.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2038.    |                        Sender Instance                        |
  2039.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2040.    |                       Receiver Instance                       |
  2041.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2042.  
  2043.    Version
  2044.              The GSMP protocol version number, currently Version = 1. It
  2045.              should be set by the sender of the message to the GSMP
  2046.              protocol version that the sender is currently running.
  2047.  
  2048.    Result
  2049.              Field is not used in the adjacency protocol. It should be
  2050.              set to zero by the sender and ignored by the receiver.
  2051.  
  2052.    Code
  2053.              Field specifies the function of the message. Four Codes are
  2054.              defined for the adjacency protocol:
  2055.  
  2056.                 SYN:     Code = 1
  2057.                 SYNACK:  Code = 2
  2058.                 ACK:     Code = 3
  2059.                 RSTACK:  Code = 4.
  2060.  
  2061.    Sender Name
  2062.              For the SYN, SYNACK, and ACK messages, is the name of the
  2063.              entity sending the message. The Sender Name is a 48 bit
  2064.              quantity that is unique within the operational context of
  2065.              the device. A 48 bit IEEE 802 MAC address, if available,
  2066.              may be used for the Sender Name. For the RSTACK message,
  2067.              the Sender Name field is set to the value of the Receiver
  2068.              Name field from the incoming message that caused the RSTACK
  2069.              message to be generated.
  2070.  
  2071.  
  2072.  
  2073.  
  2074. Newman, et. al.              Informational                     [Page 37]
  2075.  
  2076. RFC 1987              GSMP Protocol Specification            August 1996
  2077.  
  2078.  
  2079.    Receiver Name
  2080.              For the SYN, SYNACK, and ACK messages, is the name of the
  2081.              entity that the sender of the message believes is at the
  2082.              far end of the link. If the sender of the message does not
  2083.              know the name of the entity at the far end of the link,
  2084.              this field should be set to zero. For the RSTACK message,
  2085.              the Receiver Name field is set to the value of the Sender
  2086.              Name field from the incoming message that caused the RSTACK
  2087.              message to be generated.
  2088.  
  2089.    Sender Port
  2090.              For the SYN, SYNACK, and ACK messages, is the local port
  2091.              number of the link across which the message is being sent.
  2092.              Port numbers are locally assigned 32 bit values. For the
  2093.              RSTACK message, the Sender Port field is set to the value
  2094.              of the Receiver Port field from the incoming message that
  2095.              caused the RSTACK message to be generated.
  2096.  
  2097.    Receiver Port
  2098.              For the SYN, SYNACK, and ACK messages, is what the sender
  2099.              believes is the local port number for the link, allocated
  2100.              by the entity at the far end of the link.  If the sender of
  2101.              the message does not know the port number at the far end of
  2102.              the link, this field should be set to zero. For the RSTACK
  2103.              message, the Receiver Port field is set to the value of the
  2104.              Sender Port field from the incoming message that caused the
  2105.              RSTACK message to be generated.
  2106.  
  2107.    Sender Instance
  2108.              For the SYN, SYNACK, and ACK messages, is the sender's
  2109.              instance number for the link. It is used to detect when the
  2110.              link comes back up after going down or when the identity of
  2111.              the entity at the other end of the link changes. The
  2112.              instance number is a 32 bit number that is guaranteed to be
  2113.              unique within the recent past and to change when the link
  2114.              or node comes back up after going down. Zero is not a valid
  2115.              instance number. For the RSTACK message, the Sender
  2116.              Instance field is set to the value of the Receiver Instance
  2117.              field from the incoming message that caused the RSTACK
  2118.              message to be generated.
  2119.  
  2120.    Receiver Instance
  2121.              For the SYN, SYNACK, and ACK messages, is what the sender
  2122.              believes is the current instance number for the link,
  2123.              allocated by the entity at the far end of the link. If the
  2124.              sender of the message does not know the current instance
  2125.              number at the far end of the link, this field should be set
  2126.              to zero. For the RSTACK message, the Receiver Instance
  2127.  
  2128.  
  2129.  
  2130. Newman, et. al.              Informational                     [Page 38]
  2131.  
  2132. RFC 1987              GSMP Protocol Specification            August 1996
  2133.  
  2134.  
  2135.              field is set to the value of the Sender Instance field from
  2136.              the incoming message that caused the RSTACK message to be
  2137.              generated.
  2138.  
  2139. 8.2 Procedure
  2140.  
  2141.    The adjacency protocol is described by the rules and state tables
  2142.    given in this section.
  2143.  
  2144.    The rules and state tables use the following operations:
  2145.  
  2146.     o The "Update Peer Verifier" operation is defined as storing the
  2147.       values of the Sender Instance, Sender Port, and Sender Name fields
  2148.       from a SYN or SYNACK message received from the entity at the far
  2149.       end of the link.
  2150.  
  2151.     o The procedure "Reset the link" is defined as:
  2152.  
  2153.           1. Generate a new instance number for the link
  2154.           2. Delete the peer verifier (set to zero the values of Sender
  2155.              Instance, Sender Port, and Sender Name previously stored by
  2156.              the Update Peer Verifier operation)
  2157.           3. Send a SYN message
  2158.           4. Enter the SYNSENT state
  2159.  
  2160.     o The state tables use the following Boolean terms and operators:
  2161.  
  2162.         A    The Sender Instance in the incoming message matches the
  2163.              value stored from a previous message by the "Update Peer
  2164.              Verifier" operation.
  2165.  
  2166.         B    The Sender Instance, Sender Port, and Sender Name fields in
  2167.              the incoming message match the values stored from a
  2168.              previous message by the "Update Peer Verifier" operation.
  2169.  
  2170.         C    The Receiver Instance, Receiver Port, and Receiver Name
  2171.              fields in the incoming message match the values of the
  2172.              Sender Instance, Sender Port, and Sender Name currently
  2173.              sent in outgoing SYN, SYNACK, and ACK messages.
  2174.  
  2175.         "&&" Represents the logical AND operation
  2176.  
  2177.         "||" Represents the logical OR operation
  2178.  
  2179.         "!" Represents the logical negation (NOT) operation.
  2180.  
  2181.  
  2182.  
  2183.  
  2184.  
  2185.  
  2186. Newman, et. al.              Informational                     [Page 39]
  2187.  
  2188. RFC 1987              GSMP Protocol Specification            August 1996
  2189.  
  2190.  
  2191.     o A timer is required for the periodic generation of SYN, SYNACK,
  2192.       and ACK messages. The period of the timer is unspecified but a
  2193.       value of one second is suggested.
  2194.  
  2195.       There are two independent events: the timer expires, and a packet
  2196.       arrives. The processing rules for these events are:
  2197.  
  2198.          Timer Expires:   Reset Timer
  2199.                           If state = SYNSENT Send SYN
  2200.                           If state = SYNRCVD Send SYNACK
  2201.                           If state = ESTAB   Send ACK
  2202.  
  2203.          Packet Arrives:  If incoming message is an RSTACK
  2204.                              If A && C && !SYNSENT
  2205.                                 Reset the link
  2206.                              Else Discard the message
  2207.                           Else the following State Tables.
  2208.  
  2209.     o State synchronization across a link is considered to be achieved
  2210.       when the protocol reaches the ESTAB state.
  2211.  
  2212.    State Tables
  2213.  
  2214. State: SYNSENT
  2215.  
  2216. +======================================================================+
  2217. |     Condition      |                Action               | New State |
  2218. +====================+=====================================+===========+
  2219. |    SYNACK && C     |  Update Peer Verifier; Send ACK     |   ESTAB   |
  2220. +--------------------+-------------------------------------+-----------+
  2221. |    SYNACK && !C    |            Send RSTACK              |  SYNSENT  |
  2222. +--------------------+-------------------------------------+-----------+
  2223. |        SYN         |  Update Peer Verifier; Send SYNACK  |  SYNRCVD  |
  2224. +--------------------+-------------------------------------+-----------+
  2225. |        ACK         |            Send RSTACK              |  SYNSENT  |
  2226. +======================================================================+
  2227.  
  2228.  
  2229.  
  2230.  
  2231.  
  2232.  
  2233.  
  2234.  
  2235.  
  2236.  
  2237.  
  2238.  
  2239.  
  2240.  
  2241.  
  2242. Newman, et. al.              Informational                     [Page 40]
  2243.  
  2244. RFC 1987              GSMP Protocol Specification            August 1996
  2245.  
  2246.  
  2247. State: SYNRCVD
  2248.  
  2249. +======================================================================+
  2250. |     Condition      |                Action               | New State |
  2251. +====================+=====================================+===========+
  2252. |    SYNACK && C     |  Update Peer Verifier; Send ACK     |   ESTAB   |
  2253. +--------------------+-------------------------------------+-----------+
  2254. |    SYNACK && !C    |            Send RSTACK              |  SYNRCVD  |
  2255. +--------------------+-------------------------------------+-----------+
  2256. |        SYN         |  Update Peer Verifier; Send SYNACK  |  SYNRCVD  |
  2257. +--------------------+-------------------------------------+-----------+
  2258. |   ACK && B && C    |              Send ACK               |   ESTAB   |
  2259. +--------------------+-------------------------------------+-----------+
  2260. |  ACK && !(B && C)  |            Send RSTACK              |  SYNRCVD  |
  2261. +======================================================================+
  2262.  
  2263.  
  2264. State: ESTAB
  2265.  
  2266. +======================================================================+
  2267. |     Condition      |                Action               | New State |
  2268. +====================+=====================================+===========+
  2269. |   SYN || SYNACK    |           Send ACK (note 1)         |   ESTAB   |
  2270. +--------------------+-------------------------------------+-----------+
  2271. |   ACK && B && C    |           Send ACK (note 1)         |   ESTAB   |
  2272. +--------------------+-------------------------------------+-----------+
  2273. |  ACK && !(B && C)  |              Send RSTACK            |   ESTAB   |
  2274. +======================================================================+
  2275.  
  2276.    Note 1: No more than one ACK should be sent within any time period of
  2277.    length defined by the timer.
  2278.  
  2279. 9. Failure Response Messages
  2280.  
  2281.    A failure response message is formed by returning the request message
  2282.    that caused the failure with the Result field in the header
  2283.    indicating failure (Result = 4) and the Code field giving the failure
  2284.    code. The failure code specifies the reason for the switch being
  2285.    unable to satisfy the request message. A failure code of 16 is used
  2286.    for a failure that is specific to the particular request message and
  2287.    its meaning is defined within the text describing that message. The
  2288.    following failure codes are defined:
  2289.  
  2290.        1:  Unspecified reason not covered by other failure codes.
  2291.        2:  Invalid request message.
  2292.        3:  The specified request is not implemented on this switch.
  2293.        4:  Invalid port session number.
  2294.        5:  One or more of the specified ports does not exist.
  2295.  
  2296.  
  2297.  
  2298. Newman, et. al.              Informational                     [Page 41]
  2299.  
  2300. RFC 1987              GSMP Protocol Specification            August 1996
  2301.  
  2302.  
  2303.        6:  One or more of the specified ports is down.
  2304.        7:  One or more of the specified VPIs or VCIs is out of range on
  2305.            one or more of the requested ports.
  2306.        8:  The specified connection does not exist.
  2307.        9:  The specified branch does not exist.
  2308.        10: A branch belonging to the specified multicast connection is
  2309.            already established on the specified output port and the
  2310.            switch cannot support more than a single branch of any
  2311.            multicast connection on the same output port.
  2312.        11: The limit on the maximum number of multicast connections that
  2313.            the switch can support has been reached.
  2314.        12: The limit on the maximum number of branches that the
  2315.            specified multicast connection can support has been reached.
  2316.        13: Unable to assign the requested VPI/VCI value to the requested
  2317.            branch on the specified multicast connection.
  2318.        14: General problem related to the manner in which multicast is
  2319.            supported by the switch.
  2320.        15: Out of resources (e.g. memory exhausted, etc.).
  2321.        16: Failure specific to the particular message type.
  2322.  
  2323.  
  2324.  
  2325.  
  2326.  
  2327.  
  2328.  
  2329.  
  2330.  
  2331.  
  2332.  
  2333.  
  2334.  
  2335.  
  2336.  
  2337.  
  2338.  
  2339.  
  2340.  
  2341.  
  2342.  
  2343.  
  2344.  
  2345.  
  2346.  
  2347.  
  2348.  
  2349.  
  2350.  
  2351.  
  2352.  
  2353.  
  2354. Newman, et. al.              Informational                     [Page 42]
  2355.  
  2356. RFC 1987              GSMP Protocol Specification            August 1996
  2357.  
  2358.  
  2359. REFERENCES
  2360.  
  2361.    [I.361]   "B-ISDN ATM Layer Specification," International
  2362.              Telecommunication Union, ITU-T Recommendation I.361, Mar.
  2363.              1993.
  2364.  
  2365.    [I.363]   "B-ISDN ATM Adaptation Layer (AAL) Specification,"
  2366.              International Telecommunication Union, ITU-T Recommendation
  2367.              I.363, Mar. 1993.
  2368.  
  2369.    [rfc1700] "Assigned Numbers," STD 2, RFC 1700, October 1994.
  2370.  
  2371.    [rfc1573] "Evolution of the Interfaces Group of MIB-II," RFC 1573,
  2372.              January 1994.
  2373.  
  2374.  
  2375. SECURITY CONSIDERATIONS
  2376.  
  2377.    Security issues are not discussed in this document.
  2378.  
  2379.  
  2380. AUTHORS' ADDRESSES
  2381.  
  2382.  
  2383.    Peter Newman                        Phone: +1 (415) 846-4603
  2384.    Ipsilon Networks, Inc.              Email: pn@ipsilon.com
  2385.  
  2386.    W. L. Edwards, Chief Scientist      Phone:  +1 (913) 534 5334
  2387.    Sprint                              Email:  texas@sprintcorp.com
  2388.  
  2389.    Robert M. Hinden                    Phone: +1 (415) 846-4604
  2390.    Ipsilon Networks, Inc.              Email: hinden@ipsilon.com
  2391.  
  2392.    Eric Hoffman                        Phone: +1 (415) 846-4610
  2393.    Ipsilon Networks, Inc.              Email: hoffman@ipsilon.com
  2394.  
  2395.    Fong Ching Liaw                     Phone: +1 (415) 846-4607
  2396.    Ipsilon Networks, Inc.              Email: fong@ipsilon.com
  2397.  
  2398.    Tom Lyon                            Phone: +1 (415) 846-4601
  2399.    Ipsilon Networks, Inc.              Email: pugs@ipsilon.com
  2400.  
  2401.    Greg Minshall                       Phone: +1 (415) 846-4605
  2402.    Ipsilon Networks, Inc.              Email: minshall@ipsilon.com
  2403.  
  2404.  
  2405.  
  2406.  
  2407.  
  2408.  
  2409.  
  2410. Newman, et. al.              Informational                     [Page 43]
  2411.  
  2412. RFC 1987              GSMP Protocol Specification            August 1996
  2413.  
  2414.  
  2415. Ipsilon Networks, Inc. is located at:
  2416.  
  2417.    2191 East Bayshore Road
  2418.    Suite 100
  2419.    Palo Alto, CA 94303
  2420.    USA
  2421.  
  2422. Sprint is located at:
  2423.  
  2424.    Sprint
  2425.    Sprint Technology Services - Long Distance Division
  2426.    9300 Metcalf Avenue
  2427.    Mailstop KSOPKB0802
  2428.    Overland Park, KS 66212-6333
  2429.    USA
  2430.  
  2431.  
  2432.  
  2433.  
  2434.  
  2435.  
  2436.  
  2437.  
  2438.  
  2439.  
  2440.  
  2441.  
  2442.  
  2443.  
  2444.  
  2445.  
  2446.  
  2447.  
  2448.  
  2449.  
  2450.  
  2451.  
  2452.  
  2453.  
  2454.  
  2455.  
  2456.  
  2457.  
  2458.  
  2459.  
  2460.  
  2461.  
  2462.  
  2463.  
  2464.  
  2465.  
  2466. Newman, et. al.              Informational                     [Page 44]
  2467.  
  2468.