broadcom.idms.issue_dcmt_test (1.1.4) — module

Install collection

Install with ansible-galaxy collection install broadcom.idms:==1.1.4

Add to requirements.yml

  collections:
    - name: broadcom.idms
      version: 1.1.4

Description

Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.

The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by IDMS technical support
  broadcom.idms.issue_dcmt_test:
    args: debug options

Inputs

    
args:
    description:
    - DCMT TEST command arguments. Specifies which debugging options to use.
    required: true
    type: str

host:
    description:
    - Host name of the IDMS REST API service.
    required: false
    type: str

port:
    description:
    - Port for the IDMS REST API service.
    required: false
    type: int

user:
    description:
    - Mainframe user name, which can be the same as your TSO login ID.
    required: false
    type: str

password:
    description:
    - Mainframe password, which can be the same as your TSO password.
    required: false
    type: str

base_path:
    description:
    - 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. Only specify this
      option if you are using an Zowe API Mediation Layer.
    required: false
    type: str

broadcast:
    description:
    - Broadcast parameters used if the system is part of a data sharing group.
    required: false
    type: str

cert_file:
    description:
    - 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.'
    required: false
    type: path

datasource:
    description:
    - Identifies the IDMS system where the API request will be sent and is defined in
      the data sources definition file for the IDMS REST API.
    required: false
    type: str

cert_key_file:
    description:
    - The file path to a certificate key file to use for authentication.
    required: false
    type: path

reject_unauthorized:
    default: true
    description:
    - Reject self-signed certificates.
    required: false
    type: bool

response_format_type:
    choices:
    - table
    - list
    - object
    - string
    description:
    - 'The command response output format type. Must be one of the following:'
    - ''
    - 'table: Formats output data as a table. Use this option when the output data is
      an array of homogeneous JSON objects. Each property of the object will become a
      column in the table.'
    - ''
    - 'list: Formats output data as a list of strings. Can be used on any data type (JSON
      objects/arrays) are stringified and a new line is added after each entry in an array.'
    - ''
    - 'object: Formats output data as a list of prettified objects (or single object).
      Can be used in place of "table" to change from tabular output to a list of prettified
      objects.'
    - ''
    - 'string: Formats output data as a string. JSON objects/arrays are stringified.'
    required: false
    type: str

response_format_filter:
    description:
    - Filter (include) fields in the response. Accepts an array of field/property names
      to include in the output response. You can filter JSON objects properties OR table
      columns/fields. In addition, you can use this option in conjunction with '--response-format-type'
      to reduce the output of a command to a single field/property or a list of a single
      field/property.
    elements: str
    required: false
    type: list

response_format_header:
    description:
    - If "--response-format-type table" is specified, include the column headers in the
      output.
    required: false
    type: bool

Outputs

data:
  description: 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.
  elements: dict
  returned: when returned data is a dictionary
  type: list
error:
  contains:
    additional_details:
      description: Detailed message about the failure.
      type: str
    msg:
      description: Short description of the result or failure.
      type: str
    request:
      description: HTTP method used to invoke API service request.
      returned: API request failed
      type: str
    resource:
      description: URI of the resource of the API service request.
      returned: API request failed
      type: str
  description: More details about why the action has failed. If the failure is when
    calling an API service, the response contains the connection parameters.
  returned: error
  type: complex
failed:
  description: A boolean that indicates if the task was failed or not.
  returned: always
  type: bool
list:
  description: Data from the module execution (a list of data structures).
  elements: dict
  returned: when returned data is a list
  type: list
msg:
  description: Short description of the result or failure.
  returned: sometimes
  type: str
rc:
  description: Exit code of the module, successful exit code is 0, failure is typically
    1 or higher.
  returned: always
  type: int
stderr:
  description: Details of the error.
  returned: error
  type: str
stdout:
  description: Summary of the result.
  returned: success
  type: str