Contents
Audience
The audience for this documentation includes system programmers, system administrators, storage administrators, and other VM users, who are responsible for installing, configuring, authorizing, and servicing various CA VM products. The document assumes that you are thoroughly familiar with the following areas:
- CP, CMS components
- VMSES/E procedures
- VM environment and installing software in this environment
- The IT environment, processes, and procedures of your organization.
- Your organization's IT environment, processes, and procedures
If you are installing this software, you may need to work with the following personnel:
- Systems programmer, for CP and CMS definitions
- Storage administrator, for disk space allocation
- Security administrator, for establishing resource authorizations
Documentation Changes
The following documentation updates have been made after the last release of this documentation.
Note: In PDF format, page references identify the first page of the topic in which a change is made. The actual change can appear on a later page.
Installation Guide
- Changed all mentions of ZVMN011A to ZVMN012A. For example, see Installing Product Materials.
- Implementing the Directory Reader and System Information Diagnose Code Added information that different diagnose code programming TEXT files are specific to different VM releases. Added mention that diagnose codes apply to System Information, not only Directory Reader.
Format Conventions for Code Syntax
This section describes the format and conventions used to document commands, utilities, and user exits. Each convention provides examples, describing how to use commands, how to use options, or how the system responds to user entries.
Also, note that the examples and instructions throughout this document use VMANAGER as the user ID for system administrator and maintenance functions. If you use a different user ID for the system administrator or the service virtual machine, replace those names in any instructions in which the default ones appear throughout this document.
Contents
Command Abbreviations
When a command contains uppercase and lowercase letters, then the uppercase letters denote the shortest acceptable abbreviation that you can use to type the command. However, when a code item appears entirely in uppercase letters, you cannot abbreviate the item.
You can type the code item in uppercase letters, lowercase letters, or any combination.
Example:
CMDNAme
In this example, you can enter CMDNA, CMDNAM, or CMDNAME in any combination of uppercase and lowercase letters.
Continuation
The code syntax or code fragment definitions can continue from one line to the next line. The following examples describe code continuation:
Example 1:
A | B C | D
This code is equivalent to the following code:
A | B C | D
Example 2:
{choice1 | choice2 | choice99}
This code is equivalent to the following code:
{ choice1 | choice2 | choice99 }
Default Values
An underlined code item denotes the default value. The system uses the default value unless you override it. You can override the default value by coding an option from the available list.
Example:
[parm1 | parm2 | parm3]
In this example, the code item parm1 is the default value, and this is used by the system when you do not specify any of the options. However, you can code parm1, parm2, or parm3.
Keywords and Constants
A keyword name or constant always appears in uppercase letters. Code the keyword name or constant exactly as shown in the following example:
Example:
STOP {tracenumber | | * | [USER] userid}
This example displays the USER keyword.
Optional Choices
Defines optional code items -- denoted by square brackets around a code item.
Example:
CMDName [parm1]
In this example, you can choose parm1 or no parameter at all. However, when two or more items are enclosed in square brackets and separated by vertical bar characters, all of them are optional.
Multiple Optional Choices
When two or more items are enclosed in square brackets and separated by vertical bar characters, all of them are optional.
Example:
In this example, you can choose parm1, parm2, parm3, or nothing at all.
[parm1 | parm2 | parm3]
Positional Parameters
Commands with positional parameters are identified by nested square brackets. Each positional parameter requires the specification of all previous positional parameters. The following example describes the positional parameter:
Example:
CMDName [posparm1 [posparm2 [posparm3]]]
In this example, posparm3 can be specified only when posparm1 and posparm2 are also specified.
Repetition
An ellipsis following a code item means that the code item can be repeated. A list of code items enclosed in brackets and followed by an ellipsis means that you can select more than one item or, in some cases, repeat a single item.
Example 2:
Repeat...
Example 3:
{Operand1 | Operand2}...
In this example, you must choose at least one operand and you can choose both operands. If one of the operands is a variable, you may also be able to repeat that operand with different values.
Required Choices
You must select one item from a list of items when they are enclosed in curly braces. The items are separated by a vertical bar character.
Example:
CMDNAme {A | B | C}
In this example, your choice results in CMDNAME A, CMDNAME B, or CMDNAME C.
Special Symbols
The following list describes the meaning of the special symbols used in codes:
- {} (encloses a list of operands, one of which is required).
- [] (enclose an optional operand or operands).
- " " (enclose the name of a syntax fragment)
- underline (identifies a default value)
- | (separates alternative operands)
- . . . (Indicates that the preceding item or group can be repeated).
Symbols
The following list displays symbols. These symbols should be coded exactly as they appear in the code syntax.
- * (Asterisk)
- : (Colon)
- , (Comma)
- = (Equal Sign)
- -- (Hyphen)
- ( )(Parentheses)
- . (Period)
Syntax Fragments
Some codes use fragments, when the code syntax is too lengthy. The fragment name appears between double quotes in the code syntax.
The expanded fragment appears in the syntax after all other parameters or at the bottom of the code syntax. A heading with the fragment name identifies the expanded fragment.
Example1:
CMDName "Parms" Parms: [ParmA] [ParmB] [ParmC]
In this example, the fragment is named "Parms", and the expanded fragment appears at the bottom of the code syntax.
Example 2:
CMDName [( "Options"] Options: OptionA | OptionB | OptionC | OptionD [OptionD1]
In this example, the fragment is named Options. The list of options is too long to fit on one line, so they are listed vertically. Note that the outermost brackets and the "(" symbol are in the main line, not in the vertical list. Also note that one option has its own optional parameter.
System Response
Uppercase characters represent system responses or prompts.
Example:
ENTER YOUR LOGON PASSWORD:
This example displays a system response.
User-Entered Commands or Records
User-entered commands are shown in bolded lowercase letters even though you can enter commands in either upper or lower case.
Example:
vmsecure addentry writers tcom (noformat nowait
This example shows what a user-entered command looks like.
In this example "writers tcom" is the file name and file type of the directory entry you are adding.
However, if the entry is a record, it appears in uppercase letters.
Example:
ACCESS DRCT 1B0 U
This example shows a configuration record that is entered by a user.
Variables
Lowercase items in italics denote variables.
Example:
CMDNAme varname
In this example, varname represents a variable that you must specify when you code the command CMDNAME.