snaLocalTopo snapshot data

For local topology data, the structure of the long form of vertex 1 is defined as follows:

vertex1

Identifies the beginning of vertex 1. The lower level fields in vertex 1 are:

object

Object instance name of the node represented by vertex 1. VTAM® always returns the distinguishedName form of an object instance name.

class

Object identifier (OI) representing the object class of the reported node.

states

String of characters representing the OSI state of the vertex 1 node. For a list of OSI states, see OSI object states.

info

Set of attributes providing data about the vertex 1 node. Not all attributes appear in all instances of vertex 1. The list of all possible attributes is:

dependencies: Included only if vertex 1 represents an NCP.
opEquipmentList: Included only if vertex 1 represents the local VTAM host.
softwareList: Included only if vertex 1 represents the local VTAM host.
sysplexInfo: Included only if vertex 1 represents the local VTAM host.
appnNodeCapabilities: Included only if vertex 1 represents the local VTAM host and the VTAM node is an appnNN or an interchangeNode.
extendedAppnNodeCapabilities: Included only if vertex 1 represents the local VTAM host and the VTAM node is an appnNN or an interchangeNode.
subareaLimit: Included only if vertex 1 represents a subarea node, which is a t5Node, t4Node, interchangeNode, or migrationDataHost.
subareaAddress: Included only if vertex 1 represents a subarea node, which is a t5Node, t4Node, interchangeNode, or migrationDataHost.
puName: Included only if vertex 1 represents the local VTAM host, and VTAM is subarea-capable.
gatewayNode: Included only if vertex 1 represents an NCP, and the NCP is gateway-capable.
gatewaySSCP: Included only if vertex 1 represents the local VTAM host, and VTAM is gateway-capable.
interconnectedNetIds: Included only if vertex 1 represents an NCP, and the NCP is gateway-capable.

moreInfo

Included only if a port object is to be reported in vertex 1 and is followed by a ManagementExtension that contains the port object.

identifier

Object identifier for the objectStuffInMoreInfoParm, which identifies the syntax for this ManagementExtension.

information

Port data in the ManagementExtension, which contains the following fields:

object

Object instance name of the port to be reported. VTAM always reports the distinguishedName form of object instance name.

class

Object identifier (OI) representing the port object class.

states

String of characters representing the OSI state of the port. For a list of OSI states, see OSI object states.

info

Set of attributes providing data about the port. Not all attributes appear in all instances of port objects. The list of all possible attributes is:

dependencies: Always included.
adapterNumbers: Included only if the snapshot type is appnOnly.
connectionId: Included only if the snapshot type is appnPlusSubarea.
adapterAddresses: Always included.
lineType: Always included.
dlcName: Always included.
relatedAdapter: Always included.

The structure of the short form of vertex 1 is defined as follows:

vertex1

Identifies the beginning of vertex 1. The lower level fields in vertex 1 are:

object

Object instance name of the node represented by vertex 1. VTAM always returns the distinguishedName form of object instance name.

class

Object identifier (OI) representing the object class of the reported node.

states

String of characters representing the OSI state of the vertex 1 node only if a state change occurred for the vertex 1 node. For a list of OSI states, see OSI object states.

info

Set of attributes providing data about the vertex 1 node. Not all attributes appear in all instances of vertex 1. The list of all possible attributes is:

gatewayNode: Included only if vertex 1 represents an NCP and VTAM has discovered that the NCP is gateway-capable.
interconnectedNetIds: Included only if vertex 1 represents an NCP and VTAM has discovered that the NCP is gateway-capable.

moreInfo

Included only if a port object is to be reported in vertex 1 and is followed by a ManagementExtension that contains the port object. The form included here is the short form of the port.

identifier

Object identifier for the objectStuffInMoreInfoParm, which identifies the syntax for this ManagementExtension.

information

Port data in the ManagementExtension, which contains the following fields:

object

Object instance name of the port to be reported. VTAM always reports the distinguishedName form of object instance name.

class

Object identifier (OI) representing the port object class.

states

String of characters representing the OSI state of the port. For a list of OSI states, see OSI object states.

info

Set of attributes providing data about the port. Not all attributes appear in all instances of port objects. The list of all possible attributes is:

adapterAddresses: Included only to report an attribute value change.
relatedAdapter: Included only to report an attribute value change.

reason

Included only if the port is reported as deleted.

reason

Included only if the vertex 1 node is being reported as deleted.

Note that although the previous lists show the long form of the port in the long form of vertex 1 and the short form of the port in the short form of vertex 1, it is possible to have the long form of port contained in the short form of vertex 1. For example, if a node was already reported in a previous vertex 1 (long form) and was reported again (short form), but this time the vertex 1 included a port that has not yet been reported, the port is the long form. The VTAM topology agent never reports the short form of a port in a long form of vertex 1.

Vertex 2 for snaLocalTopo does not have a long form and a short form; there is only one form. The structure of vertex 2 is as follows:

vertex2

Identify the beginning of vertex 2. The lower level fields in vertex 2 are:

object: Object instance name of the node represented by vertex 2. VTAM always returns the distinguishedName form of object instance name.
class: Object identifier (OI) representing the object class of the reported node.
VTAM might not report the true object class of composite nodes such as interchange nodes. When reporting subarea connections, vertex2 object class is always t5Node or t4Node.
reason: Included only if the vertex 2 node is being reported as deleted.

The structure of endpoint 1 for snaLocalTopo is variable, depending on what objects are reported. Endpoint 1 can contain both a transmission group object and a logicalLink object, or it can contain just a logicalLink object. Endpoint 1 never contains only a transmission group object. If both a TG and a logicalLink are reported, the TG is reported as the first and primary object in endpoint 1. If only a logicalLink is reported, the logicalLink is reported as the primary object in endpoint 1.

The structure of endpoint 1 is shown in two parts; first, the structure of the TG object is shown, including where the logicalLink object fits into the structure. Then the logicalLink object is shown with a structure used for either the primary or secondary object in endpoint 1.

The TG object structure follows:

object

Object instance name of the TG to be reported. VTAM always reports the distinguishedName form of object instance name.

class

Object identifier (OI) representing either the appnTransmissionGroup or the subareaTransmissionGroup object class.

states

String of characters representing the OSI state of the TG; this field is included only for appnTransmissionGroup objects. For a list of OSI states, see OSI object states.

info

Set of attributes providing data about the TG. Not all attributes appear in all instances of TG objects. The info label and value are included only for appnTransmissionGroup objects. The list of all possible attributes is:

cp-cpSessionSupport: Included only for appnTransmissionGroup objects.
appnTGCapabilities: Included only for appnTransmissionGroup objects.

moreInfo

Always included for a TG object and is followed by a ManagementExtension that contains the logicalLink object.

identifier: Object identifier for the objectStuffInMoreInfoParm, which is a parameter that identifies the syntax for this ManagementExtension.
information: logicalLink data in the ManagementExtension. At this point the logicalLink data described below is inserted.

reason

Included only if the TG is being reported as deleted.

The logical link object structure follows:

object

Object instance name of the logicalLink to be reported. VTAM always reports the distinguishedName form of object instance name.

class

Object identifier (OI) representing the logicalLink object class.

states

String of characters representing the OSI state of the logicalLink. For a list of OSI states, see OSI object states.

info

Set of attributes providing data about the logicalLink. Not all attributes appear in all instances of logicalLink objects. The list of all possible attributes is:

dependencies: Included for initial data, object creation updates, state change updates for switched PUs, and attribute value change updates caused by line filtering through the MODIFY VTAMTOPO command.
connectionId: Included only for native ATM connections and only if the snapshot type is appnPlusSubarea, for initial data and object creation updates.
portId: Reported for initial data, object creation updates, state change updates for switched PUs, and selected attribute value change updates; however, this attribute might be suppressed if it refers to a switched logical line and switched logical lines are being suppressed (because of how the VTAMTOPO filtering option is specified).
partnerConnection: Included only if the resource represented by this logicalLink is a link station and if the partner logicalLink information is available. Included for initial data, object creation updates, and state change updates.
adjacentLinkStationAddress: Included if the associated line is a logical token ring line, a frame relay line, an XCA line, an XCF line, an ATM line, or an SDLC line with a polling address. The attribute might also be included for PUs that have the ADDR keyword coded on the PU definition statement. The attribute is included for initial data, object creation updates, state change updates, and selected attribute value change updates.
adjacentNodeType: Included for initial data, object creation updates, and state change updates.
dlurLocalLsAddress: Included when a DLUR supports downstream PUs. LogicalLink reports local addressing information.
dlurName: Included only if the PU is attached to VTAM through the dependent LU server and dependent LU requester capabilities. Included for initial data, object creation updates, and state change updates.

reason

Included only if the logicalLink is being reported as deleted.