.. Reminder for header structure: Parts (H1) : #################### with overline Chapters (H2) : ******************** with overline Sections (H3) : ==================== Subsections (H4) : -------------------- Subsubsections (H5) : ^^^^^^^^^^^^^^^^^^^^ Paragraphs (H6) : """""""""""""""""""" .. meta:: :description: Using the WAPT Console :keywords: waptconsole, WAPT, documentation, the WAPT Console .. |ok| image:: wapt-resources/icon-ok.png :scale: 5% :alt: ok .. |nok| image:: wapt-resources/icon-nok.png :scale: 5% :alt: feature not available .. _wapt_console: ###################### Using the WAPT Console ###################### To install and start the WAPT Console visit the documentation for :ref:`installing the WAPT Console `. .. note:: If you have skipped the step for creating the WAPT Agent, return to the documentation on :ref:`building the WAPT Agent installer `. On your **management computer**, hosts are displayed in the WAPT Console. .. figure:: wapt-resources/wapt_console_registered-clients_container-window.png :align: center :alt: Inventory of hosts registered with WAPT .. note:: If a host does not appear in the WAPT Console after having installed the WAPT Agent, open the Windows command line utility :program:`cmd.exe` on the host and type :command:`wapt-get register`. .. _add_package_on_host: ******************************* Adding a WAPT package to a host ******************************* If you want to add WAPT packages directly on the host, you have to edit the *host* package. To do so, there are 3 methods: 1. Double-click on the host. 2. Right-click on the host then :guilabel:`Edit host`. 3. Select a host and use the :guilabel:`Edit host` button. Then, you just have to drag and drop wanted package(s) and confirm. .. figure:: wapt-resources/wapt_console_add_package_host_container-window.gif :align: center :alt: Method for adding a WAPT package onto a host Method for adding a WAPT package onto a host Pressing :guilabel:`Save` does the same thing as doing an :ref:`update `. Pressing :guilabel:`Save and apply` does the same thing as an :ref:`update ` immediatelly followed by an :ref:`upgrade `. .. _update_host: ************************************* Checking available updates for a host ************************************* .. image:: wapt-resources/wapt_console_check-for-updates_menu-item.png :align: center :alt: Checking available updates for a host This button will execute 2 actions: 1. give current state of the host to the WAPT Server 2. the WAPT Server displays whether the host **MUST** get updates Every configuration modification require a :guilabel:`Check updates`. .. _upgrade_host: ************************** Applying updates on a host ************************** .. image:: wapt-resources/wapt_console_apply-upgrades_menu-item.png :align: center :alt: Menu option for applying updates on selected host(s) This button allows to apply pending updates on the selected host(s). .. warning:: Use with caution, it will force close the software titles that the users are currently running. One can use instead :guilabel:`Apply upgrade for not running applications` to prevent the users losing their unsaved work. .. _global_search: *************************************** Performing a global search on all hosts *************************************** Performing global searches on all the criteria presented above is possible. Choose the filters to check or uncheck. .. figure:: wapt-resources/wapt_console_advanced-search_screen-item.png :align: center :alt: Advanced search functionalities in the WAPT Console Advanced search functionalities in the WAPT Console .. list-table:: Choice of filters :header-rows: 1 :align: center :widths: auto * - Options - Description * - :guilabel:`Host` - :guilabel:`Host` section in the :guilabel:`Hardware inventory` tab when a host is selected. * - :guilabel:`Hardware` - :guilabel:`DMI` section in the :guilabel:`Hardware inventory` tab when a host is selected. * - :guilabel:`Software` - :guilabel:`Software inventory` section when a host is selected. * - :guilabel:`Packages` - Lists WAPT packages installed on the selected hosts. * - :guilabel:`Has errors` - Searches only for hosts for which a task has not finished correctly. * - :guilabel:`Needs updating` - Searches only for hosts needing upgrades. * - :guilabel:`Connected only` - Searches only for connected hosts * - :guilabel:`Only authorized computers` - Searches only for hosts authorized by certificate of current WAPT Console user. * - :guilabel:`WAPT Group` - Filters hosts based on their membership / dependency to a WAPT *group* package. * - :guilabel:`AD Site` - Filter hosts based on their membership / dependency to a Site within Active Directory. * - :guilabel:`AD Group` - Filters hosts based on their membership / dependency to a Active Directory group. .. hint:: Filters work with `regular expression `_. ********************* Showing the inventory ********************* When the WAPT Agents *register*, they send some information to the WAPT Server. Information displayed in the WAPT Console is not updated in real-time, you have to refresh the display to view new status and information. Click on the :guilabel:`Refresh` button or press :kbd:`F5` on the keyboard. .. figure:: wapt-resources/wapt_console_main-grid_screen-item.png :align: center :alt: The WAPT Console displaying the WAPT inventory The WAPT Console displaying the WAPT inventory The WAPT Console lists hosts that are registered with the WAPT Server and some information that is useful for managing the hosts. Selecting a host displays its information in the right panel of the WAPT Console (:guilabel:`Hardware inventory` and :guilabel:`Software inventory`). ************************************ How to perform actions on the hosts? ************************************ .. image:: wapt-resources/wapt_console_host-configuration_menu-list.png :align: center :alt: Host configuration menu list in the WAPT Console Some actions are not available when selecting multiple hosts. .. list-table:: List of actions available on a selection of hosts in the WAPT Console :header-rows: 1 :widths: auto :align: center * - Name - Multi-selection * - Edit host - |nok| * - Check updates - |ok| * - Apply upgrades - |ok| * - Apply upgrades for applications not currently running - |ok| * - Propose upgrades for applications not currently running - |ok| * - Send a message to users - |ok| * - Run package audits - |ok| * - Add packages to host dependencies - |ok| * - Remove packages from host dependencies - |ok| * - Re-sign *host* packages - |ok| * - Add package to host conflicts - |ok| * - Remove package from host conflicts - |ok| * - Remove the host - |ok| * - Connect via RDP - |nok| * - Remote Assistance - |nok| * - Mesh remote desktop - |ok| * - Windows Computer management - |nok| * - Update AD Group Policies on hosts - |ok| * - Run CleanMgr on host - |nok| * - Computer management - |nok| * - Local users and groups management - |nok| * - Service management - |nok| * - Power ON with WakeOnLan - |ok| * - Reboot computers - |nok| * - Shutdown computers - |nok| * - Trigger the scan of missing Windows updates - |ok| * - Trigger the download pending Windows updates - |ok| * - Trigger the install of pending Windows updates - |ok| * - Refresh host inventory - |ok| * - Trigger a restart of waptservice - |ok| ************************************************** Importing WAPT packages from external repositories ************************************************** Importing a WAPT package consists of: * Importing an existing WAPT package from an external repository. * Changing its prefix (for example from *tis* to *my-prefix*). * Re-signing the WAPT package with the :term:`Administrator`'s or the :guilabel:`Code signing` private key to allow the deployment of the imported package on your WAPT equipped hosts. * Finally, uploading it on the main WAPT repository. .. attention:: By importing a package in your repository and signing it, **YOU THEN BECOME RESPONSIBLE** for that package and for what it does. **It has been signed with your own private key**. **Tranquil IT disclaims any liability if you choose to use WAPT packages retrieved from its repositories**. Without a support contract, Tranquil IT does not guarantee the suitability of the package for your own particular use case, nor does she guarantee the ability of the package to comply with your :term:`Organization`'s internal security policies. .. note:: Tranquil IT uses a package build farm to maintain its repository up to date, which is nicknamed LUTI (from the French word "l'outil"). LUTI status is now available publicly at https://luti.tranquil.it LUTI monitors when possible the software vendor web site to trigger a package update. It will check the software installer file status on virustotal, and then test the install, uninstall and upgrade of the package. The build results are available in the https://wapt.tranquil.it/wapt-testing repository After 5 days, if the virustotal status of the package has not changed, the new package will be uploaded to WAPT main store repository. There is an exception to this rule for web browsers, which are uploaded from wapt-testing to wapt repository after 1/2 an hour. * Go to the :guilabel:`Private repository` tab. .. figure:: wapt-resources/wapt_console_import-package-from-internet_container-window.png :align: center :alt: Available WAPT packages displayed in the WAPT Console Available WAPT packages displayed in the WAPT Console Every WAPT package version loaded on the WAPT repository is shown. If no package has been imported, the list is empty. Only the *test-waptupgrade* package will be present if :ref:`the WAPT Agent has been generated previously `. Importing a WAPT package from an external repository on the Internet ==================================================================== This method allows you to download WAPT packages directly from a WAPT repository that is outside of your :term:`Organization`. By default the Tranquil IT repository is configured. To add another repository, check the documentation for :ref:`configuring external repositories `. .. note:: By default, the SSL/ TLS certificates to external repositories are verified. * Click on :guilabel:`Import package` and :guilabel:`Import from Internet`. .. image:: wapt-resources/wapt_console_import-package1_menu-list.png :align: center :alt: Menu list for importing a WAPT package into the WAPT repository .. note:: The grid view displays the list of available packages on the remote repository. It is possible to choose the architecture, the OS and the locale. .. figure:: wapt-resources/wapt_console_imported-package-into-repository_container-window.png :align: center :alt: Imported WAPT package in the local WAPT repository Imported WAPT package in the local WAPT repository * There are 2 methods for importing a WAPT package: * :menuselection:`Right-click --> Import in repository`; .. image:: wapt-resources/wapt_console_import-package2_menu-list.png :align: center :alt: Menu list for importing a WAPT package into the WAPT repository * Or in the bottom right of the Window :guilabel:`Import in repository`: * Validate the importation in your local repository. .. figure:: wapt-resources/wapt_console_import-package-confirm_dialog-box.png :align: center :alt: Dialog box to prepare and confirm the import of a WAPT package into a WAPT repository Dialog box to prepare and confirm the import of a WAPT package into a WAPT repository .. note:: It is possible to :ref:`change the maturity ` of a WAPT package before importing the WAPT package into your private repository. * The download of the WAPT package starts. .. image:: wapt-resources/wapt_console_package-download-progress_dialog-box.png :align: center :alt: Progress of the package importation process * Then, enter your private key password. .. figure:: wapt-resources/wapt_console_enter-certificate-password_dialog-box.png :align: center :alt: Entering the password for unlocking the private key in the WAPT Console Entering the password for unlocking the private key in the WAPT Console The WAPT Console confirms that the WAPT package has been imported into the local WAPT repository. The package then appears in the local WAPT repository with the Organization's prefix. .. figure:: wapt-resources/wapt_console_package-download-success_container-window.png :align: center :alt: WAPT Console displaying the imported WAPT package WAPT Console displaying the imported WAPT package .. _maturity_import: Changing the maturity of a WAPT package before importing it into the repository ------------------------------------------------------------------------------- It is possible to change the maturity of a WAPT package before loading it into your private repository by choosing **DEV**, **PREPROD** or **PROD** in :guilabel:`Default package maturity`. .. figure:: wapt-resources/wapt_console_import-package-confirm_dialog-box.png :align: center :alt: Dialog box to prepare and confirm the import of a WAPT package into a WAPT repository Dialog box to prepare and confirm the import of a WAPT package into a WAPT repository Editing a package before importing it ------------------------------------- It is possible to edit a package downloaded from an external repository before importing it into your main WAPT repository. * To do this, **2** choices are available: * :menuselection:`Right-click --> Download and Edit`; .. image:: wapt-resources/wapt_console_import-package2_menu-list.png :align: center :alt: Menu list for importing a WAPT package into the WAPT repository * or by clicking :guilabel:`Download and Edit` on the bottom right of the window; :program:`PyScripter`, if installed, will open the :file:`control` and :file:`setup.py` files of the WAPT package. For more information, visit the documentation on :ref:`creating WAPT packages from scratch `. ***************************************** Importing WAPT packages from a local file ***************************************** You can import a :mimetype:`.wapt` file from any storage. * Click on :guilabel:`Import package` and then :guilabel:`Import from file`. .. image:: wapt-resources/wapt_console_import-package2_menu-list.png :align: center :alt: Menu list for importing a WAPT package into the WAPT repository * Select the file to import. .. figure:: wapt-resources/wapt_console_import-file-select_browser-window.png :align: center :alt: Selecting the file to import * Click on the :guilabel:`Open` button to import the file. The WAPT Console confirms that the package has been imported in the local WAPT repository. The package then appears in the local WAPT repository with the Organization's prefix. .. figure:: wapt-resources/wapt_console_package-download-success_container-window.png :align: center :alt: WAPT Console displaying the imported WAPT package WAPT Console displaying the imported WAPT package .. note:: It is not possible to change the maturity before importing here. When uploading a new WAPT package to the private repository, the changing of the prefix and the re-signing of the WAPT package are transparent and automatic. *********************************************** Managing WAPT packages hosted in the repository *********************************************** In the :guilabel:`WAPT Packages` tab, the list of packages currently available in the WAPT repository appears. By default, the WAPT Console will only show the latest version of WAPT packages. .. image:: wapt-resources/wapt_console_packages_filter_screen-item.png :align: center :alt: Changing the maturity of a WAPT package .. list-table:: Listing of items in the window :header-rows: 1 :widths: auto :align: center * - Label - Description * - The :guilabel:`Type name or description` search bar - Allows to search by WAPT package name or description. * - The :guilabel:`Last version only` checkbox - Allows to display all version of WAPT packages in the WAPT Console. * - The :guilabel:`Filter packages` dropdown menu - Allows to filter WAPT packages by type (*all*, *base*, *group*, *profile*, *selfservice*, *unit*, *waptwua*). * - The :guilabel:`Show hosts` - Displays the hosts on which the selected WAPT package is installed. * - The :guilabel:`Architecture x86` checkbox - Allows to filter on hosts having a x86 based processor architecture. * - The :guilabel:`Architecture x64` checkbox - Allows to filters on hosts having a x64 based processor architecture. * - The :guilabel:`OS all` checkbox - Allows to filter hosts based on any :abbr:`OS (Operating System)`. * - The :guilabel:`OS Windows` checkbox - Allows to filter hosts based on the Windows :abbr:`OS (Operating System)`. * - The :guilabel:`OS macOS` checkbox - Allows to filter hosts based on the macOS :abbr:`OS (Operating System)`. * - The :guilabel:`OS Linux` checkbox - Allows to filter hosts based on the Linux :abbr:`OS (Operating System)`. * - The :guilabel:`Locale en` checkbox - Allows to filter hosts localized in English. * - The :guilabel:`Locale fr` checkbox - Allows to filter hosts localized in French. * - The :guilabel:`Locale de` checkbox - Allows to filter hosts localized in German. * - The :guilabel:`Locale it` checkbox - Allows to filter hosts localized in Italian. * - The :guilabel:`Locale es` checkbox - Allows to filter hosts localized in Spanish. * - The :guilabel:`Maturity` dropdown list - Allows to filter on the maturity level configured on the hosts. Doing a search based on a WAPT package ====================================== In the repository, select the package and then click on :guilabel:`Show Hosts`. The grid will display the hosts on which the package is installed. Note that the filter is only active on the :guilabel:`Package` attribute of the selected package. The different columns display information about the packages installed on the host (e.g. *package version*, *package status*, *audit status*, *installation date*, *architecture*). .. figure:: wapt-resources/wapt_console_show-hosts-configured-with-selected-package_screen-item.png :align: center :alt: Filtering hosts based on a WAPT package Filtering hosts based on a WAPT package You can also add the columns :guilabel:`Log install` and :guilabel:`Last Audit Output` to display at a glance the installation and audit logs. Changing the maturity of a WAPT package after having imported it ================================================================ When a package is imported on a WAPT repository it is possible to change the maturity by rigth-clicking on the WAPT package. Choose the maturity of the WAPT package to import using the :guilabel:`Change packages maturity` menu item. .. image:: wapt-resources/wapt_console_packages_menu-list.png :align: center :alt: Changing the maturity of a WAPT package .. figure:: wapt-resources/wapt_console_package-change-maturity_container-window.png :align: center :alt: Window for changing the maturity of a WAPT package Window for changing the maturity of a WAPT package .. list-table:: Options for changing the maturity of WAPT packages :header-rows: 1 :widths: auto :align: center * - Label - Description * - The :guilabel:`Increment the package version` checkbox - Increments the packaging version (version number after `-`). * - The :guilabel:`Delete old packages after successful process` checkbox - Delete the old WAPT package after having changed the maturity. * - The :guilabel:`Change package maturity` dropdown list - Configure the new maturity of the WAPT package. * - The :guilabel:`New packages prefix` field - Configure a new prefix for the WAPT package. .. note:: You can stop the process by pressing the :guilabel:`Abort process` button. You can confirm the process by pressing the :guilabel:`Change the package maturity` button. Once finished, the status switches to |ok|. .. hint:: You can change the maturity of a selection of WAPT packages at once .. warning:: Changing the maturity of the WAPT package will change the hash of the file. If the package is used in a :abbr:`GPO (Group Policy Object)`, like :program:`waptupgrade`, the hash in the GPO will need to be changed. .. _creating_group_package: Creating a group package ======================== WAPT *group* packages allow to create a WAPT package containing other WAPT packages as dependencies. To create a bundle of WAPT packages, go to the :guilabel:`WAPT Packages` tab in the WAPT console, then click on the :guilabel:`Make package template from setup file` button and finally choose the :guilabel:`Group` menu item. .. figure:: wapt-resources/wapt_console_package-group_screen-item.png :align: center :alt: Package group grid * Change the name in the :guilabel:`Package name` field. * Fill in the description. * Add WAPT packages to the *group* package by dragging and dropping them or by Right-clicking on the WAPT package name, and adding it to the bundle. .. GIF animation instead .. figure:: wapt-resources/wapt_console_packages-adding-to-group_container-window.png :align: center :alt: Creating a group package * Click on the :guilabel:`Save` button to save the bundle. .. hint:: To uninstall a package, it is possible to add is as a forbidden package to a *group* package. The forbidden WAPT package, if installed, will be removed before other WAPT packages are installed. .. GIF animation instead .. figure:: wapt-resources/wapt_console_packages-adding-to-group_container-window.png :align: center :alt: Adding a forbidden package to a *group* package Adding a forbidden package to a *group* package Removing a WAPT package ======================= .. figure:: wapt-resources/wapt_console_packages_menu-list.png :align: center :alt: Remove a package To delete a WAPT package from the repository, do a :menuselection:`Right-click --> Remove from repository`. .. hint:: You can select multiple WAPT packages to delete at once. Editing a WAPT package ====================== .. figure:: wapt-resources/wapt_console_packages_menu-list.png :align: center :alt: Editing a WAPT package To edit a WAPT package, do a :menuselection:`Right-click --> Edit package`. The WAPT package will be downloaded locally in **the base package development folder**, set in the WAPT Console settings. If :program:`PyScripter` is installed, :program:`PyScripter` will automatically open the :file:`control` and :file:`setup.py` files. Once edited you can upload the WAPT package :ref:`using the WAPT Console `. Deploying WAPT packages from the WAPT Console ============================================= You can deploy WAPT packages on hosts using multiple methods: * Directly by :ref:`adding a WAPT package to the selected host(s) `. * By :ref:`adding a WAPT package to an Organizational Unit ` of which the host is a member. * By :ref:`adding a package to a host profile ` that is applied to the host. * By :ref:`adding the package to a group package ` of which the host is a member.