Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
c11d1bc
1210: fix heading hierarchy; docs/administration
Nadia-JSch Jan 20, 2026
2ca9222
1210: fix heading hierarchy; docs/apps
Nadia-JSch Jan 20, 2026
bce02d2
1210: fix heading hierarchy; docs/auto-discovery
Nadia-JSch Jan 20, 2026
765d784
1210: fix heading hierarchy; unprocessed-device-records
Nadia-JSch Jan 21, 2026
28febfd
1210: fix heading hierarchy; docs/getstarted
Nadia-JSch Jan 21, 2026
c6cd58b
1210: fix heading levels; docs/infrastructure-management
Nadia-JSch Jan 21, 2026
2c8f7e6
1210: fix heading levels; docs/integration
Nadia-JSch Jan 21, 2026
7667edc
1210: fix heading levels; docs/reports
Nadia-JSch Jan 21, 2026
795919d
1210: fix heading levels; remaining files
Nadia-JSch Jan 21, 2026
50a6f1a
1210: fix remaining headings
Nadia-JSch Jan 23, 2026
6626e60
update gitignore
Nadia-JSch Jan 28, 2026
9898544
1212: change headings to imperative; docs/administration
Nadia-JSch Jan 28, 2026
928dc88
1212: change headings to imperative; docs/apps
Nadia-JSch Jan 28, 2026
234ad64
1212: change headings to imperative; docs/auto-discovery
Nadia-JSch Jan 28, 2026
3bb4878
1212: change headings to imperative; docs/getstarted
Nadia-JSch Jan 28, 2026
f039280
1212: change headings to imperative; docs/infrastructure-management
Nadia-JSch Jan 28, 2026
b54e75d
1212: change headings to imperative; docs/integration & /reports
Nadia-JSch Jan 28, 2026
a1cb5d9
1212: apply heading title case & style fixes; docs/administration
Nadia-JSch Jan 28, 2026
72042d6
1212: change headings to imperative
Nadia-JSch Jan 28, 2026
96c035e
1212: change headings to imparative
Nadia-JSch Jan 29, 2026
82ae31b
Merge pull request #1024 from ritza-co/fix-heading-language
Nadia-JSch Jan 30, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
*.swp
.vscode/
CLAUDE.md
/scripts

npm-debug.log*
yarn-debug.log*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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.

### Add multiple NICs to the VM
## Add Multiple NICs to the VM

![Add multiple NICs to the VM](/assets/images/wpid4810-vmware_nic.png)

Expand All @@ -17,23 +17,23 @@ 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.

### Configuring the assigned NICs
## 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.

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.

### First interface vs. other interfaces
### 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.

You can check your config after from the Device42 appliance manager as discussed in next step.

### Checking your network config
## Check Your Network Config

![Checking your network config](/assets/images/wpid4626-usage-network-info.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 3

You can change the Device42 Appliance hostname from the Appliance Manager or the VM console.

### Change Hostname in the Appliance Manager
## Change Hostname in the Appliance Manager

[Log in to the Appliance Manager](device42-appliance-manager-login.mdx).

Expand All @@ -17,7 +17,7 @@ You need to restart the Device42 application. Go to **Application > Restart Appl

![Change appliance name](/assets/images/changing-device42-appliance-hostname/restart-application.png)

### Change Hostname in the VM Console
## Change Hostname in the VM Console

Log in to the VM console.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ You can collect SNMP walk output for a network device or PDU right from the GUI.

From the Appliance Manager, go to **Application > Generate SNMP Output**.

### Simple SNMP Walk Output
## Simple SNMP Walk Output

If this is not a new device, select the **No: Simple walk** option.

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.

![Collect SNMP walk Appliance Manager](/assets/images/collecting-snmpwalk-output-for-troubleshooting/simple-walk.png)

### MIB Browser-Based Walk
## MIB Browser-Based Walk

For new devices, select **Yes: MIB browser based walk**.

Expand Down
4 changes: 2 additions & 2 deletions docs/administration/appliance-manager/device42-restore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Please take note of the following before you proceed with the restore process:
- 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.
:::

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

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.

## Restoring the MA and RC Backup Files
## Restore the MA and RC Backup Files

From the [Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login.mdx), navigate to **Backup/Restore > Restore**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@ title: "Enable or Disable TLS Versions from Appliance Manager"
sidebar_position: 8
---

# Disabling or Enabling TLS Versions From the Appliance Manager

Device42 allows you to restrict TLS versions for Appliance Manager Access. The radio buttons shown below control this feature.

:::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**.
:::

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

![](/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**.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If you are experiencing issues with discovery, you can generate a log bundle and

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

### Remote Collector Log Bundle
## 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.

Expand Down
8 changes: 4 additions & 4 deletions docs/administration/appliance-manager/set-up-https-cert.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ 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.

### Upload the cert and key files.
## Upload the Cert and Key Files

![](/assets/images/WEB_815_1.jpg)

Upload both files: cert and key. The software will validate the certs before applying them.

### Adding the intermediate and the CA Root
### Add the Intermediate and the CA Root

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)

### Restart the Application
## Restart the Application

![](/assets/images/WEB_815_2.jpg)

You will need to restart the application to see the new cert.

### Creating your own cert
## 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.

2 changes: 1 addition & 1 deletion docs/administration/appliance-manager/update-device42.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The URL option automates the process of downloading and uploading the upgrade pa

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

### Apply the Update
## Apply the Update

From the VM console, enter option **(a) Apply Update**:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ 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.

## Automate Restores to Back Up Your Main Appliance for Warm HA

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. This process consists of two steps:
This process consists of two steps:

- Setting up the automated restores
- Setting the backup appliance to production mode in the event of a device failure
Expand Down Expand Up @@ -50,7 +52,7 @@ 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).

## Setting Appliance Mode via API
## 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.

Expand Down
3 changes: 0 additions & 3 deletions docs/administration/custom-column-views.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,12 @@ sidebar_position: 6
import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

## Customs Column Views in Device42

You can customize the column views of all list pages in Device42. You can create and save multiple custom column views for each list page, then set a global default view or set specific custom column views as the default views for particular users.

To add a custom column view, navigate to a list page, such as **Resources > Compute > All Devices**.

Click the **gear icon** on the far right of the screen - to right of the current view name. The default view is **System Column List**.


<ThemedImage
alt="Gear icon on Devices list page"
sources={{
Expand Down
4 changes: 2 additions & 2 deletions docs/administration/customizing-device42.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Navigate to **Tools > Settings > Global Settings** and scroll down to the **Logi
}}
/>

### Add Your Company Logo to Device42
## Add Your Company Logo to Device42

If you upload a logo, it will replace the Device42 logo on the login screen.

Expand All @@ -30,7 +30,7 @@ If you upload a logo, it will replace the Device42 logo on the login screen.
}}
/>

### Add User Instructions to the Login Page
## Add User Instructions to the Login Page

If you upload user instructions, they will appear on the login page.

Expand Down
6 changes: 2 additions & 4 deletions docs/administration/data-reset-tool.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@ title: "Data Reset Tool"
sidebar_position: 9
---

## Data Reset Tool - Clear All Devices from Device42
If you're looking to wipe your Device42 instance clean, grab the Python script available on [Github](https://github.com/device42/ResetDevice42Data) and use it to remove all devices from your Device42 Main Appliance.

If you're looking to wipe your Device42 instance clean, grab the Python script available on [Github](https://github.com/device42/ResetDevice42Data) and **use it to remove all devices from your Device42 MA.**
## Clear All Devices from Device42

To use the tool, simply open it in your favorite text editor (ours are [Notepad++](https://notepad-plus-plus.org/) & [Atom](https://www.Atom.io)), and edit the Device42 URL to point at your instance. Update the username and password fields with credentials for your instance, and save.

You can then run the script on any computer with Python 3.7+ installed.

* * *

**Note:** The Device42 reset script does not currently clear subnets from the application, they will need to manually be cleared.

:::warning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ If you notice a problem in the Device42 documentation that you know how to fix,

If you see a problem but you're not sure how to fix it, or don't have the time, hit [the feedback button](./how-to-submit-documentation-feedback.mdx) at the top of each page and our team will address it!

### How Do I Edit a Document on GitHub? (Video)
## How Do I Edit a Document on GitHub? (Video)

<ReactPlayer controls url='https://device42.wistia.com/medias/tv5o91zv4w' />


### How Do I Edit a Document on GitHub? (Article)
## How Do I Edit a Document on GitHub? (Article)

To edit a document on GitHub, you can create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) with your changes, and we'll review them before making them live on our website.

Expand All @@ -32,7 +32,7 @@ In the dialog box that opens, click "Create fork".

![](/assets/images/feedback_fork_repo_create.png)

### Opening a Pull Request if Youve Forked the Device42 Documentation Repository Before
## Open a Pull Request If You've Forked the Device42 Documentation Repository Before

If you've previously forked the Device42 documentation repo and you're signed in to GitHub in your browser, clicking the "Edit this page" link will take you directly to the page on GitHub.

Expand All @@ -54,7 +54,7 @@ To target your pull request to the correct repository, do the following:

* Click "Create pull request".

### How To Make Changes to the Markdown File
## Make Changes to the Markdown File

If you're not in "Edit" mode already, enter it by clicking the pen icon on the top-right of the preview window.

Expand Down Expand Up @@ -84,7 +84,7 @@ Here are some more tips for editing in Markdown:

Visit [markdownguide.org](https://www.markdownguide.org/cheat-sheet/) for more information on Markdown syntax.

### How To Submit Your Changes by Opening a Pull Request
## Submit Your Changes by Opening a Pull Request

When you're done editing, you will commit your changes before opening a pull request.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ At Device42, we strive for accurate, clear, informative documentation. If you en

If you know exactly what change needs to be made, you can [contribute edits directly](./how-to-contribute-documentation-fixes.mdx).

### How Do I Provide Feedback Using the Device42 Feedback Widget?
## How Do I Provide Feedback Using the Feedback Widget?

Use the Device42 feedback widget on our docs site for general reporting, including comments and compliments! You can alert us to issues such as broken links or missing images, or make a request for documentation.

Expand Down
7 changes: 3 additions & 4 deletions docs/administration/generating-csrs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ title: "Generating CSRs"
sidebar_position: 10
---

## Generating a Certificate Via OpenSSL

Instructions to generate certificates with openSSL can also be found [documented here, on our support site.](https://support.device42.com/hc/en-us/articles/222221348-My-demo-certificate-for-https-expired-how-can-I-add-a-new-one-)

To generate a CSR (Certificate Signing Request), open a terminal that has the **openssl** package installed. The following commands will generate a (self-signed) SSL certificate from a new or existing OpenSSL installation:
To generate a CSR (Certificate Signing Request), open a terminal that has the **openssl** package installed.

The following commands will generate a (self-signed) SSL certificate from a new or existing OpenSSL installation:

1. Generate a **private** key for your server CA (Certificate Authority):
```bash
Expand Down Expand Up @@ -42,7 +41,7 @@ To generate a CSR (Certificate Signing Request), open a terminal that has the **

Adding a new certificate is easy; See [add a new certificate via appliance manager instructions here](appliance-manager/set-up-https-cert.mdx).

## Generating Non-Production CSRs
## Generate Non-Production CSRs

:::caution
We recommend using the OpenSSL method outlined above. Use the following online generator at your own risk, and only for non-production purposes. A 'private' key generated by this link (or any third party) is unlikely to be truly private.
Expand Down
48 changes: 24 additions & 24 deletions docs/administration/licensing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,42 @@ sidebar_position: 11
import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

## Updating Your Device42 License
Device42 licenses are valid for one year from the date of purchase. To continue using Device42 after the license expires, please [contact support](https://support.device42.com/hc/en-us) about renewing it.

Device42 licenses are valid for one year from the date of purchase. To continue using Device42 after the license expires, please renew it.
This page answers common questions about finding, applying, and managing your Device42 license.

### Where Do I Find My License Information?
## Where Do I Find My License Information?

To see your current Device42 licenses, navigate to **Tools > Settings > Licensing** from the main menu to display the Licensing page.
- To see your current Device42 licenses, navigate to **Tools > Settings > Licensing** from the main menu to display the Licensing page.

<ThemedImage
alt="Licensing menu option"
sources={{
light: useBaseUrl('/assets/images/licensing/licensing-menu-19.06-light.png'),
dark: useBaseUrl('/assets/images/licensing/licensing-menu-19.06-dark.png'),
}}
/>
<ThemedImage
alt="Licensing menu option"
sources={{
light: useBaseUrl('/assets/images/licensing/licensing-menu-19.06-light.png'),
dark: useBaseUrl('/assets/images/licensing/licensing-menu-19.06-dark.png'),
}}
/>

The page displays the available license modules and whether they are enabled.
- The page displays the available license modules and whether they are enabled.

<ThemedImage
alt="Enabled licenses"
sources={{
light: useBaseUrl('/assets/images/licensing/license-section-19.06-light.png'),
dark: useBaseUrl('/assets/images/licensing/license-section-19.06-dark.png'),
}}
style={{ width: '80%' }}
/>
<ThemedImage
alt="Enabled licenses"
sources={{
light: useBaseUrl('/assets/images/licensing/license-section-19.06-light.png'),
dark: useBaseUrl('/assets/images/licensing/license-section-19.06-dark.png'),
}}
style={{ width: '80%' }}
/>

### How Do I Get a Device42 License?
## How Do I Get a License?

After [purchasing](https://www.device42.com/pricing/?nab=0) or renewing your Device42 license, you'll receive a license file via email to upload on the Licensing page of the Main Appliance.

:::info
If you need a developer or test license, please email [support@device42.com](mailto:support@device42.com).
:::

### How Do I Apply My License?
## How Do I Apply My License?

Go to the License page under **Tools > Settings > Licensing** and do the following:

Expand Down Expand Up @@ -71,7 +71,7 @@ Go to the License page under **Tools > Settings > Licensing** and do the followi

- After registering your license, refresh the browser. The banner will disappear, and you'll see the updated expiration date on the Licensing page.

### How Do I Know When My License Expires?
## When Will My License Expire?

You can check the **License Valid Until(YYYYMMDD):** date on the License page under **Tools > Settings > Licensing**.

Expand All @@ -85,7 +85,7 @@ Two weeks before your license expires, on your Main Appliance home page, you'll
}}
/>

## What Uses a License in Device42?
## What Uses a License?

Device42 has a Core license for autodiscovery and offers additional license modules for more discovery and data retrieval capabilities.

Expand Down
Loading