add_element – Add an element to your Git repository from up the map in Endevor

Synopsis

Add an element to your Git repository from up the map in Endevor.

Parameters

context (type: str)

Git-Endevor mapping context (ID of the organization, project, team, or the Git repository owner).

mapping (type: str)

Git-Endevor mapping name (Git repository ID).

element_name (type: str)

Name of the Endevor element to add.

element_type (type: str)

Type of Endevor element to add.

endevor_system (type: str)

Endevor system where your project resides.

endevor_subsystem (type: str)

Endevor subsystem where your project resides.

with_dependencies (type: bool)

If specified, add the requested element (for example, COBOL copybooks) with dependencies.

force_get_dependencies (type: bool)

If specified, bypass the maximum number of dependencies. This only applies to the repository administrator.

branch_id (type: str)

If specified, add the requested elements to the selected branch.

all_branches (type: bool)

If specified, add the requested elements to all synchronized branches in your repository.

file (type: path)

If specified, read the elements to add from file.

Ensure that the file is in the format specified in the documentation and follows the example:

[

{

“fullElmName”: “ELMNAME”,

“typeName”: “ELMTYPE”

}

]

.

endevor_protocol (type: str)

Endevor SCM Rest API protocol.

Default: http.

Choices:

  • http

  • https

endevor_host (type: str)

Endevor Rest API hostname.

endevor_port (type: int)

Endevor Rest API port.

endevor_user (type: str)

Mainframe (Endevor) username (can be the same as your TSO login).

endevor_password (type: str)

Mainframe (Endevor) password (can be the same as your TSO password).

endevor_reject_unauthorized (type: bool)

Reject self-signed certificates.

Default: true.

endevor_base_path (type: str)

The Endevor SCM Rest API base path.

Default: EndevorService/rest.

protocol (required, type: str)

Endevor Bridge for Git SCM protocol.

Default: https.

Choices:

  • http

  • https

host (required, type: str)

Endevor Bridge for Git hostname.

port (required, type: int)

Endevor Bridge for Git port.

user (required, type: str)

Endevor Bridge for Git username (your git username).

token (required, type: str)

Git personal access token (Obtain the token from your Git Enterprise Server).

reject_unauthorized (type: bool)

Reject self-signed certificates.

Default: false.

ebg_base_path (type: str)

The Endevor Bridge for Git Rest API base path.

password (type: str)

Password to authenticate to service on the mainframe.

cert_file (type: path)

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.

cert_key_file (type: path)

The file path to a certificate key file to use for authentication.

Examples

- name: Add an element 'MY-ELEMENT-TYPE / MY-ELEMENT-NAME' for your mapping 'MY-CONTEXT / MY-MAPPING'
  broadcom.endevor_bridge_for_git.add_element:
    context: MY-CONTEXT
    mapping: MY-MAPPING
    element_name: MY-ELEMENT-NAME
    element_type: MY-ELEMENT-TYPE

- name: Add multiple elements for your mapping 'MY-CONTEXT / MY-MAPPING' from file
  broadcom.endevor_bridge_for_git.add_element:
    context: MY-CONTEXT
    mapping: MY-MAPPING
    file: MY-FILEPATH.json

Return Values

data (type: list, when returned data is a dictionary)

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.

error (type: complex, error)

More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters.

additional_details (type: str)

Detailed message about the failure.

msg (type: str)

Short description of the result or failure.

request (type: str, API request failed)

HTTP method used to invoke API service request.

resource (type: str, API request failed)

URI of the resource of the API service request.

failed (type: bool, always)

A boolean that indicates if the task was failed or not.

list (type: list, when returned data is a list)

Data from the module execution (a list of data structures).

msg (type: str, sometimes)

Short description of the result or failure.

rc (type: int, always)

Exit code of the module, successful exit code is 0, failure is typically 1 or higher.

stderr (type: str, error)

Details of the error.

stdout (type: str, success)

Summary of the result.

Status

  • This module is maintained by Broadcom.