ACTION(
snapshot) responses can be any of the following variations on PDU content:
- Single RORS
If there is no snapshot data for the VTAM topology agent to supply and the request is oneTimeOnly, the empty set might be returned in RORS message.
- Linked-reply and RORS
If the VTAM topology agent has snapshot data to provide, the response consists of one or more linked-reply ROIV messages followed by an RORS message.
- Single ROER
If an error occurs and no data linked-reply ROIV messages are sent in response, a single ROER message is sent in response, indicating the failure to process successfully.
- Linked-reply error and RORS
If one or more linked-reply ROIV messages with data is sent in response before an error occurs, an ROER message cannot be used. In this case, an additional linked-reply ROIV is sent containing an indication of the error, followed by an RORS message.
In a
snapshot response message containing valid data, the basic unit of information is a sequence of:
- vertex 1 (v1)
- vertex 2 (v2)
- endpoint 1 (e1)
Multiple sets of this sequence (v1, v2, e1) can occur within a snapshot response. Each of the three components (v1, v2, e1) has the same basic syntactic structure. However, the semantics and the actual structure of v1, v2, and e1 vary with the different target objects of the snapshot.
The structure of each v1, v2, or e1 is as follows:
- object
- Provides the distinguished name (DN) of the primary object instance being reported in this component. If this component is vertex 1 or endpoint 1, additional object instances might be reported elsewhere in the v1 or e1 string.
- class
- Provides the object class of the instance identified in the object field.
- states
- Provides a condensed, encoded form of the state attributes for the object instance identified in the object field. The attributes are given in the OCTET string form instead of the full attribute form. The state attributes, their positions in the OCTET string, and the possible values are:
- Octet
- State
- 0
- operationalState
- 00
- disabled
- 01
- enabled
- FF
- N/A or unchanged
- 1
- usageState
- 00
- idle
- 01
- active
- 02
- busy
- FF
- N/A or unchanged
- 2
- administrativeState
- 00
- locked
- 01
- unlocked
- 02
- shuttingDown
- FF
- N/A or unchanged
- 3
- availabilityStatus
Note that this attribute represents a SET, so it might have multiple values; each value shown below represents a bit position. To show multiple values, the bits representing the values are logically ORed together.
- 00
- noStatus
- 01
- notInstalled
- 02
- degraded
- 04
- dependency
- 08
- offDuty
- 10
- offLine
- 20
- powerOff
- 40
- failed
- 80
- inTest
- FF
- N/A or unchanged
- 4
- proceduralStatus
- 00
- no status
- 08
- terminating
- 10
- reporting
- 20
- initializing
- 40
- not initialized
- 80
- initialization required
- FF
- N/A or unchanged
- 5
- unknownStatus
- 00
- false
- 01
- true
- FF
- N/A or unchanged
- 6
- nativeStatus
- 00
- Active
- 01
- Active with sessions
- 02
- Inactive
- 03
- Never active
- 04
- pending active
- 05
- pending inactive
- 06
- Connectable
- 07
- Routable
- 09
- Congested
- 0A
- Released
- 0B
- Reset
- 0C
- Inop
- FF
- N/A or unchanged
- info
- Provides an optional set of attributes associated with the object instance identified in the object field. The list of attributes provided varies with the target snapshot object.
- moreInfo
- Provides for any additional information that is necessary; for example, for the vertex 1 of a snaLocalTopo snapshot this field might contain a set of object data specifying a port object.
- reason
- Indicates why the snapshot update is being sent:
- Value
- Description
- deleted
- Object is deleted.
- addOrUpdate
- Object is added or changed. The default is addOrUpdate.