Try SpotterThe print component module prints selected component information about Element in Endevor
| "added in version" 1.0.0 of broadcom.endevor"
Authors: Michal Vasak <michal.vasak@broadcom.com> (@broadcom), Andrey Makarenko <andrey.makarenko@broadcom.com> (@broadcom)
| supported by Broadcom
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install broadcom.endevor:==7.7.2
collections:
- name: broadcom.endevor
version: 7.7.2The print component module prints selected component information about Element in Endevor.
- name: Print selected component information about Element with endevor profile set up
broadcom.endevor.print_components:
element: elementName
environment: ENV
system: SYS
subsystem: SUB
type: TYPE
stage_number: 1
instance: ENDEVOR
host:
description:
- Specifies the base host name.
required: false
type: str
port:
description:
- Specifies the port number.
required: false
type: str
type:
description:
- Name of the Endevor element's type.
required: false
type: str
user:
description:
- Specifies the user name.
required: false
type: str
level:
description:
- Indicates the level number of the element (use along with the version option).
required: false
type: int
maxrc:
default: 8
description:
- The maximum value of the return code of a successful action. When the return code
is greater than the maxrc value, the module fails.
required: false
type: int
search:
description:
- Enables the search through the Endevor map.
required: false
type: bool
system:
description:
- The Endevor system where your project resides.
required: false
type: str
charset:
description:
- Specifies the clients preferred character set when retrieving, printing or updating
elements.
required: false
type: str
element:
description:
- Name of the Endevor element.
required: true
type: str
explode:
description:
- Specify to print component info from ACMQ.
required: false
type: bool
to_file:
description:
- The file name in which the data from the module output is stored.
required: false
type: str
headings:
description:
- Specify it if you want to print a header on each page.
required: false
type: bool
instance:
description:
- Specifies Endevor Web Services dataSource name.
required: false
type: str
password:
description:
- Specifies the user's password.
required: false
type: str
protocol:
choices:
- http
- https
default: https
description:
- Specifies the protocol used for connecting to Endevor Rest API.
required: false
type: str
base_path:
description:
- Specifies the base path used for connecting to Endevor Rest API.
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
subsystem:
description:
- The Endevor subsystem where your project resides.
required: false
type: str
print_comp:
choices:
- browse
- changes
- history
- summary
default: browse
description:
- Specify the type of data to print out for print component module.
required: false
type: str
report_dir:
description:
- Directory for saving reports from Endevor SCM locally, if wasn't specified. Defaults
to current directory.
required: false
type: str
environment:
description:
- The Endevor environment where your project resides.
required: false
type: str
report_file:
description:
- File name for saving reports from Endevor SCM locally.
required: false
type: str
stage_number:
choices:
- '1'
- '2'
description:
- The Endevor stage number where your project resides.
required: false
type: str
write_report:
description:
- 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.
required: false
type: bool
cert_key_file:
description:
- The file path to a certificate key file to use for authentication.
required: false
type: path
where_ccid_all:
description:
- 'Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels
for a specified CCIDs. '
- Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters
in quotes.
required: false
type: str
element_version:
description:
- Indicates the version number of the element (use along with the level option).
required: false
type: int
where_proc_group:
description:
- 'Lets you select Elements according to a specified Processor group. You can use
a wildcard when specifying the Processor group name. '
- 'Accepts up to 8 Processor group names separated by ", ". '
required: false
type: str
suppress_messages:
description:
- Suppress all [INFO]/[WARN] messages from terminal output.
required: false
type: bool
where_ccid_current:
description:
- 'Instructs Endevor to search through the CCID fields in the Master Control File
to find a specified CCIDs. '
- Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters
in quotes.
required: false
type: str
reject_unauthorized:
description:
- Specify this option to have the server certificate verified against the list of
supplied CAs.
required: false
type: bool
where_ccid_retrieve:
description:
- 'Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field. '
- Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters
in quotes.
required: false
type: str
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