Abstract for SNA Operation
Purpose of this information
This document is intended to help network operators use VTAM® commands and messages to control and maintain a telecommunication network. It contains descriptions of VTAM commands. The information in this document includes descriptions of support for both IPv6 and IPv4 networking protocols. Unless explicitly noted, descriptions of IP protocol support concern IPv4. IPv6 support is qualified within the text.
You can use this document as a reference for specific operator commands and as background reading to help understand how to operate VTAM.
Who should read this information
This document is primarily a reference for network operators. It also contains introductory material intended for a new operator. The system programmer can use this document as a reference about command syntax and function to write a local operating procedure.
To make the best use of this document, both the operator and the system programmer should be familiar with the local operating system.
As a VTAM operator, you should have background knowledge of VTAM as well as a background knowledge of network programs offered by IBM®. Information in System Network Architecture Technical Overview might also be of use to a new operator.
A more experienced operator might want to consult z/OS Communications Server: SNA Network Implementation Guide.
A system programmer preparing a local operating procedure should know how to plan a VTAM installation, include VTAM in an MVS™ operating system, and define a VTAM domain. A prerequisite publication for system programmers who use this document is z/OS Communications Server: SNA Network Implementation Guide.
How this information is organized
This document is organized into the following information:
- Introducing an operator to VTAM provides an overview of how an operator controls VTAM.
- The following topics contain VTAM operator command
descriptions and the syntax required to enter these commands. The description of each command
includes the command format, a summary of the purpose of the command, and a description of each
operand. The commands are arranged within each topic alphabetically by operation and operand. (For
example, VARY is considered an operation, and ACT in VARY ACT is considered the operand.) The topics
are:
- VTAM operator commands contains descriptions and the syntax of VTAM operator commands.
- Logon manager operator commands contains descriptions and the syntax of logon manager operator commands.
- Cross-reference for VTAM DISPLAY commands contains a cross-reference of the output from VTAM operator commands.
- "Architectural specifications" lists documents that provide architectural specifications for the SNA protocol.
- "Information APARS and technotes" lists information APARs for IP and SNA documents.
- "Accessibility" describes accessibility features to help users with physical disabilities.
- "Notices" contains notices and trademarks used in this document.
- "Bibliography" contains descriptions of the documents in the z/OS® Communications Server library.
Artwork used in this document
Figure 1 shows the conventions used in this document to illustrate the parts of a network.
Conventions and terminology that are used in this information
- When describing how to use the command in a TSO environment, the command is presented in uppercase (for example, NETSTAT).
- When describing how to use the command in a z/OS UNIX environment, the command is presented in bold lowercase (for example, netstat).
- When referring to the command in a general way in text, the command is presented with an initial capital letter (for example, Netstat).
All the exit routines described in this information are installation-wide exit routines. The installation-wide exit routines also called installation-wide exits, exit routines, and exits throughout this information.
The TPF logon manager, although included with VTAM, is an application program; therefore, the logon manager is documented separately from VTAM.
Samples used in this information might not be updated for each release. Evaluate a sample carefully before applying it to your system.
- RDMA network interface card (RNIC), which is used to refer to the IBM 10 GbE RoCE Express® feature.
- Shared RoCE environment, which means that the 10 GbE RoCE Express feature operates on an IBM z13™ (z13) or later system, and that the feature can be used concurrently, or shared, by multiple operating system instances. The RoCE Express feature is considered to operate in a shared RoCE environment even if you use it with a single operating system instance.
For definitions of the terms and abbreviations that are used in this information, you can view the latest IBM terminology at the IBM Terminology website.
Clarification of notes
- Note
- Supplemental detail
- Tip
- Offers shortcuts or alternative ways of performing an action; a hint
- Guideline
- Customary way to perform a procedure
- Rule
- Something you must do; limitations on your actions
- Restriction
- Indicates certain conditions are not supported; limitations on a product or facility
- Requirement
- Dependencies, prerequisites
- Result
- Indicates the outcome
How to read a syntax diagram
- Read the diagrams from left-to-right, top-to-bottom, following
the main path line. Each diagram begins on the left with double arrowheads
(►►)
and ends on the right with two arrowheads facing each other (►◄).
>>-| Syntax Diagram |------------------------------------------><
- If a diagram is longer than one line, the first line ends with
a single arrowhead (►)
and the second line begins with a single arrowhead.
>>-| First Line |--OPERAND1--OPERAND2--OPERAND3--OPERAND4-------> >--OPERAND5--| Second Line |-----------------------------------><
- Required operands and values appear on the main path line.
>>-REQUIRED_OPERAND--------------------------------------------><
You must code required operands and values.
If there is more than one mutually exclusive required operand or value to choose from, they are stacked vertically in alphanumeric order.
>>-+-REQUIRED_OPERAND_OR_VALUE_1-+----------------------------->< '-REQUIRED_OPERAND_OR_VALUE_2-'
- Optional operands and values appear below the main path line.
>>-+---------+------------------------------------------------->< '-OPERAND-'
You can choose not to code optional operands and values.
If there is more than one mutually exclusive optional operand or value to choose from, they are stacked vertically in alphanumeric order below the main path line.
>>-+--------------------+-------------------------------------->< +-OPERAND_OR_VALUE_1-+ '-OPERAND_OR_VALUE_2-'
- An arrow returning to the left above an operand or value on the
main path line means that the operand or value can be repeated. The
comma means that each operand or value must be separated from the
next by a comma.
.-,------------------. V | >>---REPEATABLE_OPERAND-+--------------------------------------><
- An arrow returning to the left above a group of operands or values
means more than one can be selected, or a single one can be repeated.
>>-+---------------------------------------+------------------->< | .-,---------------------------------. | | V | | '---+-REPEATABLE_OPERAND_OR_VALUE_1-+-+-' '-REPEATABLE_OPERAND_OR_VALUE_2-'
- A word in all uppercase is an operand or value you must spell
exactly as shown. In this example, you must code OPERAND.
Note: VTAM and IP commands are not case sensitive. You can code them in uppercase or lowercase. If the operand is shown in both uppercase and lowercase, the uppercase portion is the abbreviation (for example, OPERand).
>>-OPERAND-----------------------------------------------------><
If an operand or value can be abbreviated, the abbreviation is described in the text associated with the syntax diagram.
- If a diagram shows a character that is not alphanumeric (such
as parentheses, periods, commas, and equal signs), you must code the
character as part of the syntax. In this example, you must code OPERAND=(001,0.001).
>>-OPERAND--=--(--001--,--0.001--)-----------------------------><
- If a diagram shows a blank space, you must code the blank space
as part of the syntax. In this example, you must code OPERAND=(001 FIXED).
>>-OPERAND--=--(--001-- --FIXED--)-----------------------------><
- Default operands and values appear above the main path line. VTAM uses the default if you omit
the operand entirely.
.-DEFAULT-. >>-+---------+------------------------------------------------->< '-OPERAND-'
- A word in all lowercase italics is a variable.
Where you see a variable in the syntax, you must replace it with one
of its allowable names or values, as defined in the text.
>>-variable----------------------------------------------------><
- References to syntax notes appear as numbers enclosed in parentheses
above the line. Do not code the parentheses or the number.
(1) >>-OPERAND-----------------------------------------------------><
Notes:- An example of a syntax note.
- Some diagrams contain syntax fragments, which serve to
break up diagrams that are too long, too complex, or too repetitious.
Syntax fragment names are in mixed case and are shown in the diagram
and in the heading of the fragment. The fragment is placed below the
main diagram.
>>-| Reference to Syntax Fragment |----------------------------><
Syntax Fragment |--1ST_OPERAND--,--2ND_OPERAND--,--3RD_OPERAND------------------|