INGSUSPD
Purpose
The INGSUSPD command suspends and resumes automation for one or more resources. With RESUME, a previously made SUSPEND request from the same source can be canceled.
Syntax
To suspend automation for resources:
To resume automation for resources:
Parameters
- NETVASIS
- Prefix the INGSUSPD command with NETVASIS if you want to pass the description text in lower or mixed case.
- resource
- Specifies the name of the resource to be processed. The format is
name[/type[/system]]. Only resources of type APL, APG, and MTR
are supported.
Wildcards are supported as well. In full-screen mode, if more than one resource matches the wildcard specification, a selection panel is displayed. In line mode, if more than one resource matches the wildcard specification and MULT=YES is specified, all selected resources are processed. Multiple resource specification in line mode without MULT=YES causes an error message to be displayed.
Note: You need not specify the full name of the resource. This applies to the system as well as to the type. If the resource name is unique within the name space of the automation manager, the system name need not be specified. If the resource name is unique within the appropriate types, the type need not be specified. A valid resource name could be, for example, CICSPROD. - REQ
- Specifies the request to be carried out. It can be either SUSPEND or RESUME. With RESUME, a previously made SUSPEND request can be removed from the same resource.
- EXPIRE
- Specifies the expiry date and time of the request. The request is automatically removed when it
expires. The date format is yyyy-mm-dd; an asterisk (*) is used as today's
date. The time format is hh:mm.
Alternatively, you can specify a relative time, for example, +04:00. The relative time is automatically converted into the absolute date and time. The maximum relative time interval is 24:00 hours.
- REMOVE
- Indicates the condition when the request is automatically removed, regardless of whether the
request is satisfied or not. If the specified condition matches the observed status of the resource,
the request is deleted.
- SYSGONE
- If the system, where the automation agent runs, leaves the sysplex, the observed statuses of all resources running on that system become SYSGONE.
- *|NO
- Alternatively, you can specify an asterisk (*) or NO to reset the installation-defined default.
- TIMEOUT
- Specifies the interval that is used to check whether the request completes successfully. Either
a message is issued or the request is canceled, if the request is not satisfied after that time. The
format is mm.
- MSG
- Specifies that a message should be issued telling the notify operator that the request was not satisfied within the expected time interval. The default is to issue a message.
- CANCEL
- Specifies that the request should be canceled.
- VERIFY
- Specifies whether the SUSPEND or RESUME process should be verified. The following specifications
are valid:
- YES
- Depending on the NetView task type that the INGSUSPD command is running on, the verification is either displayed on a full-screen panel, or shown on the console in line mode. The latter is also done when OUTMODE=LINE is coded.
- WTOR
- The list of affected resources is displayed before the SUSPEND or RESUME begins. The operator is prompted to verify the list via WTOR.
- NO
- No verification is performed. VERIFY is set to NO for unattended tasks. Otherwise, it is set to YES.
The default depends on the type of task that the INGSUSPD command runs on.
- WAIT
- Specifies whether or not to wait until the request is complete. The default is YES.
The variable nnn is the number of seconds to wait before giving up and reporting that a timeout occurs. The maximum time interval is 999 seconds.
- CMT
- Specifies descriptive information about the request. The maximum length is 120 characters. If the text contains embedded blanks, it must be enclosed in quotation marks or parentheses.
- JOB
- Indicates that the specified resource is a job name. The job name can contain a wildcard.
- TARGET
- For information on the TARGET parameter, see TARGET Parameter.
- OUTMODE
- For information on the OUTMODE parameter, see OUTMODE Parameter.
- MULT
- Specifies that more than one resource will be accepted when running in line mode, if the resource wildcard specification results in multiple resources.
- SCOPE
- Specifies whether the SUSPEND affects only the resource or both the resource and
its descendants. Valid options are:
- ONLY
- Specifies that only the specified resource is suspended. This is the default.
- ALL
- Specifies that the resource and its descendants are suspended.
Restrictions and Limitations
To use the INGSUSPD command, system operations must be initialized.
Security Considerations
| Profile | Authority | Condition |
|---|---|---|
| AGT.sysplex.xcfgrp .RES.resname.restype[.ressys] |
UPDATE | Unless authority is CONTROL |
| CONTROL | When SCOPE is used with a value other than the default (IBM supplied or installation default) |
If multiple resources are affected, multiple profiles are checked. SUSPEND requests are carried out or rejected as a whole. RESUME requests are processed individually.
For more information, refer to IBM Z System Automation Planning and Installation.
Usage
The INGSUSPD command operates sysplexwide. For an overview, see Overview of Commands that Operate Sysplexwide.
Examples
INGSUSPD, a panel similar to Figure 1 is displayed. INGKYPS0 SA z/OS - Command Dialogs Page 1 of 1
Domain ID = IPXFI ---------- INGSUSPD ---------- Date = 10/25/16
Operator ID = NETOP1 Time = 18:52:41
Resource => CICS/APL/KEYC format: name/type/system
Target => System name, domain ID or sysplex name
Request => SUSPEND Requested action (SUSPEND or RESUME)
Scope => ONLY Request scope (ONLY/ALL)
Expire => , Expiration date(yyyy-mm-dd), time(hh:mm)
AutoRemove => Remove condition (SYSGONE/NO/*)
Verify => YES List affected resources(YES/NO/WTOR)
Comment =>
Timeout => 0 / MSG Interval in minutes / Option (MSG/CANCEL)
Command ===>
PF1=Help PF2=End PF3=Return PF6=Roll
PF8=NextPnl PF12=Retrieve
- The Resource field shows the name of the resource to be processed. The format is name/type[/system]. Only resources of type APL, APG, and MTR are supported. Wildcard is supported as well.
- The Target field shows the name of the system (system name, domain ID, or sysplex name) that the command should be routed to. Specifying this field is only necessary if the resources are not part of the local sysplex.
- The Request field shows the request to be carried out. This field is either SUSPEND or RESUME. With RESUME, a previously made SUSPEND request can be removed from the same resource.
- The Scope field shows whether the SUSPEND or RESUME affects only this resource or both this resource and its descendants.
- The Expire field shows the expiry date and time when the request is removed.
- The AutoRemove shows the condition when the request is automatically removed, regardless of whether the request is satisfied or not. If the specified condition matches the observed status of the resource, the request is deleted.
- The Verify field shows whether the SUSPEND or RESUME process should be verified. If YES or WTOR is entered, the list of affected resources is displayed before the request begins. You are prompted to verify the list. If WTOR is specified, you are prompted via a WTOR. If NO is entered, the request processing begins immediately. The default is YES.
- The Comment field specifies descriptive information, for example, why the request was made.
- The Timeout field shows the time period that the request must complete in. After this time interval, either a message is issued or the request is canceled.
