INGSET

Purpose

INGSET is a line-mode command that is primarily used in automation REXX scripts. With the INGSET command you can:

  • Remove an operator's request
  • Set a status attribute or automation flag for a resource or application group
  • Clear or set the hold flag for a resource or application group
  • Set the start or stop type for a resource

Syntax

Read syntax diagramSkip visual syntax diagramINGSETCANCELresourceREQUEST= requestSOURCE= sourceConfirmKILLresourceREQUEST= requestSOURCE= sourceVERIFY=NOSETresourceStatus optionsCommand_ParmFlagsEXPIRED=(date,00:00,time)WAIT=YESWAIT=NOWAIT= nnnTARGET=system_namedomain_idsaplex_nameOUTMODE=LINEAUTONETLOG
Confirm
Read syntax diagramSkip visual syntax diagramVERIFY=YESVERIFY=NOWTOR
Status options
Read syntax diagramSkip visual syntax diagramOBSERVED= statusAUTOSTAT= statusHEALTH= status
Command_Parm
Read syntax diagramSkip visual syntax diagramSTARTPARM=parm*STOPPARM=parm*STARTTYPE= starttypeSTOPTYPE= stoptype
Flags
Read syntax diagramSkip visual syntax diagramAUTOFLAG=YESNOHOLDFLAG=YESNOGRPFAILED=YESNO

Parameters

CANCEL
Removes a request.
resource
Specifies the resource that the request is to be canceled for. The format is name/type/system. Wildcard is supported.
KILL
Removes a request without verifying. To perform verification, specify the VERIFY parameter.
resource
Specifies the resource that the request is to be killed for. The format is name/type/system. Wildcard is supported.
SET
Sets one or more resource attributes. The following settings can be made:
  • Observed status
  • The health status
  • Automation status
  • Automation flags
  • Hold flag
  • Start type for next startup
  • Stop type for next shutdown
Wildcard is supported for the SET parameter.
resource
Specifies the resource that an attribute is to be set for. The format is name/type/system. Wildcard is supported.
REQUEST
Causes the request to be canceled. You can specify one of the following:
  • MAKEAVAILABLE/MakeAvailable
  • MAKEAVAILABLESO/MakeAvailable_Only
  • MAKEUNAVAILABLE/MakeUnAvailable
  • MAKEUNAVAILABLESC/MakeUnAvailable_Children
  • MAKEUNAVAILABLESO/MakeUnAvailable_Only
  • SUSPENDSO/Suspend_Only
  • SUSPENDSA/Suspend_All
Wildcard is supported, for example, REQUEST=MAKEUN*

A MAKEAVAILABLE/MakeAvailable vote on a resource reflects an INGREQ resource,REQ=UP,SCOPE=ALL. That is, the vote is inherited from the resource that it was issued against by all of its dependent resources.

A MAKEAVAILABLESO/MakeAvailable_Only vote on a resource reflects an INGREQ resource,REQ=UP,SCOPE=ONLY. That is, the vote is not inherited from the resource that it was issued against by all of its dependent resources, but only by that resource.

A MAKEUNAVAILABLE/MakeUnAvailable vote on a resource reflects an INGREQ resource,REQ=DOWN,SCOPE=ALL. That is, the vote is inherited from the resource that it was issued against by the resource and all of its dependent resources.

A MAKEUNAVAILABLESC/MakeUnAvailable_Children vote on a resource reflects an INGREQ resource,REQ=DOWN,SCOPE=CHILDREN. That is, the vote is inherited from the resource that it was issued against by all of its dependent resources, but it does not affect the resource itself.

A MAKEUNAVAILABLESO/MakeUnAvailable_Only vote on a resource reflects an INGREQ resource,REQ=DOWN,SCOPE=ONLY. That is, the vote is not inherited from the resource that it was issued against by all of its dependent resources, but affects only that resource.

A SUSPENDSO/Suspend_Only vote on a resource reflects an INGSUSPD resource,REQ=SUSPEND,SCOPE=ONLY. That is, the vote is not inherited from the resource that it was issued against by all of its dependent resources, but affects only that resource.

A SUSPENDSA/Suspend_All vote on a resource reflects an INGSUSPD resource,REQ=SUSPEND,SCOPE=ALL. That is, the vote is inherited from the resource that it was issued against by the resource and all of its dependent resources.

SOURCE
Specifies the source of the request, for example OPERATOR, or AUTOOPS. Wildcard is supported, for example, SOURCE=*
OBSERVED
Specifies the observed status to be assigned to the resource. The status can be abbreviated, for example, to AV for available. Here is a list of possible Observed Status values and their shortest possible abbreviations: AVAILABLE (A), UNKNOWN (U), SYSGONE (SY), SOFTDOWN (SO), HARDDOWN (H), STARTING (STAR), DEGRADED (D), STOPPING (STO), PROBLEM (P), WASAVAILABLE (W), and STANDBY (STAN).
AUTOSTAT
Specifies the automation status to be assigned to the resource. The status can be abbreviated, for example, to ID for idle. Here is a list of possible Autostat Status values and their shortest possible abbreviations: UNKNOWN (U), IDLE (ID), ORDERED (O), BUSY (B), DENIED (D), PROBLEM (P), and INTERNAL (IN).
HEALTH
Specifies the health status to be assigned to the resource. The status can be abbreviated, for example, to NO for normal. Here is a list of possible Health Status values and their shortest possible abbreviations: SYSGONE (S), UNKNOWN (U), NORMAL (N), WARNING (W), MINOR (M), CRITICAL (C), and FATAL (F).
EXPIRED
Specifies the expiry date and time of the request. Any request older than or equal to the specified timestamp is deleted when the other filter criteria are matched. The date format is yyyy-mm-dd and the time format is hh:mm. The time specification is optional.
CAUTION:
Care must be taken when using the EXPIRED parameter for a remote sysplex that runs in a different time zone. The local time of the system where INGSET CANCEL/KILL command is issued determines whether or not the request is expired.
WAIT
Specifies whether or not to wait until the request is complete. The default is YES.

nnn is the number of seconds to wait before giving up and reporting that a timeout has occurred. The maximum time interval is 999 seconds.

VERIFY
Specifies whether canceling the request is to be verified. The following specifications are valid:
YES
Depending on the NetView task type that the INGREQ or INGSUSPD command is running on, the verification is either displayed on a fullscreen panel or, in line mode, shown on the console. The latter is also done when OUTMODE=LINE is coded.
NO
No verification is performed. VERIFY is set to NO for AUTOTASKs. Otherwise, it is set to YES.
WTOR
The list of affected resources is displayed before the request is removed. The operator is prompted to verify the list via WTOR.

The default depends on the type of task that the INGREQ or INGSUSPD command runs on.

TARGET
For information on the TARGET parameter, see TARGET Parameter.
OUTMODE
For information on the OUTMODE parameter, see OUTMODE Parameter.
STARTPARM
Is the START parameter that is passed to the next START command. The value that is specified here is used only once and takes precedence over the PARM value that is specified on the next INGREQ (REQ=START) command. Use * to reset its value.
STOPPARM
Is the STOP parameter that is passed to the next STOP command. The value that is specified here is used only once and takes precedence over the PARM value that is specified on the next INGREQ (REQ=STOP) command. Use * to reset its value.
STARTTYPE
Specifies the type of command to be issued for the resource's next startup. The value specified here is used only once and takes precedence over the TYPE value specified on the next INGREQ (REQ=START) command.
STOPTYPE
Specifies the type of command to be issued for the resource's next shutdown. The value specified here is used only once and takes precedence over the TYPE value specified on the next INGREQ (REQ=STOP) command. However, a stop type of FORCE, wherever specified, will always be honored.
AUTOFLAG
Specifies the automation flag. It can be either YES or NO. It can be abbreviated.
HOLDFLAG
Specifies whether the resource is to be started. It can be either YES or NO. The HOLD flag can only be set if the resource is down, that is if its observed status is either HardDown, SoftDown, SysGone, or Unknown.
GRPFAILED
Specifies the group failed flag. It can be either YES or NO.
The INGSET command supports resource level security. If turned on, the following profiles in SYSAUTO are checked:
Profile Authority Condition
AGT.sysplex.xcfgrp.RES.resname.restype[.ressys] UPDATE When function is CANCEL or KILL
CONTROL When function option is SET

Security Considerations

If multiple resources are affected, multiple profiles are checked. For SET requests, the request is carried out or rejected as a whole. CANCEL and KILL requests are processed for each profile.

For further details, refer to IBM Z System Automation Planning and Installation.

Return Codes

The following return codes can occur:

0
The request was processed successfully.
1
An error occurred while processing the request or exit requested.

Usage

Note that if you cancel the verification process of a list of affected resources, SA z/OS® may issue a slightly misleading message. Although the verification has been canceled, message AOF099I FUNCTION COMPLETED may be returned.

Examples

To cancel a previously issued request to make a resource available, enter the following: 
INGSET CANCEL TSO/APL/KEY1 REQUEST=MAKEAVAILABLE SOURCE=OPERATOR
To set the start type for the next startup of a JES2 resource to COLD, enter the following: 
INGSET SET JES2/APL/KEY1 STARTTYPE=COLD