Tech-invite3GPPspaceIETFspace
959493929190898887868584838281807978777675747372717069686766656463626160595857565554535251504948474645444342414039383736353433323130292827262524232221201918171615141312111009080706050403020100
in Index   Prev   Next

RFC 2297

Ipsilon's General Switch Management Protocol Specification Version 2.0

Pages: 109
Informational
Updates:  1987
Part 2 of 4 – Pages 29 to 59
First   Prev   Next

Top   ToC   RFC2297 - Page 29   prevText
5. Port Management Messages

5.1 Port Management Message

   The Port Management message allows a port to be brought into service,
   taken out of service, looped back, reset, or the transmit cell rate
   changed.  Only the Bring Up and the Reset Input Port functions change
   the connection state (established connections) on the input port.
   Only the Bring Up function changes the value of the Port Session
   Number. If the Result field of the request message is "AckAll" a
   success response message must be sent upon successful completion of
   the operation. The success response message must not be sent until
   the operation has been completed. The Port Management Message is:

      Message Type = 32

   The Port Management message has the following format for the request
   and success response messages:
Top   ToC   RFC2297 - Page 30
    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             Port                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                      Port Session Number                      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                     Event Sequence Number                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |  Event Flags  |   Duration    |          Function             |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                      Transmit Cell Rate                       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Event Sequence Number
             In the success response message gives the current value of
             the Event Sequence Number of the switch port indicated by
             the Port field. The Event Sequence Number is set to zero
             when the port is initialized. It is incremented by one each
             time the port detects an asynchronous event that the switch
             would normally report via an Event message. If the Event
             Sequence Number in the success response differs from the
             Event Sequence Number of the most recent Event message
             received for that port, events have occurred that were not
             reported via an Event message. This is most likely to be
             due to the flow control that restricts the rate at which a
             switch can send Event messages for each port. In the
             request message this field is not used.

   Event Flags
             Field in the request message is used to reset the Event
             Flags in the switch port indicated by the Port field. Each
             Event Flag in a switch port corresponds to a type of Event
             message. When a switch port sends an Event message it sets
             the corresponding Event Flag on that port. The port is not
             permitted to send another Event message of the same type
             until the Event Flag has been reset. If the Function field
             in the request message is set to "Reset Event Flags," for
             each bit that is set in the Event Flags field, the
             corresponding Event Flag in the switch port is reset.

             The Event Flags field is only used in a request message
             with the Function field set to "Reset Event Flags." For all
             other values of the Function field, the Event Flags field
Top   ToC   RFC2297 - Page 31
             is not used.  In the success response message the Event
             Flags field must be set to the current value of the Event
             Flags for the port, after the completion of the operation
             specified by the request message, for all values of the
             Function field. Setting the Event Flags field to all zeros
             in a "Reset Event Flags" request message allows the
             controller to obtain the current state of the Event Flags
             and the current Event Sequence Number of the port without
             changing the state of the Event Flags.

             The correspondence between the types of Event message and
             the bits of the Event Flags field is as follows:

                 0 1 2 3 4 5 6 7
                +-+-+-+-+-+-+-+-+
                |U|D|I|N|Z|x x x|
                +-+-+-+-+-+-+-+-+

                U: Port Up          Bit 0, (most significant bit)
                D: Port Down        Bit 1,
                I: Invalid VPI/VCI  Bit 2,
                N: New Port         Bit 3,
                Z: Dead Port        Bit 4,
                x: Unused           Bits 5--7.

   Duration
             Is the length of time, in seconds, that any of the loopback
             states remain in operation. When the duration has expired
             the port will automatically be returned to service.  If
             another Port Management message is received for the same
             port before the duration has expired, the loopback will
             continue to remain in operation for the length of time
             specified by the Duration field in the new message. The
             Duration field is only used in request messages with the
             Function field set to Internal Loopback, External Loopback,
             or Bothway Loopback.

   Function
             Specifies the action to be taken. The specified action will
             be taken regardless of the current status of the port
             (Available, Unavailable, or any Loopback state).  If the
             specified function requires a new Port Session Number to be
             generated, the new Port Session Number must be returned in
             the success response message.  The defined values of the
             Function field are:

             Bring Up:
                  Function = 1. Bring the port into service. All
Top   ToC   RFC2297 - Page 32
                  connections that arrive at the specified input port
                  must be deleted and a new Port Session Number must be
                  selected using some form of random number. On
                  completion of the operation all dynamically assigned
                  VPI/VCI values for the specified input port must be
                  unassigned, i.e. no virtual connections will be
                  established in the VPI/VCI space that GSMP controls on
                  this input port. The Port Status of the port
                  afterwards will be Available.

             Take Down:
                  Function = 2. Take the port out of service. Any cells
                  received at this port will be discarded. No cells will
                  be transmitted from this port. The Port Status of the
                  port afterwards will be Unavailable.

                  The behavior is undefined if the port is taken down
                  over which the GSMP session that controls the switch
                  is running. (In this case the most probable behavior
                  would be for the switch either to ignore the message
                  or to terminate the current GSMP session and to
                  initiate another session, possibly with the backup
                  controller, if any.) The correct method to reset the
                  link over which GSMP is running is to issue an RSTACK
                  message in the adjacency protocol.

             Internal Loopback:
                  Function = 3. Cells arriving at the output port from
                  the switch fabric are looped through to the input port
                  to return to the switch fabric. All of the ATM
                  functions of the input port above the physical layer,
                  e.g. header translation, are performed upon the looped
                  back cells. The Port Status of the port afterwards
                  will be Internal Loopback.

             External Loopback:
                  Function = 4. Cells arriving at the input port from
                  the external communications link are immediately
                  looped back to the communications link at the physical
                  layer without entering the input port. None of the ATM
                  functions of the input port above the physical layer
                  are performed upon the looped back cells. The Port
                  Status of the port afterwards will be External
                  Loopback.

             Bothway Loopback:
                  Function = 5. Both internal and external loopback are
Top   ToC   RFC2297 - Page 33
                  performed. The Port Status of the port afterwards will
                  be Bothway Loopback.

             Reset Input Port:
                  Function = 6. All connections that arrive at the
                  specified input port must be deleted and the input and
                  output port hardware re-initialized. On completion of
                  the operation all dynamically assigned VPI/VCI values
                  for the specified input port must be unassigned, i.e.
                  no virtual connections will be established in the
                  VPI/VCI space that GSMP controls on this input port.
                  The range of VPIs and VCIs that may be controlled by
                  GSMP on this port will be set to the default values
                  specified in the Port Configuration message.  The
                  transmit cell rate of the output port must be set to
                  its default value. The Port Session Number is not
                  changed by the Reset Input Port function.  The Port
                  Status of the port afterwards will be Unavailable.

             Reset Event Flags:
                  Function = 7. For each bit that is set in the Event
                  Flags field, the corresponding Event Flag in the
                  switch port must be reset. The Port Status of the port
                  is not changed by this function.

             Set Transmit Cell Rate:
                  Function = 8. Sets the transmit cell rate of the
                  output port as close as possible to the rate specified
                  in the Transmit Cell Rate field. In the success
                  response message the Transmit Cell Rate must indicate
                  the actual transmit cell rate of the output port.  If
                  the transmit cell rate of the requested output port
                  cannot be changed, a failure response must be returned
                  with the Code field indicating: "The transmit cell
                  rate of this output port cannot be changed." If the
                  transmit cell rate of the requested output port can be
                  changed, but the value of the Transmit Cell Rate field
                  is beyond the range of acceptable values, a failure
                  response must be returned with the Code field
                  indicating: "Requested transmit cell rate out of range
                  for this output port." In the failure response message
                  the Transmit Cell Rate must contain the same value as
                  contained in the request message that caused the
                  failure. The transmit cell rate of the output port is
                  not changed by the Bring Up, Take Down, or any of the
                  Loopback functions. It is returned to the default
                  value by the Reset Input Port function.
Top   ToC   RFC2297 - Page 34
        Transmit Cell Rate
             This field is only used in request and success response
             messages with the Function field set to "Set Transmit Cell
             Rate." It is used to set the output cell rate of the output
             port. It is specified in cells/s. If the Transmit Cell Rate
             field contains the value 0xFFFFFFFF the transmit cell rate
             of the output port should be set to the highest valid
             value.

5.2. Label Range Message

   The default label range, Min VPI to Max VPI and Min VCI to Max VCI,
   is specified for each port by the Port Configuration or the All Ports
   Configuration messages.  When the protocol is initialized, before the
   transmission of any Label Range messages, the label range of each
   port will be set to the default label range. (The default label range
   is dependent upon the switch design and configuration and is not
   specified by the GSMP protocol.) The Label Range message allows the
   range of VPIs supported by a specified port, or the range of VCIs
   supported by a specified VPI on a specified port, to be changed.
   Each switch port must declare whether it supports the Label Range
   message in the Port Configuration or the All Ports Configuration
   messages.  The Label Range message is:

      Message Type = 33

   The Label Range message has the following format for the request and
   success response messages:

    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             Port                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                      Port Session Number                      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |Q|V|x x|      Min VPI          |x x x x|       Max VPI         |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |            Min VCI            |           Max VCI             |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |        Remaining VPIs         |        Remaining VCIs         |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Top   ToC   RFC2297 - Page 35
   Flags

        Q: Query
             If the Query flag is set in a request message, the switch
             must respond with the current range of valid VPIs, or the
             current range of valid VCIs on a specified VPI, according
             to the VPI/VCI flag. The current label range is not changed
             by a request message with the Query flag set. If the Query
             flag is zero, the message is requesting a label change
             operation.

        V: VPI/VCI
             If the VPI/VCI flag is set, the message refers to a range
             of VPIs only. The Min VCI and Max VCI fields are unused. If
             the VPI/VCI flag is zero the message refers to a range of
             VCIs on either one VPI or on a range of VPIs.

        x: Unused

   Min VPI
   Max VPI
             Specify a range of VPI values, Min VPI to Max VPI
             inclusive.  A single VPI may be specified with a Min VPI
             and a Max VPI having the same value.  In a request message,
             if the value of the Max VPI field is less than or equal to
             the value of the Min VPI field, the requested range is a
             single VPI with a value equal to the Min VPI field. Zero is
             a valid value.  In a request message, if the Query flag is
             set, and the VPI/VCI flag is zero, the Max VPI field
             specifies a single VPI and the Min VPI field is not used.
             The maximum valid value of these fields for both request
             and response messages is 0xFFF.

   Min VCI
   Max VCI
             Specify a range of VCI values, Min VCI to Max VCI
             inclusive.  A single VCI may be specified with a Min VCI
             and a Max VCI having the same value.  In a request message,
             if the value of the Max VCI field is less than or equal to
             the value of the Min VCI field, the requested range is a
             single VCI with a value equal to the Min VCI field. Zero is
             a valid value.  (However, VPI=0, VCI=0 is not available as
             a virtual channel connection as it is used as a special
             value in ATM to indicate an unassigned cell.)

   Remaining VPIs
   Remaining VCIs
             These fields are unused in the request message. In the
Top   ToC   RFC2297 - Page 36
             success response message and in the failure response
             message these fields give the maximum number of remaining
             VPIs and VCIs that could be requested for allocation on the
             specified port (after completion of the requested operation
             in the case of the success response). It gives the switch
             controller an idea of how many VPIs and VCIs it could
             request. The number given is the maximum possible given the
             constraints of the switch hardware. There is no implication
             that this number of VPIs and VCIs is available to every
             switch port.

   If the Query flag and the VPI/VCI flag are set in the request
   message, the switch must reply with a success response message
   containing the current range of valid VPIs that are supported by the
   port.  The Min VPI and Max VPI fields are not used in the request
   message.

   If the Query flag is set and the VPI/VCI flag is zero in the request
   message, the switch must reply with a success response message
   containing the current range of valid VCIs that are supported by the
   VPI specified by the Max VPI field.  If the requested VPI is invalid,
   a failure response must be returned indicating: "One or more of the
   specified input VPIs is invalid." The Min VPI field is not used in
   either the request or success response messages.

   If the Query flag is zero and the VPI/VCI flag is set in the request
   message, the Min VPI and Max VPI fields specify the new range of VPIs
   to be allocated to the input port specified by the Port field.
   Whatever the range of VPIs previously allocated to this port it
   should be increased or decreased to the specified value.

   If the Query flag and the VPI/VCI flag are zero in the request
   message, the Min VCI and Max VCI fields specify the range of VCIs to
   be allocated to each of the VPIs specified by the VPI range.
   Whatever the range of VCIs previously allocated to each of the VPIs
   within the specified VPI range on this port, it should be increased
   or decreased to the specified value.  The allocated VCI range must be
   the same on each of the VPIs within the specified VPI range.

   The success response to a Label Range message requesting a change of
   label range is a copy of the request message with the Remaining VPIs
   and Remaining VCIs fields updated to the new values after the Label
   Range operation.

   If the switch is unable to satisfy a request to change the VPI range,
   it must return a failure response message with the Code field set to
   "Cannot support requested VPI range." In this failure response
Top   ToC   RFC2297 - Page 37
   message the switch must use the Min VPI and Max VPI fields to suggest
   a VPI range that it would be able to satisfy.

   If the switch is unable to satisfy a request to change the VCI range
   on all VPIs within the requested VPI range, it must return a failure
   response message with the Code field set to "Cannot support requested
   VCI range on all requested VPIs." In this failure response message
   the switch must use the Min VPI, Max VPI, Min VCI, and Max VCI fields
   to suggest a VPI and VCI range that it would be able to satisfy.

   In all other failure response messages for the label range operation
   the switch must return the values of Min VPI, Max VPI, Min VCI, and
   Max VCI from the request message.

   While switches can typically support all 256 or 4096 VPIs the VCI
   range that can be supported is often more constrained. Often the Min
   VCI must be 0 or 32. Typically all VCIs within a particular VPI must
   be contiguous.  The hint in the failure response message allows the
   switch to suggest a label range that it could satisfy in view of its
   particular architecture.

   While the Label Range message is defined to specify both a range of
   VPIs and a range of VCIs within each VPI, the most likely use is to
   change either the VPI range or the range of VCIs within a single VPI.
   It is possible for a VPI to be valid but to be allocated no valid
   VCIs. Such a VPI could be used for a virtual path connection but to
   support virtual channel connections it would need to be allocated a
   range of VCIs.

   A Label Range request message may be issued regardless of the Port
   Status or the Line Status of the target switch port. If the Port
   field of the request message contains an invalid port (a port that
   does not exist or a port that has been removed from the switch) a
   failure response message must be returned with the Code field set to,
   "One or more of the specified ports does not exist."


6. State and Statistics Messages

   The state and statistics messages permit the controller to request
   the values of various hardware counters associated with the switch
   input and output ports, virtual path connections, virtual channel
   connections, and QoS Classes.  They also permit the controller to
   request the connection state of a switch input port.  The Connection
   Activity message is used to determine whether one or more specific
   virtual channel connections or virtual path connections have recently
   been carrying traffic.  The Statistics message is used to query the
   various port, connection, and QoS class traffic and error counters.
Top   ToC   RFC2297 - Page 38
   The Report Connection State message is used to request an input port
   to report the connection state for a single virtual channel
   connection, a single virtual path connection, or for the entire input
   port.

6.1 Connection Activity Message

   The Connection Activity message is used to determine whether one or
   more specific virtual channel connections or virtual path connections
   have recently been carrying traffic. The Connection Activity message
   contains one or more Activity Records. Each Activity Record is used
   to request and return activity information concerning a single
   virtual channel connection or virtual path connection.  Each virtual
   channel connection is specified by its input port, input VPI, and
   input VCI. Each virtual path connection is specified by its input
   port and input VPI. These are specified in the Input Port, Input VPI,
   and Input VCI fields of each Activity Record.  Two forms of activity
   detection are supported. If the switch supports per connection
   traffic accounting, the current value of the traffic counter for each
   specified virtual channel connection or virtual path connection must
   be returned. The units of traffic counted are not specified but will
   typically be either cells or frames.  The controller must compare the
   traffic counts returned in the message with previous values for each
   of the specified connections to determine whether each connection has
   been active in the intervening period.  If the switch does not
   support per connection traffic accounting, but is capable of
   detecting per connection activity by some other unspecified means,
   the result may be indicated for each connection using the Flags
   field. The Connection Activity message is:

      Message Type = 48

   The Connection Activity request and success response messages have
   the following format:

    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |       Number of Records       |           Reserved            |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   ~                       Activity Records                        ~
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Top   ToC   RFC2297 - Page 39
   Number of Records
             Field specifies the number of Activity Records to follow.
             The number of Connection Activity records in a single
             Connection Activity message must not cause the packet
             length to exceed the maximum transmission unit defined by
             the encapsulation.

   Each Activity Record has the following format:

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                          Input Port                           |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |V|C|A|x|      Input VPI        |          Input VCI            |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                         Traffic Count                         +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Input Port
             Identifies the port number of the input port on which the
             connection of interest arrives in order to identify the
             connection (regardless of whether the traffic count for the
             connection is maintained on the input port or the output
             port).

   Input VPI
   Input VCI
             Fields identify the specific virtual path connection or
             virtual channel connection for which statistics are being
             requested. For a virtual path connection the Input VCI
             field is not used.

   Flags

        V: Valid Record
             In the success response message the Valid Record flag is
             used to indicate an invalid Activity Record. The flag must
             be zero if any of the fields in this Activity Record are
             invalid, if the input port specified by the Input Port
             field does not exist, or if the specified connection does
             not exist. If the Valid Record flag is zero in a success
             response message, the Counter flag, the Activity flag, and
             the VC Traffic Count field are undefined. If the Valid
             Record flag is set, the Activity Record is valid, and the
             Counter and Activity flags are valid. The Valid Record flag
             is not used in the request message.
Top   ToC   RFC2297 - Page 40
        C: Counter
             In a success response message, if the Valid Record flag is
             set, the Counter flag, if zero, indicates that the value in
             the VC Traffic Count field is valid.  If set, it indicates
             that the value in the Activity flag is valid. The Counter
             flag is not used in the request message.

        A: Activity
             In a success response message, if the Valid Record and
             Counter flags are set, the Activity flag, if set, indicates
             that there has been some activity on this connection since
             the last Connection Activity message for this connection.
             If zero, it indicates that there has been no activity on
             this connection since the last Connection Activity message
             for this connection. The Activity flag is not used in the
             request message.

        x: Unused

   Traffic Count
             Field is not used in the request message.  In the success
             response message, if the switch supports per connection
             traffic counting, the Traffic Count field must be set to
             the value of a free running, connection specific, 64-bit
             traffic counter counting traffic flowing across the
             specified connection.  The value of the traffic counter is
             not modified by reading it.  If per connection traffic
             counting is supported, the switch must report the
             Connection Activity result using the traffic count rather
             than using the Activity flag.

   The format of the failure response is the same as the request message
   with the Number of Records field set to zero and no VC Activity
   records returned in the message. If the switch is incapable of
   detecting per connection activity, a failure response must be
   returned indicating, "The specified request is not implemented on
   this switch."

6.2 Statistics Messages

   The Statistics messages are used to query the various port,
   connection, and QoS class traffic and error counters.

   The Statistics request messages have the following format:
Top   ToC   RFC2297 - Page 41
    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             Port                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   | zero  |          VPI          |              VCI              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                      QoS Class Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   VPI
   VCI
             Fields identify the specific virtual path connection or
             virtual channel connection for which statistics are being
             requested.  For a virtual path connection the Input VCI
             field is not used.  For requests that do not require a
             virtual path connection or virtual channel connection to be
             specified, the VPI and VCI fields are not used.

   QoS Class Identifier
             Field identifies the QoS class for which statistics are
             being requested. This field is only used if the QoS Class
             Establishment message defined in section 9.4 is
             implemented.

   The success response for the Statistics message has the following
   format:
Top   ToC   RFC2297 - Page 42
    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             Port                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   | zero  |          VPI          |              VCI              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                      QoS Class Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                       Input Cell Count                        +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                       Input Frame Count                       +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                    Input Cell Discard Count                   +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                   Input Frame Discard Count                   +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                     Input HEC Error Count                     +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                  Input Invalid VPI/VCI Count                  +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                       Output Cell Count                       +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                      Output Frame Count                       +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                   Output Cell Discard Count                   +
   |                                                               |
Top   ToC   RFC2297 - Page 43
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   +                  Output Frame Discard Count                   +
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Port
   VPI/VCI
   QoS Class Identifier
             Fields are the same as those of the request message.

   Input Cell Count
   Output Cell Count
             Give the value of a free running 64-bit counter counting
             cells arriving at the input or departing from the output
             respectively.

   Input Frame Count
   Output Frame Count
             Give the value of a free running 64-bit counter counting
             frames (packets) arriving at the input or departing from
             the output respectively.

   Input Cell Discard Count
   Output Cell Discard Count
             Give the value of a free running 64-bit counter counting
             cells discarded due to queue overflow on an input port or
             on an output port respectively.

   Input Frame Discard Count
   Output Frame Discard Count
             Give the value of a free running 64-bit counter counting
             frames discarded due to congestion on an input port or on
             an output port respectively.

   HEC Error Count
             Gives the value of a free running 64-bit counter counting
             cells discarded due to header checksum errors on arrival at
             an input port.

   Invalid VPI/VCI Count
             Gives the value of a free running 64-bit counter counting
             cells discarded because their VPI/VCI is invalid on arrival
             at an input port. For a virtual channel connection an
             incoming VPI/VCI is invalid if no connection is currently
             established having that value of VPI/VCI. For a virtual
             path connection an incoming VPI is invalid if no connection
             is currently established having that value of VPI.
Top   ToC   RFC2297 - Page 44
6.2.1 Port Statistics Message

   The Port Statistics message requests the statistics for the switch
   port specified in the Port field. The contents of the VPI/VCI and the
   QoS Class Identifier fields in the Port Statistics request message
   are ignored. All of the count fields in the success response message
   refer to per-port counts regardless of the connection or QoS class to
   which the cells belong.  Any of the count fields in the success
   response message not supported by the port must be set to zero. The
   Port Statistics message is:

      Message Type = 49

6.2.2 Connection Statistics Message

   The Connection Statistics message requests the statistics for the
   virtual channel connection specified in the VPI/VCI field, or the
   virtual path connection specified in the VPI field, that arrives on
   the switch input port specified in the Port field, regardless of the
   QoS class to which the cells belong. All of the count fields in the
   success response message refer only to the specified connection.  The
   HEC Error Count and Invalid VPI/VCI Count fields are not connection
   specific and must be set to zero. Any of the other count fields not
   supported on a per connection basis must be set to zero in the
   success response message. The Connection Statistics message is:

      Message Type = 50

6.2.3 QoS Class Statistics Message

   The QoS Class Statistics message requests the statistics for the QoS
   class specified by the QoS Class Identifier field that arrives on the
   switch input port specified in the Port field, regardless of the
   connection to which the cells belong. The QoS Statistics message is
   only used if the QoS Class Establishment message defined in section
   9.4 is implemented.  The contents of the VPI/VCI fields in the QoS
   Class Statistics request message are ignored. All of the count fields
   in the success response message refer only to the specified QoS
   class.  The HEC Error Count and Invalid VPI/VCI Count fields are not
   specific to a QoS class and must be set to zero. Any of the other
   count fields not supported on a per QoS class basis must be set to
   zero in the success response message. The QoS Class Statistics
   message is:

      Message Type = 51
Top   ToC   RFC2297 - Page 45
6.3 Report Connection State Message

   The Report Connection State message is used to request an input port
   to report the connection state for a single virtual channel
   connection, a single virtual path connection, or for the entire input
   port. The Report Connection State message is:

      Message Type = 52

   The Report Connection State request message has the following format:

    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                          Input Port                           |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |A|V|x x|       Input VPI       |          Input VCI            |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Input Port
             Identifies the port number of the input port for which the
             connection state is being requested.

   Flags

        A: All Connections
             If the All Connections flag is set, the message requests
             the connection state for all virtual path connections and
             virtual channel connections that arrive at the input port
             specified by the Input Port field. In this case the Input
             VPI and Input VCI fields and the VPI/VCI flag are unused.

        V: VPI/VCI
             If the All Connections flag is zero and the VPI/VCI flag is
             set, the message requests the connection state for the
             virtual path connection that arrives at the input port
             specified by the Input Port and Input VPI fields.  If the
             specified Input VPI identifies a virtual path connection
             (i.e. a single switched virtual path) the state for that
             connection is requested.  If the specified Input VPI
             identifies a virtual path containing virtual channel
             connections, the message requests the connection state for
             all virtual channel connections that belong to the
             specified virtual path. The Input VCI field is not used.
Top   ToC   RFC2297 - Page 46
             If the All Connections flag is zero and the VPI/VCI flag is
             also zero, the message requests the connection state for
             the virtual channel connection that arrives at the input
             port specified by the Port, Input VPI and Input VCI fields.

             x: Unused.

   Input VPI
   Input VCI
             Fields identify the specific virtual path connection, the
             specific virtual path, or the specific virtual channel
             connection for which connection state is being requested.
             For a virtual path connection (switched as a single virtual
             path connection) or a virtual path (switched as one or more
             virtual channel connections within the virtual path) the
             Input VCI field is not used.  For requests that do not
             require a virtual path connection or virtual channel
             connection to be specified, the Input VPI and Input VCI
             fields are not used.

   The Report Connection State success response message has the
   following format:

    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                          Input Port                           |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                       Sequence Number                         |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   ~                       Connection Records                      ~
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Input Port
             Is the same as the Input Port field in the request message.
             It identifies the port number of the input port for which
             the connection state is being reported.

   Sequence Number
             In the case that the requested connection state cannot be
             reported in a single success response message, each
             successive success response message in reply to the same
Top   ToC   RFC2297 - Page 47
             request message must increment the Sequence Number. The
             Sequence Number of the first success response message, in
             response to a new request message, must be zero.

   Connection Records
             Each success response message must contain one or more
             Connection Records. Each Connection Record specifies a
             single point-to-point or point-to-multipoint virtual path
             connection or virtual channel connection. The number of
             Connection Records in a single Report Connection State
             success response must not cause the packet length to exceed
             the maximum transmission unit defined by the encapsulation.
             If the requested connection state cannot be reported in a
             single success response message, multiple success response
             messages must be sent. All success response messages that
             are sent in response to the same request message must have
             the same Input Port and Transaction Identifier fields as
             the request message. A single Connection Record must not be
             split across multiple success response messages. The More
             flag of the last Connection Record in a success response
             message indicates whether the response to the request has
             been completed or whether one or more further success
             response messages should be expected in response to the
             same request message.

   Each Connection Record has the following format:

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |A|V|P|M|       Input VPI       |          Input VCI            |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   ~                      Output Branch Records                    ~
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Flags

        A: All Connections
        V: VPI/VCI
             For the first Connection Record in each success response
             message the All Connections and the VPI/VCI flags must be
             the same as those of the request message. For successive
             Connection Records in the same success response message
             these flags are not used.

        P: VPC
             The VPC flag, if set, indicates that the Connection Record
             refers to a virtual path connection.  If zero, it indicates
Top   ToC   RFC2297 - Page 48
             that the Connection Record refers to a virtual channel
             connection.

        M: More
             If the More flag is set, it indicates that another
             Connection Record, in response to the same request message,
             will follow either in the same success response message or
             in a successive success response message. If the More flag
             is zero it indicates that this is the last Connection
             record in this success response message and that no further
             success response messages will be sent in response to the
             current request message. It indicates that the response to
             the request message is now complete.

   Input VPI
   Input VCI
             The input VPI and VCI of the connection specified in this
             Connection Record. If this Connection Record specifies a
             virtual path connection (the VPC flag is set) the Input VCI
             field is unused.

   Output Branch Records
             Each Connection Record must contain one or more Output
             Branch Records. Each Output Branch Record specifies a
             single output branch belonging to the connection identified
             by the Input VPI and Input VCI fields of the Connection
             Record. A point-to-point connection will require only a
             single Output Branch Record. A point-to-multipoint
             connection will require multiple Output Branch Records. The
             last Output Branch Record of each Connection Record is
             indicated by the Last Branch flag of the Output Branch
             Record. If a point-to-multipoint connection has more output
             branches than can fit in a single Connection Record
             contained within a single success response message, that
             connection may be reported using multiple Connection
             Records in multiple success response messages.

   Each Output Branch Record has the following format:

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                          Output Port                          |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |L|x x x|       Output VPI      |          Output VCI           |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Output Port
             The output port of the switch to which this output branch
             is routed.
Top   ToC   RFC2297 - Page 49
   Flags

        L: Last Branch
             The Last Branch flag, if set, indicates that this is the
             last Output Branch Record of this Connection Record. If
             zero, it indicates that one or more further Output Branch
             Records are to follow. If this is the last Output Branch
             Record in the message and the Last Branch flag is zero,
             further output branches belonging to the same connection
             will be given in another Connection Record. This Connection
             Record will be the first Connection Record in the next
             success response message. This Connection Record must have
             the same Input VPI and Input VCI values as the current
             Connection Record.

             x: Unused.

   Output VPI
   Output VCI
             The output VPI and VCI of the output branch specified in
             this Output Branch Record.  If this Output Branch Record is
             part of a Connection Record that specifies a virtual path
             connection (the VPC flag is set) the Output VCI field is
             unused.

   A Report Connection State request message may be issued regardless of
   the Port Status or the Line Status of the target switch port.

   If the Input Port of the request message is valid, and the All
   Connections flag is set, but there are no connections established on
   that port, a failure response message must be returned with the code
   field set to, "Failure specific to the particular message type." For
   the Report Connection State message, this failure code indicates that
   no connections matching the request message were found.  This failure
   message should also be returned if the Input Port of the request
   message is valid, the All Connections flag is zero, and no
   connections are found on that port matching the specified virtual
   path connection, virtual path, or virtual channel connection.


7. Configuration Messages

   The configuration messages permit the controller to discover the
   capabilities of the switch. Three configuration request messages have
   been defined: Switch, Port, and All Ports.

   All configuration request messages have the following format:
Top   ToC   RFC2297 - Page 50
    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             Port                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

7.1 Switch Configuration Message

   The Switch Configuration message requests the global (non port-
   specific) configuration for the switch. The Switch Configuration
   message is:

      Message Type = 64

   The Port field is not used in the request message.

   The Switch Configuration success response message has the following
   format:

    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Firmware Version Number    |          Window Size          |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |          Switch Type          |                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
   |                          Switch Name                          |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Firmware Version Number
             The version number of the switch control firmware
             installed.

   Window Size
             The maximum number of unacknowledged request messages that
             may be transmitted by the controller without the
             possibility of loss.  This field is used to prevent request
             messages being lost in the switch because of overflow in
             the receive buffer. The field is a hint to the controller.
             If desired, the controller may experiment with higher and
Top   ToC   RFC2297 - Page 51
             lower window sizes to determine heuristically the best
             window size.

   Switch Type
             A 16-bit field allocated by the manufacturer of the switch.
             (For these purposes the manufacturer of the switch is
             assumed to be the organization identified by the OUI in the
             Switch Name field.) The Switch Type identifies the product.
             When the Switch Type is combined with the OUI from the
             Switch Name the product is uniquely identified. Network
             Management may use this identification to obtain product
             related information from a database.

   Switch Name
             A 48-bit quantity that is unique within the operational
             context of the device. A 48-bit IEEE 802 MAC address, if
             available, may be used as the Switch Name. The most
             significant 24 bits of the Switch Name must be an
             Organizationally Unique Identifier (OUI) that identifies
             the manufacturer of the switch.

7.2 Port Configuration Message

   The Port Configuration message requests the switch for the
   configuration information of a single switch port. The Port field in
   the request message specifies the port for which the configuration is
   requested.  The Port Configuration message is:

      Message Type = 65.

   The Port Configuration success response message has the following
   format:
Top   ToC   RFC2297 - Page 52
    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             Port                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                       Port Session Number                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |V|M|L|R|      Min VPI          |Q|x x x|       Max VPI         |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |            Min VCI            |           Max VCI             |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                       Receive Cell Rate                       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                      Transmit Cell Rate                       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |  Port Status  |   Port Type   |  Line Status  |  Priorities   |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |     Physical Slot Number      |     Physical Port Number      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Port
             The switch port to which the configuration information
             refers. Configuration information relating to both the
             input and the output sides of the switch port is given.
             Port numbers are 32 bits wide and allocated by the switch.
             The switch may choose to structure the 32 bits into
             subfields that have meaning to the physical structure of
             the switch hardware (e.g.  physical slot and port). This
             structure may be indicated in the Physical Slot Number and
             Physical Port Number fields.

   Flags

        V: VP Switching
             The VP Switching flag, if set, indicates that this input
             port is capable of supporting virtual path switching. Else,
             if zero, it indicates that this input port is only capable
             of virtual channel switching.

        M: Multicast Labels
             The Multicast Labels flag, if set, indicates that this
             output port is capable of labelling each output branch of a
             point-to-multipoint tree with a different label. If zero,
             it indicates that this output port is not able to label
Top   ToC   RFC2297 - Page 53
             each output branch of a point-to-multipoint tree with a
             different label.

        L: Logical Multicast
             The Logical Multicast flag, if set, indicates that this
             output port is capable of supporting more than a single
             branch from any point-to-multipoint connection.  This
             capability is often referred to as logical multicast.  If
             zero, it indicates that this output port can only support a
             single output branch from each point-to-multipoint
             connection.

        R: Label Range
             The Label Range flag, if set, indicates that this switch
             port is capable of reallocating its VPI label range or its
             VCI label range and therefore accepts the Label Range
             message. Else, if zero, it indicates that this port does
             not accept Label Range messages.

        Q: QoS
             The QoS flag, if set, indicates that this switch port is
             capable of handling the Quality of Service messages defined
             in section 9 of this specification.  Else, if zero, it
             indicates that this port does not accept the Quality of
             Service messages.

        x: Unused

   Min VPI
             The default minimum value of dynamically assigned incoming
             VPI that the connection table on the input port supports
             and that may be controlled by GSMP. This value is not
             changed as a result of the Label Range message.

   Max VPI
             The default maximum value of dynamically assigned incoming
             VPI that the connection table on the input port supports
             and that may be controlled by GSMP.  This value is not
             changed as a result of the Label Range message.

             At power-on, after a hardware reset, and after the Reset
             Input Port function of the Port Management message, the
             input port must handle all values of VPI within the range
             Min VPI to Max VPI inclusive and GSMP must be able to
             control all values within this range.  It should be noted
             that the range Min VPI to Max VPI refers only to the
             incoming VPI range that can be supported by the associated
             port. No restriction is placed on the values of outgoing
Top   ToC   RFC2297 - Page 54
             VPIs that may be written into the cell header. If the
             switch does not support virtual paths it is acceptable for
             both Min VPI and Max VPI to specify the same value, most
             likely zero.

             Use of the Label Range message allows the range of VPIs
             supported by the port to be changed. However, the Min VPI
             and Max VPI fields in the Port Configuration and All Ports
             Configuration messages always report the same default
             values regardless of the operation of the Label Range
             message.

   Min VCI
             The default minimum value of dynamically assigned incoming
             VCI that the connection table on the input port can support
             and may be controlled by GSMP. This value is not changed as
             a result of the Label Range message.

   Max VCI
             The default maximum value of dynamically assigned incoming
             VCI that the connection table on the input port can support
             and may be controlled by GSMP. This value is not changed as
             a result of the Label Range message.

             At power-on, after a hardware reset, and after the Reset
             Input Port function of the Port Management message, the
             input port must handle all values of VCI within the range
             Min VCI to Max VCI inclusive, for each of the virtual paths
             in the range Min VPI to Max VPI inclusive, and GSMP must be
             able to control all values within this range.  It should be
             noted that the range Min VCI to Max VCI refers only to the
             incoming VCI range that can be supported by the associated
             port on each of the virtual paths in the range Min VPI to
             Max VPI. No restriction is placed on the values of outgoing
             VCIs that may be written into the cell header.

             Use of the Label Range message allows the range of VCIs to
             be changed on each VPI supported by the port.  However, the
             Min VCI and Max VCI fields in the Port Configuration and
             All Ports Configuration messages always report the same
             default values regardless of the operation of the Label
             Range message.

             For a port over which the GSMP protocol is operating, the
             VCI of the GSMP control channel may or may not be reported
             as lying within the range Min VCI to Max VCI.  A switch
             should honor a connection request message that specifies
Top   ToC   RFC2297 - Page 55
             the VCI value of the GSMP control channel even if it lies
             outside the range Min VCI to Max VCI.

   Receive Cell Rate
             The maximum rate of cells that may arrive at the input port
             in cells/s.

   Transmit Cell Rate
             The maximum rate of cells that may depart from the output
             port in cells/s. (The transmit cell rate of the output port
             may be changed by the Set Transmit Cell Rate function of
             the Port Management message.)

   Port Status
             Gives the administrative state of the port. The defined
             values of the Port Status field are:

             Available:
                  Port Status = 1. The port is available to both send
                  and receive cells. When a port changes to the
                  Available state from any other administrative state,
                  all dynamically assigned virtual connections must be
                  cleared and a new Port Session Number must be
                  generated.

             Unavailable:
                  Port Status = 2. The port has intentionally been taken
                  out of service. No cells will be transmitted from this
                  port.  No cells will be received by this port.

             Internal Loopback:
                  Port Status = 3. The port has intentionally been taken
                  out of service and is in internal loopback: cells
                  arriving at the output port from the switch fabric are
                  looped through to the input port to return to the
                  switch fabric. All of the ATM functions of the input
                  port above the physical layer, e.g. header
                  translation, are performed upon the looped back cells.

             External Loopback:
                  Port Status = 4. The port has intentionally been taken
                  out of service and is in external loopback: cells
                  arriving at the input port from the external
                  communications link are immediately looped back to the
                  communications link at the physical layer without
                  entering the input port. None of the ATM functions of
                  the input port above the physical layer are performed
                  upon the looped back cells.
Top   ToC   RFC2297 - Page 56
             Bothway Loopback:
                  Port Status = 5. The port has intentionally been taken
                  out of service and is in both internal and external
                  loopback.

             The Port Status of the port over which the GSMP session
             controlling the switch is running, must be declared
             Available. The controller will ignore any other Port status
             for this port. The Port Status of switch ports after
             power-on initialization is not defined by GSMP.

   Port Type
             The type of physical transmission interface for this port.
             The values for this field are defined by the atmIfType
             object specified in the Ipsilon IP Switch MIB [IpsilonMIB].

   Line Status
             The status of the physical transmission medium connected to
             the port. The defined values of the Line Status field are:

             Up:
                  Line Status = 1. The line is able to both send and
                  receive cells.  When the Line Status changes to Up
                  from either the Down or Test states, a new Port
                  Session Number must be generated.

             Down:
                  Line Status = 2. The line is unable either to send or
                  receive cells or both.

             Test:
                  Line Status = 3. The port or line is in a test mode,
                  for example, power-on test.

   Priorities
             The number of different priority levels that this output
             port can assign to virtual connections.  Zero is invalid in
             this field. If an output port is able to support "Q"
             priorities, the highest priority is numbered zero and the
             lowest priority is numbered "Q-1". The ability to offer
             different qualities of service to different connections
             based upon their priority is assumed to be a property of
             the output port of the switch. It may be assumed that for
             connections that share the same output port, an ATM cell on
             a connection with a higher priority is much more likely to
             exit the switch before an ATM cell on a connection with a
             lower priority if they are both in the switch at the same
             time.
Top   ToC   RFC2297 - Page 57
   Physical Slot Number
             The physical location of the slot in which the port is
             located. It is an unsigned 16-bit integer that can take any
             value except 0xFFFF. The value 0xFFFF is used to indicate
             "unknown." The Physical Slot Number is not used by the GSMP
             protocol. It is provided to assist network management in
             functions such as logging, port naming, and graphical
             representation.

   Physical Port Number
             The physical location of the port within the slot in which
             the port is located. It is an unsigned 16-bit integer that
             can take any value except 0xFFFF. The value 0xFFFF is used
             to indicate "unknown." The Physical Port Number is not used
             by the GSMP protocol. It is provided to assist network
             management in functions such as logging, port naming, and
             graphical representation.

             There must be a one to one mapping between Port Number and
             the Physical Slot Number and Physical Port Number
             combination. Two different Port Numbers must not yield the
             same Physical Slot Number and Physical Port Number
             combination. The same Port Number must yield the same
             Physical Slot Number and Physical Port Number within a
             single GSMP session.  If both Physical Slot Number and
             Physical Port Number indicate "unknown" the physical
             location of switch ports may be discovered by looking up
             the product identity in a database to reveal the physical
             interpretation of the 32-bit Port Number.

7.3 All Ports Configuration Message

   The All Ports Configuration message requests the switch for the
   configuration information of all of its ports. The All Ports
   Configuration message is:

      Message Type = 66

   The Port field is not used in the request message.

   The All Ports Configuration success response message has the
   following format:
Top   ToC   RFC2297 - Page 58
    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |    Version    | Message Type  |    Result     |     Code      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Transaction Identifier                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |       Number of Records       |      Port Record Length       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                                                               |
   ~                          Port Records                         ~
   |                                                               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   Number of Records
             Field gives the total number of Port Records to be returned
             in response to the All Ports Configuration request message.
             The number of port records in a single All Ports
             Configuration success response must not cause the packet
             length to exceed the maximum transmission unit defined by
             the encapsulation. If a switch has more ports than can be
             sent in a single success response message it must send
             multiple success response messages. All success response
             messages that are sent in response to the same request
             message must have the same Transaction Identifier as the
             request message and the same value in the Number of Records
             field.  All success response messages that are sent in
             response to the same request message, except for the last
             message, must have the result field set to "More." The last
             message, or a single success response message, must have
             the result field set to "Success." All Port records within
             a success response message must be complete, i.e. a single
             Port record must not be split across multiple success
             response messages.

   Port Record Length
             Field gives the length of each port record in bytes. This
             is currently 32 but the Port Record Length field allows for
             the future definition of further fields at the end of the
             port record while preserving compatibility with earlier
             versions of the protocol.

   Port Records
             Follow in the remainder of the message. Each port record
             has the following format:
Top   ToC   RFC2297 - Page 59
    0                   1                   2                   3
    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
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             Port                              |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                       Port Session Number                     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |V|M|L|R|      Min VPI          |Q|x x x|       Max VPI         |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |            Min VCI            |           Max VCI             |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                       Receive Cell Rate                       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                      Transmit Cell Rate                       |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |  Port Status  |   Port Type   |  Line Status  |  Priorities   |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |     Physical Slot Number      |     Physical Port Number      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   The definition of the fields in the Port Record is exactly the same
   as that of the Port Configuration message.




(page 59 continued on part 3)

Next Section