Try SpotterThe retrieve element module retrieves an existing 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 retrieve element module retrieves an existing element in Endevor.
- name: Retrieve element from specified inventory location to local file with endevor profile set up
broadcom.endevor.retrieve_element:
element: elementName
environment: ENVNAME
system: SYSNAME
subsystem: SUBNAME
type: TYPENAME
stage_number: 1
to_file: localfile.txt
instance: ENDEVOR
- name: Bulk Retrieve elements with wildcarded element name and type, to local directory with endevor profile set up
broadcom.endevor.retrieve_element:
element: '*'
environment: ENVNAME
system: SYSNAME
subsystem: SUBNAME
type: '*'
stage_number: 1
to_dir: /user/localdir
instance: ENDEVOR
ccid:
description:
- The CCID you want to use when performing an Element action.
required: false
type: str
flat:
description:
- ' Store the output of the bulk action within one folder. When you use this option,
ensure that the results do not contain duplicate names. (Duplicate names occur when
two or more Elements have the same name and type.).'
required: false
type: bool
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
to_dir:
description:
- Directory name in which the module output will be stored.
required: false
type: str
charset:
description:
- Specifies the clients preferred character set when retrieving, printing or updating
elements.
required: false
type: str
comment:
description:
- The comment you want to have when performing an Element action.
required: false
type: str
element:
description:
- Name of the Endevor element.
required: true
type: str
signout:
description:
- Specify if you want to perform the action with signing the element out.
required: false
type: bool
to_file:
description:
- The file name in which the data from the module output is stored.
required: false
type: str
to_path:
description:
- Provide a USS path to a destination location.
required: false
type: str
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
to_member:
description:
- Provide a destination member name inside the data set.
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
to_dataset:
description:
- Provide a destination data set name.
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
to_uss_file:
description:
- Provide a USS file as a destination file.
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
file_extension:
choices:
- none
- file-ext
- type-name
- mixed
default: mixed
description:
- 'The strategy for deciding what file extension to use during a bulk retrieve or
workspace synchronization. Must be one of the following:'
- ''
- ' none: File name is equal to element name, no extension is added.'
- ''
- ' file-ext: The file extension defined in the Type definition is used; If not
defined, no extension is added.'
- ''
- ' type-name: The type name is used as the file extension.'
- ''
- ' mixed: The file extension defined in Type definition is used; If not defined,
the type name is used instead.'
required: false
type: str
replace_member:
description:
- Specify if you want to replace the member currently in the library with the new
element contents.
required: false
type: bool
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
expand_includes:
description:
- Indicates that INCLUDE statements should be expanded in the course of the action.
required: false
type: bool
get_fingerprint:
description:
- Return fingerprint of a retrieved, added or updated element as the first line of
the response.
required: false
type: bool
override_signout:
description:
- Specify if you want to override the Signout of an Endevor element while performing
this action.
required: false
type: bool
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_change:
description:
- 'This option is only valid when the data option is ele or comp. Instructs Endevor
to filter the results of the list data summary function that is based on the specified
ccids. '
- Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters
in quotes.
required: false
type: str
with_dependencies:
description:
- Retrieve Elements, including their Endevor-managed input components.
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
where_ccid_lastact:
description:
- 'Instructs Endevor to search using the last action CCID associated with an Element. '
- Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters
in quotes.
required: false
type: str
where_ccid_lastlvl:
description:
- 'Instructs Endevor to search using the last level CCID associated with an Element. '
- Accepts 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_generate:
description:
- 'Instructs Endevor to search using the generate CCID associated with an Element. '
- Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters
in quotes.
required: false
type: str
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
response_format_type:
choices:
- table
- list
- object
- string
description:
- 'The module 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 module 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
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