• AnsibleFest
  • Products
  • Community
  • Webinars & Training
  • Blog
Ansible Logo
Broadcom Ansible Collections for Mainframe documentation
Broadcom Ansible Collections for Mainframe

Getting Started

  • Requirements
  • Installation
  • Using collections
  • Connection methods and details
  • Troubleshooting

Collections

  • broadcom.ca7
  • broadcom.dbm_db2
  • broadcom.endevor
    • add_element – The add element module lets you add an Element to an Environment entry Stage in Endevor
    • approve_package – The approve package module approves Package in Endevor for execution
    • backin_package – The backin package module reverses the backout action and returns the Package to a status of Executed
    • backout_package – The backout package module restores the executable and output modules of the Package to the status they were in before execution
    • cast_package – The cast package module prepares the Package for review and subsequent execution. Casting a Package freezes the contents of the Package and prevents further changes to the Package
    • check_instance – The check instance module triggers the web services health check for a given instance
    • commit_package – The commit package module commits a Package, which removes all backout/backin data while retaining Package event information
    • confirm_resolution – Confirm a manual conflict resolution inside an Endevor workspace file is complete
    • create_package – The create package module lets you create a package in Endevor
    • delete_element – The delete element module deletes an Element from the specified inventory location in Endevor
    • delete_package – The delete package module lets you delete Packages of any status type in Endevor
    • deny_package – The deny package module changes the status of a Package to Denied
    • execute_package – The execute package module executes a Package that have a status of Approved or Execfailed
    • generate_element – The generate element module executes the generate Processor for the current level of the Element
    • initialize_workspace – Initialize current directory as an Endevor workspace
    • list_code_page_config – The list code-page-config module lists the EBCDIC code page mapping rules used by Endevor Web Services
    • list_defaults – List the contents of the main Endevor configuration table (C1DEFLTS)
    • list_dialog – List the contents of the Endevor ISPF dialog defaults table (ENDIECFG)
    • list_elements – The list elements module lists element information in Endevor
    • list_environments – The list environments module lists environments in Endevor
    • list_features – List the contents of the Endevor optional features table (ENCOPTBL)
    • list_instances – The list instances module lists instances used by Endevor Web Services
    • list_packages – The list packages module lists package information in Endevor
    • list_processor_groups – The list processor-groups module lists processor group information in Endevor
    • list_processor_symbols – The list processor-symbols module lists processor group symbol overrides information in Endevor
    • list_stages – The list stages module lists stages in Endevor SCM
    • list_subsystems – The list subsystems module lists subsystem information in Endevor
    • list_symbols – List the Endevor site symbols
    • list_systems – The list systems module lists system information in Endevor
    • list_tasks – List asynchronous tasks submitted by this user
    • list_type_sequence – List the contents of the Endevor type sequence
    • list_types – The list types module lists type information in Endevor
    • merge_element – Merge Endevor elements from one Endevor location into another. Requires an initialized Endevor workspace to perform conflict resolution. Use “synchronize workspace” module afterwards to push the result back into Endevor
    • move_element – The move element module moves Elements between inventory locations along a map
    • print_components – The print component module prints selected component information about Element in Endevor
    • print_element – The print element module prints selected information about Element in Endevor
    • print_member – The print member module prints a member from a specified dataset
      • Synopsis
      • Parameters
      • Examples
      • Return Values
      • Status
    • queryacm_components – Query components used by a specified Element with the Endevor ACM Query facility
    • reset_package – The reset package module lets you set the status of a Package back to In-edit so you can modify it
    • retrieve_element – The retrieve element module retrieves an existing element in Endevor
    • retrieve_result – Retrieve the result of an asynchronous task
    • signin_element – The signin element module signs in an existing element in Endevor
    • submit_package – The submit package module submits a JCL job stream to execute one or more Packages
    • submit_scl – The submit scl modules submits a SCL file to be executed
    • synchronize_workspace – Synchronize a selected subset of remote Endevor inventory with a local Endevor workspace
    • transfer_element – The Transfer element module transfers Elements from one Endevor location to another
    • unsynchronize_workspace – Remove a selected subset of remote Endevor inventory from a local Endevor workspace
    • update_element – The update element module updates an Element in the entry Stage, thereby creating a new level for the Element in the entry Stage.
    • update_package – The update package module lets you update a package in Endevor
    • view_element – The view element module views an existing element in Endevor
    • view_pkgscl – The view pkgscl module views the SCL of an existing package in Endevor
  • broadcom.endevor_bridge_for_git
  • broadcom.file_master_plus
  • broadcom.idms
  • broadcom.jclcheck
  • broadcom.mat
  • broadcom.mat_pma_util
  • broadcom.ops
  • broadcom.spool
  • broadcom.sysview
  • broadcom.view
  • broadcom.zowe_core
  • broadcom.zowe_core_3
Broadcom Ansible Collections for Mainframe
  • broadcom.endevor
  • print_member – The print member module prints a member from a specified dataset
  • View page source

print_member – The print member module prints a member from a specified dataset

  • Synopsis

  • Parameters

  • Examples

  • Return Values

  • Status

Synopsis

The print member module prints a member from a specified dataset.

Parameters

member (required, type: str)

Name of the member.

from_dataset (type: str)

Use this input to provide source data set name.

headings (type: bool)

Specify it if you want to print a header on each page.

charset (type: str)

Specifies the clients preferred character set when retrieving, printing or updating elements.

asynchronous (type: bool)

Submit this module as an asynchronous Endevor Web Services task.

to_file (type: str)

The file name in which the data from the module output is stored.

host (type: str)

Specifies the base host name.

port (type: str)

Specifies the port number.

instance (type: str)

Specifies Endevor Web Services dataSource name.

protocol (type: str, default: https)

Specifies the protocol used for connecting to Endevor Rest API.

Choices:

  • http

  • https ←

user (type: str)

Specifies the user name.

password (type: str)

Specifies the user’s password.

reject_unauthorized (type: bool)

Specify this option to have the server certificate verified against the list of supplied CAs.

base_path (type: str)

Specifies the base path used for connecting to Endevor Rest API.

suppress_messages (type: bool)

Suppress all [INFO]/[WARN] messages from terminal output.

report_file (type: str)

File name for saving reports from Endevor SCM locally.

report_dir (type: str)

Directory for saving reports from Endevor SCM locally, if wasn’t specified. Defaults to current directory.

write_report (type: bool)

Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false.

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: Print a member from specified dataset
  broadcom.endevor.print_member:
    member: memName
    from_dataset: DSNAME
    instance: ENDEVOR

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.

Previous Next

© Copyright 2022, Broadcom.

Built with Sphinx using a Sphinx Ansible Theme that is based on the Read the Docs theme and is maintained by the Ansible Community.