beautypg.com

Mvscommand – Visara Master Console Center Scripting Guide User Manual

Page 221

background image

Chapter 6 Obsolete Material

Scripting Guide

221

MVSCOMMAND

Syntax:

MVSCOMMAND( %ObjID, $CmdArray, $Output Array, %ErrArray

$ErrorTextArray[, %PortID] [, $JobName] [, $Filter1] [, $Filter2] [,

$Filter3] [, %MvsMsgCount] [, %MvsResponseTime] ) ==>
%ReturnValue

Description:

Enters commands to MVS using the GW-MVS agent.

Action:

The commands in the $CmdArray parameter are issued to the OS

(LPAR) referenced by the ObjID parameter.

Parameters:

%ObjID. Numeric expression. The unique object identifier of the OS

to which to send the commands. Refer to Object ID on page 26 for more
information.
$CmdArray. Normal string array. The array of MVS commands to

execute on the target OS.
Note: Each command string must be less than eighty (80) characters

long.
$OutputArray. Associative array. Holds the text outputs of the
MVSCOMMANDS. The output is bounded by ===> and <===

characters, allowing the user to determine the output from each
command.
%ErrorArray. Normal integer array. Each command in $CmdArray

will have a corresponding element in %ErrorArray indicating the error
status of that command. A value of zero (0) indicates successful

submission to the host.
Note: A success (0) situation does not necessarily guarantee successful

processing. The command may have been submitted successfully, but

the action could not be completed on the host.
$ErrorTextArray. Normal string array. Each command in the

$CmdArray will have a corresponding string in $ErrorTextArray.

Each entry will give diagnostic information describing any problems
that occurred when submitting the command to the host.
%PortID. Numeric expression. Optional. The port to use to KEY the
commands to if the host service is unavailable. MVSCOMMAND will

automatically KEY all of the commands to the specified port when

necessary. The alternate route uses the KEY() command behind the
scenes. Specifying zero (0) indicates that an alternate route should not

be used if the service is unavailable, instead just returning an error

code. If not specified, zero (0) is the default.
$JobName. String expression. Optional. A filter to restrict output

from the submitted commands to only those which correspond to this
job name. The output is read using the QREAD() command.
$Filter1, 2, 3. String expression. Optional. These filters are used to
qualify which lines will be output from the submitted commands.

$Filter2 will be ignored unless $Filter1 is not empty. Similarly,

$Filter3 will be ignored unless $Filter2 is not empty.
Note: There is a 15-character limit on the size of each filter string.
$MvsMsgCount. Numeric expression. Optional. The maximum

number of messages (possibly filtered) that will return in the MVS-