.. _unsynchronize_workspace_module:


unsynchronize_workspace -- Remove a selected subset of remote Endevor inventory from a local Endevor workspace
==============================================================================================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Remove a selected subset of remote Endevor inventory from a local Endevor workspace.







Parameters
----------

  workspace_dir (type: str)
    The Endevor workspace directory, if different from current working directory.



  environment (type: str)
    The Endevor environment where your project resides.



  system (type: str)
    The Endevor system where your project resides.



  subsystem (type: str)
    The Endevor subsystem where your project resides.



  type (type: str)
    Name of the Endevor element's type.



  stage_number (type: str)
    The Endevor stage number where your project resides.


    Choices:
      * ``\*`` 
      * ``\%`` 
      * ``1`` 
      * ``2`` 

  element (type: str, default: ``*``)
    Name filter to synchronize only specific Endevor element(s).



  force (type: bool)
    Force unsynchronization of local workspace regardless of any local changes not yet saved into Endevor.



  host (type: str)
    Specifies the base host name.



  port (type: str)
    Specifies the port number.



  instance (type: str)
    Specifies Endevor Web Services dataSource name.



  protocol (type: str, default: ``https``)
    Specifies the protocol used for connecting to Endevor Rest API.


    Choices:
      * ``http`` 
      * ``https`` **←**

  user (type: str)
    Specifies the user name.



  password (type: str)
    Specifies the user's password.



  reject_unauthorized (type: bool)
    Specify this option to have the server certificate verified against the list of supplied CAs.



  base_path (type: str)
    Specifies the base path used for connecting to Endevor Rest API.



  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
--------

.. code-block:: yaml+jinja

    
    - name: Remove all elements in the map location defined by the currently active endevor-location profile from current directory
      broadcom.endevor.unsynchronize_workspace:

    - name: Remove all elements in the map location defined by the currently active endevor-location profile from current directory, throwing away any local changes not saved in Endevor
      broadcom.endevor.unsynchronize_workspace:
        force: y

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




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.