zowe › system-automation › stop › resource🖨️

Issues a stop request, that will cause the resource to stop in case the request is winning.

Requires (min.): SA Operations API 1.0.0

Following Success Message can be created by this command:
SACLI010100 - Requesting stop of resource {ResourceName} success

Usage

zowe system-automation stop resource [options]

Options

• --id (string)

  • The ID of the resource

• --name (string)

  • The name of the resource

• --type (string)

  • The type of the resource

    Allowed values: APL, APG, SYS, MTR, GRP, SYG, DMN, REF

• --system (string)

  • The system of the resource

• --priority | --prio (string)

  • The priority of this start request

    Default value: LOW
    Allowed values: LOW, HIGH, FORCE

• --override (array)

  • Overrides to be considered for the request

    Allowed values: NO, ALL, DPY, FLG, STS, TRG, SUS

• --comment (string)

  • Comment.

• --scope (string)

  • Whether the startup affects a resource or its descendants or both

    Default value: ONLY
    Allowed values: ALL, ONLY

• --restart (string)

  • Restart the resource after it shutdown conpletely

    Default value: NO
    Allowed values: YES, NO

Profile Options

• --sa-profile | --sa-p (string)

  • The name of a (sa) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --host | -H (string)

  • Host name of service on the mainframe.

• --port | -P (number)

  • Port number of service on the mainframe.

• --user | -u (string)

  • User name to authenticate to service on the mainframe.

• --password | --pass | --pw (string)

  • Password to authenticate to service on the mainframe.

• --reject-unauthorized | --ru (boolean)

  • Reject self-signed certificates.

    Default value: true

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file path)

  • The file path to a certificate file to use for authentication

• --cert-key-file (local file path)

  • The file path to a certificate key file to use for authentication

Examples

• Issue stop request on resource with ID <RESOURCE_ID>. Use the ID that is displayed in "zowe sa list resources --showid":

  • zowe system-automation stop resource --id=RESOURCE_ID Copy

• Issue stop request on resource with name <RESOURCE_NAME>It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>:

  • zowe system-automation stop resource --name=RESOURCE_NAME Copy

• Stop a resource identified by ID specifying a priority and a comment:

  • zowe system-automation stop resource --id=RESOURCE_ID --priority=low --comment="This is a request comment" Copy

• Stop a resource identified by ID specifying override value to the "FLG" and "STS":

  • zowe system-automation stop resource --id=RESOURCE_ID ----override=flg sts Copy