RESET function

The RESET function corresponds to the RESet line command, which can be issued for objects from the TOBJOR view, sets from the TSETO view, or Definition Bases from the TDEFBS view.

Use the RESET function to reset indicators and counters for the following items:

  • One or more objects or the objects within a set
  • All of the objects within a Definition Base

Related topic

Using-the-TOM-programming-interface

Important

When an operator manually stops an object, you should use the START function (without specifying the FORCE keyword) to return an object to an active status.

Often, users choose to use the RESET function however, when you use the START function (without FORCE), you can specify the system where the object will be set to active. The RESET function does not provide this capability.

The following lists the parameters you can use to reset an object or a set:

Command

Parameters

TOMEXEC FUNCTION RESET [OBJECT | SET]

OBJECT(name)|SET(name)

RESETOPT ([ALL] | [OPER])

RESETOPT ([ABENDCT] [FORCED] [STARTCMDCT] [STATUS|RUNSTAT] [SUSPEND] [OMODE]

RESETOPT (INFLIGHT)

SCOPE ([ALL] | [CHILDREN] | [PARENTS] | [NONE])

[NOTE('xxx')]

[TOMID(tom ID) | TOMPLEX(tomplex name)]

The following table lists the parameters you can use to reset a Definition Base:

Command

Parameters

TOMEXEC FUNCTION RESET DEFBASE

DEFBASE(name)

RESETOPT ([ALL] [CNTLMODE] [IPLOCCUR] [OMODE] )

[SYSPLEX(name]

[TOMID(tom ID) | TOMPLEX(tomplex name)]

The following table describes the parameters:

Parameter

Function

OBJECT

Specify the object name to be reset.

You cannot specify the OBJECT and SET parameters together.

For information about specifying the object name, see Object-and-set-naming-restrictions.

SET

Specify the set name to be reset.

You cannot specify the OBJECT and SET parameters together.

For information about specifying the set name, see Object-and-set-naming-restrictions.

DEFBASE

Specify the object Definition Base to be reset.

The object Definition Base does not have to ACTIVE.

You cannot specify DEFBASE with the OBJECT, SET, or SCOPE parameters.

RESETOPT (when specifying the OBJECT or SET parameter)

For the OBJECT or SET parameters, specify either RESETOPT(ALL) to reset all of the following object attributes or RESETOPT with one (or more) of the following values:

  • ABENDCT resets the number of abnormal termination events to zero.
  • FORCED resets the indicator that states the object was started by an operator using START command with the FORCE option.
  • STARTCMDCT resets the START command count to zero.
  • STATUS attempts to bring the object's status to its desired state from the actual state on each system in its VSL. It also resets the exception indicator and the stopped-in-dependency-order indicator.

  • RUNSTAT attempts to bring the object's status to its desired state on each system in its VSL, with the exception of these statuses:

    • SCHEDULED-START, SCHEDULED-STOP
    • SCHEDULED-LOCKED, SCHEDULED-BLOCKED
    • LOCKED, BLOCKED

    If the status is STARTING, STOPPING, ACTIVE-BOUNCE, or BOUNCED and there is a pending, in-flight start, stop or bounce in progress, the status will not be reset.

  • SUSPEND resets the control mode attribute for an object from SUSPEND to ACTIVE.
  • INFLIGHT cancels a pending start or stop of an object during the wait for its start or stop-validation-event and during the scheduling of its pre-start or pre-stop commands.
  • OMODE resets the operating mode (also referred to as OMODE) of the object. All of the Valid System List (VSL) entries that are defined for the object are reset with this option. When the OMODE is reset for an object, TOM might start or stop any dependent objects that define the dependency using the @OMODE property.

Or, specify RESETOPT(OPER) to reset the following subset of values:

  • ABENDCT
  • FORCED
  • STARTCMDCT
  • RUNSTAT

You cannot specify the CNTLMODE and IPLOCCUR parameters with the OBJECT or SET parameters.

For more information about using the RUNSTAT and OPER parameters, see RUNSTAT and OPER parameters .

Enclose multiple keywords in parentheses ( ).

RESETOPT (when specifying the DEFBASE parameter)

For the DEFBASE parameter, specify either RESETOPT(ALL) to reset all of the following object attributes, or specify RESETOPT with one (or more) of the following values:

  • CNTLMODE changes the control mode from SUSPEND to ACTIVE for each object in the Definition Base specified by the DEFBASE parameter.
  • IPLOCCUR resets the reinstatement IPL occurrence count to zero for all of the objects that have reinstatement attributes specified in the selected Definition Base.
  • OMODE resets the operating mode (also referred to as OMODE) for each object in the Definition Base. All of the Valid System List (VSL) entries that are defined for the object are reset with this option. When the OMODE is reset for an object, TOM might start or stop any dependent objects that define the dependency using the @OMODE property.

You cannot specify the ABENDCT, FORCED, STARTCMDCT, STATUS, RUNSTAT,SUSPEND, OPER, and INFLIGHT with the DEFBASE parameter. The specified object Definition Base does not have to be ACTIVE.

Enclose multiple parameters in parentheses ( ).

SCOPE

Specify which (if any) of the object's dependencies (parents or children) are affected by the RESET command.

Specify SCOPE with one of the following values:

  • ALL resets the named object and all of its dependencies and dependents and is an alternative way of specifying SCOPE(PARENTS,CHILDREN).
  • PARENTS includes the selected object and its dependencies, which includes all of the objects in its dependency tree to the oldest parents.
  • CHILDREN includes the selected object and its dependents, which includes all of the objects in the dependency tree to the newest descendents.
  • NONE resets only the named object. NONE is the same as not specifying SCOPE.

The SCOPE keyword is optional. If you do not specify it, the reset function applies only to the object or set of objects specified in the request.

You cannot specify the SCOPE keyword with the DEFBASE() parameter.

See RESET-Return-codes for more information about how SCOPE affects an object or set.

SYSPLEX

Specify the name of the sysplex that is associated with the Definition Base to be reset.

If you do not specify a sysplex name, the RESET command resets the Definition Base for the local sysplex.

NOTE

Specify a reason for the action taken.

By default this parameter is optional but it is required if you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

If NOTE('xxx') is required but is not specified, the request will be rejected with RC147. Error message MAMOD2035E is written to the log.

TOMID

Specify the ID of the TOM PAS on which you want the command issued.

TOMPLEX

Specify the name of the TOMPLEX where you want to issue the function.

See Specifying-the-TOMID-and-TOMPLEX-parameters for usage information.

RUNSTAT and OPER parameters

Use the RUNSTAT and OPER parameters with the OBJECT or SET parameters to simplify which values the RESET function affects.

Warning

The RESET function can significantly impact objects in a Definition Base. Use caution when choosing which options you want to RESET because you can unintentionally change additional object, set, or Definition Base attributes.

Use the RUNSTAT parameter when you want to reconcile the object's actual state to its desired state. Specifying RUNSTAT means that TOM ensures the object's actual state matches the desired state when the object is:

  • Not in a transitional status
  • Has a LOCKED or BLOCKED status

If the status of the object on the local system is a transitional one or is LOCKED or BLOCKED, TOM processing ignores the RESET RESETOPT(RUNSTAT) request. If the object has any other status, the RESET RESETOPT(RUNSTAT) request causes TOM to schedule an evaluation cycle to reconcile the objects in the active Definition Base to their desired state.

The OPER parameter groups together the following keywords that the operations staff are most likely to use to ensure an object meets availability goals:

  • ABENDCT
  • STARTCMDCT
  • FORCED
  • RUNSTAT

Use RESET RESETOPT(OPER) to perform the following actions:

  • Clear counters and exception indicators for an object
  • Cause TOM to ensure that the actual state of the object corresponds to the desired state of the object.

Using the OPER parameter prevents you from unintentionally changing the control mode of an object in SUSPEND mode to ACTIVE mode. It also prevents the RESET from unintentionally un-locking or un-blocking the object, which may cause it to start or affect the status of related objects.

You can secure who can issue the following RESET functions:

  • RESET with any RESETOPT keywords
  • RESET RESETOPT(ALL)
  • RESET RESETOPT(OPER)

For example, you might decide to prevent users from the RESETOPT(ALL) option (which might un-lock, un-block, or un-suspend objects) but authorize them to use RESET RESETOPT(OPER). For more information about these security resources, see Managing security for BMC AMI Ops products.

This section contains the following topics:

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*