agent_cred_get_agent_credentials_status – Get Agent credentials status for CA 7 instance specified in path

Synopsis

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

Parameters

ca7_id (required, type: str)

CA7ONL Instance.

userid (required, type: str)

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.

agent (type: str)

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.

job_type (type: str)

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 (type: str)

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.

host (required, type: str)

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

port (required, type: int)

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

user (required, type: str)

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

password (required, type: str)

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

base_path (type: str)

The base path for your Zowe 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 Zowe API Mediation Layer.

protocol (required, type: str)

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

Choices:

  • http

  • https

reject_unauthorized (type: bool, default: True)

Reject self-signed certificates.

cert_file (type: 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 (type: path)

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

Examples

- name: Get the Agent credential status associated with a user wlaagent for INSTANCE1
  broadcom.ca7.agent_cred_get_agent_credentials_status:
    userid: wlaagent

Return Values

data (type: list, when returned data is a dictionary)

Data from the module execution (a data structure). The items of this dict are set as individual return values on the top level as well.

error (type: complex, error)

More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters.

additional_details (type: str)

Detailed message about the failure.

msg (type: str)

Short description of the result or failure.

request (type: str, API request failed)

HTTP method used to invoke API service request.

resource (type: str, API request failed)

URI of the resource of the API service request.

failed (type: bool, always)

A boolean that indicates if the task was failed or not.

list (type: list, when returned data is a list)

Data from the module execution (a list of data structures).

msg (type: str, sometimes)

Short description of the result or failure.

rc (type: int, always)

Exit code of the module, successful exit code is 0, failure is typically 1 or higher.

stderr (type: str, error)

Details of the error.

stdout (type: str, success)

Summary of the result.

Status

  • This module is maintained by Broadcom.