broadcom.endevor_bridge_for_git.build_job_submit (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 from git local repository in Endevor by submitting a job. It supports autogen for building dependencies using with the option of selecting autogen span. After submitting, the command 'build job-report' must be issued to finalize processing.

Usage examples

Scanned by Steampunk Spotter

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

- name: Compile the changed elements at "/endevor/ebg/repository" using work area with ID "WORKAREA1", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles
  broadcom.endevor_bridge_for_git.build_job_submit:
    work_area_id: WORKAREA1
    skeleton_jcl: /endevor/jcl/jcl.txt
    work_dir: /endevor/ebg/repository

Scanned by Steampunk Spotter

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

- name: Compile the changed elements at "/endevor/ebg/repository" using build subsystem "SUBNAME", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles
  broadcom.endevor_bridge_for_git.build_job_submit:
    endevor_subsystem: SUBNAME
    endevor_environment: ENVNAME
    endevor_system: SYSNAME
    skeleton_jcl: /endevor/jcl/jcl.txt
    work_dir: /endevor/ebg/repository

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

zosmf_host:
    description:
    - The z/OSMF server host name.
    required: false
    type: str

zosmf_port:
    description:
    - The z/OSMF server port.
    - ''
    - 'Default value: 443'
    required: false
    type: int

zosmf_user:
    description:
    - Mainframe (z/OSMF) username, which can be the same as your TSO login.
    required: false
    type: str

autogen_span:
    choices:
    - NONE
    - ALL
    - SYSTEMS
    - SUBSYSTEMS
    default: NONE
    description:
    - Specifies the autogen action option to automatically generate using elements.
    - 'The allowed values which have the following meaning:'
    - NONE - Generates all elements that use the component being acted upon.
    - ALL - Generates using elements that are found in any System and Subsystem combinations
      within the Environment and Stage of the component's logical map.
    - SYSTEMS - Generates using elements that are found in any System, provided the element's
      Subsystem name matches the name of the Subsystem of the target component.
    - SUBSYSTEMS - Generates using elements from all Subsystems with the same-named System
      of the component specified.
    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

skeleton_jcl:
    description:
    - 'The path of the file of skeleton JCL to submit endevor scl statements. Download
      it from: https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/devops/ca-endevor-integrations-for-enterprise-devops/1-0/ca-endevor-bridge-for-git/set-up-and-run-the-ca-endevor-bridge-for-git/configuration-for-build-using-zowe-cli.html.'
    required: true
    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

zosmf_password:
    description:
    - Mainframe (z/OSMF) password, which can be the same as your TSO password.
    required: false
    type: str

zosmf_base_path:
    description:
    - The base path for your Zowe API Mediation Layer instance. Specify this option toprepend
      the base path to all z/OSMF resources when making REST requests. Do notspecify this
      option if you are not using an Zowe API Mediation Layer.
    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

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