zowe › system-automation › suspend › member🖨️

Suspend an agent (SAPlex member).

Requires (min.): SA Operations API 1.1.0

Following Success Message can be created by this command:
SACLI02300 - Request suspend of agent {AgentName} success

Usage

zowe system-automation suspend member [options]

Options

• --id (string)

  • The ID of the agent member

• --system (string)

  • The system hosting the agent member

• --role (string)

  • The role of the member

    Allowed values: AGENT, PAM, SAM

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

• Suspend an agent member with ID <MEMBER_ID>. Use the ID that is displayed in "zowe sa list members --showid":

  • zowe system-automation suspend member --id=MEMBER_ID Copy

• Suspend the agent on specified system:

  • zowe system-automation suspend member --system=SYSTEM_NAME --role=AGENT Copy

• Suspend member running on system <SYSTEM_NAME>:

  • zowe system-automation suspend member --system=SYSTEM_NAME Copy