z/OS Communications Server: CMIP Services and Topology Agent Guide
Previous topic |
Next topic
|
Contents
|
Contact z/OS
|
Library
|
PDF
Contents (exploded view)
z/OS Communications Server: CMIP Services and Topology Agent Guide
SC27-3646-00
Abstract for CMIP Services and Topology Agent Guide
Summary of changes
VTAM CMIP services
Introduction to Object Orientation and CMIP services
Object-Oriented view of resources
Relationship between CMIP services and local application programs
Relationship between CMIP services and remote management systems
Overview of CMIP services
Locates objects
Registers objects
Coordinates traffic
Replicates scoped requests
Filters and routes events
Provides security
Creates and ends associations
Creating associations
Ending associations
Manages associations
Manages PDUs
Supports all CMIP verbs and most CMIP parameters
Requirements for application programs
Types of application programs
Basic application programs
Subtree managers
Create handlers
Special considerations for manager application programs
Special considerations for topology manager application programs
Patterns of EFDs that CMIP services recognizes
Specific object classes that CMIP services recognizes
CMIP error handling
General error handling
Errors found during outbound CMIP processing
Errors found during inbound CMIP processing
CMIP sequencing for separate CMIP operations
Sample CMIP application program
ACYCMS1C source file
ACYCMS2A source file
ACYCMS3A source file
ACYCMS4A source file
ACYCMS5A source file
ACYCMS6A source file
ACYCMS7A source file
Overview of CMIP services API functions
Decisions to make before coding
Common storage area storage or data space storage?
Common storage area interface
Data space interface
Advantages of CSA interface and data space interface
What form of distinguished name?
What type of application program—manager or agent?
Requirements for CMIP application programs
Format of API messages
Description and example of the API header
API header fields
Description and example of the string
Rules for the source and destination fields in the string
CMIP services API function syntax and operands
Overview of API functions
How the functions are coded
How the functions are described
Completion information
Synchronous and asychronous functions
MIBConnect—MIB connection function
MIBDisconnect—MIB disconnection function
MIBSendCmipRequest—CMIP request function
MIBSendCmipResponse—CMIP response function
MIBSendDeleteRegistration—Deregistration function
MIBSendRegister—MIB asynchronous registration function
MIBSendRequest—MIB queue request function
MIBSendResponse—MIB queue response function
Read queue exit routine
Read queue exit routine for the CSA interface
VTAM reason codes (for CSA)
Registers upon entry (for CSA)
Registers upon termination (for CSA)
Parameter list (for CSA)
Read queue exit routine for data space storage
VTAM reason codes (for data space)
Registers upon entry (for data space)
Registers upon termination (for data space)
Parameter list (for data space)
Dequeue and release routines for data space storage
Format of data on data space
Dequeueing a buffer with the dequeue routine
Input to the dequeue routine
Output for dequeue routine
Releasing a buffer with the release routine
Input to the release routine
Output to the release routine
Abnormal exits
Rules for constructing standard CMIP strings
Overview
How application programs format data to be sent to CMIP services
Explicit value format
ASN.1 value format
MIB variable format
Constructed value format
Hexadecimal BER format
Primitive ASN.1 data types
BOOLEAN type
How an application program sends a BOOLEAN value to CMIP services
How CMIP services sends a BOOLEAN value to an application program
INTEGER type
How an application program sends an INTEGER value to CMIP services
How CMIP services sends an INTEGER value to an application program
ENUMERATED type
How an application program sends an ENUMERATED value to CMIP services
How CMIP services sends an ENUMERATED value to an application program
REAL type
How an application program sends a REAL value to CMIP services
How CMIP services sends a REAL value to an application program
BIT STRING type
How an application program sends a BIT STRING to CMIP services
How an application program specifies a BIT STRING value
How CMIP services sends a BIT STRING to an application program
OCTET STRING type
How an application program sends an OCTET STRING to CMIP services
How an application program specifies an OCTET STRING
How CMIP services sends an OCTET STRING to an application program
NULL type
How an application program sends a NULL value to CMIP services
How an application program specifies a NULL value
How CMIP services sends a NULL value to an application program
OBJECT IDENTIFIER type
How an application program sends an OBJECT IDENTIFIER to CMIP services
How an application program specifies an OBJECT IDENTIFIER value
How CMIP services sends an OBJECT IDENTIFIER to an application program
Character string types
How an application program sends a character string to CMIP services
Valid characters for character strings
Valid characters for NumericString type
Valid characters for PrintableString type
Valid characters for GraphicString and ISO646String
How CMIP services sends a character string to an application program
Time types
How an application program sends a TIME value to CMIP services
How CMIP services sends a TIME value to an application program
Constructed ASN.1 types
How CMIP services sends a constructed type to an application program
SEQUENCE
SET
SET OF and SEQUENCE OF types
Decision types
CHOICE types
How an application program sends a CHOICE to CMIP services
How an application program specifies CHOICE values
How CMIP services sends a CHOICE to an application program
ANY DEFINED BY types
How an application program sends an ANY DEFINED BY value to CMIP services
How an application program specifies ANY DEFINED BY values
ANY types
How an application program sends an ANY value to CMIP services
How CMIP services sends an ANY value to an application program
Additional examples of how application programs send data
Examples of standard CMIP strings
Requests and indications
GET request—syntax
GET request—example request string
GET request—corresponding indication
ACTION request—syntax
ACTION request—example request string
ACTION request—corresponding indication
Responses and confirmations
GET response—syntax
GET response—example response string
GET response—corresponding confirmation
CREATE response—syntax
CREATE response—example response string
CREATE response—corresponding confirmation
Create and delete requests
Create requests
Creating the new object requested on the create request
Rejecting the create request
Creating an object different from object on the create request
Delete requests
Deleting the object requested on the delete request
Rejecting the delete request
VTAM-specific requests and responses
Subscribing to association information
Syntax for the subscription strings
Examples of subscription strings
How the subscription strings are used
Registering an application entity
Syntax of the registration strings
Examples of RegisterAE strings
How the registration strings are used
Starting associations
Syntax of the associate strings
Examples of the associate strings
How the associate strings are used
Ending associations
Syntax of the ACF.Release and ACF.Abort strings
Examples of the ACF.Release and ACF.Abort strings
How the ACF.Release and ACF.Abort strings are used
Getting association information
Syntax of the GetAssociationInfo string
Examples of the GetAssociationInfo string
How the GetAssociationInfo string is used
Creating a dedicated association
Requests and responses with the MIB prefix
MIB.GeneralRequest, MIB.GeneralResponse, and MIB.GeneralError
MIB.ServiceError
MIB.ServiceAccept
MIB.RegisterAccept
Application-program-to-application-program security
VTAM topology agent
Introduction to VTAM topology agent
OSI object classes and VTAM resources
OSI object classes
Mapping VTAM resources to OSI object classes
Naming the objects
OSI object states
Mapping VTAM status to OSI states
OSI states for VTAM resources with VTAM status
OSI states for VTAM resources without VTAM native status
OSI operations
Specifying OSI operations with CMIP verbs
GET
CANCEL-GET
ACTION
SET
DELETE
Other operations
Responding to CMIP requests
Responding to GET ROIV messages
Responding to CANCEL-GET messages
Responding to ACTION ROIV messages
EVENT-REPORT, SET, and DELETE messages
Monitoring resources with the ACTION(snapshot) operation
ACTION(snapshot) request
ACTION(snapshot) response
ACTION(snapshot) initial data
ACTION(snapshot) update data
ACTION(snapshot) update merging
ACTION(snapshot) termination
VTAM topology monitoring
Requesting and monitoring network data (snaNetwork)
Overview
Action request
Initial data response
Update data response
Action termination
snaNetwork snapshot data (APPN data)
snaNetwork snapshot data (subarea data)
snaNetwork snapshot example
Requesting and monitoring local topology (snaLocalTopo)
Overview
Action request
Initial data response
Update data response
Action termination
snaLocalTopo snapshot data
snaLocalTopo snapshot example
Requesting and monitoring LU data (luCollection)
Overview
Action request
Initial data response
Update data response
Action termination
luCollection snapshot data
luCollection (PU) snapshot example
Monitoring resources through event reports
Overview
Management of the event reporting environment
Creation of the event forwarding discriminator
Reporting events to the manager application program
Event report data
Event report example
Requesting specific resource data
Requesting specific resource data (GET)
Overview
GET request
Network-qualified names and GET requests
GET response
GET data
GET data example
Requesting specific resource data (logicalUnitIndex)
Overview
Action request
Initial data response
Action termination
logicalUnitIndex snapshot data
logicalUnitIndex snapshot example
C language header file (ACYAPHDH)
ASN.1 specification of the basic CMIP strings
Error codes sent by CMIP services
MIB.ServiceError error codes
0
7
8
250
251
252
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
319
320
321
322
323
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
343
344
345
347
348
349
354
356
357
358
359
360
361
362
363
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
419
420
421
422
424
425
426
427
428
429
430
431
432
433
434
435
436
439
440
500
501
502
503
504
505
506
507
508
509
550
551
552
553
554
581
557
559
560
561
562
563
564
568
573
574
578
802
803
806
807
808
812
814
815
817
819
823
824
826
827
828
829
830
831
832
833
834
835
836
838
840
900
901
903
904
914
918
919
920
921
922
925
929
931
932
933
934
935
936
937
938
939
941
945
952
953
954
955
956
957
958
961
962
963
964
965
1000
1001
1002
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
CMER VIT entry error codes
151
153
156
157
158
159
161
162
166
167
168
174
1051
1052
1053
1054
1055
1056
1057
VTAM CMIP services compliance with related standards and profiles
ISO standards documents
ISO 9596-1 CMIP—Common Management Information Protocol
(ISO 10164-5) OSI systems management part 5: event report function
ISO 8650 ACSE—Association Control Service Element
ISO 8823 presentation layer
ISO 8825 BER—Basic Encoding Rules (BER)
ISO standards documents
DISP 11183-1, AOM 10
DISP 11183-3, AOM 12
AOM221—general event report management
VTAM topology agent object and attribute tables
VTAM-supported objects for snapshot operations
Naming attributes for snapshot objects
VTAM-supported objects for snapshot responses
VTAM-supported attributes for snapshot responses
VTAM-supported objects for GET operation
VTAM-supported attributes for GET operation
VTAM topology agent attributes definition
abmSupported
adapterAddresses
adapterNumbers
adjacentLinkStationAddress
adjacentNodeName
adjacentNodeType
administrativeState
allomorphs
appnNodeCapabilities
appnTGcapabilities
attachedCircuitList
availabilityStatus
cdrscRealLUname
connectionID
connectionType
cp-cpSessionSupport
definitionGroupName
dependencies
dlcName
dlurList
dlurLocalLsAddress
dlurName
endpointForArc
erList
extendedAppnNodeCapabilities
functionID
gatewayNode
gatewaySSCP
interconnectedNetids
limitedResource
limitedResourceTimeout
lineType
linkName
linkStationRole
luGroupMembers
luGroupName
luGroupSize
luSecondName
maxBTUsize
nameBinding
nativeStatus
nlrResidentNodePointer
nnServerPointer
nonLocalResourceName
nonLocalResourceType
objectClass
opEquipmentList
opNetworkName
operationalState
packages
partnerConnection
portId
proceduralStatus
puName
receiveWindowSize
realSSCPname
registeredBy
relatedAdapter
residentNodePointer
resourceSequenceNumber
routeAdditionResistance
sendWindowSize
snaNodeName
softwareList
subareaAddress
subareaLimit
supportedResources
sysplexInfo
tn3270ClientDnsName
tn3270ClientIpAddress
tn3270ClientPortNumber
transmissionGroupNumber
underlyingConnectionNames
userLabel
unknownStatus
usageState
VTAMTOPO filtering option reporting
Related protocol specifications
Accessibility
Bibliography
Index for CMIP Services and Topology Agent Guide
Communicating your comments to IBM
Copyright IBM Corporation 1990, 2014