Parameters within Syntax [ Using Your System The User's Guide ] MPE/iX 5.0 Documentation
Using Your System The User's Guide
Parameters within Syntax
MPE/iX commands instruct the system to perform a desired function. If
you include parameters with the command before you enter it, the
parameters specifically instruct the system how it should perform the
command function.
There are three types of parameters:
* required
* optional
* positional
Required parameters
You must enter all required parameters; otherwise, MPE/iX displays an
error message when you enter the command. In the syntax diagrams for
each command, either braces { } or no marks surround required parameters.
In the following example, myfile is a required parameter because no marks
surround it:
BUILD myfile
Anything italicized, such as myfile, is a representational name or value
and must be replaced with an actual name or value.
Sometimes you must select one parameter from two or more parameters. In
the following example, you must provide either a job number or a session
number because braces surround these parameters:
ALTJOB {#Jnnn}
{#Snnn}
Optional parameters
You can either specify or ignore optional parameters, if any, depending
on how you want the command to execute. In the syntax diagrams for each
command, brackets [ ] surround optional parameters. If you ignore
optional parameters, MPE/iX uses the system-defined default values for
each parameter.
In the following example, [;PASS] is an optional parameter because
brackets surround it:
NEWGROUP groupname [;PASS=[password]]
In this example, PASS is the parameter and password is the parameter
value. You would substitute an actual password in place of password to
provide a value for the parameter PASS. The syntax diagram indicates that
the value password is optional within the optional parameter PASS.
Positional parameters
The effect of a positional parameter depends on its location in the
parameter list. In the syntax diagram for each command, the comma (,)
separates positional parameters. If you omit a positional parameter from
the list, you must provide a comma placeholder that would normally
precede that parameter.
In the following example, the parameter values that follow the command
are positional:
LIMIT 10,32
In the following example, a comma holds the position of the current value
of the first parameter:
LIMIT ,32
ABORTJOB/CtrlA ABORTJOB
The ABORTJOB/CtrlA ABORTJOB command terminates either a designated job or
session. Typically, you would use this command to cancel a job that you
decided not to run but had already streamed. You could also use this
command to terminate one or more sessions, if necessary, for system
emergencies or scheduled shutdowns.
Syntax
From a terminal:
{#Jnnn }
ABORTJOB {#Snnn }
{[jobname,]user.acct}
From the console:
{#Jnnn }
CtrlA ABORTJOB {#Snnn }
{[jobname,]user.acct}
Parameters
#Jnnn Specifies a job number.
#Snnn Specifies a session number.
jobname Specifies the name of the job, as identified by the
SHOWJOB command.
user Specifies a user name.
acct Specifies an account name.
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break does not affect this command.
You must enter the CtrlA ABORTJOB command from the console. You
can enter the ABORTJOB command from a terminal other than the
console if the JOBSECURITY command is set to LOW, or if your
system administrator has used the ALLOW command, which permits you
to enter this command.
* Differences between ABORTJOB and CtrlA ABORTJOB
Both of these commands function identically except that you can
enter CtrlA ABORTJOB only from the console. The = sign appears
when you press CtrlA. Pressing these keys enables you to enter
certain commands on a console from which another process (such as
STORE) is currently running.
* Recommended usage
If you use the [jobname,]user.acct form of the command when more
than one job or session is executing with the same name, the
system selects the job or session that it aborts. Consequently,
you should use the #Jnnn or #Snnn form of the command for more
precise control of jobs or sessions to be terminated. Although
the job or session abnormally terminates, log records are issued,
and CPU times and connect times are updated. All I/O activity
terminates, such as printing, and reading or writing files.
* Waiting and scheduled jobs
You can also use the ABORTJOB command for waiting and scheduled
jobs, as well as for executing jobs. If a request is pending at
the console, the command automatically terminates the request, and
the following message appears on the console:
time/#Snnn/pin/REQUEST REQUIRING OPERATOR REPLY FOR
PIN #nn HAS BEEN ABORTED
Refer to the Glossary for a definition of the process
identification number (PIN).
Examples
* To terminate session number 139, enter:
:ABORTJOB #S139
The system responds by displaying the following logoff message on
the console if the session ends successfully:
17:10/#S139/34/LOGOFF ON LDEV #12
* To terminate job number 9, enter:
:ABORTJOB #J9
The system responds by displaying the following logoff message if
the executing job successfully terminates:
20:18/#J9/26/LOGOFF ON LDEV #10
This message does not appear when you terminate waiting or
scheduled jobs.
* To terminate session 6, which has the following pending device
allocation message, enter:
?17:00/#S6/23/LDEV# FOR "SCRTAPE" ON TAPE (NUM)?
:ABORTJOB #S6
The system responds by displaying the following message:
17:10/#S6/120/REQUEST REQUIRING OPERATOR REPLY FOR
PIN 23 HAS BEEN ABORTED
17:10/#S6/120/LOGOFF ON LDEV #58
Related Commands
ABORTIO
ALLOW
BREAKJOB
CONSOLE
JOBSECURITY
SHOWJOB
STREAM
ALLOW
The ALLOW command enables the system administrator to permit one or more
users to enter one or more operator commands. The ALLOW command
specifies which users can enter operator commands, and specifies which
commands these users can enter.
Syntax
Interactive and subsystem mode:
[@.@ ]
ALLOW [@.acct ];COMMANDS=command[,command,...]
[user.@ ]
[user.acct]
Program mode:
ALLOW FILE=formaldesignator[;SHOW]
Parameters
@.@ Gives access to all users whether or not they are
logged on.
@.acct Gives access to all users logged on to a specific
account.
user.@ Gives access to a specific user logged on to any
account.
user.acct Gives access to a specific user logged on in a
specific account.
COMMANDS Specifies the names of the console commands that
the user(s) can access.
FILE Specifies an ASCII file name, formaldesignator,
that consists of from one to eight alphanumeric
characters, beginning with an alphabetic character.
The formaldesignator can be fully or partially
qualified and can be backreferenced in a file
equation.
SHOW Lists input lines to $STDLIST.
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break terminates subsystem mode and produces
an error message, but does not affect commands already entered in
subsystem mode.
This command can only be entered from the console, unless your
system administrator has used the ALLOW command, which permits you
to enter this command.
You can only allow commands to users currently logged on unless
you use the @.@ parameter. Remember, however, that this parameter
allows commands to all users. An alternative would be to use the
ALLOW command with the @.@ parameter, then use the DISALLOW
command to disallow commands to selected users.
Additional commands that you allow for users are valid only for
the duration of their current session. When a user logs off and
then back on to the system, the previously allowed commands are no
longer available until they are allowed again.
* Command modes
The ALLOW command enables you to enter the command in one of three
modes:
* interactive
* subsystem
* program
When using interactive mode, you enter the entire command along
with the desired parameters as shown in syntax and press Return.
Subsystem mode is similar, except you just enter the ALLOW command
and then provide the remaining parameters after the subsystem
prompt (>) appears. The subsystem accepts command parameters
until you enter the EXIT or END command.
Program mode is beneficial from an administrative perspective,
because you can create a customized file granting specific
permissions that you do not have to alter, unless desired. When
using program mode, you first create a file that:
* Identifies the users and accounts that are permitted to use
operator commands.
* Lists the allowed commands.
Then you enter the ALLOW command, using the SHOW parameter to
display each command line as it executes from the file.
Refer to "Examples" for examples of all three modes.
* Console commands versus operator commands
Console commands function differently from operator commands.
Console commands are not allowable, must be entered on the actual
console (usually configured as LDEV 20), and must be preceded by
CtrlA. Some console commands have the same name as non-console
commands, such as RECALL, which can be entered on any device.
Operator commands are generally used in the daily operation of
your system and are generally allowable.
* Allowable commands
You can allow up to 19 of the following commands at a time in
interactive and subsystem modes. If you need to specify more than
19 commands, use program mode.
[REV BEG]
ABORTIO HEADON RESUMESPOOL
ABORTJOB JOBFENCE SHUTQ
ACCEPT JOBSECURITY STARTSPOOL
ALLOW LDSMOUNT STOPSPOOL
ALTJOB LIMIT STREAMS
ALTSPOOLFILE LOG UP
CONSOLE MRJECONTROL VMOUNT
DELETESPOOLFILE OPENQ VSCLOSE
DISALLOW OUTFENCE VPOPEN
DISCRPS REFUSE VSRELEASESYS
DOWN REPLY VSRESERVESYS
DOWNLOAD RESUMEJOB WARN
HEADOFF SPOOLER WELCOME
[REV END]
Not all of these commands are described in this chapter. For
information about commands not described in this chapter, use the
Help Facility.
Before allowing any users access to these commands, you should
enter the SHOWALLOW command to determine which operator commands
have already been allowed.
Examples
* In interactive mode, to allow a user named USER.TECH to enter the
REPLY and ABORTJOB commands, enter the following command at the
console:
:ALLOW USER.TECH;COMMANDS=REPLY,ABORTJOB
* In subsystem mode, to allow a user named MGR.MANUALS to enter the
BREAKJOB command, enter the following command sequence at the
console:
:ALLOW
>MGR.MANUALS;COMMANDS=BREAKJOB
>EXIT
* In program mode, to allow the users named SUSAN.PAYROLL and
JOHN.ACCTNG to enter the LIMIT command, do the following:
1. Execute the EDITOR command, create a program file, and save
it to ALLOWTMP, as shown:
:EDITOR
HP32201A.07.17 EDIT/3000 WED, MAY 8, 1991, 3:02 PM
(C) HEWLETT-PACKARD CO. 1990
/ADD
1 SUSAN.PAYROLL;COMMANDS=LIMIT
2 JOHN.ACCTNG;COMMANDS=LIMIT
3 //
...
/K ALLOWTMP
/E
2. Execute the ALLOW command using the SHOW parameter, if
desired, to display each command line as it executes from
the file:
:ALLOW FILE=ALLOWTMP;SHOW
* You can also include a lockword for the file, if
any, as shown:
:ALLOW FILE=ALLOWTMP/LOCKWORD;SHOW
* You can backreference the file with a file equation,
as shown:
:FILE BACKF=ALLOWTMP
:ALLOW FILE=*BACKF;SHOW
Related Commands
CONSOLE
DISALLOW
SHOWALLOW
ALTACCT
The ALTACCT command enables a system administrator to change the
parameters of an existing account.
Syntax
ALTACCT acctname [;PASS=[password]][;CAP=[capabilitylist]]
[;ACCESS=[(fileaccess)]]
Parameters
acctname Specifies the name of the account that you want to
alter. The name must consist of one to eight
alphanumeric characters, beginning with an
alphabetic character.
PASS Specifies the account password, only used for
verifying logon access. Entering the ALTACCT
command without this parameter retains the current
password. Entering PASS without specifying
password removes the existing password. Entering
PASS and specifying password changes the current
password or creates one if a password did not
previously exist.
CAP Specifies the list of capabilities permitted for
this account that were assigned with the NEWACCT
command. Each capability is indicated by a
two-letter mnemonic, separated by commas, as
follows:
SM = System manager
AM = Account manager[REV DEL]
DI = Diagnostician
OP = System supervisor
NA = Network administrator
NM = Node manager
SF = Save files
ND = Access to nonshareable I/O devices
UV = Use volumes
CV = Create volumes
CS = Use communication subsystem
PS = Programmatic sessions
LG = User logging
PH = Process handling
DS = Extra data segments
MR = Multiple RINs
PM = Privileged mode
IA = Interactive access
BA = Batch access
The defaults are [REV BEG]AM, SF, ND, IA, and
BA,[REV END] for all accounts except for the SYS
account. The defaults for the SYS account are SM,
AM, AL, GL, DI, OP, SF, ND, PH, DS, MR, and PM. You
should not alter the SYS account because it is
assigned the maximum account capabilities when the
system is delivered.
If you remove a capability from an account, it is
unavailable to users of that account only after
they log off the system and then log back on.
ACCESS Specifies the restriction on file access pertinent
to this account. Valid syntax options are as
follows:
[{R} {ANY}]
[{L} {AC }]
([{A} [,...]: {GU }] [,...])
[{W} {AL }]
[{X} {GL }]
[{S} ]
where R, L, A, W, X, and S specify modes of access
by types of users (ANY, AC, GU, AL, GL) and are
defined as follows:
R = Read
L = Lock (exclusive file access)
A = Append (implies L)
W = Write (implies A and L)
X = Execute
S = Save
The user types are defined as follows:
ANY = Any user
AC = Member of this account only
GU = Member of this group only
AL = Account librarian user only
GL = Group librarian user only
You can specify two or more user and/or access
types if you separate them with commas.
The defaults are R,A,L,W,X:AC for all accounts
except for SYS. The SYS account defaults are
(R,X:ANY;A,W,L:AC).
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break does not affect this command.
You must have system manager (SM) capability in order to use this
command.
* Altering account parameters
Basic guidelines for altering account parameters are as follows:
* You can enter multiple parameters on a single command line
by using the semicolon (;) delimiter.
* When you change one capability in a capability list that
contains several nondefault values, you must specify an
entire new capability list.
* A parameter remains unchanged for the account if you omit a
parameter and its value when entering the command.
* When you include a parameter but omit its value as in
PASS=Return, the default value is assigned.
* Activating the changes
If you alter one or more parameters while users are logged on, the
changes do not become effective until the users log off their
current jobs or sessions and log back on. Since the system does
not automatically generate a message informing users of changes,
you should notify users before you make any account changes. This
is particularly advisable when you remove a capability from an
account. In this case, all account members and groups within the
account are denied the capability.
* Restrictions
You cannot remove system manager (SM) capability from the SYS
account or account manager (AM) capability from any account. From
within any account, you can remove AM capability from all but one
(the last) of the users assigned the capability; however, you can
remove AM capability from all users in an account if you do this
from another user and account with SM capability.
Examples
* To change the password of an account named AC2 to GLOBALX, enter:
:ALTACCT AC2;PASS=GLOBALX
* To add SM capability to an account named AC2 and retain the
default capabilities, enter:
:ALTACCT AC2;CAP=SM,AM,AL,GL,ND,SF,BA,IA
Related Commands
ALTGROUP
ALTUSER
LISTACCT
LISTGROUP
LISTUSER
NEWACCT
NEWGROUP
NEWUSER
REPORT
RESETACCT
ALTGROUP
The ALTGROUP command changes one or more parameters of a group within an
account.
Syntax
ALTGROUP groupname[.acctname] [;PASS=[password]]
[;CAP=[capabilitylist]][;ACCESS=[(fileaccess)]]
Parameters
groupname Specifies the name of the group for which you want
to change parameters. The name must consist of one
to eight alphanumeric characters, beginning with an
alphabetic character.
acctname Specifies the account in which the group resides.
You must have system manager (SM) capability to use
this parameter.
PASS Specifies the group password. Entering the
ALTGROUP command without this parameter retains the
current password. Entering PASS without specifying
password removes the existing password. Entering
PASS and specifying password changes the current
password or creates one if a password did not
previously exist.
CAP Specifies capability class attributes consisting of
any or all of the following:
BA = Batch access capability (default)
DS = Permits extra data segments
IA = Interactive access capability (default)
MR = Permits multiple resource identification numbers (RINs)
PH = Process handling capability
PM = Privileged mode capability
The default is IA and BA, except for the PUB group
of the SYS account. The default for PUB.SYS is PH,
DS, MR, PM, IA, and BA. Typically, you should not
change PUB.SYS because it is assigned the maximum
group capabilities when the system is delivered.
You must separate each capability class with a
comma (BA,DS,IA, and so on).
ACCESS Specifies the restriction on file access pertinent
to this group. Capability options that you can
change are as follows:
[{R} {ANY}]
[{L} {AC }]
([{A} [,...]: {GU }] [,...])
[{W} {AL }]
[{X} {GL }]
[{S} ]
where R, L, A, W, X, and S specify modes of access
by types of users (ANY, AC, GU, AL, GL) and are
defined as follows:
R = Read
L = Lock (exclusive file access)
A = Append (implies L)
W = Write (implies A and L)
X = Execute
S = Save
The user types are defined as follows:
ANY = Any user
AC = Member of this account only
GU = Member of this group only
AL = Account librarian user only
GL = Group librarian user only
You can specify two or more user and/or access
types if you separate them with commas.
The defaults for the public group (PUB) are:
R,X:ANY;A,W,L,S:AL,GU
The default for all other groups is:
R,A,W,L,X,S:GU
Capabilities assigned to the user group for
ALTGROUP cannot exceed those assigned to the
account.
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break does not affect this command.
You must have account manager (AM) or system manager (SM)
capability in order to use this command.
* Altering group parameters
Basic guidelines for altering group parameters are as follows:
* You can enter multiple parameters on a single command line
by using the semicolon (;) delimiter.
* When you omit an entire parameter, the corresponding value
for the group remains unchanged.
* When you include a parameter but omit its value as in
PASS=Return, the default value is assigned.
* Activating the changes
If you alter one or more parameters, the changes in the directory
become effective immediately; however, the changes do not affect
any active users with open files in the group until they log off
from their current sessions and log back on to the same group.
Since the system does not automatically generate a message
informing users of changes, you should notify users before you
make any changes to the group.
Examples
* To assign a new password, PASS2, to a group named GROUPX, enter:
:ALTGROUP GROUPX;PASS=PASS2
* To assign the same password to the same group as above and add DS
and PH capabilities, enter:
:ALTGROUP GROUPX;PASS=PASS2;CAP=IA,BA,DS,PH
Related Commands
ALTACCT
ALTUSER
LISTACCT
LISTGROUP
LISTUSER
NEWACCT
NEWGROUP
NEWUSER
ALTUSER
The ALTUSER command changes the parameters currently defined for a user.
Syntax
ALTUSER username[.acctname] [;PASS=[password]][;CAP=[capabilitylist]]
[;HOME=[homegroupname]]
Parameters
username Specifies the name of the user. The name must
consist of one to eight alphanumeric characters,
beginning with an alphabetic character.
acctname Specifies the account in which the user resides.
The name must consist of one to eight alphanumeric
characters, beginning with an alphabetic character.
You must have system manager (SM) capability to use
this parameter from outside the account, or you
must have account manager (AM) capability to use
this parameter from within the account.
PASS Specifies the user password, used for verifying
logon access only. The password must consist of
one to eight alphanumeric characters, beginning
with an alphabetic character. The default is that
no password is assigned.
If you omit the parameter PASS, the existing
password, if any, does not change. If you include
PASS but do not provide its value password, the
current password is removed.
CAP Specifies the list of capabilities permitted for
the user. Each capability is indicated by a two
letter mnemonic, separated by commas, as follows:
SM = System manager
AM = Account manager
AL = Account librarian
GL = Group librarian
DI = Diagnostician
OP = System supervisor
NA = Network administrator
NM = Node manager
SF = Save files
ND = Access to nonshareable I/O devices
UV = Use volumes
CV = Create volumes
CS = Use communication subsystem
PS = Programmatic sessions
LG = User logging
PH = Process handling
DS = Extra data segments
MR = Multiple RINs
PM = Privileged mode
IA = Interactive access
BA = Batch access
The default is IA, BA, ND, and SF.
Note the following points about this parameter:
* Capabilities assigned to the user cannot
exceed those assigned to the account.
* Any capabilities removed from the account
cannot be assigned to the user.
* The user's capabilities are always verified
to be a subset of the account's capabilities
at logon. This prevents a user from having
a capability not assigned to the account.
HOME Specifies the name of an existing group to be
assigned as the user's home group. The first user
established when an account is created, by default,
has PUB assigned as the home group. Subsequent new
users, by default, have no home group assigned. If
no home group is assigned, the user must always
specify a group when logging on.
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break does not affect this command.
You must have account manager (AM) capability to enter this
command. You must have system manager (SM) capability to specify
a user in an account other than your own.
* Altering user parameters
Basic guidelines for altering user parameters are as follows:
* You can enter multiple parameters on a single command line
by using the semicolon (;) delimiter.
* If more than one user within an account is assigned AM
capability, you can remove the capability from all but one
user.
* When you omit an entire parameter, the corresponding value
for the group remains unchanged.
* When you include a parameter but omit its value as in
PASS=Return, the default value is assigned.
* You cannot remove SM capability from MANAGER.SYS.
* You cannot remove your own AM capability.
* Activating the changes
If you alter one or more parameters, the changes in the directory
become effective immediately, however, the changes do not affect
any active users until they log off from their current sessions
and log back on to the same user name and account. Since the
system does not automatically generate a message informing users
of changes, you should notify users before you make any changes.
Examples
* To change the capability list of the user JONES from IA, BA, SF,
PH, and DS to include privileged mode (PM) capability, enter:
:ALTUSER JONES;CAP=IA,BA,SF,PH,DS,PM
* To change the password and capability list of JONES, enter:
:ALTUSER JONES;PASS=JJ;CAP=IA,BA,SF,PH,DS,PM
Related Commands
ALTACCT
ALTGROUP
LISTACCT
LISTGROUP
LISTUSER
NEWACCT
NEWGROUP
NEWUSER
BREAKJOB
The BREAKJOB command suspends any executing job, including spooled and
streamed jobs. A job using a critical system resource does not suspend
until it releases the resource.
Syntax
BREAKJOB #Jnnn
Parameters
#Jnnn Specifies a job number.
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break does not affect this command.
You must enter this command from the console. You can enter this
command from a terminal other than the console under one of the
following conditions:
* The JOBSECURITY command is set to LOW and the job is logged
on to your user account. (AM users only need to match the
job's account name.)
* Your system administrator has used the ALLOW command, which
permits you to enter this command.
* Nonshareable devices
When you enter this command for a job that controls a nonshareable
device, a console message appears that lists the device(s) that
the job controls. As many as ten devices may be listed. You can
then decide whether to allow the job to continue running until it
releases the device(s), or whether you should abort the job.
Examples
* To suspend the processing of job number 68, enter:
:BREAKJOB #J68
* To display suspended jobs, enter:
:SHOWJOB SUSP
JOBNUM STATE INPRI JIN JLIST INTRODUCED JOB NAME
#68 SUSP 105 LP WED. 7:56AM TEST,USER.ACCT
Related Commands
ALTJOB
ABORTJOB
CONSOLE
JOBSECURITY
RESUMEJOB
SHOWJOB
STREAM
MPE/iX 5.0 Documentation