broadcom.endevor_bridge_for_git.endevor_connection_create (2.5.8) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: broadcom.endevor_bridge_for_git
      version: 2.5.8

Description

Create new Endevor connection for Endevor Bridge for Git.

Usage examples

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

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

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

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.
    required: false
    type: path

connection:
    description:
    - Endevor connection name.
    required: true
    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

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

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

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