broadcom.endevor_bridge_for_git.mapping_list (2.6.0) — module

List Git-Endevor mappings

| "added in version" 1.0.0 of broadcom.endevor_bridge_for_git"

Authors: Zachariah Mullen <zachariah.mullen@broadcom.com> (@broadcom)

| supported by Broadcom

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install broadcom.endevor_bridge_for_git:==2.6.0


Add to requirements.yml

  collections:
    - name: broadcom.endevor_bridge_for_git
      version: 2.6.0

Description

List Git-Endevor mappings. If the mapping contains multiple systems and/or subsystems, the field 'system' and 'subsystem' will contain the value 'multi'.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List all the Git-Endevor mappings using the default EBG profile
  broadcom.endevor_bridge_for_git.mapping_list:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List all the Git-Endevor mappings and show their Endevor details using the default EBG profile
  broadcom.endevor_bridge_for_git.mapping_list:
    view: endevor
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List all the Git-Endevor mappings and show all their details using the default EBG profile
  broadcom.endevor_bridge_for_git.mapping_list:
    view: all
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List all the Git-Endevor mappings without an EBG profile
  broadcom.endevor_bridge_for_git.mapping_list:
    protocol: http
    host: my-host
    port: 8080
    user: my-git-username
    token: 1234567890

Inputs

    
host:
    description:
    - The Endevor Bridge for Git hostname.
    required: true
    type: str

port:
    description:
    - The Endevor Bridge for Git port.
    required: true
    type: int

user:
    description:
    - Endevor Bridge for Git username (your git username).
    required: true
    type: str

view:
    choices:
    - default
    - endevor
    - all
    default: default
    description:
    - Type of detail to be displayed.
    required: false
    type: str

token:
    description:
    - Git personal access token (it can be obtained from your Git Enterprise Server).
    required: true
    type: str

export:
    description:
    - Export list of mapping to a json file.
    required: false
    type: bool

password:
    description:
    - Password to authenticate to service on the mainframe.
    required: false
    type: str

protocol:
    choices:
    - http
    - https
    default: https
    description:
    - 'The Endevor Bridge for Git SCM protocol. '
    - ''
    - 'Default value: https'
    required: true
    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

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

reject_unauthorized:
    description:
    - 'Reject self-signed certificates. '
    - ''
    - 'Default value: false'
    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