zowe › ca7 › agent › stopAgent🖨️

Stop an Agent. This operation will stop the specified Agent.

Note: WARNING: If successful, the Agent will be stopped and no longer available to accept work. The Agent must be manually started.

Usage

zowe ca7 agent stopAgent [options]

Required Options

• --ca7Id (string)

  • CA7ONL Instance

• --agent-name | --agname (string)

  • Specifies the name of the Agent for which to retrieve additional details.
    Limits: 1 to 16 alphanumeric characters

Options

• --os (string)

  • Specifies the operating system of the Agent as known by the Scheduler.
    WindowsLinuxUnixetc.Default: Linux

CA7 Connection Options

• --host | -H (string)

  • Host name of the CA7 API service that is running on the mainframe system.

• --port | -P (number)

  • Port for the CA7 API service that is running on the mainframe system.

• --user | -u (string)

  • User name for authenticating connections to the CA7 API service that is running on the mainframe system.

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

  • Password for authenticating connections to the CA7 API service that is running on the mainframe system.

• --base-path | --bp (string)

  • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

• --protocol | -o (string)

  • Specifies protocol to use for CA7 connection (http or https).

    Allowed values: http, https

Profile Options

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

  • The name of a (ca7) 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

• --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.

    Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

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

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

Examples

• Stop Agent AGENTTEST for INSTANCE1:

  • zowe ca7 agent stopAgent --agname AGENTTEST --ca7Id INSTANCE1 Copy