broadcom.endevor_bridge_for_git.build_execute (2.6.0) — module

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

Build changes against remote git repository's Endevor Bridge for Git synchronized branch, using work area or build subsystem.It does not support autogen for building dependencies.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Compile the changed elements in the current Git working directory using the work area "WORKAREA1" and an existing Endevor profile
  broadcom.endevor_bridge_for_git.build_execute:
    endevor_instance: INSTANCE
    work_area_id: WORKAREA1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Compile the changed elements in the current Git working directory using the build subsystem "SUBNAME" and an existing Endevor profile
  broadcom.endevor_bridge_for_git.build_execute:
    endevor_instance: INSTANCE
    endevor_subsystem: SUBNAME
    endevor_environment: ENVNAME
    endevor_system: SYSNAME

Inputs

    
host:
    description:
    - Host name of service on the mainframe.
    required: false
    type: str

port:
    description:
    - Port number of service on the mainframe.
    required: false
    type: int

user:
    description:
    - User name to authenticate to service on the mainframe.
    required: false
    type: str

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

work_dir:
    default: ./
    description:
    - The local working directory of your Git-Endevor mapping that you are building.
    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

listing_rc:
    default: 4
    description:
    - All the elements that have a generate result equal to or greater than "listing-rc"
      will have their build outputs downloaded into "listing-dir".
    required: false
    type: int

listing_dir:
    default: .endevor/listings
    description:
    - Specify the directory where you would like to have your build outputs downloaded.
    required: false
    type: str

endevor_host:
    description:
    - The Endevor Rest API hostname.
    required: false
    type: str

endevor_port:
    description:
    - The Endevor Rest API port.
    required: false
    type: int

endevor_user:
    description:
    - Mainframe (Endevor) username, which can be the same as your TSO login.
    required: false
    type: str

work_area_id:
    description:
    - Endevor work area ID. Name-masking is not allowed.
    required: false
    type: str

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

force_cleanup:
    description:
    - Starts the build process after cleaning the build subsystem.
    required: false
    type: bool

endevor_system:
    description:
    - The Endevor SCM system where your build subsystem resides.
    required: false
    type: str

endevor_instance:
    description:
    - The Endevor Web Services Endevor configuration name.
    required: false
    type: str

endevor_password:
    description:
    - Mainframe (Endevor) password, which can be the same as your TSO password.
    required: false
    type: str

endevor_protocol:
    choices:
    - http
    - https
    description:
    - 'The Endevor SCM Rest API protocol. '
    - ''
    - 'Default value: http'
    required: false
    type: str

endevor_base_path:
    description:
    - 'The Endevor SCM Rest API base path. '
    - ''
    - 'Default value: EndevorService/rest'
    required: false
    type: str

endevor_subsystem:
    description:
    - 'The Endevor SCM build subsystem. Note: The build subsystem can be cleared without
      prior permission.'
    required: false
    type: str

endevor_environment:
    description:
    - The Endevor SCM environment where your build subsystem resides.
    required: false
    type: str

reject_unauthorized:
    default: true
    description:
    - Reject self-signed certificates.
    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

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