zowe › ca7 › agent-cred › getAgentCredentialsStatus🖨️

Check for the presence of Agent credentials associated with the specified user ID, Agent name, job type and source.

Usage

zowe ca7 agent-cred getAgentCredentialsStatus [options]

Required Options

• --ca7Id (string)

  • CA7ONL Instance

• --userid (string)

  • Specifies a user ID that is passed with a password to an agent for authorization.
    Limits:
    1 to 128 characters. The wildcard characters * and ? are not permitted

Options

• --agent (string)

  • Specifies the agent that is the target of a job submission and where the user ID and password authorization takes place.

    Limits: 1 to 16 characters. The wildcard characters * and ? are not permitted

    Example: WINAGENT001

• --jobType (string)

  • Specifies the job type of the job that requires a user ID and password authorization.

    Limits: 1 to 16 characters. The wildcard characters * and ? are not permitted

    Example: NT_JOB

• --source (string)

  • Specifies the source field for a job that requires a user ID and password authorization. This property applies to agent job types which allow CONNECTIONUSER or PROXYUSER C-LANG statements.

    Limits: 1 to 64 characters. The wildcard characters * and ? are not permitted

    Example: example.domain.com

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

• Get the Agent credential status associated with a user wlaagent for INSTANCE1:

  • zowe ca7 agent-cred getAgentCredentialsStatus --userid wlaagent --ca7Id INSTANCE1 Copy