.. Reminder for header structure: Parts (H1) : #################### with overline Chapters (H2) : ******************** with overline Sections (H3) : ==================== Subsections (H4) : -------------------- Subsubsections (H5) : ^^^^^^^^^^^^^^^^^^^^ Paragraphs (H6) : """""""""""""""""""" .. meta:: :description: WAPT Console in detail :keywords: waptconsole, detailed, WAPT, preferences, documentation .. |enterprise_feature| image:: wapt-resources/wapt_enterprise.png :scale: 1% :alt: WAPT Enterprise feature only .. _wapt_console_detailed: This page details various windows of the WAPT console. ***** Menus ***** Detailed tabs of the menu bar File Tab ======== .. figure:: wapt-resources/wapt_console-file-from-menu.png :align: center :alt: Exit the WAPT console The action closes the WAPT console. The keyboard shortcut is :kbd:`Ctrl+Q`. View tab ======== Refresh ------- .. figure:: wapt-resources/wapt_console-refresh-from-menu.png :align: center :alt: Menu option for refreshing the display of the WAPT console The action refreshes the display of the WAPT console. The keyboard shortcut is :kbd:`F5`. Displaying preferences ---------------------- .. figure:: wapt-resources/wapt_console-display-preferences-from-menu.png :align: center :alt: Menu option for setting display preferences for the WAPT console .. figure:: wapt-resources/wapt_console-display-preferences.png :align: center :alt: Window for personalizing the WAPT console This window allows you to set your own preferences for the WAPT console. .. list-table:: List of available actions to display preference options :header-rows: 1 :align: center :widths: auto * - Name - Description - Example * - Maximum number of hosts to display - Max host in Inventory - 2000 * - Language - Show the locale of the WAPT console - French/English/German * - Reset console layout - Load default settings - * - Show debug informations - Add debug informations panel on the bottom of the WAPT console - False * - Enable external tools in host popup menus - Show Windows tools on right-click - True * - Hide unavaible actions - Hide if action are not possible for current user - False * - Enable WAPTWUA features - Show Windows Update tab - True * - Show host audit data tab - Show tab on Inventory of host - False Restoring the default grid layout --------------------------------- .. figure:: wapt-resources/wapt_console-restore-default-grid-layout.png :align: center :alt: Menu option for restoring the default grid layout of the WAPT console Re-apply the default layout for the WAPT console. For example, you can remove the column :ref:`Hardware inventory added in this section of the documentation `. Tools tab ========= .. figure:: wapt-resources/wapt_console-tools-menu.png :align: center :alt: Menu Tools Changing the Superadmin password of the WAPT Server --------------------------------------------------- .. figure:: wapt-resources/wapt_console-change-admin-password.png :align: center :alt: Menu option for changing the Superadmin password of the WAPT Server .. figure:: wapt-resources/wapt_console-change-admin-password-new.png :align: center :alt: Window for changing the Superadmin password of the WAPT Server This window allows you to update the Super Admin password initially created during the postconfiguration of the WAPT Server. To change the WAPT Server password, fill in the old password and enter a new one. Building an Administrator certificate ------------------------------------- .. figure:: wapt-resources/wapt_console-build-certificate-from-menu.png :align: center :alt: Menu option for creating a certificate for a WAPT Administrator Refer to the documentation on :ref:`generating the Administrator's certificate for signing WAPT packages `. Building the WAPT agent ----------------------- .. figure:: wapt-resources/wapt_console-build-wapt-agent-from-menu.png :align: center :alt: Menu option for building the WAPT agent Refer to the documentation on :ref:`building the WAPT agent installer `. Changing the password of the Administrator's private key -------------------------------------------------------- .. figure:: wapt-resources/wapt_console-change-pass-private-key-from-menu.png :align: center :alt: Menu option for changing the password of the Administrator's private key Allows you to update the :ref:`private key` password. .. figure:: wapt-resources/wapt_console-enter-certificate-password.png :align: center :alt: Window for entering the password to unlock the private key .. figure:: wapt-resources/wapt_console-change-pass-private-key-from-menu-new.png :align: center :alt: Window for changing the password of the Administrator's private key To change the private key password, fill in the old password and enter a new one. Cleaning the local cache ------------------------ When importing a package from the Internet, the WAPT console downloads the package in :file:`%appdata%\\local\\waptconsole\\cache`. To clean the cache and free up disk space, click on :menuselection:`Tools --> Clean local cache`. .. figure:: wapt-resources/wapt_console-clear-cache-from-menu.png :align: center :alt: Menu option for cleaning up the local cache Resetting Websocket connections ------------------------------- .. figure:: wapt-resources/wapt_console-reset-websocket-from-menu.png :align: center :alt: Menu option for resetting Websocket connections Use this method if you are restarting the waptserver service without restarting the :program:`Nginx` web service. Making a WAPT package template from a setup file ------------------------------------------------ .. figure:: wapt-resources/wapt_console-make-package-template-scroll.png :align: center :alt: Menu option for making a WAPT package template from a setup file For more information, refer to the documentation for :ref:`creating a package template from the WAPT console `. Building and uploading a WAPT package from the WAPT console to a repository --------------------------------------------------------------------------- .. figure:: wapt-resources/wapt_console-build-upload-from-menu.png :align: center :alt: Menu option for building and uploading a WAPT package from the WAPT console to a repository For more information, refer to the documentation on :ref:`building the package and sending it to the WAPT server `. .. _external_repositories_settings: External repositories settings ------------------------------ .. figure:: wapt-resources/wapt_console-external-repositories-from-menu.png :align: center :alt: Menu option for setting external repositories You can add external repositories to get packages from different sources. .. figure:: wapt-resources/wapt_console-repositories-settings.png :align: center :alt: Window for setting up external repositories .. list-table:: List of available actions to apply on repositories :header-rows: 1 :align: center :widths: auto * - Name - Description - Example * - Repository name - Name of the repository in the list - wapt-template * - Register new repository - Clear interface - * - Unregister repository - Delete the selected repository - * - External packages repository - repository address - https://store.wapt.fr/wapt * - Browse certificates - Download the certificate of the repository - * - http proxy to use (if needed) - proxy address - http://proxy.mydomain.lan * - Advanced parameters - Shows advanced settings - Checked * - Check HTTPS server certificate - Use the HTTPS certificates - Checked Normalizing software titles --------------------------- .. figure:: wapt-resources/wapt_console-normalize-titles-from-menu.png :align: center :alt: Menu option for normalizing software titles For more information, refer to the documentation on :ref:`normalizing software names `. .. _configuring_the_WAPT_console: Configuring the WAPT console preferences ---------------------------------------- To make changes to the WAPT console settings, go to :menuselection:`Tools --> Preferences`. .. figure:: wapt-resources/wapt_console-access-to-menu-preferences.png :align: center :alt: Menu option for configuring the WAPT console preferences Basic configuration ^^^^^^^^^^^^^^^^^^^ Basic tab for basic configuration options; .. figure:: wapt-resources/wapt_console-basic-configuration-tab.png :align: center :alt: Window for the basic configuration of the WAPT console .. list-table:: :header-rows: 1 :align: center :widths: auto * - Arguments - Description - Example * - WAPT server address or name - URL (IP or :abbr:`FQDN (Fully Qualified Domain Name)`) of the WAPT Server - *srvwapt.mydomain.lan*. * - :guilabel:`Check and set` - Check whether the server exists and set this configuration. Write the WAPT Server URL to :file:`waptconsole.ini` - * - Manual override - Used for bypass automatic generation. - Checked * - URL to the main WAPT repository - Set repository address of WAPT (only if :guilabel:`Manual override` is checked). - http://srvwapt.mydomain.lan/wapt/ * - WAPT server URL - Set the WAPT Server address (only if :guilabel:`Specify manually` is checked). - *https://srvwapt.mydomain.lan/* * - Verify the HTTPS server certificate - Indicates whether the HTTPS certificate must be verified. - Checked * - Path to CA certificates bundle - Path to the CA bundle of certificates that will allow certificates to be verified. Visit :ref:`the documentation on activating HTTPS verification `. - :file:`C:\\Program Files (x86)\\wapt\\lib\\site-packages\\certifi\\cacert.pem` * - :guilabel:`Get Server https Certificate` - Retrieve the https certificate chain from the WAPT Server. - * - WAPT packages prefix - Prefix that is given to packages during replication. - tis * - Path to personal certificate - Path to the certificate associated with the private key used to sign packages. - :file:`C:\\private\\mykey.crt` * - Licence directory - Path to the licence for Enterprise version. Set (empty) by default in WAPT install folder. It is possible to set another path. - :file:`X:\\licence` * - :guilabel:`Check matching private key` - Check whether the :mimetype:`.crt` certificate matches the :mimetype:`.pem` private key. - * - :guilabel:`New private key and certificate` - Create a new :ref:`private key / certificate ` pair. - * - Show config file - Open :file:`%appdata%\\Local\\waptconsole\\waptconsole.ini` file with a text editor. - All parameters of the WAPT console .. hint:: The button :guilabel:`Get the server certificate` downloads the WAPT Server HTTPS certificate to :file:`WAPT\\ssl\\server` and tells the WAPT console to verify HTTPS connections using that bundle of certificates. The method is called :ref:`Certificate pinning `. Before downloding the HTTPS certificate, you must be sure that you are connecting with the right server. .. _console_detailed_advanced_config: Advanced configuration ^^^^^^^^^^^^^^^^^^^^^^ Advanced tab for advanced configuration options; .. figure:: wapt-resources/wapt_console-advanced-config-tab.png :align: center :alt: Window for the advanced configuration of the WAPT console .. list-table:: :header-rows: 1 :align: center :widths: auto * - Arguments - Description - Example * - Base directory for package development - Indicates the path to the directory for storing packages being developed. - :file:`C:\\waptdev` * - http proxy to use (if needed) - Indicates a proxy server to be used by the WAPT console when accessing the WAPT repository or the WAPT Server. - http://srvproxy.mydomain.lan:8080 * - Activates proxy when accessing the main repository - Activate proxy settings for connecting to the WAPT repository. - Checked * - Activate proxy when accessing the WAPT server - Use the proxy when accessing the WAPT server. - Checked * - Default package maturity - Default maturity for imported packages. - PROD * - Client certificate path for authentication - Path to the certificate for using :ref:`Client side SSL authentication `. - Blank * - Client auth key path - Path to the key for using :ref:`Client side SSL authentication `. - Blank * - Editor for packages - Default development environment for importing WAPT packages. - PyScripter * - Show config file - Open :file:`waptconsole.ini` file in :file:`%appdata%\\Local\\waptconsole` - All parameters of the WAPT console .. _plugins_host: Plugins ^^^^^^^ Pluggins allow you to add custom actions not natively available with WAPT. .. figure:: wapt-resources/wapt_console-plugins-empty.png :align: center :alt: Creating a plugin Click :guilabel:`Add` to add plugins, then edit the corresponding columns. .. list-table:: :header-rows: 1 :align: center :widths: auto * - Column - Description * - Name - Name that will appear in the menu. * - Executable - Path of the executable that will be executed. * - Arguments - Arguments passed to the executable. Some variables can be used like {ip}, {uuid} or {computer_fqdn}. * - Show config file - Open :file:`waptconsole.ini` file in :file:`%appdata%/Local/waptconsole`. Plugins will then appear in the menu: .. figure:: wapt-resources/wapt_console-plugins-full.png :align: center :alt: Inserting "Explorer" as a plugin with IP variables ? tab ===== .. figure:: wapt-resources/wapt_console-int-point-tab.png :align: center :alt: More info tab More info tab Online help ----------- :guilabel:`Online help` opens a web browser with this documentation. Check Waptagent updates ----------------------- :guilabel:`Check Waptagent updates` checks whether an agent update is available on the server. Licences -------- :guilabel:`Licences` :ref:`active WAPT licence ` on WAPT Server. About ----- .. figure:: wapt-resources/wapt_console-about.png :align: center :alt: About tab .. list-table:: List of available options :header-rows: 1 :align: center :widths: auto * - Column - Description - Example * - Status - License's validity status - :guilabel:`Ok` * - Count - Number of hosts included in the license - :guilabel:`5` * - Licence nr - License number - :file:`12345678-aaa-bbb-ccc-123456789acb` * - Licenced to - License"s owner - pdegalles * - Date - License creation date - 2021-01-12 00:00 * - Valid from - Start date for the licence. - 2021-01-12 00:00 * - Valid until - End date for the licence. - 2022-01-12 00:00 * - Contact email - Email of the licence's owner. - pdegalles@paysdegalles.org * - Message - Message displayed when license has an :guilabel:`ERROR` status. - `SSLVerifyException: SSL signature verification failed for certificate` * - Filename - Path to use to get license with its name - :file:`C:\\Program Files (x86)\\wapt\\licences\\pdegalles-12345678-aaa-bbb-ccc-123456789acb.lic` ************* Inventory tab ************* .. figure:: wapt-resources/wapt_console-inventory-tab.png :align: center :alt: Inventory tab Refresh ======= :guilabel:`Refresh` refreshes the WAPT console display. The keyboard shortcut is :kbd:`F5`. Edit host ========= .. figure:: wapt-resources/wapt_console-edit-host.png :align: center :alt: Edit host :guilabel:`Edit host` allows you to :ref:`edit ` host package. Check updates ============= .. figure:: wapt-resources/wapt_console-check-updates.png :align: center :alt: Edit host :guilabel:`Check updates` allows you to :ref:`check updates ` for the selected host(s). Apply updates ============= .. figure:: wapt-resources/wapt_console-apply-upgrades.png :align: center :alt: Edit host :guilabel:`Apply updates` allows you to :ref:`apply upgrades ` on the selected host(s). *************************************** Performing a global search on all hosts *************************************** .. figure:: wapt-resources/wapt_console-advanced-search.png :align: center :alt: Advanced search functionalities in the WAPT console The filters allow you to search hosts based on :ref:`multiple criterias `. ********************************** OU AD on WAPT |enterprise_feature| ********************************** WAPT console is not directly connected to Active Directory. The arborescence is built from WAPT agent inventory information. If the tree structure is not up-to-date, you have to launch a :guilabel:`Check Updates` on a :ref:`client ` or on :ref:`OU `. Include computers from subfolders ================================= .. figure:: wapt-resources/wapt_console-subfolders.png :align: center :alt: Including computers from subfolders This option allows you to display all available hosts in :abbr:`OU (Organizational Unit)` folders and subfolders. If not checked, only available hosts in selected :abbr:`OU (Organizational Unit)` will be displayed in the console. Searching Organizational Units ============================== .. figure:: wapt-resources/wapt_console-search-ou.png :align: center :alt: Searching an Organizational Unit This option allows you to search in :abbr:`OU (Organizational Unit)` folders. .. hint:: Filters work with `regular expression `_. Displaying Organizational Units =============================== .. figure:: wapt-resources/wapt_console-display-ou.gif :align: center :alt: Unfolding Organizational Unit folders Unfolding Organizational Unit folders allows you to display nested :abbr:`OU (Organizational Unit)`. Creating or editing Organizational Unit package =============================================== .. figure:: wapt-resources/wapt_console-create-edit-ou.png :align: center :alt: Menu option for creating or editing Unit packages This option allows you to :ref:`edit or create Unit package `. Checking for updates on all host of an Organizational Unit ========================================================== .. figure:: wapt-resources/wapt_console-check-updates-ou.png :align: center :alt: Menu option for checking updates for hosts in OU This option allows you to :ref:`check updates ` of all the hosts in the :abbr:`OU (Organizational Unit)`. Applying upgrades on all hosts in an Organizational Unit ======================================================== .. figure:: wapt-resources/wapt_console-apply-upgrades-ou.png :align: center :alt: Menu option for applying upgrades on hosts in a OU This option allows you to :ref:`apply upgrades ` on all hosts in the :abbr:`OU (Organizational Unit)`. .. _console_host_inventory: ************** Host inventory ************** .. figure:: wapt-resources/wapt_console-host-inventory-package.png :align: center :alt: Host inventory Main inventory displays every host according to the selected filters. .. _host_status_inventory: Host status =========== .. figure:: wapt-resources/wapt_console-host-inventory-status.png :align: center :alt: Host status Each columns can have different status. .. list-table:: :header-rows: 1 :widths: auto :align: center * - Status - Description * - :guilabel:`OK` - Host does not report issue. * - :guilabel:`OK` - Host is connected. * - :guilabel:`TO-UPGRADE` - Host has a pending install / update. * - :guilabel:`ERROR` - Host has errors. Host layout =========== .. figure:: wapt-resources/wapt_console-host-inventory-package-layout.png :align: center :alt: Host inventory layout Some columns are not displayed by default, you can select more columns with a right-click on the inventory header. .. list-table:: :header-rows: 1 :widths: auto :align: center * - Status - Description * - :guilabel:`Status (host_status)` - :ref:`Status ` of the host. * - :guilabel:`Reachable (reachable)` - If the host is seen by the WAPT server. * - :guilabel:`Audit status (audit_status)` - Audit status of all packages on the host. * - :guilabel:`WUA (waptwua_status.status)` - :ref:`WUA service ` status via WAPT. * - :guilabel:`Host (computer_fqdn)` - :abbr:`FQDN (Fully Qualified Domain Name)` of the host. * - :guilabel:`Description (description)` - Description of the host * - :guilabel:`Manufacturer (manufacturer)` - Manufacturer of the host * - :guilabel:`IP addresses (connected_ips)` - IP address list of the host * - :guilabel:`Plateform (plateform)` - Processor architecture * - :guilabel:`Operating system (os_name)` - Operating System name * - :guilabel:`Model (productname)` - Model for the host * - :guilabel:`Serial number (serialnr)` - Host serial number * - :guilabel:`Last seen on (last_seen_on)` - Last host inventory done * - :guilabel:`Logged in users (last_seen_on)` - Current logged in user * - :guilabel:`MAC address (mac_addresses)` - MAC Address associated to host's IP * - :guilabel:`WAPT version (wapt_version)` - WAPT version deployed on the host * - :guilabel:`uuid (uuid)` - UUID identifier of the host * - :guilabel:`purchase_order (purchase_order)` - Purchase Order of the host * - :guilabel:`purchase_date (purchase_date)` - Purchase date of the host * - :guilabel:`Domain controller (host_info/domain_controller)` - Host Domain controller * - :guilabel:`Groups (depends)` - Groups which the host is a member of * - :guilabel:`Domaine (host_info/domain_controller_address)` - Domain name * - :guilabel:`Listening address (listening_address)` - Listening address * - :guilabel:`Domain contoller address (host_info/domain_controller_address)` - Domain controler's address * - :guilabel:`AD DN` - Distinguished Name of the machine * - :guilabel:`Last logged on user (last_logged_on_user)` - Last logged on user * - :guilabel:`Registration Method (registration_auth_user)` - User that has registered the host with the WAPT Server * - :guilabel:`Repositories (repositories)` - Repositories seen by the host You can add columns from :ref:`Software Inventory ` by using a drag and drop. You have to refresh the WAPT console (:kbd:`F5`) to see the additional data. .. figure:: wapt-resources/wapt_console-drag-and-drop.gif :align: center :alt: Dragging and dropping inventory items in the WAPT console grid .. _detailled_host_actions: Detailed actions on the hosts ============================= Host configuration menu ----------------------- The menu options are accessible using Right-Click on the selected host(s). .. figure:: wapt-resources/wapt_console-host-configuration-menu.png :align: center :alt: Host configuration menu Edit host ^^^^^^^^^ .. figure:: wapt-resources/wapt_console-edit-host.png :align: center :alt: Edit host button The :guilabel:`Edit host` button allows you to :ref:`edit ` the configuration on the selected host(s). Check updates ^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-check-updates.png :align: center :alt: Check updates button The :guilabel:`Check updates` button allows you to :ref:`check for available updates ` for the selected host(s). Apply upgrades ^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-apply-upgrades.png :align: center :alt: Menu option for triggering upgrades The :guilabel:`Apply upgrades` menu option allows you to :ref:`trigger upgrades ` on the selected host(s). Apply upgrades for not running applications ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-apply-upgrades-not-run.png :align: center :alt: Menu option for triggering upgrades on software not in use The :guilabel:`Apply upgrades for not running applications` menu option allows you to :ref:`apply upgrades ` on the selected host(s) **if the software is not being currently used by a user**. Propose Upgrades to logged on users ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-apply-upgrades-logged-users.png :align: center :alt: Menu option for proposing Upgrades to logged on users Menu option for proposing Upgrades to logged on users The :guilabel:`Propose Upgrades to logged on users` menu option allows you to propose upgrades to currently logged-in users of the selected host(s). **A popup will then appear on the user's terminal allowing the user to trigger or postpone the offered upgrade**. This menu option is equivalent to :ref:`waptexit `. Send a message to users ^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-send-message-users.png :align: center :alt: Menu option for sending a message to users The :guilabel:`Send a message to users` menu option allows you to send a message to logged-in users of the selected host(s). Run packages audit ^^^^^^^^^^^^^^^^^^ The :guilabel:`Run packages audit` menu option allows you to trigger manually a :ref:`compliance audit ` on the selected host(s). Add package(s) to host(s) ^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-add-package-host.png :align: center :alt: Menu option for adding package(s) to host(s) The :guilabel:`Add packages to host` menu option allows you to :ref:`add a list of WAPT packages ` on the selected host(s). Remove package(s) from host(s) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-remove-package-host.png :align: center :alt: Menu option for removing package(s) from host(s) The :guilabel:`Remove package(s) from host(s)` menu option allows you :ref:`to remove a list of WAPT packages ` from the selected host(s). Re-sign host packages ^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-re-sign-host-package.png :align: center :alt: Menu option for re-signing a host configuration The :guilabel:`Resign host packages` menu option allows you to :ref:`re-sign the WAPT configuration ` of the selected host(s). Add package to host conflicts ----------------------------- .. figure:: wapt-resources/wapt_console-add-package-host-conflict.png :align: center :alt: Menu option for adding a forbidden package The :guilabel:`Add package to host conflicts` menu option allows you to forbid a package from being installed on the selected host(s). Remove package from host conflicts ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-remove-package-host-conflict.png :align: center :alt: Menu option for removing a package from the conflict list The :guilabel:`Remove package from host conflicts` menu option allows you to re-authorize a forbidden package on the selected host(s). Remove host ^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-remove-host.png :align: center :alt: Menu option for removing host(s) The :guilabel:`Remove host` menu option allows you to remove the selected host(s) from the WAPT Server database. 2 options are available: .. figure:: wapt-resources/wapt_console-confirm-delete-host.png :align: center :alt: Window to confirm removing host(s) * Delete host from inventory database to delete inventory data. * Delete host configuration (Package) to delete host package data. Plugins ^^^^^^^ .. figure:: wapt-resources/wapt_console-plugins.png :align: center :alt: Plugins console :ref:`See here `. Connect via RDP ^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-connect-rdp.png :align: center :alt: Menu option for connecting to the host via RDP The :guilabel:`Connect via RDP` menu option allows you to connect with RDP on the selected host. Remote Assistance ^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-remote-assistance.png :align: center :alt: Menu option for connecting to the host via Remote Assistance The :guilabel:`Remote Assistance` menu option allows you to launch Windows remote assistance. Mesh remote desktop ^^^^^^^^^^^^^^^^^^^ The :guilabel:`Mesh remote desktop` menu option allows you to use `Mesh Commander `_ from the WAPT console. .. _windows_management_by_console: Windows Computer management ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-windows-computer_management.png :align: center :alt: Menu option for remotely managing a host The :guilabel:`Windows Computer management` menu option allows you to launch the Windows remote management tools from the WAPT console. Update AD Group Policies on host """""""""""""""""""""""""""""""" .. figure:: wapt-resources/wapt_console-update-gpo.png :align: center :alt: Menu option for remotely applying GPO on hosts The :guilabel:`Update AD Group Policies on host` menu option allows you to launch :command:`gpupdate /force` command on the selected host(s). Run CleanMgr on host """""""""""""""""""" .. figure:: wapt-resources/wapt_console-cleanmgr.png :align: center :alt: Menu option for remotely triggering CleanMgr on hosts The :guilabel:`Run CleanMgr on host` menu option allows you to remotely trigger the :program:`cleanmgr` tool on the selected host(s). Computer management """"""""""""""""""" .. figure:: wapt-resources/wapt_console-computer-management.png :align: center :alt: Menu option for remotely launching the Computer Management tool on the host The :guilabel:`Computer management` menu option allows you to remotely launch :program:`compmgmt.msc` on the selected host. Local users and groups management """"""""""""""""""""""""""""""""" .. figure:: wapt-resources/wapt_console-local-management.png :align: center :alt: Menu option for launching the Local users and groups management tool The :guilabel:`Local users and groups management` menu option allows you to remotely launch :program:`lusrmgr.exe` on the selected host. Services management """"""""""""""""""" .. figure:: wapt-resources/wapt_console-service-management.png :align: center :alt: Menu option for remotely launching the Service Management tool on host The :guilabel:`Services management` menu option allows you to remotely launch :program:`services.msc` on the selected host. Power ON with WakeOnLan ^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-wakeonlan.png :align: center :alt: Menu option for remotely powering on hosts The :guilabel:`Power ON with WakeOnLan` menu option allows you to remotely wake selected host(s) if magic packages are authorized. .. _reboot_command: Reboot computers ^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-reboot-computer.png :align: center :alt: Menu option for remotely rebooting hosts The :guilabel:`Reboot computers` menu option allows you to remotely reboot the selected host(s). This feature is disabled by default, see :ref:`Configuring the WAPT agent ` for enabling the feature. .. _shutdown_command: Shutdown computers ^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-shutdown-computer.png :align: center :alt: Menu option for remotely shutting down hosts The :guilabel:`Shutdown computers` menu option allows you to remotely shut down the selected host(s). This feature is disabled by default, see :ref:`Configuring the WAPT agent ` for enabling the feature. Trigger the scan of missing Windows Updates ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-scan-windows-updates.png :align: center :alt: Menu option for remotely triggering the scan for missing Windows Updates on hosts The :guilabel:`Trigger the scan of missing Windows Updates` menu option allows you to remotely trigger the scan for missing Windows Updates on the selected host(s). For more information, visit this :ref:`documentation `. Trigger the download of pending Windows Updates ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-down-windows-updates.png :align: center :alt: Menu option for remotely triggering the download of pending Windows Updates on hosts The :guilabel:`Trigger the download of pending Windows Updates` menu option allows you to remotely trigger the download of pending Windows Updates on the selected host(s). For more information, visit this :ref:`documentation `. Trigger the install of pending Windows Updates ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-trigg-windows-updates.png :align: center :alt: Menu option for remotely triggering the installation Windows Updates on hosts The :guilabel:`Trigger the install of pending Windows Updates` menu option allows you to remotely trigger the installation of pending Windows Updates on the selected host(s). For more information, visit this :ref:`documentation `. Refresh host inventory ^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-refresh-host-inventory.png :align: center :alt: Menu option for refreshing the host inventory The :guilabel:`Refresh host inventory` menu option allows you to force selected host(s) to send their current inventory. .. figure:: wapt-resources/wapt_console-refresh-host-inventory-trigg.png :align: center :alt: Window listing hosts currently updating their inventory .. list-table:: :header-rows: 1 :widths: auto :align: center * - Column - Description * - Host - Hostname * - IP - IP of host * - Status - Status of the Trigger * - status - Visual status * - Message - Result message from update * - :guilabel:`Launch update` - Launch update * - :guilabel:`Close` - Close the window Trigger a restart of waptservice ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-trigger-restart-waptservice.png :align: center :alt: Menu option for remotely triggering a restart of the waptservice on hosts The :guilabel:`Trigger a restart of waptservice` menu option allows you to remotely force selected host(s) to restart their **waptservice**. Host sub tab ============ .. figure:: wapt-resources/wapt_console-host-sub-tab.png :align: center :alt: Host sub tab Overview tab ------------ .. figure:: wapt-resources/wapt_console-host-sub-tab-overview.png :align: center :alt: Host summary Host informations ================= .. figure:: wapt-resources/wapt_console-host-sub-tab-overview-common-info.png :align: center :alt: Host summary .. list-table:: Informations displayed in the :guilabel:`Overview` tab :header-rows: 1 :widths: auto :align: center * - :guilabel:`Name` - The name of the host * - :guilabel:`Description` - The description of the host * - :guilabel:`Operating system` - The operating system running on the host * - :guilabel:`IP address` - The IP address of the host * - :guilabel:`Last task` - The last WAPT task that was run on the host * - :guilabel:`Manufacturer` - The manufacturer of the host * - :guilabel:`Model` - The model of the host * - :guilabel:`Last seen` - The date of the latest update on the host * - :guilabel:`Logged in users` - The name of the user last or currently connected on the host * - :guilabel:`UUID` - UUID BIOS to the host Search keywords =============== .. figure:: wapt-resources/wapt_console-host-sub-tab-overview-search.png :align: center :alt: Field for searching on WAPT package keywords Package status filtering ======================== .. figure:: wapt-resources/wapt_console-host-sub-tab-status-filter.png :align: center :alt: Checkboxes for filtering on host status The checkboxes allow you to filter packages by their :ref:`status `. .. list-table:: Status of packages in the WAPT console :header-rows: 1 :align: center :widths: auto * - Status - Description * - :guilabel:`Errors` - List of packages that have not installed correctly. * - :guilabel:`To upgrade` - List of packages for which an update is available. * - :guilabel:`To install` - List of packages waiting to be installed. * - :guilabel:`To remove` - List of packages waiting to be removed. The checkbox :guilabel:`All` allows you to select all status. The button :guilabel:`Pending` allows you to select packages having status: * :guilabel:`NEED-UPGRADE`; * :guilabel:`NEED-INSTALL`; * :guilabel:`TO-REMOVE`. Package layout =============== .. figure:: wapt-resources/wapt_console-host-sub-tab-package-layout.png :align: center :alt: Header of the grid showing the list of WAPT packages installed on host It is possible to select more columns with a Right-Click on the grid header. .. figure:: wapt-resources/wapt_console-host-sub-tab-package-layout-detailed.png :align: center :alt: List of available columns to add to the grid .. list-table:: Status of packages in the WAPT console :header-rows: 1 :align: center :widths: auto * - Status - Description * - :guilabel:`Status (install_status)` - :ref:`Status ` of the WAPT package. * - :guilabel:`Audit status (last_audit_status)` - :ref:`Last date of compliance audit `. * - :guilabel:`Version (version)` - Version of the WAPT package. * - :guilabel:`Description (description)` - Description of the WAPT package. * - :guilabel:`Dependencies (depends)` - Dependancies of the WAPT package. * - :guilabel:`Install date (install_date)` - Install date of the WAPT package. * - :guilabel:`priority` - **Not used**. * - :guilabel:`sources (sources)` - URL for downloading the original software load. * - :guilabel:`Installed by (explicit_by)` - User who has installed the package on the host. * - :guilabel:`Section (section)` - :ref:`Type ` of WAPT package. * - :guilabel:`Architecture (architecture)` - CPU architecture of the package. * - :guilabel:`Locale (locale)` - Language of the WAPT package. * - :guilabel:`md5sum (md5sum)` - md5 sum of the WAPT package. * - :guilabel:`File name (filename)` - Name of the package on the WAPT repository. * - :guilabel:`Parameters (install_params)` - List of installation parameters for the WAPT package. * - :guilabel:`Log install (install_output)` - Installation logs of the WAPT package. * - :guilabel:`maintainer (maintainer)` - Name of the maintainer of the WAPT package. * - :guilabel:`conflict (conflict)` - List of forbidden packages (packages that need to be uninstalled before the package can install). * - :guilabel:`Size after install (installed_size)` - Storage occupied by the software once installed. * - :guilabel:`URL of repository (repo_url)` - URL of the repository from which the package has been downloaded. * - :guilabel:`Size (size)` - Size of the WAPT package in the repository. * - :guilabel:`Name of repository (repo_url)` - :abbr:`FQDN (Fully Qualified Domain Name)` of the repository from which the package has been downloaded. * - :guilabel:`Maturity (maturity)` - Level of maturity of the WWAPT package (**DEV**, **PREPROD**, **PROD**). * - :guilabel:`Audited on` - Date of the last compliance audit. * - :guilabel:`Next audit (next_audit_on)` - Date of the next compliance audit. * - :guilabel:`uninstall_key (uninstall_key)` - Uninstall key of the software. * - :guilabel:`update_on (update_on)` - Date of the last package update. * - :guilabel:`update_by (update_by)` - User having last updated the package. * - :guilabel:`created_on (created_on)` - Date of first installation of the WAPT package. * - :guilabel:`created_by (created_by)` - User having first installed the WAPT package. * - :guilabel:`last_audit_output (last_audit_output)` - Log of the last compliance audit * - :guilabel:`id (id)` - Database ID of the package in the WAPT agent local :file:`sqlite`. .. _packages_status: Package status ============== .. figure:: wapt-resources/wapt_console-host-sub-tab-package-status.png :align: center :alt: Package status .. list-table:: Status of packages in the WAPT console :header-rows: 1 :align: center :widths: auto * - Status - Description * - :guilabel:`OK` - Installed package * - :guilabel:`ERROR` - Package with install error * - :guilabel:`NEED-UPGRADE` - Package with pending upgrade * - :guilabel:`NEED-INSTALL` - Package with pending install * - :guilabel:`TO-REMOVE` - Package with pending uninstall It is possible to get informations about status by clicking on it. For example, here is an error status: .. figure:: wapt-resources/wapt_console-host-in-error.png :align: center :alt: Error detail Acting on packages installed on a host ====================================== .. figure:: wapt-resources/wapt_console-action-menu-on-packages.png :align: center :alt: Possible actions for WAPT packages Possible actions for WAPT packages .. hint:: * Selecting several packages is possible; * If several hosts are selected, the action will be launched on all selected hosts; .. list-table:: Available parameters for the [option] section of waptserver.ini :header-rows: 1 :widths: auto * - Action - Description * - Install a package - The action installs the selected package on the selected host(s). * - Force a package - The action forces the re-installation of a selected package on the selected host(s). * - Remove a package - The action removes the selected package from the selected host(s) * - Forget a package - The action tells the selected host(s) **to no longer use WAPT** to manage the software or the configuration * - Audit the package |enterprise_feature| - The action triggers an audit on the selected package(s) .. _hardware_host_tab: Hardware inventory tab ====================== Information displayed by default in the :guilabel:`Hardware inventory` tab is: * Information on the host's hardware components. * Information about the host. * Information on the status of WAPT. .. figure:: wapt-resources/wapt_console-hardware-inventory.png :align: center :alt: Host hardware inventory A :guilabel:`Filter` box allows to search for hosts. .. hint:: Filters work with `regular expression `_. .. _adding_inventory_column: To add a column in the grid, drag and drop a hardware property from the :guilabel:`Hardware inventory` grid to the main grid. Example: in :guilabel:`hosts`, drag and drop *physical_memory* in the left panel, and the column :guilabel:`physical_memory` appears in the main grid. .. figure:: wapt-resources/wapt_console-add-filter-column-to_grid.png :align: center :alt: Adding a criteria to the main grid of the WAPT console Software inventory tab ====================== Common information displayed in the :guilabel:`Software Inventory` tab is: * :guilabel:`maker`; * :guilabel:`software name`; * :guilabel:`software version`; * :guilabel:`installation date`; * :guilabel:`uninstall key`; * :guilabel:`uninstall string`. .. figure:: wapt-resources/wapt_console-software-inventoried-in-windows-registry-grid.png :align: center :alt: Software inventory as registered in the Windows registry of the host Windows update tab |enterprise_feature| ======================================= Information displayed in the :guilabel:`Windows update` tab is: * Windows update agent version. * Date of the last Windows update scan. * Duration of the last scan. * WAPTWUA status. * Date of the last version of :file:`wsusscn2.cab` processed by WAPT. * Status of WAPTWUA Enabled (True/ False). The grid then lists Windows cab files that have been installed or that are pending installation. Information displayed in the :guilabel:`Windows Updates` tab are: * :guilabel:`Status`; * :guilabel:`Product`; * :guilabel:`Update ID`; * :guilabel:`Kbids`; * :guilabel:`Published on`; * :guilabel:`installation on`; * :guilabel:`Severity on`; * :guilabel:`Classification`; * :guilabel:`Title`; * :guilabel:`Download size`. .. figure:: wapt-resources/wapt_console-windows-update-inventory.png :align: center :alt: Inventory of Windows Updates Task tab ======== Information displayed by default in the :guilabel:`Tasks` tab is: * Pending tasks. .. figure:: wapt-resources/wapt_console-pending-task-grid.png :align: center :alt: Details of pending tasks on the host * Completed tasks. .. figure:: wapt-resources/wapt_console-done-tasks-grid.png :align: center :alt: Details of completed tasks * Tasks in error. .. figure:: wapt-resources/wapt_console-tasks-in-error.png :align: center :alt: Details of tasks in error Packages overview ================= Audit data ========== ***************** WAPT Packages tab ***************** Refresh packages list ===================== Import packages =============== .. figure:: wapt-resources/wapt_console-import-package.png :align: center :alt: Button for importing a WAPT package .. figure:: wapt-resources/wapt_console-import-package-options.png :align: center :alt: Menu for importing a WAPT package .. figure:: wapt-resources/wapt_console-import-package-options-repositories-settings.png :align: center :alt: Window for setting up a repository to import packages from .. _package_signature: .. attention:: If the verification of :ref:`the package signature ` is enabled for added security, the public certificate of the signer(s) whose packages are stored in the repository must be located in one of the following folders: * :file:`C:\\Program Files (x86)\\wapt\\ssl`; * :file:`%appdata%\\waptconsole\\ssl`; If the certificate is not found in one of these two folders, then the following error will occur and no package will not be imported from the repository. .. figure:: wapt-resources/wapt_console-error-with-package-signature.png :align: center :alt: Error while validating the signature of an external repository Error while validating the signature of an external repository Import from file ================ Build and upload packages ------------------------- Make packages template from setup file ====================================== .. figure:: wapt-resources/wapt_console-make-package-template-scroll.png :align: center :alt: Make packages template from setup file Package template ---------------- .. figure:: wapt-resources/wapt_console-package-wizard.png :align: center :alt: Package wizard To select file, click on: .. figure:: wapt-resources/select_file.png :align: center :alt: Select file Windows installer (.msi/.msix/.exe) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Portable Windows application ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Windows Update package (.msu) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ macOS package (.dmg/.pkg) ^^^^^^^^^^^^^^^^^^^^^^^^^ Linux package (.deb/rpm) ^^^^^^^^^^^^^^^^^^^^^^^^ .. _build_crt: Certificate package (.crt) ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-package-wizard-certificate.png :align: center :alt: Certificate package Select .crt and click on ``Continue`` .. figure:: wapt-resources/wapt_console-package-wizard-certificate-valid.png :align: center :alt: Confirmation package Confirm informations and click to ``Build and upload`` Empty package ^^^^^^^^^^^^^ Group ----- AD profile ---------- .. figure:: wapt-resources/wapt-profile-bundle-create-group1.png :align: center :alt: Click on New host AD profile to create a *profile* bundle After clicking : .. figure:: wapt-resources/wapt-profile-bundle-create-group2.png :align: center :alt: Adding packages to profile bundle For using, see :ref:`AD profile ` WUA rules --------- Self-service rules ------------------ Search tab ========== Last version only ================= .. _filter_packages: Filter packages =============== .. figure:: wapt-resources/wapt_console-filter-packages.png :align: center :alt: Filter of a WAPT package Show host ========= Architecture ============ OS === Locale ====== Maturity ======== Action on packages ================== Remove from repository ---------------------- Edit packages ------------- Change packages maturity ------------------------ .. figure:: wapt-resources/wapt_console-change-maturity-on-repositorie.png :align: center :alt: Changing the maturity of a WAPT package .. figure:: wapt-resources/wapt_console-change-packages-maturity.png :align: center :alt: Changing the maturity of a WAPT package Resign packages --------------- Download Packages ----------------- Search ------ ****************** Windows Update tab ****************** .. figure:: wapt-resources/wapt_console-windows-update-empty.png :align: center :alt: Windows Updates tab Refresh ======= .. figure:: wapt-resources/wapt_console-windows-updates-refresh.png :align: center :alt: Windows Updates refresh Button to refresh Windows Update display Download WSUSScan cab from Microsoft Web site ============================================= .. figure:: wapt-resources/wapt_console-windows-updates-dl-wsusscan.png :align: center :alt: Windows Updates download WSUSScan cab Button to force download WSUSScan cab Show Download history ===================== .. figure:: wapt-resources/wapt-wua-windows-update-clean.png :align: center :alt: Windows Updates show download history Button to show download history ActWUAGetUnusedKB ================= .. figure:: wapt-resources/wapt-wua-windows-update-clean.png :align: center :alt: Windows Updates delete unused kb Button to delete unused Windows Update ********** Source tab ********** ************* Reporting tab ************* Refresh ======= .. figure:: wapt-resources/wapt_console-secondary-repo-refresh.png :align: center :alt: Reporting refresh Button to refresh reporting tab display Design mode =========== .. figure:: wapt-resources/wapt_console-reporting-design-mode.png :align: center :alt: Reporting design mode Button to switch to design mode in repoting tab Execute ======= .. figure:: wapt-resources/wapt_console-reporting-execute.png :align: center :alt: Reporting execute Button to execute query Export to spreadsheet ===================== .. figure:: wapt-resources/wapt_console-reporting-export-spreadsheet.png :align: center :alt: Reporting export to spreadsheet Button to export to spreadsheet query result Normalize software titles ========================= .. figure:: wapt-resources/wapt_console-reporting-normalize-soft.png :align: center :alt: Reporting normalize software titles Button to normalize software titles Right click menu ================ .. figure:: wapt-resources/wapt_console-reporting-right-click-menu.png :align: center :alt: Reporting Right-click menu Right-click menu on the left of reporting tab Execute ------- .. figure:: wapt-resources/wapt_console-reporting-right-click-execute.png :align: center :alt: Reporting Right-click execute Other way to execute query Edit name --------- .. figure:: wapt-resources/wapt_console-reporting-right-click-rename.png :align: center :alt: Reporting Right-click rename Rename query name Export to spreadsheet --------------------- .. figure:: wapt-resources/wapt_console-reporting-right-click-export-spreadsheet.png :align: center :alt: Reporting Right-click export to spreadsheet Other way to export spreadsheet query result Export queries to file ---------------------- .. figure:: wapt-resources/wapt_console-reporting-right-click-export-query.png :align: center :alt: Reporting Right-click export to file Export query result to file Import queries -------------- .. figure:: wapt-resources/wapt_console-reporting-right-click-import-query.png :align: center :alt: Reporting Right-click import Import query from external source Search ------ .. figure:: wapt-resources/wapt_console-reporting-right-click-search.png :align: center :alt: Reporting Right-click search Search query name ******************* Secondary repos tab ******************* Left on tab =========== Refresh ------- .. figure:: wapt-resources/wapt_console-secondary-repo-refresh.png :align: center :alt: Secondary repos refresh Button to refresh secondary repos display Up rule ------- .. figure:: wapt-resources/wapt_console-secondary-repo-up-rule.png :align: center :alt: Secondary repos up rule Button to put up rule in secondary repo Down rule --------- .. figure:: wapt-resources/wapt_console-secondary-repo-down-rule.png :align: center :alt: Secondary repos down rule Button to put down rule in secondary repo Add rule -------- .. figure:: wapt-resources/wapt_console-secondary-add-rule.png :align: center :alt: Secondary repos add rule Button to add rule in secondary repo Edit rule --------- .. figure:: wapt-resources/wapt_console-secondary-edit-rule.png :align: center :alt: Secondary repos edit rule Button to edit rule in secondary repo Delete rule ----------- .. figure:: wapt-resources/wapt_console-secondary-delete-rule.png :align: center :alt: Secondary repos delete rule Button to delete rule in secondary repo Save rule changes ----------------- .. figure:: wapt-resources/wapt_console-secondary-save-rule.png :align: center :alt: Secondary repos save rule Button to save rule in secondary repo Import Rules ------------ .. figure:: wapt-resources/wapt_console-secondary-import-rule.png :align: center :alt: Secondary repos import rule Button to import rule in secondary repo Export Rules ------------ .. figure:: wapt-resources/wapt_console-secondary-export-rule.png :align: center :alt: Secondary repos export rule Button to export rule in secondary repo Right click menu ---------------- .. figure:: wapt-resources/wapt_console-secondary-rigth-click-rule.png :align: center :alt: Secondary repos right-click edit rule Other way to edit a selected rule Edit rule ^^^^^^^^^ .. figure:: wapt-resources/wapt_console-secondary-click-edit-rule.png :align: center :alt: Secondary repos right-click edit rule Other way to edit a selected rule Delete rule ^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-secondary-click-delete-rule.png :align: center :alt: Secondary repos right-click delete rule Other way to delete a selected rule Right on tab ============ Refresh ------- .. figure:: wapt-resources/wapt_console-secondary-repo-refresh.png :align: center :alt: Secondary repos refresh client display Button to refresh secondary repos client display Sync selected ------------- .. figure:: wapt-resources/wapt_console-secondary-repo-sync-selected.png :align: center :alt: Secondary repos sync selected Button to sync selected secondary repos client Sync all -------- .. figure:: wapt-resources/wapt_console-secondary-repo-sync-all.png :align: center :alt: Secondary repos sync all Button to sync all secondary repos client Update index ------------ .. figure:: wapt-resources/wapt_console-secondary-repo-update-index.png :align: center :alt: Secondary repos update index Button to update index secondary repos Changelog --------- .. figure:: wapt-resources/wapt_console-secondary-repo-changelog.png :align: center :alt: Secondary repos changelog Button to get changelog of secondary repos Search input ------------ .. figure:: wapt-resources/wapt_console-secondary-repo-search.png :align: center :alt: Secondary repos search input Search in secondary repos host with keywords Right click menu ---------------- .. figure:: wapt-resources/wapt_console-secondary-repo-right-click-right-tab.png :align: center :alt: Secondary repos Right-click menu from right tab Secondary repos Right-click menu from right tab Sync selected ^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-secondary-repo-sync-selected-click.png :align: center :alt: Secondary repos Right-click sync selected Secondary repos Right-click sync selected host to synchronise Force sync selected ^^^^^^^^^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-secondary-repo-force-sync-selected-click.png :align: center :alt: Secondary repos Right-click force sync selected Secondary repos Right-click force sync selected host to synchronise Show errors ^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-secondary-repo-show-errors.png :align: center :alt: Secondary repos Right-click show errors Secondary repos Right-click show errors on selected host Check files ^^^^^^^^^^^ .. figure:: wapt-resources/wapt_console-secondary-repo-check-files.png :align: center :alt: Secondary repos Right-click check files Secondary repos Right-click check files on selected host