endevor_connection_create – Create new Endevor connection
Synopsis
Create new Endevor connection for Endevor Bridge for Git.
Parameters
- connection (required, type: str)
Endevor connection name.
- endevor_instance (type: str)
The Endevor Web Services Endevor configuration name.
- endevor_protocol (type: str)
The Endevor SCM Rest API protocol.
Default value: http
- Choices:
http
https
- endevor_host (type: str)
The Endevor Rest API hostname.
- endevor_port (type: int)
The Endevor Rest API port.
- endevor_user (type: str)
Mainframe (Endevor) username, which can be the same as your TSO login.
- endevor_password (type: str)
Mainframe (Endevor) password, which can be the same as your TSO password.
- endevor_reject_unauthorized (type: bool)
Reject self-signed certificates.
Default value: true
- endevor_base_path (type: str)
The Endevor SCM Rest API base path.
Default value: EndevorService/rest
- protocol (required, type: str, default:
https
)The Endevor Bridge for Git SCM protocol.
Default value: https
- Choices:
http
https
←- host (required, type: str)
The Endevor Bridge for Git hostname.
- port (required, type: int)
The 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 (it can be obtained from your Git Enterprise Server).
- reject_unauthorized (type: bool)
Reject self-signed certificates.
Default value: false
- 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: Create the Endevor connection 'MY-CONNECTION' using the default EBG and Endevor profile
broadcom.endevor_bridge_for_git.endevor_connection_create:
connection: MY-CONNECTION
endevor_instance: INSTANCE
- name: Create the Endevor connection 'MY-CONNECTION' using the default EBG profile
broadcom.endevor_bridge_for_git.endevor_connection_create:
connection: MY-CONNECTION
endevor_instance: INSTANCE
endevor_protocol: http
endevor_host: endevor-host
endevor_port: 12345
- name: Create the Endevor connection 'MY-CONNECTION' using the default Endevor profile
broadcom.endevor_bridge_for_git.endevor_connection_create:
connection: MY-CONNECTION
endevor_instance: INSTANCE
protocol: http
host: bridge-host
port: 8080
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.