broadcom.endevor.synchronize_workspace (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

Synchronize a selected subset of remote Endevor inventory with a local Endevor workspace.

Usage examples

Scanned by Steampunk Spotter

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

- name: Synchronize all elements in the map location defined by the currently active endevor-location profile with current directory
  broadcom.endevor.synchronize_workspace:

Scanned by Steampunk Spotter

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

- name: Synchronize all elements in the map location defined by the currently active endevor-location profile with workspace directory 'C:/projects/myWorkspace'
  broadcom.endevor.synchronize_workspace:
    workspace_dir: C:/projects/myWorkspace

Scanned by Steampunk Spotter

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

- name: Synchronize all elements in the map location defined by the currently active endevor-location profile, whose name is 'PRFX' followed by any 2 characters and ending with '11', with workspace directory 'C:/projects/myWorkspace'
  broadcom.endevor.synchronize_workspace:
    workspace_dir: C:/projects/myWorkspace
    ccid: myccid
    comment: my changes
    element: PRFX%%11

Scanned by Steampunk Spotter

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

- name: Revert all local changes in the map location defined by the currently active endevor-location profile, resetting your workspace to match Endevor
  broadcom.endevor.synchronize_workspace:
    reset: y

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

reset:
    description:
    - Revert any local changes, resetting the local workspace to match the current state
      of the remote Endevor inventory.
    required: false
    type: bool

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:
    default: '*'
    description:
    - Name filter to synchronize only specific Endevor element(s).
    required: false
    type: str

one_way:
    description:
    - Do not update Endevor elements with local changes, only retrieve remote changes
      from Endevor and resolve any conflicts.
    required: false
    type: bool

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

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

allow_deletes:
    description:
    - Allow workspace synchronization to delete unchanged Endevor elements when it detects
      the corresponding local files have been deleted. Default is off to maintain backward
      compatibility.
    required: false
    type: bool

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

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

file_extension:
    choices:
    - none
    - file-ext
    - type-name
    - mixed
    default: mixed
    description:
    - 'The strategy for deciding what file extension to use during a bulk retrieve or
      workspace synchronization. Must be one of the following:'
    - ''
    - '     none: File name is equal to element name, no extension is added.'
    - ''
    - '     file-ext: The file extension defined in the Type definition is used; If not
      defined, no extension is added.'
    - ''
    - '     type-name: The type name is used as the file extension.'
    - ''
    - '     mixed: The file extension defined in Type definition is used; If not defined,
      the type name is used instead.'
    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

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