/ home / broadcom / broadcom.endevor_bridge_for_git / 2.6.0 / module / branch_add

broadcom.endevor_bridge_for_git.branch_add (2.6.0) — module

Add a branch to an existing mapping

| "added in version" 1.0.0 of broadcom.endevor_bridge_for_git"

Authors: Zachariah Mullen <zachariah.mullen@broadcom.com> (@broadcom)

| supported by Broadcom

This plugin has a corresponding action plugin.

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

Add a branch to an existing mapping.

Usage examples

Scanned by Steampunk Spotter

- name: Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile
  broadcom.endevor_bridge_for_git.branch_add:
    context: MY-CONTEXT
    mapping: MY-MAPPING
    branch: MY-BRANCH
    endevor_system: SYSNAME
    endevor_subsystem: SUBNAME
    endevor_environment: ENVNAME

Scanned by Steampunk Spotter

- name: Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different environment
  broadcom.endevor_bridge_for_git.branch_add:
    context: MY-CONTEXT
    mapping: MY-MAPPING
    branch: MY-BRANCH
    endevor_environment: DIFFERENT_ENVIRONMENT
    like: TEMPLATE_BRANCH

Scanned by Steampunk Spotter

- name: Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different system/subsystem
  broadcom.endevor_bridge_for_git.branch_add:
    context: MY-CONTEXT
    mapping: MY-MAPPING
    branch: MY-BRANCH
    endevor_system: DIFFERENT_SYSTEM
    endevor_subsystem: DIFFERENT_SUBSYSTEM
    like: TEMPLATE_BRANCH

Inputs

    
host:
    description:
    - The Endevor Bridge for Git hostname.
    required: true
    type: str

like:
    description:
    - Add branch using parameters from another branch in the same repository.
    required: false
    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

branch:
    description:
    - Name of the branch that will be added/removed.
    required: true
    type: str

context:
    description:
    - Git-Endevor mapping context (ID of the organization, project, team or owner of the
      Git repository).
    required: true
    type: str

mapping:
    description:
    - Git-Endevor mapping name (ID of the Git repository).
    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.
    - ''
    - '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

read_only:
    description:
    - If specified, it is necessary to use the option --endevor-stage-number. The synchronized
      elements will be read-only.
    required: false
    type: bool

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

mapping_mode:
    choices:
    - FULL
    - WORK_ENV_ONLY
    - MIRROR
    description:
    - Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR').
    required: false
    type: str

system_alias:
    description:
    - The alias of Endevor system.
    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_system:
    description:
    - The Endevor system where your project resides.
    required: false
    type: str

subsystem_alias:
    description:
    - The alias of Endevor subsystem.
    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

repository_check:
    choices:
    - REQUIRE_EMPTY
    - ALLOW_NON_EMPTY
    default: REQUIRE_EMPTY
    description:
    - If set to allowNonEmpty, user can proceed with initialization of the branch even
      if the branch exists.
    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 subsystem where your project resides.
    required: false
    type: str

endevor_environment:
    description:
    - The Endevor environment where your project resides.
    required: false
    type: str

reject_unauthorized:
    description:
    - 'Reject self-signed certificates. '
    - ''
    - 'Default value: false'
    required: false
    type: bool

endevor_stage_number:
    description:
    - The Endevor stage where your project resides (only for read only mappings).
    required: false
    type: str

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