broadcom.endevor.merge_element (7.7.2) — module

Install collection

Install with ansible-galaxy collection install broadcom.endevor:==7.7.2

Add to requirements.yml

  collections:
    - name: broadcom.endevor
      version: 7.7.2

Description

Merge Endevor elements from one Endevor location into another. Requires an initialized Endevor workspace to perform conflict resolution. Use "synchronize workspace" module afterwards to push the result back into Endevor.

Usage examples

Scanned by Steampunk Spotter

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

- name: Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into the same element found in subsystem SUBTO (system, stage and env taken from current location profile)
  broadcom.endevor.merge_element:
    element: ELEMENT1
    subsystem: SUBTO
    type: COBPGM
    merge_subsystem: SUBFROM

Scanned by Steampunk Spotter

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

- name: Merge any elements that are currently out of sync with their next element version up the map (map location determined by current profile)
  broadcom.endevor.merge_element:
    element: '*'
    merge_out_of_sync: y

Scanned by Steampunk Spotter

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

- name: Report which elements are currently out of sync with their next element version up the map, but do not merge them yet (map location determined by current profile)
  broadcom.endevor.merge_element:
    element: '*'
    merge_out_of_sync: y
    dry_run: y

Scanned by Steampunk Spotter

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

- name: Merge all elements from system SYSFROM, subsystem SUBFROM into matching elements in system SYSTO subsystem SUBTO (system, stage and env taken from current location profile)
  broadcom.endevor.merge_element:
    element: '*'
    system: SYSTO
    subsystem: SUBTO
    merge_system: SYSFROM
    merge_subsystem: SUBFROM

Inputs

    
ccid:
    description:
    - The CCID you want to use when performing an Element action.
    required: false
    type: str

host:
    description:
    - Specifies the base host name.
    required: false
    type: str

port:
    description:
    - Specifies the port number.
    required: false
    type: str

type:
    description:
    - Name of the Endevor element's type.
    required: false
    type: str

user:
    description:
    - Specifies the user name.
    required: false
    type: str

limit:
    description:
    - If the synchronization would need to perform more than 'limit' Endevor actions,
      do not perform the actions now, only report them. 0 means no limit.
    required: false
    type: int

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

comment:
    description:
    - The comment you want to have when performing an Element action.
    required: false
    type: str

dry_run:
    description:
    - List all actions the synchronization would perform, without executing them.
    required: false
    type: bool

element:
    description:
    - Name of the Endevor element.
    required: false
    type: str

signout:
    description:
    - Specify if you want to perform the action with signing out any retrieved elements.
    required: false
    type: bool

instance:
    description:
    - Specifies Endevor Web Services dataSource name.
    required: false
    type: str

password:
    description:
    - Specifies the user's password.
    required: false
    type: str

protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Specifies the protocol used for connecting to Endevor Rest API.
    required: false
    type: str

base_path:
    description:
    - Specifies the base path used for connecting to Endevor Rest API.
    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

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

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

merge_system:
    description:
    - Merge elements from this system into the target system (specified by 'system').
      Defaults to the same system as the target.
    required: false
    type: str

stage_number:
    choices:
    - \*
    - \%
    - '1'
    - '2'
    description:
    - The Endevor stage number where your project resides.
    required: false
    type: str

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

workspace_dir:
    default: .
    description:
    - The Endevor workspace directory, if different from current working directory.
    required: false
    type: str

merge_subsystem:
    description:
    - Merge elements from this subsystem into the target subsystem (specified by 'subsystem').
      Defaults to the same subsystem as the target.
    required: false
    type: str

override_signout:
    description:
    - Specify if you want to override the Signout of any Endevor elements affected by
      this action.
    required: false
    type: bool

merge_environment:
    description:
    - Merge elements from this environment to the target environment (specified by 'environment').
      Defaults to the same environment as the target.
    required: false
    type: str

merge_out_of_sync:
    description:
    - Merge out-of-sync elements at the target location with their next version in the
      map, and attempt to resolve the out-of-sync during the next synchronization with
      Endevor.
    required: false
    type: bool

merge_stage_number:
    description:
    - Merge elements from this stage number into the target stage number (specified by
      'stage-number'). Defaults to the same stage number as the target.
    required: false
    type: str

reject_unauthorized:
    description:
    - Specify this option to have the server certificate verified against the list of
      supplied CAs.
    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