Try SpotterThe list environments module lists environments 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 list environments module lists environments in Endevor.
- name: List all environments in Endevor with endevor profile set up
broadcom.endevor.list_environments:
instance: ENDEVOR
host:
description:
- Specifies the base host name.
required: false
type: str
path:
choices:
- log
- phy
description:
- Specifies a PHYsical or LOGical path.
required: false
type: str
port:
description:
- Specifies the port number.
required: false
type: str
user:
description:
- Specifies the user name.
required: false
type: str
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
return:
choices:
- fir
- all
description:
- 'Sets mapping options for returned results: return FIRst match or ALL matching results.'
required: false
type: str
search:
description:
- Enables the search through the Endevor map.
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
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:
- Name of the Endevor environment.
required: false
type: str
full_output:
description:
- Specify this option if you want a full output of list action.
required: false
type: bool
report_file:
description:
- File name for saving reports from Endevor SCM locally.
required: false
type: str
asynchronous:
description:
- Submit this module as an asynchronous Endevor Web Services task.
required: false
type: bool
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
suppress_messages:
description:
- Suppress all [INFO]/[WARN] messages from terminal output.
required: false
type: bool
reject_unauthorized:
description:
- Specify this option to have the server certificate verified against the list of
supplied CAs.
required: false
type: bool
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