From 80f1cbf193e2120f460fbcf2d592f66342d74afd Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 17:59:31 +0200 Subject: [PATCH 01/24] 1262: language-improvements; appliance-manager/index --- .../appliance-manager/index.mdx | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/administration/appliance-manager/index.mdx b/docs/administration/appliance-manager/index.mdx index e64a65a3d..d3066e53c 100644 --- a/docs/administration/appliance-manager/index.mdx +++ b/docs/administration/appliance-manager/index.mdx @@ -2,25 +2,25 @@ title: "Appliance Manager" --- -The Device42 Appliance Manager runs on port 4242 (HTTP by default; enable HTTPs within) to manage various Device42 Administrative functions. You can do backups & restores, manage HTTPS certifcates, Restart/Stop the application, generate logs or SNMPwalks for tech support, and more. The following topics are covered in this section: +The Device42 Appliance Manager runs on port 4242 (HTTP by default, with HTTPS available to enable from inside) and provides administrative functions such as backups and restores, HTTPS certificate management, application restart and stop controls, and log or SNMPwalk generation for support. This section covers the topics below. -## Table of contents +## Table of Contents -- [Adding multiple Network Interface Cards(NIC) to Device42 VM](administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm.mdx) -- [API Limits](administration/appliance-manager/api-limits.mdx) -- [Changing Device42 Appliance Hostname](administration/appliance-manager/changing-device42-appliance-hostname.mdx) -- [Collecting SNMPWALK output for troubleshooting](administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.mdx) -- [Delete History Logs](administration/appliance-manager/delete-history-logs.mdx) -- [Device42 Appliance Manager login](administration/appliance-manager/device42-appliance-manager-login.mdx) -- [Device42 Restore](administration/appliance-manager/device42-restore.mdx) -- [Enable or Disable TLS versions from Appliance Manager](administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx) -- [Enabling SSL in Appliance Manager](administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx) -- [Generate log bundle](administration/appliance-manager/generate-log-bundle.mdx) -- [Generating IPMI output for troubleshooting](administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx) -- [Global and Password manager session timeout](global-and-password-manager-session-timeout.mdx) -- [Installing VMWare or Xenserver tools](administration/appliance-manager/installing-vmware-or-xenserver-tools.mdx) -- [Pendo Guided Tours and Usage Information Collection](administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx) -- [Set FQDN for Web Access](administration/appliance-manager/set-fqdn-for-web-access.mdx) -- [Set up HTTPS cert](administration/appliance-manager/set-up-https-cert.mdx) -- [Setting up backup via Device42 Appliance Manager](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx) -- [Warm HA Setup, Failover, and Automated Backups](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) +- [Add Multiple Network Interface Cards (NICs) to a Device42 VM](/administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm) +- [API Limits](/administration/appliance-manager/api-limits) +- [Change the Device42 Appliance Hostname](/administration/appliance-manager/changing-device42-appliance-hostname) +- [Collect SNMPwalk Output for Troubleshooting](/administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting) +- [Delete History Logs](/administration/appliance-manager/delete-history-logs) +- [Device42 Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login) +- [Device42 Restore](/administration/appliance-manager/device42-restore) +- [Enable or Disable TLS Versions from Appliance Manager](/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager) +- [Enable SSL in Appliance Manager](/administration/appliance-manager/enabling-ssl-in-appliance-manager) +- [Generate a Log Bundle](/administration/appliance-manager/generate-log-bundle) +- [Generate IPMI Output for Troubleshooting](/administration/appliance-manager/generating-ipmi-output-for-troubleshooting) +- [Global and Password Manager Session Timeout](/administration/appliance-manager/global-and-password-manager-session-timeout) +- [Install VMware or XenServer Tools](/administration/appliance-manager/installing-vmware-or-xenserver-tools) +- [Pendo Guided Tours and Usage Information Collection](/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection) +- [Set FQDN for Web Access](/administration/appliance-manager/set-fqdn-for-web-access) +- [Set Up HTTPS Certificate](/administration/appliance-manager/set-up-https-cert) +- [Set Up Backup via Device42 Appliance Manager](/administration/appliance-manager/setting-up-backup-device42-appliance-manager) +- [Warm HA Setup, Failover, and Automated Backups](/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups) From 68fe8c2ec3c6b9ae00b2c40a3f2ed90df0e198df Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 17:59:52 +0200 Subject: [PATCH 02/24] 1262: language-improvements; appliance-manager/adding-multiple-network-interface-cards --- ...work-interface-cardsnic-to-device42-vm.mdx | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm.mdx b/docs/administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm.mdx index 3f74d3a8c..8e21d71a4 100644 --- a/docs/administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm.mdx +++ b/docs/administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm.mdx @@ -1,40 +1,40 @@ --- -title: "Adding multiple Network Interface Cards(NIC) to Device42 VM" +title: "Adding Multiple Network Interface Cards (NICs) to a Device42 VM" sidebar_position: 1 --- -If you need to reach networks that can not be reached from the primary virtual machine network adapter (e.g. for autodiscovery), you can add additional network adapters to your virtual machine as outlined below. +If you need to reach networks that aren't reachable from the primary virtual machine network adapter — for example, for discovery — you can add additional network adapters to the Device42 VM. This page covers how to add NICs, configure them, and verify the network configuration. ## Add Multiple NICs to the VM ![Add multiple NICs to the VM](/assets/images/wpid4810-vmware_nic.png) -First, create an additional network adapter in the virtual machine settings. This is illustrated above for VMWare ESX. +Create an additional network adapter in the virtual machine settings. The screenshot above shows the process for VMware ESX. -Please note: Some virtualization platforms do not support adding NIC cards to a running instance. If this is the case for your virtualization platform, you will need to shutdown the Device42 instance first. +:::note +Some virtualization platforms do not support adding NICs to a running instance. If this is the case for your platform, shut down the Device42 instance before adding the NIC. +::: -You can add as many NICs as you want. - -One of the NICs will be the primary interface and will have default gateway and DNS defined. The other NICs will serve as the direct connection to specific network segments only. +You can add as many NICs as needed. One NIC will serve as the primary interface with the default gateway and DNS defined. The other NICs will provide direct connections to specific network segments only. ## Configure the Assigned NICs ![Configuring the assigned NICs](/assets/images/wpid4809-vmware_console_ip_settings.png) -From the Device42 virtual machine console, select option 1, then choose 'n' at the 'Use DHCP' prompt. +From the Device42 VM console, select option 1, then choose `n` at the **Use DHCP** prompt. -For each NIC, you will be prompted for the IP Address, Netmask, Gateway, and DNS Server (see below). As displayed above, the console will display the MAC address of the NIC being configured. Please make sure you are assigning the right IPs to each card. To make sure, please compare the displayed MAC address with the one shown in the virtual machine console. +For each NIC, you will be prompted for the IP Address, Netmask, Gateway, and DNS Server. The console displays the MAC address of the NIC being configured — compare it with the MAC address shown in the virtual machine console to confirm you are assigning the correct IPs to each card. ### First Interface Vs. Other Interfaces ![First interface vs. other interfaces](/assets/images/wpid4807-first_vs_rest_interface.png) -As shown in the image above, first add the Gateway and DNS info for the first NIC card. For the rest of the NIC cards, please add the IP Address and Netmask but please do NOT add the Gateway and DNS for any of the additional NIC cards. If you do, it will significantly slow down the boot up process while configuring the network interfaces. +Add the Gateway and DNS information for the first NIC. For all additional NICs, add only the IP Address and Netmask — do not add the Gateway or DNS, as doing so will significantly slow the boot process while configuring the network interfaces. -You can check your config after from the Device42 appliance manager as discussed in next step. +You can verify your configuration from the Device42 Appliance Manager, as described in the next section. -## Check Your Network Config +## Check Your Network Configuration ![Checking your network config](/assets/images/wpid4626-usage-network-info.png) -You can check your network config from the appliance manager under System > Usage/Network Info. +In the Appliance Manager, navigate to **System > Usage/Network Info** to view your network configuration. From 2e70204e22e86218ca471d2516f92af9fb51b1dd Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 18:00:09 +0200 Subject: [PATCH 03/24] 1262: language-improvements; appliance-manager/api-limits --- docs/administration/appliance-manager/api-limits.mdx | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/administration/appliance-manager/api-limits.mdx b/docs/administration/appliance-manager/api-limits.mdx index 4b1c13c48..c779cefef 100644 --- a/docs/administration/appliance-manager/api-limits.mdx +++ b/docs/administration/appliance-manager/api-limits.mdx @@ -3,8 +3,12 @@ title: "API Limits" sidebar_position: 2 --- -From the Appliance Manager, you can set a limit on the number of remote agents that can attempt to update at once. This option is intended for administrators who have hundreds of agents and need to prevent those agents from simultaneously attempting to update, possibly causing the Main Appliance to become overloaded. +The API Limits setting in the Appliance Manager lets you cap the number of remote agents that can update concurrently. This page explains how the limit works and how to configure it. -The default setting for the API limit is 16 concurrent agent updates. You can configure this number to best suit your needs, choosing a value between `8` and `128`. +This setting is useful for administrators with hundreds of agents who need to prevent simultaneous updates from overloading the Main Appliance. -![](/assets/images/api-limits/api-limits.png) +## Configure the API Limit + +The default API limit is 16 concurrent agent updates. You can set this to any value between `8` and `128`. + +![API Limits setting in the Appliance Manager](/assets/images/api-limits/api-limits.png) From 944b49272749ab779cc72c60928af596c3e3f803 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 18:00:28 +0200 Subject: [PATCH 04/24] 1262: language-improvements; appliance-manager/changing-device42-appliance-hostname --- .../changing-device42-appliance-hostname.mdx | 30 +++++++++---------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/administration/appliance-manager/changing-device42-appliance-hostname.mdx b/docs/administration/appliance-manager/changing-device42-appliance-hostname.mdx index 50697a5e6..bc8c4387b 100644 --- a/docs/administration/appliance-manager/changing-device42-appliance-hostname.mdx +++ b/docs/administration/appliance-manager/changing-device42-appliance-hostname.mdx @@ -3,32 +3,30 @@ title: "Changing Device42 Appliance Hostname" sidebar_position: 3 --- -You can change the Device42 Appliance hostname from the Appliance Manager or the VM console. +You can change the Device42 Appliance hostname from either the Appliance Manager or the VM console. This page covers both methods. -## Change Hostname in the Appliance Manager +## Change the Hostname in the Appliance Manager -[Log in to the Appliance Manager](device42-appliance-manager-login.mdx). +[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login). -From the left panel, go to **System > Appliance Hostname**, enter the new hostname you would like to use, and click **Save**. You should see a success message. +From the left panel, go to **System > Appliance Hostname**, enter the new hostname, and click **Save**. A success message will appear. -![Change appliance name](/assets/images/changing-device42-appliance-hostname/appliance-hostname-change.png) +![Change appliance hostname](/assets/images/changing-device42-appliance-hostname/appliance-hostname-change.png) -You need to restart the Device42 application. Go to **Application > Restart Application** in the Appliance Manager. +Restart the Device42 application by navigating to **Application > Restart Application** in the Appliance Manager. -![Change appliance name](/assets/images/changing-device42-appliance-hostname/restart-application.png) +![Restart the application](/assets/images/changing-device42-appliance-hostname/restart-application.png) -## Change Hostname in the VM Console +## Change the Hostname in the VM Console -Log in to the VM console. +Log in to the VM console and select **Server Settings** from the main menu. -- Select **Server Settings** from the main menu. +![Server Settings option in the console](/assets/images/changing-device42-appliance-hostname/console-server-settings.png) - ![Change appliance name](/assets/images/changing-device42-appliance-hostname/console-server-settings.png) +Enter the new hostname and select **Save**. -- Enter the new hostname and select **Save**. +![Enter new hostname](/assets/images/changing-device42-appliance-hostname/console-hostname.png) - ![Change appliance name](/assets/images/changing-device42-appliance-hostname/console-hostname.png) +Select **Reboot Server** from the main menu and select **Reboot** to restart the server. -- Select **Reboot Server** from the main menu and select **Reboot** to restart the server. - - ![Change appliance name](/assets/images/changing-device42-appliance-hostname/console-reboot-server.png) +![Reboot Server option in the console](/assets/images/changing-device42-appliance-hostname/console-reboot-server.png) From 34f049affc06ac00299ba81b7754588be1cbca2a Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 18:00:51 +0200 Subject: [PATCH 05/24] 1262: language-improvements; appliance-manager/collecting-snmpwalk-output-for-troubleshooting --- ...ng-snmpwalk-output-for-troubleshooting.mdx | 36 ++++++++++--------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.mdx b/docs/administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.mdx index 125bc9c23..2dd1c6a91 100644 --- a/docs/administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.mdx +++ b/docs/administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.mdx @@ -3,46 +3,48 @@ title: "Collecting SNMP Walk Output" sidebar_position: 4 --- -You can collect SNMP walk output for a network device or PDU right from the GUI. Then, you can download the output and send it to us for further troubleshooting. +You can collect SNMP walk output for a network device or PDU directly from the Appliance Manager and send the output to support for troubleshooting. This page covers the simple walk and MIB browser-based walk options, plus how to generate SNMP output from the terminal. -From the Appliance Manager, go to **Application > Generate SNMP Output**. +From the Appliance Manager, go to **Application > Generate SNMP Output**. ## Simple SNMP Walk Output -If this is not a new device, select the **No: Simple walk** option. +If the target is not a new device, select **No: Simple walk**. -Add your target switch or other SNMP target device info, click **Submit**, and please be patient as it might take a few minutes. Download the generated file and send it to support. +Enter the target switch or SNMP device details, click **Submit**, and wait — generation may take a few minutes. Download the generated file and send it to support. - ![Collect SNMP walk Appliance Manager](/assets/images/collecting-snmpwalk-output-for-troubleshooting/simple-walk.png) +![Simple SNMP walk in the Appliance Manager](/assets/images/collecting-snmpwalk-output-for-troubleshooting/simple-walk.png) ## MIB Browser-Based Walk -For new devices, select **Yes: MIB browser based walk**. +For new devices, select **Yes: MIB browser based walk**. -- Select your **RC** and enter the required fields: **FQDN or IP Address**, **Community String**, and MIB file upload. +Select your **RC** and enter the required fields: **FQDN or IP Address**, **Community String**, and MIB file upload. - ![MIB file upload](/assets/images/collecting-snmpwalk-output-for-troubleshooting/browser-based-walk.png) +![MIB file upload](/assets/images/collecting-snmpwalk-output-for-troubleshooting/browser-based-walk.png) -- Select the data to generate for the new device and **Submit**. +Select the data to generate for the new device and click **Submit**. - ![Generation options](/assets/images/collecting-snmpwalk-output-for-troubleshooting/generate-snmp.png) +![SNMP generation options](/assets/images/collecting-snmpwalk-output-for-troubleshooting/generate-snmp.png) -- Click **Download Archive File** and save the file to attach to an existing support ticket. If needed, [create a new ticket](https://support.device42.com/hc/en-us/requests/new) or [email support](mailto:support@device42.com). +Click **Download Archive File** and save the file to attach to an existing support ticket. If needed, [create a new ticket](https://support.device42.com/hc/en-us/requests/new) or [email support](mailto:support@device42.com). - ![Download Archive file](/assets/images/collecting-snmpwalk-output-for-troubleshooting/download-archive-file.png) +![Download Archive file](/assets/images/collecting-snmpwalk-output-for-troubleshooting/download-archive-file.png) ## Alternative SNMP Walk Generation -If there is an issue, the network is not reachable, or you simply prefer using the terminal, you can instead run the following from any machine that has 'snmpwalk' installed for SNMP v2: +If the network is not reachable from the Appliance Manager or you prefer the terminal, run the following from any machine with `snmpwalk` installed. -``` +For SNMP v2: + +```bash snmpbulkwalk -Cc -ObentU -v2c -c COMMUNITY DEVICE > output_file_name snmpbulkwalk -ObentU -v 2c -c COMMUNITY DEVICE .1.3.6.1.4.1 >> output_file_name ``` -You can use the following for any system using SNMP v3: +For SNMP v3: -``` +```bash snmpbulkwalk -Cc -ObentU -v 3 -u user_name -l authNoPriv -a MD5 -A auth_pass DEVICE > output_file_name snmpbulkwalk -Cc -ObentU -v 3 -u user_name -l authNoPriv -a MD5 -A auth_pass DEVICE .1.3.6.1.4.1 >> output_file_name -``` \ No newline at end of file +``` From 4394913642a73476ca3497777749b5d5fe8706df Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 18:01:06 +0200 Subject: [PATCH 06/24] 1262: language-improvements; appliance-manager/delete-history-logs --- docs/administration/appliance-manager/delete-history-logs.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/administration/appliance-manager/delete-history-logs.mdx b/docs/administration/appliance-manager/delete-history-logs.mdx index 60c667d4f..302626738 100644 --- a/docs/administration/appliance-manager/delete-history-logs.mdx +++ b/docs/administration/appliance-manager/delete-history-logs.mdx @@ -3,6 +3,6 @@ title: "Delete History Logs" sidebar_position: 5 --- -You can delete older history (audit logs) and trending data for performance gains and to clean up old data. +You can delete older history (audit logs) and trending data from the Appliance Manager for performance gains and to clean up old data. -![](/assets/images/media_1414488371177.png) +![Delete history logs option in the Appliance Manager](/assets/images/media_1414488371177.png) From 81d78aeaac4a386eb9c5e32a8dfc848cac89f40e Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 18:01:27 +0200 Subject: [PATCH 07/24] 1262: language-improvements; appliance-manager/device42-appliance-manager-login --- .../device42-appliance-manager-login.mdx | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/administration/appliance-manager/device42-appliance-manager-login.mdx b/docs/administration/appliance-manager/device42-appliance-manager-login.mdx index 5bdd38993..835b9821a 100644 --- a/docs/administration/appliance-manager/device42-appliance-manager-login.mdx +++ b/docs/administration/appliance-manager/device42-appliance-manager-login.mdx @@ -6,14 +6,16 @@ sidebar_position: 6 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Use the Device42 Appliance Manager to back up your data, update the Main Appliance, generate a log bundle [for uploading to the Device42 Support Portal](https://upload.device42.com/), restart the application, and configure **System** and **Global Settings**. +The Device42 Appliance Manager is a web interface for backing up data, updating the Main Appliance, generating log bundles for the [Device42 Support Portal](https://upload.device42.com/), restarting the application, and configuring **System** and **Global Settings**. This page covers how to access the Appliance Manager, log in, and change your password. ## Access the Appliance Manager -![Device42 Appliance Manager Home Screen v19](/assets/images/device42-appliance-manager-login/ap-home-view.png) +![Appliance Manager home screen](/assets/images/device42-appliance-manager-login/ap-home-view.png) -- For HTTP, access the Appliance Manager using port 4242: `http://your-ip-address-or-FQDN:4242` -- For HTTPS, use port 4343: `https://your-ip-address-or-FQDN:4343` +Access the Appliance Manager at one of the following URLs: + +- HTTP on port 4242: `http://:4242` +- HTTPS on port 4343: `https://:4343` Alternatively, go to your Main Appliance login page and click the **Appliance Manager** link. @@ -27,7 +29,7 @@ Alternatively, go to your Main Appliance login page and click the **Appliance Ma ## Login Credentials -The default username and password are `d42admin` and `default`. Please [change the password](#change-your-password) as soon as you log in. +The default username and password are `d42admin` and `default`. [Change the password](#change-your-password) as soon as you log in. ![Appliance Manager login screen](/assets/images/device42-appliance-manager-login/ap-login-screen.png) @@ -37,8 +39,8 @@ Click your username at the top of the left sidebar and select **Change password* ![Change Password screen in Appliance Manager](/assets/images/device42-appliance-manager-login/change-password.png) -## AWS Login +## AWS Login -For **marketplace** AWS installations, use `d42admin` as the username and your **AWS Instance ID** as the default password. See [the AWS installation instructions](https://docs.device42.com/getstarted/deploy-device42/installation-amazon-web-services/#accessing-the-d42-appliance-manager---aws-marketplace-installs) for more information. +For **marketplace** AWS installations, use `d42admin` as the username and your **AWS Instance ID** as the default password. See the [AWS installation instructions](/getstarted/deploy-device42/installation-amazon-web-services/#accessing-the-d42-appliance-manager---aws-marketplace-installs) for details. -If you **manually** installed AWS using a downloaded image, use the default Device42 username, `d42admin`, and password, `default`, to log in to the Appliance Manager. +For **manual** AWS installations using a downloaded image, log in with the default Device42 username `d42admin` and password `default`. From 88e73ecc1360c67171a2165007dfcdf46af9d078 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 18:01:52 +0200 Subject: [PATCH 08/24] 1262: language-improvements; appliance-manager/device42-restore --- .../appliance-manager/device42-restore.mdx | 57 ++++++++++--------- 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/docs/administration/appliance-manager/device42-restore.mdx b/docs/administration/appliance-manager/device42-restore.mdx index 276e955d1..ee033580e 100644 --- a/docs/administration/appliance-manager/device42-restore.mdx +++ b/docs/administration/appliance-manager/device42-restore.mdx @@ -3,53 +3,56 @@ title: "Device42 Restore" sidebar_position: 7 --- +The Device42 restore process replaces the current appliance data with data from a backup file. This page covers Active Directory considerations, the restore steps for Main Appliance and Remote Collector backups, and recommended test restore options. + :::caution -Please take note of the following before you proceed with the restore process: +Note the following before starting the restore: -- The Device42 versions of the backup and restore must be identical for the backup-restore scenario to be supported. -- The restore process will delete all current data in the appliance. You can do a [test restore](#test-restore-options) first to verify that the restore works as you expect. +- The Device42 versions of the backup and the appliance must be identical for the backup-restore scenario to be supported. +- The restore process deletes all current data in the appliance. Run a [test restore](#test-restore-options) first to verify that it works as expected. ::: -## Active Directory Settings +## Active Directory Settings -Active Directory settings are crucial for logging back in. Otherwise, you can use local accounts to log back in after the restore and add Active Directory settings later. +Active Directory settings are critical for logging back in. If you have only Active Directory users (no local Device42 users), manually add the Active Directory settings before the restore. -If you are doing a restore and have only Active Directory users (no Device42-only users), you will need to manually add the Active Directory settings prior to the restore. +If you have local accounts, you can use them to log in after the restore and add Active Directory settings later. ## Restore the MA and RC Backup Files -From the [Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login.mdx), navigate to **Backup/Restore > Restore**. +From the [Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login), navigate to **Backup/Restore > Restore**. + +Select **Main Appliance** or **Remote Collector**. You need separate backup `.enc` files for the MA and RC. -- Select **Main Appliance** or **Remote Collector**. You need separate backup `.enc` files for the MA and RC. -- To restore the MA or RC, enter the passphrase you used for the backup. If you have forgotten the password encryption phrase, you can create a new backup: +To restore the MA or RC, enter the passphrase you used for the backup. If you have forgotten the encryption passphrase, create a new backup: - - Click **Set Passphrase** on the left menu panel, click **Clear Passphrase**, enter a new passphrase, and create a new backup. +- Click **Set Passphrase** in the left menu panel, click **Clear Passphrase**, enter a new passphrase, and create a new backup. -- Select the **Restore Meta Data** option. If you did not select the **Backup Meta Data** option [when creating the backup](/administration/appliance-manager/setting-up-backup-device42-appliance-manager#run-backup-now), re-enter the following settings and options after restoring the appliance: +Select the **Restore Meta Data** option. If you did not select **Backup Meta Data** [when creating the backup](/administration/appliance-manager/setting-up-backup-device42-appliance-manager#run-backup-now), re-enter the following settings after restoring the appliance: - - Passphrases for backups and Password Encryption - - Language - - Time - - SSL/HTTPS - - Host/hostname information - - All appliance manager settings (including backup schedules) - - All certificates +- Passphrases for backups and password encryption +- Language +- Time +- SSL/HTTPS +- Host and hostname information +- All Appliance Manager settings (including backup schedules) +- All certificates -- **Browse** to the backup `.enc` file you want to restore. +Click **Browse** to select the backup `.enc` file you want to restore. - ![Restore](/assets/images/device42-restore/restore-ma.png) +![Restore screen](/assets/images/device42-restore/restore-ma.png) -- You'll see a success message at the bottom of the screen. Contact our [support team](https://support.device42.com/) if you have any issues. +A success message appears at the bottom of the screen. Contact the [support team](https://support.device42.com/) if you encounter any issues. - ![Restore success](/assets/images/device42-restore/ma-restore-success.png) +![Restore success](/assets/images/device42-restore/ma-restore-success.png) -- Restart the application once it has been restored by going to **Application > Restart Application**. +Restart the application once the restore is complete by navigating to **Application > Restart Application**. - ![Restore](/assets/images/device42-restore/restart-application.png) +![Restart application](/assets/images/device42-restore/restart-application.png) ## Test Restore Options -If you are doing a test restore, we recommend the following two options: +For a test restore, use one of these two approaches: -1. Spin up a new Device42 virtual appliance and restore your backup there. It is useful to have a second instance for disaster recovery or business continuity purposes, as described on the [Warm HA Configuration](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) page. Your license allows one production and one backup instance. -2. Take a VM snapshot first, and then do a test restore. +1. Spin up a new Device42 virtual appliance and restore your backup there. Having a second instance is useful for disaster recovery or business continuity, as described in the [Warm HA Configuration](/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups) page. Your license allows one production and one backup instance. +2. Take a VM snapshot first, then run a test restore. From e232a201946a1bbf7db1b066ded5a7efd843e2c3 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 18:02:10 +0200 Subject: [PATCH 09/24] 1262: language-improvements; appliance-manager/enable-or-disable-tls-versions-from-appliance-manager --- ...sable-tls-versions-from-appliance-manager.mdx | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx b/docs/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx index f9178ced2..b3707bce8 100644 --- a/docs/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx +++ b/docs/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx @@ -3,14 +3,18 @@ title: "Enable or Disable TLS Versions from Appliance Manager" sidebar_position: 8 --- -Device42 allows you to restrict TLS versions for Appliance Manager Access. The radio buttons shown below control this feature. +Device42 lets you restrict the TLS versions used for Appliance Manager and Web Console access. This page covers how to change the TLS version setting. -To apply TLS version restrictions, log in to the Device42 Appliance Manager. See [Device42 Appliance Manager Login](device42-appliance-manager-login.mdx) for more details about accessing and logging in to the Appliance Manager. -- From the main menu on the left side of the Appliance Manager, select **Global Settings** and then **TLS versions for Web Console** or **TLS versions for Appliance Manager**. -- Select the appropriate radio button and click **Submit** to apply your changes. +## Apply TLS Version Restrictions - ![](/assets/images/enable-or-disable-tls-versions-from-appliance-manager/main-appliance-tls-options.png) +Log in to the Device42 Appliance Manager. See [Device42 Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login) for instructions. + +From the main menu on the left, select **Global Settings**, then choose **TLS versions for Web Console** or **TLS versions for Appliance Manager**. + +Select the appropriate radio button and click **Submit** to apply your changes. + +![TLS version options in the Appliance Manager](/assets/images/enable-or-disable-tls-versions-from-appliance-manager/main-appliance-tls-options.png) :::note -The Appliance Manager now defaults to **Enable TLS v1.2 only**. You can change the TLS settings in the Appliance Manager to **Enable TLS v.1.1 and v1.2** or **Enable All TLS**. +The Appliance Manager defaults to **Enable TLS v1.2 only**. You can change the setting to **Enable TLS v1.1 and v1.2** or **Enable All TLS**. ::: From 2d72d2e5bdb7a21b05edd6c61b7aba2bde9cbb5d Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Thu, 30 Apr 2026 18:02:27 +0200 Subject: [PATCH 10/24] 1262: language-improvements; appliance-manager/enabling-ssl-in-appliance-manager --- .../enabling-ssl-in-appliance-manager.mdx | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx b/docs/administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx index 612b3218f..fb2e5cb7d 100644 --- a/docs/administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx +++ b/docs/administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx @@ -3,15 +3,18 @@ title: "Enabling SSL in Appliance Manager" sidebar_position: 9 --- -Device42 now has the ability to use HTTPS in the Appliance Manager, in addition to the existing HTTPS in the Main Appliance. +Device42 supports HTTPS in the Appliance Manager in addition to the Main Appliance. This page covers how to enable SSL for the Appliance Manager. -To enable this functionality, log in to the Device42 Appliance Manager by clicking the link at the bottom of the main login page and entering your Device42 credentials. The default username and password for the Appliance Manager are `d42admin` and `default`. For details about which URL to use and how to update the default password, see [Appliance Manager Login](device42-appliance-manager-login.mdx). +## Enable HTTPS in the Appliance Manager -- From the main menu (left panel) of the Appliance Manager, select **Appliance Manager SSL**: -- Check **Enable HTTPS** to enable SSL and click **Set**. You'll see a success message prompting you to restart the appliance from the VM console. +Log in to the Device42 Appliance Manager. The default username and password are `d42admin` and `default` — see [Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login) for the URL and password change instructions. - ![HTTPS enabled](/assets/images/enabling-ssl-in-appliance-manager/appliance-manager-ssl.png) +From the main menu in the left panel, select **Appliance Manager SSL**. -- Log in to the VM console and select **Reboot Server**. +Check **Enable HTTPS** and click **Set**. A success message will prompt you to restart the appliance from the VM console. - ![Reboot appliance](/assets/images/enabling-ssl-in-appliance-manager/console-reboot-services.png) +![HTTPS enabled in Appliance Manager](/assets/images/enabling-ssl-in-appliance-manager/appliance-manager-ssl.png) + +Log in to the VM console and select **Reboot Server**. + +![Reboot Server option in the console](/assets/images/enabling-ssl-in-appliance-manager/console-reboot-services.png) From f374119da7570ad39985c0fa707331afc9558ae6 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 1 May 2026 09:39:29 +0200 Subject: [PATCH 11/24] 1262: language-improvements; appliance-manager/generate-log-bundle --- .../appliance-manager/generate-log-bundle.mdx | 24 +++++++++++-------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/administration/appliance-manager/generate-log-bundle.mdx b/docs/administration/appliance-manager/generate-log-bundle.mdx index 191f54f5b..a71103d25 100644 --- a/docs/administration/appliance-manager/generate-log-bundle.mdx +++ b/docs/administration/appliance-manager/generate-log-bundle.mdx @@ -6,9 +6,11 @@ sidebar_position: 10 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -If you are experiencing issues with discovery, you can generate a log bundle and send it to support for further analysis. +When you encounter issues with discovery or other Device42 functionality, you can generate a log bundle and send it to support for analysis. This page covers how to generate the Main Appliance log bundle and the Remote Collector log bundle. -1. Edit the discovery job and set the debug mode to **Debug On**. For issues unrelated to autodiscovery, you can keep debug mode off and proceed to Step 3. +## Generate the Main Appliance Log Bundle + +1. Edit the discovery job and set the debug mode to **Debug On**. For issues unrelated to discovery, leave debug mode off and skip to step 3. + /> + +2. If the issue is discovery-related, rerun the failing discovery job with the debug flag enabled. + +3. Log in to the Appliance Manager via **Tools > Appliance Manager** in the main menu, or follow the [Device42 Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login) directions. + +4. In the Appliance Manager, navigate to **Application > Generate Log Bundle** and click **Run**. -2. If the issue is discovery-related, rerun the failing discovery job now that you've enabled the debug flag. -3. Log in to the Appliance Manager via the main menu, **Tools > Appliance Manager**, or by following the [Device42 Appliance Manager Login](device42-appliance-manager-login.mdx) directions. -4. Generate the log bundle via the Appliance Manager. Navigate to **Application > Generate Log Bundle** and click **Run**. - - ![Generate Log Bundle via Appliance Manager](/assets/images/generate-log-bundle/generate-log-bundle-19.06.png) + ![Generate Log Bundle in the Appliance Manager](/assets/images/generate-log-bundle/generate-log-bundle-19.06.png) 5. Upload the generated log file at [upload.device42.com](https://upload.device42.com/). ## Remote Collector Log Bundle -If you were also using the Remote Collector (RC) for the job, please get and upload the RC logs using the [same upload link](https://upload.device42.com/) above. +If you were also using a Remote Collector (RC) for the job, upload the RC logs at the [same upload link](https://upload.device42.com/). -Navigate to **Discovery > Remote Collectors** and click on the **Logs** link for the corresponding RC under the **Actions** column. Let us know when the file has been uploaded, and we'll continue investigating the issue. +Navigate to **Discovery > Remote Collectors** and click the **Logs** link for the corresponding RC in the **Actions** column. Notify support once the file has been uploaded so they can continue investigating the issue. Date: Fri, 8 May 2026 17:01:38 +0200 Subject: [PATCH 12/24] 1262: language-improvements; appliance-manager/generating-ipmi-output-for-troubleshooting --- .../generating-ipmi-output-for-troubleshooting.mdx | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx b/docs/administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx index 4dd576893..9e14f0e97 100644 --- a/docs/administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx +++ b/docs/administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx @@ -1,15 +1,14 @@ --- -title: "Generating IPMI output for troubleshooting" +title: "Generating IPMI Output for Troubleshooting" sidebar_position: 11 --- -You can collect Intelligent Platform Management Interface (IPMI) output for a device right from the Appliance Manager GUI and send us the output for further troubleshooting. +You can collect Intelligent Platform Management Interface (IPMI) output for a device directly from the Appliance Manager and send the output to support for troubleshooting. This page covers how to generate the IPMI output. ## Collect IPMI Output -[Log in to the Appliance Manager](device42-appliance-manager-login.mdx), and navigate to **Application > Generate IPMI Output**. +[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login) and navigate to **Application > Generate IPMI Output**. -![Collect IPMI output](/assets/images/generating-ipmi-output-for-troubleshooting/generate-ipmi-output.png) - -Add the **FQDN or IP Address**, **Username**, and **Password**, and click **Generate**. The file will take a few minutes to generate. Once downloaded, please send us the generated file. +![Generate IPMI Output in the Appliance Manager](/assets/images/generating-ipmi-output-for-troubleshooting/generate-ipmi-output.png) +Enter the **FQDN or IP Address**, **Username**, and **Password**, then click **Generate**. The file takes a few minutes to generate. Once downloaded, send the file to support. From d29ab19778f3d67901a9ab7705a65b6252ed3722 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 8 May 2026 17:02:02 +0200 Subject: [PATCH 13/24] 1262: language-improvements; appliance-manager/global-and-password-manager-session-timeout --- ...l-and-password-manager-session-timeout.mdx | 20 +++++++++---------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/administration/appliance-manager/global-and-password-manager-session-timeout.mdx b/docs/administration/appliance-manager/global-and-password-manager-session-timeout.mdx index 080f0801b..caa8f84c9 100644 --- a/docs/administration/appliance-manager/global-and-password-manager-session-timeout.mdx +++ b/docs/administration/appliance-manager/global-and-password-manager-session-timeout.mdx @@ -6,29 +6,27 @@ sidebar_position: 12 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -By default, the global session timeout in Device42 is set to 30 minutes. You can change it from the [Appliance Manager](device42-appliance-manager-login.mdx). +Device42 has two separate inactivity timeouts: a global session timeout for the Main Appliance and Appliance Manager, and a shorter inactivity timer for pages containing Secrets and credentials. This page covers how to configure both. -For enhanced security, pages containing Secrets and credentials have an additional check for inactivity – if a user is inactive for 500 seconds (8 minutes), it logs them out of the session. You can change this setting from the Main Appliance. +The default global session timeout is 30 minutes. Pages containing Secrets and credentials have an additional 500-second (8-minute) inactivity timer for enhanced security. ## Global Session Timeout You can set timeout values for the Main Appliance and Appliance Manager: -- [Log in to the Main Appliance](device42-appliance-manager-login.mdx) and navigate to **Global Settings > Set Inactivity logout time**. +[Log in to the Main Appliance](/administration/appliance-manager/device42-appliance-manager-login) and navigate to **Global Settings > Set Inactivity logout time**. -- Set a new value (in minutes) for the session timeout. +Set a new value, in minutes, for the session timeout. - ![Global Session timeout](/assets/images/global-and-password-manager-session-timeout/global-inactivity-timeout.png) +![Global session timeout setting](/assets/images/global-and-password-manager-session-timeout/global-inactivity-timeout.png) -- Once you have chosen and saved the optimal value(s) for your purposes, you need to restart the application to bring the new session timeout into effect. +After saving the new value, restart the application to apply the new session timeout. ## Password Pages Inactivity Timer -All password pages (the list, view, and edit pages) also have an inactivity timer. If there is no mouse or keyboard activity for 500 seconds (8 minutes), the user will be logged out of the session. +All password pages (list, view, and edit pages) have an inactivity timer. If there is no mouse or keyboard activity for 500 seconds (8 minutes), the user is logged out. -- You can change the password page inactivity timer from the Main Appliance, under **Tools > Settings > Global Settings**. - -- Set a new **Password Timeout** value (in seconds) under the **Secrets** section. +To change the password page inactivity timer, go to the Main Appliance under **Tools > Settings > Global Settings**, and set a new **Password Timeout** value, in seconds, in the **Secrets** section. -Note that the appliance global session timeouts are different from the password page inactivity timers and must be changed separately. +The global session timeout and the password page inactivity timer are separate settings and must be configured independently. From deaafa31a0ac4ad7456f59b760cbd30eb706e21e Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 8 May 2026 17:02:26 +0200 Subject: [PATCH 14/24] 1262: language-improvements; appliance-manager/installing-vmware-or-xenserver-tools --- .../installing-vmware-or-xenserver-tools.mdx | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/administration/appliance-manager/installing-vmware-or-xenserver-tools.mdx b/docs/administration/appliance-manager/installing-vmware-or-xenserver-tools.mdx index 9ab81895b..cfc4dac69 100644 --- a/docs/administration/appliance-manager/installing-vmware-or-xenserver-tools.mdx +++ b/docs/administration/appliance-manager/installing-vmware-or-xenserver-tools.mdx @@ -1,25 +1,26 @@ --- -title: "Installing VMWare or Xenserver tools" +title: "Installing VMware or XenServer Tools" sidebar_position: 13 --- -You can install VMware or XenServer tools in the Device42 appliance. Begin by downloading the ISO file from the vendor. +You can install VMware or XenServer tools in the Device42 appliance to enable better integration with the host hypervisor. This page covers how to attach the tools ISO and install it from the Device42 VM console. -Download the VMware Tools ISO file from the VMware website. See the [VMware documentation](https://docs.vmware.com/en/VMware-Workstation-Player-for-Windows/17.0/com.vmware.player.win.using.doc/GUID-D9B1B1D1-A81D-4B1C-AE9C-35EEFAAE2D41.html) for more information. +## Download the Tools ISO -If you're using XenServer, download the VM Tools from the [XenSever Downloads page](https://www.xenserver.com/downloads). +Download the VMware Tools ISO from the VMware website. See the [VMware documentation](https://docs.vmware.com/en/VMware-Workstation-Player-for-Windows/17.0/com.vmware.player.win.using.doc/GUID-D9B1B1D1-A81D-4B1C-AE9C-35EEFAAE2D41.html) for details. -Then proceed as follows: +For XenServer, download the VM Tools from the [XenServer Downloads page](https://www.xenserver.com/downloads). -1. Add a **CD/DVD Drive** as additional hardware. The default shipped VM doesn't have this. - - ![](/assets/images/wpid4571-add-cd.png) +## Install the Tools -2. Choose the option to install the tools. - This is an example from the VMware ESX server: +1. Add a **CD/DVD Drive** as additional hardware — the default shipped VM does not include one. - ![](/assets/images/install-tools.png) + ![Add CD/DVD drive](/assets/images/wpid4571-add-cd.png) -3. Log in to the Device42 VM console and use option **9** to install the update. If it doesn't recognize the CD/DVD, please reboot and try step 2 and 3 again. +2. Choose the option to install the tools. The screenshot below is an example from the VMware ESX server. - ![](/assets/images/wpid4572-device42-install-vmware-tools.png) + ![Install tools option](/assets/images/install-tools.png) + +3. Log in to the Device42 VM console and select option `9` to install the update. If the CD/DVD is not recognized, reboot the VM and repeat steps 2 and 3. + + ![Install VMware tools from the Device42 console](/assets/images/wpid4572-device42-install-vmware-tools.png) From 86c3d9b6f75bb98b8109bf2058230f7c7f25ebb3 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 8 May 2026 17:02:52 +0200 Subject: [PATCH 15/24] 1262: language-improvements; appliance-manager/pendo-guided-tours-and-usage-information-collection --- ...guided-tours-and-usage-information-collection.mdx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx b/docs/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx index 0157badcf..9043879fc 100644 --- a/docs/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx +++ b/docs/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx @@ -3,14 +3,16 @@ title: "Guided Tours and Usage Information Collection" sidebar_position: 14 --- -Device42 collects certain usage information to better assist users, prioritize future product updates, and provide guided product tours of Device42 features. +Device42 collects usage information to better assist users, prioritize future product updates, and provide guided tours of Device42 features. This page covers how to disable usage data collection or opt out of guided tours. -You can use the Device42 Appliance Manager to disable the collection of usage data, which will also disable guided product tours, as usage data is needed for guided Device42 tours. However, you can keep usage metric sharing enabled and opt out of guided tours. +Disabling usage data collection also disables guided tours, since usage data is required for the tours. You can keep usage metric sharing enabled and opt out of guided tours separately. -- [Log in to the Appliance Manager](device42-appliance-manager-login.mdx), and navigate to **Global Settings > Misc. Settings**. +## Configure Usage Data and Guided Tours -- To disable the collection of usage data, uncheck the **Allow usage metric sharing** option – the **Allow Guided Product Tours** option will also be disabled. -- To opt out of guided tours, uncheck the **Allow Guided Product Tours** option. +[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login) and navigate to **Global Settings > Misc. Settings**. + +- To disable usage data collection, uncheck **Allow usage metric sharing** — this also disables **Allow Guided Product Tours**. +- To opt out of guided tours only, uncheck **Allow Guided Product Tours**. - Click **Update Settings** to save your changes. ![Misc. Settings in Appliance Manager](/assets/images/pendo-guided-tours-and-usage-information-collection/misc-settings-appliance-manager.png) From 4ccab82d84c83347b44f5ddbb3da7ddffcee9ccd Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 8 May 2026 17:03:10 +0200 Subject: [PATCH 16/24] 1262: language-improvements; appliance-manager/set-fqdn-for-web-access --- .../appliance-manager/set-fqdn-for-web-access.mdx | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/administration/appliance-manager/set-fqdn-for-web-access.mdx b/docs/administration/appliance-manager/set-fqdn-for-web-access.mdx index e69622658..c79c170fa 100644 --- a/docs/administration/appliance-manager/set-fqdn-for-web-access.mdx +++ b/docs/administration/appliance-manager/set-fqdn-for-web-access.mdx @@ -3,10 +3,12 @@ title: "Set FQDN for Web Access" sidebar_position: 16 --- -You can limit access to the Device42 Main Appliance to a specific FQDN. Using this setting will prevent anyone from accessing Device42 via IP address or another hostname or domain. +You can restrict access to the Device42 Main Appliance to a specific FQDN, preventing access via IP address or any other hostname or domain. This page covers how to configure the FQDN restriction. -[Log in to the Appliance Manager](device42-appliance-manager-login.mdx), then navigate to **Global Settings > Set Hostname for Web Console**. +## Configure the FQDN Restriction -Enter the FQDN you want to use, check **Enable Hostname Checking**, and click **Submit**. +[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login) and navigate to **Global Settings > Set Hostname for Web Console**. -![](/assets/images/set-fqdn-for-web-access/set-hostname-for-web-console.png) +Enter the FQDN you want to use, check **Enable Hostname Checking**, and click **Submit**. + +![Set Hostname for Web Console](/assets/images/set-fqdn-for-web-access/set-hostname-for-web-console.png) From 032b8b23d339ce226503904fbc7b55b7c8f8ee86 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 8 May 2026 17:03:30 +0200 Subject: [PATCH 17/24] 1262: language-improvements; appliance-manager/set-up-an-http-https-proxy --- .../set-up-an-http-https-proxy.mdx | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/administration/appliance-manager/set-up-an-http-https-proxy.mdx b/docs/administration/appliance-manager/set-up-an-http-https-proxy.mdx index 49d9c696e..684c1120f 100644 --- a/docs/administration/appliance-manager/set-up-an-http-https-proxy.mdx +++ b/docs/administration/appliance-manager/set-up-an-http-https-proxy.mdx @@ -3,12 +3,14 @@ title: "Set Up an HTTP/HTTPS Proxy" sidebar_position: 18 --- -You can set up a proxy for any outbound HTTP/HTTPS connections from the Device42 Appliance Manager: +You can configure a proxy for outbound HTTP and HTTPS connections from the Device42 Appliance Manager. This page covers how to set or remove the proxy. -1. Navigate to **Global Settings > Set Proxy** and enter the IP for the proxy server in the appropriate fields. +## Configure the Proxy + +1. Navigate to **Global Settings > Set Proxy** and enter the proxy server IP address in the appropriate fields. 2. Click **Set**. -3. Restart your virtual machine for the proxy to take effect. - -To remove the proxies, leave the field blank, click **Set**, and restart your virtual machine. +3. Restart the virtual machine for the proxy to take effect. + +To remove the proxy, clear the field, click **Set**, and restart the virtual machine. -![Appliance Manager global proxy location](/assets/images/set-up-an-http-https-proxy/set-proxy.png) +![Set Proxy in the Appliance Manager](/assets/images/set-up-an-http-https-proxy/set-proxy.png) From 8741d80b9f541c92d811b3cf23ae151ea4f6b6f5 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 8 May 2026 17:03:54 +0200 Subject: [PATCH 18/24] 1262: language-improvements; appliance-manager/set-up-https-cert --- .../appliance-manager/set-up-https-cert.mdx | 25 +++++++++++-------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/docs/administration/appliance-manager/set-up-https-cert.mdx b/docs/administration/appliance-manager/set-up-https-cert.mdx index 69dc6527b..1fe0792f3 100644 --- a/docs/administration/appliance-manager/set-up-https-cert.mdx +++ b/docs/administration/appliance-manager/set-up-https-cert.mdx @@ -1,27 +1,32 @@ --- -title: "Set up HTTPS cert" +title: "Set Up HTTPS Certificate" sidebar_position: 17 --- -You can add your own https cert and key in apache style cert files to use a secure web console for Device42 and the Remote Collectors. You can generate a self-signed certificate with a CA using OpenSSL or Microsoft certificate server and upload it here, or you can also have one issued from a trusted certificate authority. +You can upload your own HTTPS certificate and key in Apache-style cert files to enable a secure web console for Device42 and the Remote Collectors. This page covers how to upload the certificate, concatenate the certificate chain, and restart the application. + +You can generate a self-signed certificate with a CA using OpenSSL or Microsoft Certificate Server and upload it, or use a certificate issued by a trusted certificate authority. ## Upload the Cert and Key Files -![](/assets/images/WEB_815_1.jpg) +![Upload HTTPS certificate and key](/assets/images/WEB_815_1.jpg) + +Upload both the certificate and key files. The software validates the certificates before applying them. -Upload both files: cert and key. The software will validate the certs before applying them. +### Add the Intermediate and CA Root Certificates -### Add the Intermediate and the CA Root +Concatenate all the certificates, starting with the server certificate and working through the chain to the intermediate and CA root certificates. Run the following on the command line, or use copy-paste in a text editor: -You'll need to concatenate all the certificates, starting with the server certificate, and going deeper in the chain, running through all the intermediate certificates. This can be done with "cat chain.crt >> mysite.com.crt" on the command line. (or via copy-paste via a text editor) +```bash +cat chain.crt >> mysite.com.crt +``` ## Restart the Application -![](/assets/images/WEB_815_2.jpg) +![Restart the application](/assets/images/WEB_815_2.jpg) -You will need to restart the application to see the new cert. +Restart the application for the new certificate to take effect. ## Create Your Own Cert -If you create your own certs, these can be uploaded via the Appliance Manager. Device42 is unable to assist in the creation and signing of certificates, please use a CA like Thawte for creation and signing. - +If you create your own certificates, upload them via the Appliance Manager. Device42 is unable to assist with the creation and signing of certificates — use a CA such as Thawte for creation and signing. From 9ece824f44f71cb2b669fe884c653a7dabbb4e75 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 8 May 2026 17:04:47 +0200 Subject: [PATCH 19/24] 1262: language-improvements; appliance-manager/setting-up-backup-device42-appliance-manager --- ...g-up-backup-device42-appliance-manager.mdx | 84 +++++++++---------- 1 file changed, 38 insertions(+), 46 deletions(-) diff --git a/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx b/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx index ac88e09dc..552bfa9ad 100644 --- a/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx +++ b/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx @@ -1,20 +1,18 @@ --- -title: "Set up backup via the Appliance Manager" +title: "Set Up Backup via the Appliance Manager" sidebar_position: 18 --- import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Follow the steps below to set up one-time and scheduled backups in the Device42 Appliance Manager. +The Device42 Appliance Manager lets you create one-time and scheduled backups of the Main Appliance and Remote Collectors, with destinations including SFTP, NFS, and Amazon S3. This page covers how to set the backup passphrase, configure backup options, schedule backups, and limit backup retention. -For login instructions, see [Device42 Appliance Manager login](/administration/appliance-manager/device42-appliance-manager-login.mdx). +For login instructions, see [Device42 Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login). ## Set the Passphrase -Choose a 12-20 character passphrase to encrypt the backup file. - -You will need this passphrase to restore the backup, so please save it in a safe location. This is a required step, as you won't be able to create a backup until a backup passphrase has been set. +Choose a 12 to 20 character passphrase to encrypt the backup file. You will need this passphrase to restore the backup, so save it in a secure location. This is a required step — you cannot create a backup until a passphrase has been set. ![Set the passphrase](/assets/images/setting-up-backup-device42-appliance-manager/set-passphrase.png) @@ -22,38 +20,37 @@ You will need this passphrase to restore the backup, so please save it in a safe Configure the backup options for the Main Appliance and Remote Collectors (RCs). - ### Main Appliance Options -- **Backup Meta Data**: Include the password passphrase, backup passphrase, Active Directory settings, and the following settings in the backup as well. We recommend backing up the Meta Data, so you don't have to manually re-enter data for the following settings and options: +- **Backup Meta Data:** Includes the password passphrase, backup passphrase, Active Directory settings, and the following settings in the backup. Backing up the Meta Data is recommended so you don't have to manually re-enter the following settings: - Passphrases for backups and password encryption - Language - Time - SSL/HTTPS - - Host/hostname info - - All appliance manager settings (including backup schedules) + - Host and hostname information + - All Appliance Manager settings (including backup schedules) - All certificates -- **Backup SSH key pair** (for SFTP backups): Back up the key that was used to set up the SFTP server. -- **Backup Audit Data**: Back up the audit logs table. If disabled, Device42 backs up the DB without that table. -- **Backup System Configuration Files**: Back up the `/data/pgsql/data/postgresql.override.conf` and `/etc/systemctl.conf` system configuration files to preserve any manual config optimizations. +- **Backup SSH key pair:** For SFTP backups, backs up the key used to set up the SFTP server. +- **Backup Audit Data:** Backs up the audit logs table. If disabled, Device42 backs up the database without that table. +- **Backup System Configuration Files:** Backs up the `/data/pgsql/data/postgresql.override.conf` and `/etc/systemctl.conf` files to preserve any manual configuration optimizations. ![Run the backup](/assets/images/setting-up-backup-device42-appliance-manager/backup-now-form.png) ### For Standby Instances -Select the **Backup Meta Data** option when creating a Device42 instance for recovery or failover purposes. Selecting the metadata option copies all system identifiers, passphrases, certificates, and configuration settings – preparing the standby instance to fully replace your production instance when needed. +Select **Backup Meta Data** when creating a Device42 instance for recovery or failover. The metadata option copies all system identifiers, passphrases, certificates, and configuration settings, preparing the standby instance to fully replace your production instance when needed. -The standby instance will have the same system identifiers as the production instance, which means it will connect as the primary instance. For this reason, keep one instance with the identifier data active at a time. See the [Warm HA Setup documentation](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) for failover procedures. +The standby instance will share system identifiers with the production instance and will connect as the primary. For this reason, only one instance with the identifier data should be active at a time. See the [Warm HA Setup documentation](/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups) for failover procedures. ### For Test Instances -Do not select the **Backup Meta Data** option when creating test or development environments. Backing up and restoring this way is useful when you just want to recover your data, rather than replacing your production instance. The GUIDs will not be copied without the metadata option selected, and without these GUIDs, the machine cannot connect to external services or be used to replace the production instance. +Do not select **Backup Meta Data** when creating test or development environments. Backing up and restoring without metadata is useful when you want to recover data only, rather than replacing your production instance. Without the metadata option, GUIDs are not copied, so the machine cannot connect to external services or replace the production instance. ### Remote Collector Options -The following table summarizes the backup settings for the selected RC(s): +The following table summarizes the backup settings for the selected RCs: @@ -69,18 +66,18 @@ The following table summarizes the backup settings for the selected RC(s): -
Backs up various settings and registration data.
    -
  • TLS configuration (NGINX)
    • -
  • RC environment variables
    • -
  • WDS keys
    • -
  • Hostname settings
    • -
  • NTP settings
    • +
  • TLS configuration (NGINX)
    • +
  • RC environment variables
    • +
  • WDS keys
    • +
  • Hostname settings
    • +
  • NTP settings
**Backup TLS Key Pair** Backs up the TLS certificate and key. +
  • `/etc/nginx/ssl.crt/server.crt`
  • `/etc/nginx/ssl.cert/server.key`
    • @@ -108,24 +105,23 @@ The following table summarizes the backup settings for the selected RC(s):
- ## Back Up to an SFTP Server -The backup file can be scheduled to be sent to an SFTP server. All fields are required. +You can schedule the backup file to be sent to an SFTP server. All fields are required. ![Backup to an SFTP server](/assets/images/setting-up-backup-device42-appliance-manager/sftp-server-settings.png) ## Back Up to an NFS Server -The backup file can be scheduled to be sent to an NFS server. All fields are required. The IP address should be the address of the target NFS server, and the folder path should be the path to the directory where the backups will be stored. This folder should be writable by a user with `uid=1000`. +You can schedule the backup file to be sent to an NFS server. All fields are required. The IP address should be that of the target NFS server, and the folder path should point to the directory where backups will be stored. This folder must be writable by a user with `uid=1000`. ![Backup to an NFS server](/assets/images/setting-up-backup-device42-appliance-manager/nfs-server-settings.png) ## Back Up Using Amazon S3 -The backup file can be scheduled to be sent to Amazon S3 as well. All fields are required. +You can schedule the backup file to be sent to Amazon S3. All fields are required. -The **Region Endpoint** field **is not** simply the endpoint name, as each region has many endpoints. Unknown endpoint URLs can be looked up in the [AWS Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) section of the AWS Documentation. +The **Region Endpoint** field is not simply the endpoint name — each region has multiple endpoints. Look up unknown endpoint URLs in the [AWS Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) documentation. ![Backup using Amazon S3](/assets/images/setting-up-backup-device42-appliance-manager/s3-settings.png) @@ -133,18 +129,16 @@ The **Region Endpoint** field **is not** simply the endpoint name, as each regio You can create multiple backup schedules to automate the backup process. All fields are required. -Choose the time and days of the week you want the backup to run. Indicate whether you want to use Mail Server, SFTP, Amazon S3, or NFS as the source for the backup. +Choose the time and days of the week you want the backup to run. Indicate whether you want to use Mail Server, SFTP, Amazon S3, or NFS as the destination for the backup. Test the backup by clicking the **Save and Test backup now** button. -![Scheduling the backup](/assets/images/setting-up-backup-device42-appliance-manager/backup-schedule.png) +![Backup schedule](/assets/images/setting-up-backup-device42-appliance-manager/backup-schedule.png) -Please check your time settings to avoid potential issues with AWS services. From the Device42 Main Appliance, navigate to **Tools > Settings > Time Settings**. - -If your **Current System Time** is incorrect, change it in your VM system configuration console. +Check your time settings to avoid potential issues with AWS services. From the Device42 Main Appliance, navigate to **Tools > Settings > Time Settings**. If your **Current System Time** is incorrect, change it in the VM system configuration console. Click to expand the code block - ``` - # Delete all Files in C:temp older than 7 day(s) + ```powershell + # Delete all files in C:\device42\backups older than 7 days - $Path = "C:device42backups" + $Path = "C:\device42\backups" $Daysback = "-7" $CurrentDate = Get-Date $DatetoDelete = $CurrentDate.AddDays($Daysback) @@ -188,4 +180,4 @@ For Windows Servers, the following PowerShell script can be used to delete files ## Restore the Backup -See [Restore the Backup](/administration/appliance-manager/device42-restore.mdx). +See [Device42 Restore](/administration/appliance-manager/device42-restore). From ff60e6de65c898ee19d5e55b3005118da409e125 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 8 May 2026 17:05:08 +0200 Subject: [PATCH 20/24] 1262: language-improvements; appliance-manager/update-device42 --- .../appliance-manager/update-device42.mdx | 26 +++++++++++-------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/administration/appliance-manager/update-device42.mdx b/docs/administration/appliance-manager/update-device42.mdx index e8e6dad8f..2a49346ca 100644 --- a/docs/administration/appliance-manager/update-device42.mdx +++ b/docs/administration/appliance-manager/update-device42.mdx @@ -3,27 +3,31 @@ title: "Updating Device42" sidebar_position: 18.5 --- -When you [log in to the Appliance Manager](device42-appliance-manager-login.mdx) and go to **Application > Update Software**, you'll see two methods for updating your Device42 Main Appliance. You only need to complete one of the options: +You can update the Device42 Main Appliance from the Appliance Manager using either a download URL or a manually uploaded upgrade package. This page covers both methods and how to apply the update from the VM console. -![](/assets/images/update-device42/updgrade-options-AM-19.06.png) +## Download the Update -- **Enter URL:** Enter the provided URL from the update notification and click **Download**. -- **Upload D42 upgrade package:** - - Click the **Check for latest version** link or visit the [Device42 update page](https://www.device42.com/update) and enter your name, surname, and email address. +[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login) and go to **Application > Update Software**. You will see two methods for updating — only one is required. + +![Update options in the Appliance Manager](/assets/images/update-device42/updgrade-options-AM-19.06.png) + +- **Enter URL:** Enter the URL from the update notification and click **Download**. +- **Upload D42 upgrade package:** + - Click the **Check for latest version** link or visit the [Device42 update page](https://www.device42.com/update) and enter your details. - Download the update package using the "Device42 MA Update File" link emailed to you. - - Head back to the Appliance Manager and **Browse** your machine for the downloaded package file. + - Return to the Appliance Manager, click **Browse**, and select the downloaded package file. - Click **Upload** and wait for the progress bar to complete. -The URL option automates the process of downloading and uploading the upgrade package. The manual upload option is available for when you have already downloaded the package file or when you are using an instance without internet access. +The URL option automates downloading and uploading the upgrade package. The manual upload option is intended for cases where you have already downloaded the package or your instance has no internet access. In both cases, a green status message will appear instructing you to complete the upgrade from the VM console. ## Apply the Update -From the VM console, enter option **(a) Apply Update**: +From the VM console, select option `(a) Apply Update`. -- Click **Yes** to confirm the upgrade process. +- Click **Yes** to confirm the upgrade. - Wait for the process to complete. -- Once the update is applied, you can log in to the Device42 Main Appliance and go to **Tools > Settings > Update** to verify the new version number. +- Once the update is applied, log in to the Device42 Main Appliance and go to **Tools > Settings > Update** to verify the new version number. -![](/assets/images/update-device42/vm-console-options-19.06.png) +![VM console with Apply Update option](/assets/images/update-device42/vm-console-options-19.06.png) From b770e9be8ea6533caa0a5aeb4829d28cc6b85848 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Fri, 8 May 2026 17:05:54 +0200 Subject: [PATCH 21/24] 1262: language-improvements; appliance-manager/warm-ha-setup-failover-and-automated-backups --- ...a-setup-failover-and-automated-backups.mdx | 76 +++++++++---------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/docs/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx b/docs/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx index 34503eed1..77ad5e13c 100644 --- a/docs/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx +++ b/docs/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx @@ -3,94 +3,94 @@ title: "Warm HA Setup, Failover, and Automated Backups" sidebar_position: 19 --- -The Device42 Warm High Availability (HA) configuration allows you to put a second appliance on standby mode and do periodic restorations to the device for use as a failover. +The Device42 Warm High Availability (HA) configuration lets you keep a second appliance on standby and run periodic restores to it for use as a failover. This page covers automating restores to the standby appliance, switching the appliance mode via API, and configuring automated failover with a monitoring system. ## Automate Restores to Back Up Your Main Appliance for Warm HA -This process consists of two steps: +Setting up Warm HA consists of two steps: -- Setting up the automated restores -- Setting the backup appliance to production mode in the event of a device failure +- Configure automated restores to the standby appliance. +- Switch the standby appliance to production mode in the event of a failure. -From the [Device42 Appliance Manager](device42-appliance-manager-login.mdx), you can set up automated restores to a backup appliance. This is done by setting the appliance to standby mode and configuring the appliance to restore from a backup file on a remote server. The appliance will then automatically restore from the backup file at specified intervals. +From the [Device42 Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login), you can set the appliance to standby mode and configure it to restore from a backup file on a remote server. The appliance will then automatically restore from the backup file at the intervals you specify. ## Set Up Automated Restores for a Warm HA Appliance -Log in to the Appliance Manager and navigate to **Global Settings > Appliance Mode**. You will see the following screen with the option to **Enable Standby**: +Log in to the Appliance Manager and navigate to **Global Settings > Appliance Mode**. The Appliance Mode screen includes an **Enable Standby** option: ![Enable standby in Appliance Manager](/assets/images/warm-ha-setup/enable-standby.png) -You can declare an appliance to be in standby mode and then enable regular restores from either an NFS export or an SFTP location. Putting the appliance in standby mode does the following: +You can mark an appliance as standby and then enable regular restores from an NFS export or SFTP location. Putting the appliance in standby mode does the following: -- Disables the background scheduler that runs the autodiscovery jobs +- Disables the background scheduler that runs discovery jobs - Disables scheduled reports - Disables backups from the appliance -You can add the auto-restore schedule using crontab syntax. Configure the interval for how often you want the secondary appliance to pick up the backup file from the remote server. +Add the auto-restore schedule using crontab syntax. Configure how often you want the standby appliance to pick up the backup file from the remote server. -![Warm HA Settings](/assets/images/warm-ha-setup/set-up-restore.png) +![Warm HA settings](/assets/images/warm-ha-setup/set-up-restore.png) -The credentials you use for the passphrase, SFTP server settings, and the backup file name should be identical on both the production and the standby appliance. You can use Amazon S3, NFS, and SFTP as backup locations. +The passphrase, SFTP credentials, and backup file name must be identical on both the production and standby appliances. You can use Amazon S3, NFS, or SFTP as the backup location. -The NFS and SFTP paths, their credential settings and the S3 settings are configured in their respective sub-menus in the Device42 Appliance Manager. Once you have chosen your restore method, look for **NFS Server Settings**, **SFTP Server Settings**, and **Amazon S3 Settings** in the left sidebar: +NFS, SFTP, and S3 paths and credentials are configured in their respective submenus in the Device42 Appliance Manager. Once you have chosen your restore method, look for **NFS Server Settings**, **SFTP Server Settings**, and **Amazon S3 Settings** in the left sidebar. ![Configure server settings](/assets/images/warm-ha-setup/server-settings.png) -While doing an auto-restore, all schedules get disabled, so if another auto-restore falls within the same window, it will not kick off. To let you know whether an auto-restore has succeeded or failed, we have also added success and failure notifications. Mail server settings must be set for these notifications to work. +While an auto-restore is running, all schedules are disabled, so any auto-restore that falls within the same window will not start. Success and failure notifications for auto-restore are also available — mail server settings must be configured for these notifications to work. ## Important Note for Backup Schedules with Auto-Restore Any attempt to auto-restore from a backed-up file will fail if the metadata is not included in the backup. -It is critical that you select to include **Backup Meta Data** as an option under **Backup schedules** for backups to your SFTP, NFS, or S3 storage. +You must select **Backup Meta Data** under **Backup schedules** for backups to your SFTP, NFS, or S3 storage. - ![Backup meta data](/assets/images/warm-ha-setup/backup-schedules.png) +![Backup metadata option](/assets/images/warm-ha-setup/backup-schedules.png) -Without the metadata, restore and passphrase settings will not be included in the backup archive and the appliance will have no reference for using the data when attempting to restore from schedule. +Without the metadata, restore and passphrase settings are not included in the backup archive, and the appliance has no reference for using the data when attempting a scheduled restore. -A backup file without metadata can still be used for an on-demand **Restore**. +A backup file without metadata can still be used for an on-demand restore. -Refer to the Device42 docs to find additional details about [backup metadata](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx#backing-up-metadata) and [scheduling the backup](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx#scheduling-the-backup). +For details, see [backup metadata](/administration/appliance-manager/setting-up-backup-device42-appliance-manager#backing-up-metadata) and [scheduling the backup](/administration/appliance-manager/setting-up-backup-device42-appliance-manager#scheduling-the-backup). ## Set Appliance Mode via API -With automated restores in place on your backup appliance, you're ready to set the backup appliance to production mode in the event of a device failure. You can send a POST call to `/api/1.0/appliancemode/` with the payload `appliance_mode=production` or `appliance_mode=standby` to set the appliance to production or standby mode. This is intended to be triggered from the monitoring software of your choice (see the example below). After switching, a simple update to the DNS settings to point your domain to the new production instance IP will facilitate continuous use of Device42 without downtime. +With automated restores in place on your backup appliance, you can switch the backup appliance to production mode in the event of a failure. Send a `POST` call to `/api/1.0/appliancemode/` with the payload `appliance_mode=production` or `appliance_mode=standby` to switch modes. This is intended to be triggered from your monitoring software (see the example below). After switching, update DNS settings to point your domain to the new production instance IP for continuous use of Device42 without downtime. -## Automatic Failover Using Your Monitoring System +## Automatic Failover Using Your Monitoring System -When running Device42 in HA mode with a warm standby configured, in the event of primary instance failure, the secondary instance must be promoted from the warm standby state (with job processing, scheduler, and backups deactivated) to a primary (and fully active) state. A Device42 appliance instance can be toggled from warm standby mode to production mode and back again with a simple API call. +When running Device42 in HA mode with a warm standby, the secondary instance must be promoted from warm standby (with job processing, scheduler, and backups deactivated) to a fully active production state if the primary fails. A Device42 appliance can be toggled between warm standby and production mode with a simple API call. -To toggle between warm standby and production, simply pass the `appliance_mode` parameter in a POST call to the following API endpoint: `/api/1.0/appliancemode/`. +To toggle between warm standby and production, pass the `appliance_mode` parameter in a `POST` call to `/api/1.0/appliancemode/`: -- Sending the `appliance_mode=production` parameter will toggle a **warm standby appliance** to **production mode**. -- Sending the `appliance_mode=standby` parameter will toggle a **production appliance** to **warm standby mode**. +- `appliance_mode=production` toggles a **warm standby appliance** to **production mode**. +- `appliance_mode=standby` toggles a **production appliance** to **warm standby mode**. -For example, the following API POST call toggles a Device42 appliance instance from standby to production with curl: +For example, the following `curl` call toggles a Device42 appliance from standby to production: ```bash - curl -X POST -d "appliance\_mode=production" -u 'd42admin:default' https://Device42Instance:4343/api/1.0/appliancemode/ --insecure +curl -X POST -d "appliance_mode=production" -u 'd42admin:default' https://Device42Instance:4343/api/1.0/appliancemode/ --insecure ``` ![Example curl API POST](/assets/images/failover_API_call_curl.PNG) -By embedding the above call in a script that is called in response to a failure event detected by your monitoring system, the failover process can be fully automated. +By embedding this call in a script triggered by a failure event from your monitoring system, you can fully automate the failover process. ### Nagios Automated Failover Example -The following example uses Nagios along with the above example API call to automatically switch a Device42 backup appliance from warm standby mode to production mode in a failover scenario. +The following example uses Nagios with the API call above to automatically switch a Device42 backup appliance from warm standby to production mode in a failover scenario. -1. First, add the following configuration GitHub link to your Nagios host file: +1. Add the following configuration to your Nagios host file: - ![nagios host file additions](/assets/images/automated_failover-Nagios_host_file.PNG) + ![Nagios host file additions](/assets/images/automated_failover-Nagios_host_file.PNG) -2. Then, create a script file similar to this example GitHub link: - - ![Example curl API POST](/assets/images/nagios_automated_failover_script.PNG) +2. Create a script file similar to the following example: -If used exactly as written, the example script only enables automated failover to the secondary instance, and not to failback. The provisions to failback are present in the example script but are currently commented out, as can be seen in lines 11 and 12. Though it may be unnecessary, depending on the failure mode of the primary instance, it’s not a bad idea for your production script to attempt to send an API call to place the primary instance on standby mode as a precaution. Setting the primary instance on standby will prevent it from running jobs should it recover before a failback is intentionally initiated. + ![Example failover script](/assets/images/nagios_automated_failover_script.PNG) -- Please ensure the script runs as the proper Nagios user, and is also allowed the `$ chown nagios:nagios <> && chmod 755 <>` execution permissions. -- The current example works by using `check_http` to detect failure, but it is possible to change it to use other commands. -- The production DNS entry must be edited to point at the IP of the new primary Device42 instance to allow reachability via the same URL. For Windows DNS environments, this can be accomplished with the following [powershell example script](https://gallery.technet.microsoft.com/scriptcenter/Update-DNS-records-with-da10910d%5C) (you can see usage examples by the script's author in [this blog post](https://discoposse.com/2013/04/14/updating-same-as-parent-folder-records-with-dnscmd-and-powershell/)). For other platforms, you will need to write and use a custom script. +If used as written, the example script enables automated failover to the secondary instance only, not failback. The failback provisions are present in the script but commented out (lines 11 and 12). Depending on the failure mode of the primary instance, it can be useful for the production script to send an API call to place the primary instance into standby mode as a precaution — this prevents the primary from running jobs should it recover before a failback is intentionally initiated. -**How it works:** If the main Device42 server instance goes down and the failure is detected by monitoring, the above script switches the appliance mode of the secondary server to production mode with a POST call to the `/api/1.0/appliancemode/` RESTful API endpoint with the payload `appliance\_mode=production`. If the main server comes back up again, the script can switch the secondary appliance back to standby mode, allowing the first server to once again become authoritative. Uncomment lines 11 and 12 to allow this to happen automatically. Ensure that you have also made provisions to switch the DNS entry back to the primary instance’s IP address. +- Ensure the script runs as the proper Nagios user, and has the `chown nagios:nagios && chmod 755 ` execution permissions. +- The example uses `check_http` to detect failure, but you can use other commands. +- The production DNS entry must be edited to point at the new primary Device42 instance IP for reachability via the same URL. For Windows DNS environments, you can use this [PowerShell example script](https://gallery.technet.microsoft.com/scriptcenter/Update-DNS-records-with-da10910d%5C) (with usage examples in [this blog post](https://discoposse.com/2013/04/14/updating-same-as-parent-folder-records-with-dnscmd-and-powershell/)). For other platforms, you will need a custom script. + +**How it works:** If the primary Device42 server goes down and the failure is detected by monitoring, the script switches the secondary server to production mode via a `POST` call to `/api/1.0/appliancemode/` with the payload `appliance_mode=production`. If the primary comes back up, the script can switch the secondary back to standby mode, restoring the primary as authoritative — uncomment lines 11 and 12 to enable this. Ensure you also have provisions to switch the DNS entry back to the primary instance's IP address. From 53a001a6a9ca430ec7209938e5c7553ccb91ed33 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Tue, 19 May 2026 16:40:44 +0200 Subject: [PATCH 22/24] 1262: fix internal link format; appliance-manager pages --- .../changing-device42-appliance-hostname.mdx | 2 +- .../device42-appliance-manager-login.mdx | 2 +- .../appliance-manager/device42-restore.mdx | 6 ++-- ...le-tls-versions-from-appliance-manager.mdx | 2 +- .../enabling-ssl-in-appliance-manager.mdx | 2 +- .../appliance-manager/generate-log-bundle.mdx | 2 +- ...rating-ipmi-output-for-troubleshooting.mdx | 2 +- ...l-and-password-manager-session-timeout.mdx | 2 +- .../appliance-manager/index.mdx | 36 +++++++++---------- ...tours-and-usage-information-collection.mdx | 2 +- .../set-fqdn-for-web-access.mdx | 2 +- ...g-up-backup-device42-appliance-manager.mdx | 8 ++--- .../appliance-manager/update-device42.mdx | 2 +- ...a-setup-failover-and-automated-backups.mdx | 4 +-- 14 files changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/administration/appliance-manager/changing-device42-appliance-hostname.mdx b/docs/administration/appliance-manager/changing-device42-appliance-hostname.mdx index bc8c4387b..3e27da6dd 100644 --- a/docs/administration/appliance-manager/changing-device42-appliance-hostname.mdx +++ b/docs/administration/appliance-manager/changing-device42-appliance-hostname.mdx @@ -7,7 +7,7 @@ You can change the Device42 Appliance hostname from either the Appliance Manager ## Change the Hostname in the Appliance Manager -[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login). +[Log in to the Appliance Manager](administration/appliance-manager/device42-appliance-manager-login.mdx). From the left panel, go to **System > Appliance Hostname**, enter the new hostname, and click **Save**. A success message will appear. diff --git a/docs/administration/appliance-manager/device42-appliance-manager-login.mdx b/docs/administration/appliance-manager/device42-appliance-manager-login.mdx index 835b9821a..e46097044 100644 --- a/docs/administration/appliance-manager/device42-appliance-manager-login.mdx +++ b/docs/administration/appliance-manager/device42-appliance-manager-login.mdx @@ -41,6 +41,6 @@ Click your username at the top of the left sidebar and select **Change password* ## AWS Login -For **marketplace** AWS installations, use `d42admin` as the username and your **AWS Instance ID** as the default password. See the [AWS installation instructions](/getstarted/deploy-device42/installation-amazon-web-services/#accessing-the-d42-appliance-manager---aws-marketplace-installs) for details. +For **marketplace** AWS installations, use `d42admin` as the username and your **AWS Instance ID** as the default password. See the [AWS installation instructions](getstarted/deploy-device42/installation-amazon-web-services.mdx#accessing-the-d42-appliance-manager---aws-marketplace-installs) for details. For **manual** AWS installations using a downloaded image, log in with the default Device42 username `d42admin` and password `default`. diff --git a/docs/administration/appliance-manager/device42-restore.mdx b/docs/administration/appliance-manager/device42-restore.mdx index ee033580e..9cb1f44ad 100644 --- a/docs/administration/appliance-manager/device42-restore.mdx +++ b/docs/administration/appliance-manager/device42-restore.mdx @@ -20,7 +20,7 @@ If you have local accounts, you can use them to log in after the restore and add ## Restore the MA and RC Backup Files -From the [Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login), navigate to **Backup/Restore > Restore**. +From the [Appliance Manager](administration/appliance-manager/device42-appliance-manager-login.mdx), navigate to **Backup/Restore > Restore**. Select **Main Appliance** or **Remote Collector**. You need separate backup `.enc` files for the MA and RC. @@ -28,7 +28,7 @@ To restore the MA or RC, enter the passphrase you used for the backup. If you ha - Click **Set Passphrase** in the left menu panel, click **Clear Passphrase**, enter a new passphrase, and create a new backup. -Select the **Restore Meta Data** option. If you did not select **Backup Meta Data** [when creating the backup](/administration/appliance-manager/setting-up-backup-device42-appliance-manager#run-backup-now), re-enter the following settings after restoring the appliance: +Select the **Restore Meta Data** option. If you did not select **Backup Meta Data** [when creating the backup](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx#run-backup-now), re-enter the following settings after restoring the appliance: - Passphrases for backups and password encryption - Language @@ -54,5 +54,5 @@ Restart the application once the restore is complete by navigating to **Applicat For a test restore, use one of these two approaches: -1. Spin up a new Device42 virtual appliance and restore your backup there. Having a second instance is useful for disaster recovery or business continuity, as described in the [Warm HA Configuration](/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups) page. Your license allows one production and one backup instance. +1. Spin up a new Device42 virtual appliance and restore your backup there. Having a second instance is useful for disaster recovery or business continuity, as described in the [Warm HA Configuration](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) page. Your license allows one production and one backup instance. 2. Take a VM snapshot first, then run a test restore. diff --git a/docs/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx b/docs/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx index b3707bce8..205346fc7 100644 --- a/docs/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx +++ b/docs/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx @@ -7,7 +7,7 @@ Device42 lets you restrict the TLS versions used for Appliance Manager and Web C ## Apply TLS Version Restrictions -Log in to the Device42 Appliance Manager. See [Device42 Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login) for instructions. +Log in to the Device42 Appliance Manager. See [Device42 Appliance Manager Login](administration/appliance-manager/device42-appliance-manager-login.mdx) for instructions. From the main menu on the left, select **Global Settings**, then choose **TLS versions for Web Console** or **TLS versions for Appliance Manager**. diff --git a/docs/administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx b/docs/administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx index fb2e5cb7d..6a6a74362 100644 --- a/docs/administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx +++ b/docs/administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx @@ -7,7 +7,7 @@ Device42 supports HTTPS in the Appliance Manager in addition to the Main Applian ## Enable HTTPS in the Appliance Manager -Log in to the Device42 Appliance Manager. The default username and password are `d42admin` and `default` — see [Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login) for the URL and password change instructions. +Log in to the Device42 Appliance Manager. The default username and password are `d42admin` and `default` — see [Appliance Manager Login](administration/appliance-manager/device42-appliance-manager-login.mdx) for the URL and password change instructions. From the main menu in the left panel, select **Appliance Manager SSL**. diff --git a/docs/administration/appliance-manager/generate-log-bundle.mdx b/docs/administration/appliance-manager/generate-log-bundle.mdx index a71103d25..9d66296de 100644 --- a/docs/administration/appliance-manager/generate-log-bundle.mdx +++ b/docs/administration/appliance-manager/generate-log-bundle.mdx @@ -22,7 +22,7 @@ When you encounter issues with discovery or other Device42 functionality, you ca 2. If the issue is discovery-related, rerun the failing discovery job with the debug flag enabled. -3. Log in to the Appliance Manager via **Tools > Appliance Manager** in the main menu, or follow the [Device42 Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login) directions. +3. Log in to the Appliance Manager via **Tools > Appliance Manager** in the main menu, or follow the [Device42 Appliance Manager Login](administration/appliance-manager/device42-appliance-manager-login.mdx) directions. 4. In the Appliance Manager, navigate to **Application > Generate Log Bundle** and click **Run**. diff --git a/docs/administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx b/docs/administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx index 9e14f0e97..1b0b8c382 100644 --- a/docs/administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx +++ b/docs/administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx @@ -7,7 +7,7 @@ You can collect Intelligent Platform Management Interface (IPMI) output for a de ## Collect IPMI Output -[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login) and navigate to **Application > Generate IPMI Output**. +[Log in to the Appliance Manager](administration/appliance-manager/device42-appliance-manager-login.mdx) and navigate to **Application > Generate IPMI Output**. ![Generate IPMI Output in the Appliance Manager](/assets/images/generating-ipmi-output-for-troubleshooting/generate-ipmi-output.png) diff --git a/docs/administration/appliance-manager/global-and-password-manager-session-timeout.mdx b/docs/administration/appliance-manager/global-and-password-manager-session-timeout.mdx index caa8f84c9..501a8009e 100644 --- a/docs/administration/appliance-manager/global-and-password-manager-session-timeout.mdx +++ b/docs/administration/appliance-manager/global-and-password-manager-session-timeout.mdx @@ -14,7 +14,7 @@ The default global session timeout is 30 minutes. Pages containing Secrets and c You can set timeout values for the Main Appliance and Appliance Manager: -[Log in to the Main Appliance](/administration/appliance-manager/device42-appliance-manager-login) and navigate to **Global Settings > Set Inactivity logout time**. +[Log in to the Main Appliance](administration/appliance-manager/device42-appliance-manager-login.mdx) and navigate to **Global Settings > Set Inactivity logout time**. Set a new value, in minutes, for the session timeout. diff --git a/docs/administration/appliance-manager/index.mdx b/docs/administration/appliance-manager/index.mdx index d3066e53c..84ea2c977 100644 --- a/docs/administration/appliance-manager/index.mdx +++ b/docs/administration/appliance-manager/index.mdx @@ -6,21 +6,21 @@ The Device42 Appliance Manager runs on port 4242 (HTTP by default, with HTTPS av ## Table of Contents -- [Add Multiple Network Interface Cards (NICs) to a Device42 VM](/administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm) -- [API Limits](/administration/appliance-manager/api-limits) -- [Change the Device42 Appliance Hostname](/administration/appliance-manager/changing-device42-appliance-hostname) -- [Collect SNMPwalk Output for Troubleshooting](/administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting) -- [Delete History Logs](/administration/appliance-manager/delete-history-logs) -- [Device42 Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login) -- [Device42 Restore](/administration/appliance-manager/device42-restore) -- [Enable or Disable TLS Versions from Appliance Manager](/administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager) -- [Enable SSL in Appliance Manager](/administration/appliance-manager/enabling-ssl-in-appliance-manager) -- [Generate a Log Bundle](/administration/appliance-manager/generate-log-bundle) -- [Generate IPMI Output for Troubleshooting](/administration/appliance-manager/generating-ipmi-output-for-troubleshooting) -- [Global and Password Manager Session Timeout](/administration/appliance-manager/global-and-password-manager-session-timeout) -- [Install VMware or XenServer Tools](/administration/appliance-manager/installing-vmware-or-xenserver-tools) -- [Pendo Guided Tours and Usage Information Collection](/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection) -- [Set FQDN for Web Access](/administration/appliance-manager/set-fqdn-for-web-access) -- [Set Up HTTPS Certificate](/administration/appliance-manager/set-up-https-cert) -- [Set Up Backup via Device42 Appliance Manager](/administration/appliance-manager/setting-up-backup-device42-appliance-manager) -- [Warm HA Setup, Failover, and Automated Backups](/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups) +- [Add Multiple Network Interface Cards (NICs) to a Device42 VM](administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm.mdx) +- [API Limits](administration/appliance-manager/api-limits.mdx) +- [Change the Device42 Appliance Hostname](administration/appliance-manager/changing-device42-appliance-hostname.mdx) +- [Collect SNMPwalk Output for Troubleshooting](administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.mdx) +- [Delete History Logs](administration/appliance-manager/delete-history-logs.mdx) +- [Device42 Appliance Manager Login](administration/appliance-manager/device42-appliance-manager-login.mdx) +- [Device42 Restore](administration/appliance-manager/device42-restore.mdx) +- [Enable or Disable TLS Versions from Appliance Manager](administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx) +- [Enable SSL in Appliance Manager](administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx) +- [Generate a Log Bundle](administration/appliance-manager/generate-log-bundle.mdx) +- [Generate IPMI Output for Troubleshooting](administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx) +- [Global and Password Manager Session Timeout](administration/appliance-manager/global-and-password-manager-session-timeout.mdx) +- [Install VMware or XenServer Tools](administration/appliance-manager/installing-vmware-or-xenserver-tools.mdx) +- [Pendo Guided Tours and Usage Information Collection](administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx) +- [Set FQDN for Web Access](administration/appliance-manager/set-fqdn-for-web-access.mdx) +- [Set Up HTTPS Certificate](administration/appliance-manager/set-up-https-cert.mdx) +- [Set Up Backup via Device42 Appliance Manager](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx) +- [Warm HA Setup, Failover, and Automated Backups](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) diff --git a/docs/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx b/docs/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx index 9043879fc..232235937 100644 --- a/docs/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx +++ b/docs/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx @@ -9,7 +9,7 @@ Disabling usage data collection also disables guided tours, since usage data is ## Configure Usage Data and Guided Tours -[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login) and navigate to **Global Settings > Misc. Settings**. +[Log in to the Appliance Manager](administration/appliance-manager/device42-appliance-manager-login.mdx) and navigate to **Global Settings > Misc. Settings**. - To disable usage data collection, uncheck **Allow usage metric sharing** — this also disables **Allow Guided Product Tours**. - To opt out of guided tours only, uncheck **Allow Guided Product Tours**. diff --git a/docs/administration/appliance-manager/set-fqdn-for-web-access.mdx b/docs/administration/appliance-manager/set-fqdn-for-web-access.mdx index c79c170fa..e71e2306a 100644 --- a/docs/administration/appliance-manager/set-fqdn-for-web-access.mdx +++ b/docs/administration/appliance-manager/set-fqdn-for-web-access.mdx @@ -7,7 +7,7 @@ You can restrict access to the Device42 Main Appliance to a specific FQDN, preve ## Configure the FQDN Restriction -[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login) and navigate to **Global Settings > Set Hostname for Web Console**. +[Log in to the Appliance Manager](administration/appliance-manager/device42-appliance-manager-login.mdx) and navigate to **Global Settings > Set Hostname for Web Console**. Enter the FQDN you want to use, check **Enable Hostname Checking**, and click **Submit**. diff --git a/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx b/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx index 552bfa9ad..2604c46cd 100644 --- a/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx +++ b/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl' The Device42 Appliance Manager lets you create one-time and scheduled backups of the Main Appliance and Remote Collectors, with destinations including SFTP, NFS, and Amazon S3. This page covers how to set the backup passphrase, configure backup options, schedule backups, and limit backup retention. -For login instructions, see [Device42 Appliance Manager Login](/administration/appliance-manager/device42-appliance-manager-login). +For login instructions, see [Device42 Appliance Manager Login](administration/appliance-manager/device42-appliance-manager-login.mdx). ## Set the Passphrase @@ -42,7 +42,7 @@ Configure the backup options for the Main Appliance and Remote Collectors (RCs). Select **Backup Meta Data** when creating a Device42 instance for recovery or failover. The metadata option copies all system identifiers, passphrases, certificates, and configuration settings, preparing the standby instance to fully replace your production instance when needed. -The standby instance will share system identifiers with the production instance and will connect as the primary. For this reason, only one instance with the identifier data should be active at a time. See the [Warm HA Setup documentation](/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups) for failover procedures. +The standby instance will share system identifiers with the production instance and will connect as the primary. For this reason, only one instance with the identifier data should be active at a time. See the [Warm HA Setup documentation](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) for failover procedures. ### For Test Instances @@ -147,7 +147,7 @@ Check your time settings to avoid potential issues with AWS services. From the D ### Important Note for Scheduled Backups -If you intend to use a backup schedule for auto-restore to a standby appliance, as described in the [Warm HA Configuration](/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups) documentation, you must select **Backup Meta Data** for the backup schedule. +If you intend to use a backup schedule for auto-restore to a standby appliance, as described in the [Warm HA Configuration](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) documentation, you must select **Backup Meta Data** for the backup schedule. Without the metadata, the restore and passphrase settings are not included in the backup archive, and the appliance will have no reference for how to use the data on restore. @@ -180,4 +180,4 @@ For Windows servers, use the following PowerShell script to delete files older t ## Restore the Backup -See [Device42 Restore](/administration/appliance-manager/device42-restore). +See [Device42 Restore](administration/appliance-manager/device42-restore.mdx). diff --git a/docs/administration/appliance-manager/update-device42.mdx b/docs/administration/appliance-manager/update-device42.mdx index 2a49346ca..7a1fcc2ed 100644 --- a/docs/administration/appliance-manager/update-device42.mdx +++ b/docs/administration/appliance-manager/update-device42.mdx @@ -7,7 +7,7 @@ You can update the Device42 Main Appliance from the Appliance Manager using eith ## Download the Update -[Log in to the Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login) and go to **Application > Update Software**. You will see two methods for updating — only one is required. +[Log in to the Appliance Manager](administration/appliance-manager/device42-appliance-manager-login.mdx) and go to **Application > Update Software**. You will see two methods for updating — only one is required. ![Update options in the Appliance Manager](/assets/images/update-device42/updgrade-options-AM-19.06.png) diff --git a/docs/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx b/docs/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx index 77ad5e13c..7e467e978 100644 --- a/docs/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx +++ b/docs/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx @@ -12,7 +12,7 @@ Setting up Warm HA consists of two steps: - Configure automated restores to the standby appliance. - Switch the standby appliance to production mode in the event of a failure. -From the [Device42 Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login), you can set the appliance to standby mode and configure it to restore from a backup file on a remote server. The appliance will then automatically restore from the backup file at the intervals you specify. +From the [Device42 Appliance Manager](administration/appliance-manager/device42-appliance-manager-login.mdx), you can set the appliance to standby mode and configure it to restore from a backup file on a remote server. The appliance will then automatically restore from the backup file at the intervals you specify. ## Set Up Automated Restores for a Warm HA Appliance @@ -50,7 +50,7 @@ Without the metadata, restore and passphrase settings are not included in the ba A backup file without metadata can still be used for an on-demand restore. -For details, see [backup metadata](/administration/appliance-manager/setting-up-backup-device42-appliance-manager#backing-up-metadata) and [scheduling the backup](/administration/appliance-manager/setting-up-backup-device42-appliance-manager#scheduling-the-backup). +For details, see [backup metadata](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx#backing-up-metadata) and [scheduling the backup](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx#scheduling-the-backup). ## Set Appliance Mode via API From 7cb82589f772e359f265e6cf41f189fe01963869 Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Tue, 19 May 2026 16:47:55 +0200 Subject: [PATCH 23/24] 1262: replace TOC with grouped overview; appliance-manager index --- .../appliance-manager/index.mdx | 27 +++++-------------- 1 file changed, 7 insertions(+), 20 deletions(-) diff --git a/docs/administration/appliance-manager/index.mdx b/docs/administration/appliance-manager/index.mdx index 84ea2c977..413ccc21c 100644 --- a/docs/administration/appliance-manager/index.mdx +++ b/docs/administration/appliance-manager/index.mdx @@ -2,25 +2,12 @@ title: "Appliance Manager" --- -The Device42 Appliance Manager runs on port 4242 (HTTP by default, with HTTPS available to enable from inside) and provides administrative functions such as backups and restores, HTTPS certificate management, application restart and stop controls, and log or SNMPwalk generation for support. This section covers the topics below. +The Device42 Appliance Manager is a separate administrative interface that runs on port 4242 (HTTP) or 4343 (HTTPS). It provides low-level controls that are not available in the main Device42 UI, including backup and restore, certificate management, network configuration, and log generation for troubleshooting. Use the sidebar to navigate to specific topics. -## Table of Contents +**Backup and recovery** — Set up scheduled or on-demand backups to local storage, SFTP, NFS, or Amazon S3. Restore the appliance from a backup file, and configure Warm HA for automatic standby failover. See [Set Up Backup](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx), [Device42 Restore](administration/appliance-manager/device42-restore.mdx), and [Warm HA Setup](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx). -- [Add Multiple Network Interface Cards (NICs) to a Device42 VM](administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm.mdx) -- [API Limits](administration/appliance-manager/api-limits.mdx) -- [Change the Device42 Appliance Hostname](administration/appliance-manager/changing-device42-appliance-hostname.mdx) -- [Collect SNMPwalk Output for Troubleshooting](administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.mdx) -- [Delete History Logs](administration/appliance-manager/delete-history-logs.mdx) -- [Device42 Appliance Manager Login](administration/appliance-manager/device42-appliance-manager-login.mdx) -- [Device42 Restore](administration/appliance-manager/device42-restore.mdx) -- [Enable or Disable TLS Versions from Appliance Manager](administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx) -- [Enable SSL in Appliance Manager](administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx) -- [Generate a Log Bundle](administration/appliance-manager/generate-log-bundle.mdx) -- [Generate IPMI Output for Troubleshooting](administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx) -- [Global and Password Manager Session Timeout](administration/appliance-manager/global-and-password-manager-session-timeout.mdx) -- [Install VMware or XenServer Tools](administration/appliance-manager/installing-vmware-or-xenserver-tools.mdx) -- [Pendo Guided Tours and Usage Information Collection](administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx) -- [Set FQDN for Web Access](administration/appliance-manager/set-fqdn-for-web-access.mdx) -- [Set Up HTTPS Certificate](administration/appliance-manager/set-up-https-cert.mdx) -- [Set Up Backup via Device42 Appliance Manager](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx) -- [Warm HA Setup, Failover, and Automated Backups](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) +**Security and network** — Enable HTTPS, manage TLS versions, upload SSL certificates, set the FQDN for web access, configure an HTTP or HTTPS proxy, and add additional network interfaces to the VM. See [Enable SSL](administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx), [Set Up HTTPS Certificate](administration/appliance-manager/set-up-https-cert.mdx), [TLS Versions](administration/appliance-manager/enable-or-disable-tls-versions-from-appliance-manager.mdx), and [Add NICs](administration/appliance-manager/adding-multiple-network-interface-cardsnic-to-device42-vm.mdx). + +**Troubleshooting and support** — Generate log bundles or SNMPwalk output to send to Device42 Support, generate IPMI output for hardware-level diagnostics, and delete history logs to free up space. See [Generate Log Bundle](administration/appliance-manager/generate-log-bundle.mdx), [Collect SNMPwalk Output](administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.mdx), and [Generate IPMI Output](administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx). + +**Appliance settings** — Change the appliance hostname, configure session timeouts, install VMware or XenServer tools, set API rate limits, and manage Pendo guided tours and usage data collection. See [Change Hostname](administration/appliance-manager/changing-device42-appliance-hostname.mdx), [Session Timeout](administration/appliance-manager/global-and-password-manager-session-timeout.mdx), and [API Limits](administration/appliance-manager/api-limits.mdx). From 08e55167abdbebffaace83fb73ca819acf2dce1b Mon Sep 17 00:00:00 2001 From: Nadia <98525884+Nadia-JSch@users.noreply.github.com> Date: Tue, 19 May 2026 16:53:25 +0200 Subject: [PATCH 24/24] 1262: fix broken AWS link path; device42-appliance-manager-login --- .../appliance-manager/device42-appliance-manager-login.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/administration/appliance-manager/device42-appliance-manager-login.mdx b/docs/administration/appliance-manager/device42-appliance-manager-login.mdx index e46097044..612c0c58a 100644 --- a/docs/administration/appliance-manager/device42-appliance-manager-login.mdx +++ b/docs/administration/appliance-manager/device42-appliance-manager-login.mdx @@ -41,6 +41,6 @@ Click your username at the top of the left sidebar and select **Change password* ## AWS Login -For **marketplace** AWS installations, use `d42admin` as the username and your **AWS Instance ID** as the default password. See the [AWS installation instructions](getstarted/deploy-device42/installation-amazon-web-services.mdx#accessing-the-d42-appliance-manager---aws-marketplace-installs) for details. +For **marketplace** AWS installations, use `d42admin` as the username and your **AWS Instance ID** as the default password. See the [AWS installation instructions](getstarted/deploy-device42/installation-guides/installation-amazon-web-services.mdx#accessing-the-d42-appliance-manager---aws-marketplace-installs) for details. For **manual** AWS installations using a downloaded image, log in with the default Device42 username `d42admin` and password `default`.