Skip to content

Commit 1abb04f

Browse files
authored
Merge pull request #452 from ritza-co/19.06.06
Docs 19.06.06 release (Week 24, 2025)
2 parents ed90553 + 4766c33 commit 1abb04f

91 files changed

Lines changed: 940 additions & 688 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/administration/appliance-manager/api-limits.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "API Limits"
33
sidebar_position: 2
44
---
55

6-
Released in 18.08.00, there is a now a setting in the Appliance Manager that will limit how many remote agents can attempt to update at once. This is intended for customers with hundreds of agents so that those agents will not simultaneously attempt to update causing the Main Appliance to be overloaded.
6+
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.
77

8-
The default setting for the API limit is 16 concurrent agent updates. Customers can configure this number to best suit their needs, between 8 and 128.
8+
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`.
99

10-
![](/assets/images/API-Limits-700x733.png)
10+
![](/assets/images/api-limits/api-limits.png)

docs/administration/appliance-manager/enabling-ssl-in-appliance-manager.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@ title: "Enabling SSL in Appliance Manager"
33
sidebar_position: 9
44
---
55

6-
# Enabling SSL in Appliance Manager
6+
Device42 now has the ability to use HTTPS in the Appliance Manager, in addition to the existing HTTPS in the Main Appliance.
77

8-
Device42 now has the ability to use HTTPS in the Appliance Manager in addition to the existing HTTPS in the main appliance.
8+
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).
99

10-
To enable this functionality, log into the Device42 Appliance Manager by clicking the link at the bottom of the main login page, and entering your Device42 credentials. The default name and password for the Appliance Manager is d42admin/default. ![Appliance Manager Login](/assets/images/2015-12-17-Appliance-Manager-SSL-04.png)
10+
- From the main menu (left panel) of the Appliance Manager, select **Appliance Manager SSL**:
11+
- 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.
1112

12-
From the main menu on the left side of the Appliance Manager, select "Appliance Manager SSL": ![Appliance Manager SSL](/assets/images/2015-12-17-Appliance-Manager-SSL-06.png)
13+
![HTTPS enabled](/assets/images/enabling-ssl-in-appliance-manager/appliance-manager-ssl.png)
1314

14-
This will bring you to a screen with the option to enable SSL. ![HTTPS enabled](/assets/images/2015-12-17-Appliance-Manager-SSL-02.png)
15+
- Log in to the VM console and select **Reboot Server**.
1516

16-
Upon doing so, you will see a success message at the bottom, and will need to restart the appliance by logging into the console and selecting option 4. ![Reboot appliance](/assets/images/2015-12-17-Appliance-Manager-SSL-01.png)
17+
![Reboot appliance](/assets/images/enabling-ssl-in-appliance-manager/console-reboot-services.png)
Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
---
2-
title: "Generate log bundle"
2+
title: "Generate Log Bundle"
33
sidebar_position: 10
44
---
55

66
import ThemedImage from '@theme/ThemedImage'
77
import useBaseUrl from '@docusaurus/useBaseUrl'
88

9-
To generate log bundle for a support call:
9+
If you are experiencing issues with discovery, you can generate a log bundle and send it to support for further analysis.
1010

11-
1. If you are experiencing autodiscovery issues, enable debug in the discovery job settings. For issues unrelated to autodiscovery, keep debug mode off and proceed to step three.
11+
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.
1212

1313
<ThemedImage
1414
alt="Enable debug by editing discovery job settings"
1515
sources={{
16-
light: useBaseUrl('/assets/images/generate-log-bundle/discovery-job-enable-debug-light.png'),
17-
dark: useBaseUrl('/assets/images/generate-log-bundle/discovery-job-enable-debug-dark.png'),
16+
light: useBaseUrl('/assets/images/generate-log-bundle/edit-debug-level-light.png'),
17+
dark: useBaseUrl('/assets/images/generate-log-bundle/edit-debug-level-dark.png'),
1818
}}
1919
/>
2020

21-
2. If your issue is autoDiscovery related, re-run the failing autodiscovery job now that you've enabled the debug flag.
22-
3. Login to the appliance manager via the main menu, **Tools > Appliance Manager** or follow the [Device42 Appliance Manager login](device42-appliance-manager-login.mdx) directions.
21+
2. If the issue is discovery-related, rerun the failing discovery job now that you've enabled the debug flag.
22+
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.
2323
4. Generate the log bundle via the Appliance Manager. Navigate to **Application > Generate Log Bundle** and click **Run**.
2424

25-
![Generate Log Bundle via Appliance Manager](/assets/images/generate-log-bundle/am-generate-log-bundle.png)
25+
![Generate Log Bundle via Appliance Manager](/assets/images/generate-log-bundle/generate-log-bundle-19.06.png)
2626

2727
5. Upload the generated log file at [upload.device42.com](https://upload.device42.com/).
2828

2929
### Remote Collector Log Bundle
3030

31-
If you were also using the Remote Collector (RC) for the job, please get and upload the RC log using the [same upload link](https://upload.device42.com/) above.
31+
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.
3232

33-
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 investing the issue.
33+
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.
3434

3535
<ThemedImage
36-
alt="Download RC log button"
36+
alt="Download RC logs button"
3737
sources={{
38-
light: useBaseUrl('/assets/images/generate-log-bundle/rc-log-download-light.png'),
39-
dark: useBaseUrl('/assets/images/generate-log-bundle/rc-log-download-dark.png'),
38+
light: useBaseUrl('/assets/images/generate-log-bundle/rc-log-download-19.06-light.png'),
39+
dark: useBaseUrl('/assets/images/generate-log-bundle/rc-log-download-19.06-dark.png'),
4040
}}
41-
/>
41+
/>

docs/administration/appliance-manager/generating-ipmi-output-for-troubleshooting.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@ title: "Generating IPMI output for troubleshooting"
33
sidebar_position: 11
44
---
55

6-
You can collect IPMI output for a device right from the GUI and send us the output for further troubleshooting.
6+
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.
77

8-
### Collect IPMI output
8+
## Collect IPMI Output
99

10-
![Collect IPMI output](/assets/images/2016-04-07-Generate-IPMI-output-01.png)
10+
[Log in to the Appliance Manager](device42-appliance-manager-login.mdx), and navigate to **Application > Generate IPMI Output**.
1111

12-
Go to: Application > Generate IPMI output
12+
![Collect IPMI output](/assets/images/generating-ipmi-output-for-troubleshooting/generate-ipmi-output.png)
13+
14+
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.
1315

14-
Add the FQDN or IP address, name and password, click generate, wait as it might take few minutes and send us the file it generates.
Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,41 @@
11
---
2-
title: "Global and Password manager session timeout"
2+
title: "Global and Password Manager Session Timeout"
33
sidebar_position: 12
44
---
55

6-
The global session timeout in device42 is set to 30 minutes by default and can be changed as discussed below. Password pages have an additional check for inactivity time (for enhanced security) and if user is inactive for a minute, it logs them out of the session.
6+
import ThemedImage from '@theme/ThemedImage'
7+
import useBaseUrl from '@docusaurus/useBaseUrl'
78

8-
### Global session timeout
9+
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).
910

10-
![wpid2153-Global_session_timeout.png](/assets/images/wpid2153-Global_session_timeout.png)
11+
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.
1112

12-
Global session timeout can be set between 1 to 60 minutes as shown above. Once you choose and save optimal value for you, you will need to restart the application to see the new session timeout in effect.
13+
## Global Session Timeout
1314

14-
### Password pages inactivity timer
15+
You can set timeout values for the Main Appliance and Appliance Manager:
1516

16-
All password pages(list, view, edit etc.) also have an inactivity timer. If there is no mouse or keyboard activity for 1 minute, the user will be logged out of the session.
17+
- [Log in to the Main Appliance](device42-appliance-manager-login.mdx) and navigate to **Global Settings > Set Inactivity logout time**.
1718

18-
You can change the password page inactivity timer from main app from Tools > Settings > Password timeout.
19+
- Set a new value (in minutes) for the session timeout.
1920

20-
The global session timeout is independent and must be changed separately.
21+
![Global Session timeout](/assets/images/global-and-password-manager-session-timeout/global-inactivity-timeout.png)
22+
23+
- 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.
24+
25+
## Password Pages Inactivity Timer
26+
27+
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.
28+
29+
- You can change the password page inactivity timer from the Main Appliance, under **Tools > Settings > Global Settings**.
30+
31+
- Set a new **Password Timeout** value (in seconds) under the **Secrets** section.
32+
33+
<ThemedImage
34+
alt="Secrets section of Global Settings"
35+
sources={{
36+
light: useBaseUrl('/assets/images/global-and-password-manager-session-timeout/global-settings-password-timeout-light.png'),
37+
dark: useBaseUrl('/assets/images/global-and-password-manager-session-timeout/global-settings-password-timeout-dark.png'),
38+
}}
39+
/>
40+
41+
Note that the appliance global session timeouts are different from the password page inactivity timers and must be changed separately.

docs/administration/appliance-manager/pendo-guided-tours-and-usage-information-collection.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,14 @@ title: "Guided Tours and Usage Information Collection"
33
sidebar_position: 14
44
---
55

6-
Device42 collects certain usage information to help us better assist users, prioritize future product updates, and provide guided product tours for Device42 features.
6+
Device42 collects certain usage information to better assist users, prioritize future product updates, and provide guided product tours of Device42 features.
77

8-
You can use the Device42 Appliance Manager to disable the collection of usage data if you so choose.
8+
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.
99

10-
- Log into the Appliance Manager, and select _Global Settings_ and then _Misc. Settings_.
11-
- Uncheck _Allow guided product tours (shares usage data)_ and then click _Update Settings_.
10+
- [Log in to the Appliance Manager](device42-appliance-manager-login.mdx), and navigate to **Global Settings > Misc. Settings**.
1211

13-
![](/assets/images/D42-25467_pendo-setting-in-app-mgr.png)
12+
- To disable the collection of usage data, uncheck the **Allow usage metric sharing** option – the **Allow Guided Product Tours** option will also be disabled.
13+
- To opt out of guided tours, uncheck the **Allow Guided Product Tours** option.
14+
- Click **Update Settings** to save your changes.
15+
16+
![Misc. Settings in Appliance Manager](/assets/images/pendo-guided-tours-and-usage-information-collection/misc-settings-appliance-manager.png)

docs/administration/appliance-manager/set-fqdn-for-web-access.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: "Set FQDN for Web Access"
33
sidebar_position: 16
44
---
55

6-
![](/assets/images/set-fqdn.png)
6+
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.
77

8-
Use this feature to restrict access to Device42 application (web UI) to a specific FQDN. Use of this setting will deny access to Device42 via IP address or other hostname and/or domain.
8+
[Log in to the Appliance Manager](device42-appliance-manager-login.mdx), then navigate to **Global Settings > Set Hostname for Web Console**.
9+
10+
Enter the FQDN you want to use, check **Enable Hostname Checking**, and click **Submit**.
11+
12+
![](/assets/images/set-fqdn-for-web-access/set-hostname-for-web-console.png)

docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -163,15 +163,18 @@ find /device42/backup/directory -type f -mtime +7 -delete
163163

164164
For Windows Servers, the following PowerShell script can be used to delete files older than seven days from the targeted directory:
165165

166-
```
167-
# Delete all Files in C:temp older than 7 day(s)
168-
169-
$Path = "C:device42backups"
170-
$Daysback = "-7"
171-
$CurrentDate = Get-Date
172-
$DatetoDelete = $CurrentDate.AddDays($Daysback)
173-
Get-ChildItem $Path | Where-Object { $_.LastWriteTime -lt $DatetoDelete } | Remove-Item
174-
```
166+
<details>
167+
<summary>Click to expand the code block</summary>
168+
```
169+
# Delete all Files in C:temp older than 7 day(s)
170+
171+
$Path = "C:device42backups"
172+
$Daysback = "-7"
173+
$CurrentDate = Get-Date
174+
$DatetoDelete = $CurrentDate.AddDays($Daysback)
175+
Get-ChildItem $Path | Where-Object { $_.LastWriteTime -lt $DatetoDelete } | Remove-Item
176+
```
177+
</details>
175178

176179
## Restore the Backup
177180

docs/administration/appliance-manager/update-device42.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: "Updating Device42"
33
sidebar_position: 18.5
44
---
55

6-
When you log in to the Appliance Manager you'll see two methods for updating your Device42 Main Appliance. You only need to complete one of the options.
6+
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:
77

8-
![](/assets/images/update-device42/updgrade-options-AM.png)
8+
![](/assets/images/update-device42/updgrade-options-AM-19.06.png)
99

1010
- **Enter URL:** Enter the provided URL from the update notification and click **Download**.
1111
- **Upload D42 upgrade package:**
@@ -14,12 +14,16 @@ When you log in to the Appliance Manager you'll see two methods for updating you
1414
- Head back to the Appliance Manager and **Browse** your machine for the downloaded package file.
1515
- Click **Upload** and wait for the progress bar to complete.
1616

17-
The URL option automates the process of downloading and uploading the upgrade package. The manual upload option is available for when you've already downloaded the package file or are using an instance without internet access.
17+
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.
1818

1919
In both cases, a green status message will appear instructing you to complete the upgrade from the VM console.
2020

2121
### Apply the Update
2222

23-
From the VM console, enter option **3**.
23+
From the VM console, enter option **(a) Apply Update**:
2424

25-
![](/assets/images/update-device42/vm-console-options.png)
25+
- Click **Yes** to confirm the upgrade process.
26+
- Wait for the process to complete.
27+
- 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.
28+
29+
![](/assets/images/update-device42/vm-console-options-19.06.png)

docs/administration/auto-clean-feature.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,6 @@ Build search criteria for the selected object type using the basic dropdown filt
118118

119119
Select the actions to perform on CIs matching added object types and its criteria. The available Auto Clean Rule **Action** options vary depending on which **Object type** you select for the rule. The example below shows the action options for Device objects.
120120

121-
![](/assets/images/AutoClean-device-action-options.png)
122-
123121
<ThemedImage
124122
alt="Auto Clean Rules Action options for Devices"
125123
sources={{

0 commit comments

Comments
 (0)