ca7_instances_post_list_instance – Find Instances

Synopsis

Find all configured instances that have all the properties in the request.

Parameters

name (type: str)

The unique name of this instance.

This is the name to be used in all API requests.

ca7_host (type: str)

The CA7ONL host IP/DNS.

ca7_port (type: int)

The CA7ONL port.

ca7_secure (type: bool)

True, if the communication with CA 7 should use secure sockets.

ca7_keystore (type: str)

The full path to the keystore/truststore file used for SSL communication to CA7ONL.

ca7_protocol (type: str)

The SSL protocol to be used for secure socket communication with CA7ONL.

The default is TLSv1.2.

If it is not specified the default will be used.

ca7_communicator_pool_size (type: int)

The maximum number of connections to be opened to a CA7ONL instance.

This must be a positive value that does not exceed the maximum number of terminals.

ca7_communicator_evictable_idle_time_seconds (type: int)

The time, in seconds, to keep an existing connection open.

If the connection is not used and the idle time passes, the connection will be closed.

ca7_authorization_retry_count (type: int)

The number of retries to be used for access to endpoint authorization.

If HttpStatus.SERVICE_UNAVAILABLE is returned, the authorization will be retried up to ca7_authorizationRetryCount.

The default is 5.

ca7_timeout (type: int)

The timeout, in seconds, used when connecting to and reading from CA 7 via the TCP/IP terminal interface.

The default is 60.

ca7_use_uid_filter (type: bool)

Flag to turn on/off the UID/COIDs usage

Default: false.

ca7_pool_retry (type: int)

How many times to try to get the communicator from the pool

Default: 10.

ca7_pool_retry_timeout (type: int)

The time interval between 2 attempts to get the communicator from the pool, in milliseconds

Default: 500.

db_logical_name (type: str)

The logical database name

If not specified in the instance configuration, the name will need to be passed as a parameter to the request.

db_host (type: str)

The Datacom server host IP/DNS

If not specified in the instance configuration, all the requests that requires Datacom connection will fail.

db_port (type: int)

The Datacom server port

If not specified in the instance configuration, all the requests that requires Datacom connection will fail.

db_user (type: str)

The Datacom user ID

If not specified in the instance configuration, all the requests that requires Datacom connection will fail.

db_server_name (type: str)

The Datacom server name

If not specified in the instance configuration, all the requests that requires Datacom connection will fail.

db_secure (type: bool)

Flag to be set to true if the connection to db will be done using SSL

The default is false.

db_trust_store (type: str)

The full path to the keystore/truststore file used for SSL communication to Datacom.

db_protocol (type: str)

The SSL protocol to be used for secure socket communication with Datacom.

The default is TLSv1.2.

If it is not specified, the default will be used.

db_max_pool (type: int)

The maximum number of Datacom connections to be available in the same time.

Default: 10.

db_min_pool (type: int)

The minimum number of Datacom connections to be kept idle when they are not used

Default: 0.

db_timeout (type: int)

The connection to Datacom timeout in seconds

Default: 60.

db_trace (type: bool)

Flag to turn on/off the jdbc trace on the RestApi side for Datacom queries

Default: false.

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: Find all configured instances that have all the properties in the request
  broadcom.ca7.ca7_instances_post_list_instance:
    name: INSTANCE1
    ca7_host: myhost.domain.com
    ca7_port: 12345

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.