Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
e581ed9
1253: language-improvements; administration/index
Nadia-JSch Apr 16, 2026
1de275b
1253: language-improvements; updating-device42
Nadia-JSch Apr 16, 2026
e627bd3
1253: language-improvements; active-directory-and-openldap-support
Nadia-JSch Apr 16, 2026
6d1b0e2
1253: language-improvements; advanced-routing
Nadia-JSch Apr 17, 2026
efde5c6
1253: language-improvements; add-an-active-directory-user-as-a-device…
Nadia-JSch Apr 17, 2026
f68c15b
1253: language-improvements; auto-clean-feature
Nadia-JSch Apr 17, 2026
c925c89
1253: language-improvements; bulk-add-active-directory-group-members-…
Nadia-JSch Apr 17, 2026
91e76e4
1253: language-improvements; custom-column-views
Nadia-JSch Apr 24, 2026
01b71c6
1253: language-improvements; custom-key-value-pairs-explained
Nadia-JSch Apr 24, 2026
c9e4eff
1253: language-improvements; customizing-device42
Nadia-JSch Apr 24, 2026
2f48ee8
1253: language-improvements; data-reset-tool
Nadia-JSch Apr 24, 2026
cddb9f7
1253: language-improvements; generating-csrs
Nadia-JSch Apr 24, 2026
b6137dd
1253: language-improvements; licensing
Nadia-JSch Apr 24, 2026
4bc8fac
1253: language-improvements; main-appliance-remote-collector-faq
Nadia-JSch Apr 24, 2026
3019551
1253: language-improvements; saml-2-0-configuration
Nadia-JSch Apr 24, 2026
1d79e0a
1253: language-improvements; setting-time-zone-and-ntp
Nadia-JSch Apr 24, 2026
35bd05a
1253: language-improvements; console-menu
Nadia-JSch Apr 24, 2026
2c701ef
1253: language-improvements; tags
Nadia-JSch Apr 24, 2026
1a884aa
1253: language-improvements; transferring-devices-assets-and-parts-to…
Nadia-JSch Apr 24, 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
52 changes: 26 additions & 26 deletions docs/administration/active-directory-and-openldap-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 1
import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

Device42 can now be configured to work with multiple Active Directory (AD) servers. AD servers can be used for both Active Directory-based logins and AD synchronization.
Device42 can be configured to work with multiple Active Directory (AD) servers. AD servers can be used for both Active Directory-based logins and AD synchronization.

AD settings can be found and configured under **Tools > Settings > Active Directory Settings** and are only accessible to Device42 superusers. Multiple Active Directory settings and up to one OpenLDAP server setting can be configured at a time to properly describe your environment. Each Active Directory setting can also specify multiple domains.

Expand All @@ -22,10 +22,10 @@ From the Active Directory/LDAP Settings list page, click **Create**.
}}
/>

Under **LDAP Type**, choose **Active Directory** or **Open LDAP**.
Under **LDAP Type**, choose **Active Directory** or **OpenLDAP**.

<ThemedImage
alt="Active Directory/LDAP Settings list page"
alt="LDAP Type and server name fields"
sources={{
light: useBaseUrl('/assets/images/active-directory-and-openldap-support/ad-name-server-light.png'),
dark: useBaseUrl('/assets/images/active-directory-and-openldap-support/ad-name-server-dark.png'),
Expand All @@ -34,68 +34,68 @@ Under **LDAP Type**, choose **Active Directory** or **Open LDAP**.

For the **Active Directory** type, choosing **Domain\Username** as your **Username login Style** reveals the **Get Referral NetBIOS** option, which returns usernames in the format `ReferralNetbios/Username`.

<ThemedImage
alt="Active Directory/LDAP Settings list page"
<ThemedImage
alt="Username login style and Get Referral NetBIOS option"
sources={{
light: useBaseUrl('/assets/images/active-directory-and-openldap-support/ad-login-style-light.png'),
dark: useBaseUrl('/assets/images/active-directory-and-openldap-support/ad-login-style-dark.png'),
}}
/>
/>

If you select **Domain\Username** as your **Username login Style**, users will be required to enter both their domain and username to log in to Device42.

<ThemedImage
<ThemedImage
alt="AD credentials in login form"
sources={{
light: useBaseUrl('/assets/images/active-directory-and-openldap-support/ad-login-light.png'),
dark: useBaseUrl('/assets/images/active-directory-and-openldap-support/ad-login-dark.png'),
}}
/>
/>

For the **Open LDAP** type, you can choose an **OpenLDAP group attribute** to identify group members. The available options are **memberUid**, **uniqueMember**, **members**, and **member**.
For the **OpenLDAP** type, you can choose an **OpenLDAP group attribute** to identify group members. The available options are **memberUid**, **uniqueMember**, **members**, and **member**.

<ThemedImage
alt="Active Directory/LDAP Settings list page"
<ThemedImage
alt="OpenLDAP group attribute options"
sources={{
light: useBaseUrl('/assets/images/active-directory-and-openldap-support/openldap-attributes-light.png'),
dark: useBaseUrl('/assets/images/active-directory-and-openldap-support/openldap-attributes-dark.png'),
}}
/>
/>

You can add multiple **AD/LDAP Domains** and mark them as **Default**.

<ThemedImage
alt="Active Directory/LDAP Settings list page"
<ThemedImage
alt="AD/LDAP Domains configuration"
sources={{
light: useBaseUrl('/assets/images/active-directory-and-openldap-support/ad-domains-light.png'),
dark: useBaseUrl('/assets/images/active-directory-and-openldap-support/ad-domains-dark.png'),
}}
/>
/>

### Test Connections
### Test a Connection

Test a user account for permission to query AD:
To verify that a user account has permission to query AD, test the connection from the settings details page.

- Save your settings to display the settings details page, then open the **ellipsis** (...) menu and select **Test Connection**.
- Save your settings to display the settings details page, then open the **ellipsis** (...) menu and select **Test Connection**.

<ThemedImage
alt="Active Directory/LDAP Settings list page"
<ThemedImage
alt="Test Connection option in ellipsis menu"
sources={{
light: useBaseUrl('/assets/images/active-directory-and-openldap-support/test-connection-button-light.png'),
dark: useBaseUrl('/assets/images/active-directory-and-openldap-support/test-connection-button-dark.png'),
}}
/>
/>

- You will be prompted to provide credentials for initiating the test. Leave the credentials blank to use the currently selected username and password.

<ThemedImage
alt="Test Connections settings prompt"
<ThemedImage
alt="Test connection credentials prompt"
sources={{
light: useBaseUrl('/assets/images/active-directory-and-openldap-support/test-auth-prompt-light.png'),
dark: useBaseUrl('/assets/images/active-directory-and-openldap-support/test-auth-prompt-dark.png'),
}}
/>
/>

## Configuring an Active Directory User Sync / Discovery Job
## Configure an Active Directory User Sync or Discovery Job

You may now configure an AD Sync Job to pull AD users in bulk and/or keep them synced. Proceed to [the Active Directory Discovery Job docs page](auto-discovery/active-directory-sync.mdx) to view the AD discovery process.
You can configure an AD sync job to pull AD users in bulk and keep them synced. See the [Active Directory Discovery Job](/auto-discovery/active-directory-sync) page for details on the AD discovery process.
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ sidebar_position: 3
import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

You can create Active Directory (AD) settings in Device42 and use them to add AD users as administrators.
You can create Active Directory (AD) settings in Device42 and use them to add AD users as administrators. This page covers adding AD settings, manually adding an AD administrator, and configuring an AD user sync job.

First, add your AD settings under **Tools > Settings > Active Directory Settings**. See the [Active Directory and OpenLDAP](active-directory-and-openldap-support.mdx) page for details.
First, add your AD settings under **Tools > Settings > Active Directory Settings**. See the [Active Directory and OpenLDAP](/administration/active-directory-and-openldap-support) page for details.

Next, manually add an administrator user from the Active Directory domain you configured. Navigate to **Tools > Admins & Permissions > Administrators** and click **Create Active Directory Admin**.
Next, manually add an administrator user from the Active Directory domain you configured. Navigate to **Tools > Admins & Permissions > Administrators** and click **Create Active Directory Admin**.

<ThemedImage
alt="Create AD Admin option"
Expand All @@ -22,7 +22,7 @@ Next, manually add an administrator user from the Active Directory domain you co

Search for an Active Directory user to add as an administrator. Device42 displays the AD domain associated with the user you searched for before you add them.

[The **Username login Style** option](active-directory-and-openldap-support.mdx#add-new-active-directory-or-openldap-settings) selected when the AD settings were added controls how Device42 formats and recognizes usernames during login (for example, as `Domain\Username` or `username@domain`).
The [**Username login Style** option](/administration/active-directory-and-openldap-support#add-new-active-directory-or-openldap-settings) selected when the AD settings were added controls how Device42 formats and recognizes usernames during login (for example, as `Domain\Username` or `username@domain`).

<ThemedImage
alt="Add Active Directory user as admin"
Expand All @@ -34,6 +34,6 @@ Search for an Active Directory user to add as an administrator. Device42 display

Note that Active Directory credentials are not stored in the Device42 application. You need to enter valid domain user credentials each time you search for a user.

## Configuring the Active Directory User Discovery/sync Job
## Configure the Active Directory User Discovery or Sync Job

You can configure an AD Sync Job to pull in AD user data in bulk and/or keep them synced. See [the Active Directory Discovery Job docs page](auto-discovery/active-directory-sync.mdx) to view the AD discovery process.
You can configure an AD sync job to pull in AD user data in bulk and keep it synced. See the [Active Directory Discovery Job](/auto-discovery/active-directory-sync) page for details on the AD discovery process.
22 changes: 12 additions & 10 deletions docs/administration/advanced-routing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,29 @@ title: "Advanced Routing"
sidebar_position: 2
---

You can add complex or advanced routing for your Device42 appliance or delete it using the virtual machine (VM) console menu.
You can add or delete complex routing for your Device42 appliance using the virtual machine (VM) console menu. This page explains how to add a new route and apply it.

To add a new route, follow these steps:
## Add a New Route

1. Log in to the Device42 VM console.
2. Choose **(u) Network, Connectivity and Utilities**.
2. Select **(u) Network, Connectivity and Utilities**.

![Network options](/assets/images/advanced-routing/1-network.png)

3. Select **(r) Routing**.

![Routing options](/assets/images/advanced-routing/2-routing.png)

4. Select **(a) Add a new Route** from the **Routing Configuration Main Menu**.

![Add route option](/assets/images/advanced-routing/3-route-options.png)

5. Fill in the new route details and click **Add Route**. Use the `Tab` key to navigate to the next field.
5. Fill in the new route details and click **Add Route**. Use the `Tab` key to navigate to the next field.

![Add route details](/assets/images/advanced-routing/4-route-details.png)

6. After configuring the new route, enter option **(p) Apply Routes** from the previous menu to apply the changes.

6. Select **(p) Apply Routes** from the previous menu to apply the changes.

:::note
The Device42 VM must be manually rebooted to clear deleted routes.
:::
48 changes: 22 additions & 26 deletions docs/administration/auto-clean-feature.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@ sidebar_position: 4
import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

Auto Clean rules help you manage old and possibly stale data in Device42, automatically. Should an object (like a device or an IP address) not be found by a subsequent autodiscovery job, or modified by a manual effort, it may be out of service. This is especially true of servers and other objects in public clouds, but can also apply to objects that are behind the corporate firewall.
Auto Clean rules help you automatically manage old or stale data in Device42. If an object (like a device or an IP address) isn't found by a subsequent discovery job or updated manually, it may be out of service — this is especially common for servers and other objects in public clouds, but can also apply to objects behind a corporate firewall.

The rules for when a particular type of object should be considered and the rules for what to do about such objects vary from organization to organization. This feature enables you to define your own rules and tell Device42 what actions should be taken.

Device42 includes several system-defined disabled Auto Clean rules (related to ADM data) as suggested examples you can use to base your own rules on. You can also enable these example rules to keep your ADM data cleaner.
This page covers the CI types that Auto Clean rules can target, how to view existing rules, and how to create new ones. Device42 includes several system-defined disabled Auto Clean rules (related to ADM data) that you can enable or use as templates for your own rules.

## Auto Clean Supported CIs

Auto Clean rules can target a wide variety of Configuration Items (CIs), from Assets to Users to VLANs, and everything in between.
Auto Clean rules can target a wide variety of Configuration Items (CIs), from Assets to Users to VLANs, and everything in between.

You can select the following object types as Auto Clean rule targets:

Expand All @@ -41,12 +39,11 @@ You can select the following object types as Auto Clean rule targets:
- Subnets
- VLANs


## View Auto Clean Rules

Navigate to the Auto Clean Rules list page under **Tools > Templates & Bulk Operations > Auto Clean Rules**.

Note that the system rule, **Shared IPs maintenance**, uses a **Number of Days** option instead of the **Modify Search** option
Note that the system rule, **Shared IPs maintenance**, uses a **Number of Days** option instead of the **Modify Search** option.

<ThemedImage
alt="Auto Clean Rules menu location"
Expand All @@ -58,11 +55,11 @@ Note that the system rule, **Shared IPs maintenance**, uses a **Number of Days

## Create New Auto Clean Rules

Navigate to **Tools > Templates & Bulk Operations > Auto Clean Rules** and then click **Create**.
Navigate to **Tools > Templates & Bulk Operations > Auto Clean Rules** and then click **Create**.

The combination of object types and the search criteria you select for those object types defines the Auto Clean rule. As you build your search criteria, the **Preview** list shows the objects that the Auto Clean rule will be applied to.
The combination of object types and search criteria you select defines the Auto Clean rule. As you build your search criteria, the **Preview** list shows the objects that the rule will be applied to.

- Name the rule and click the **pencil icon**.
- Name the rule and click the **pencil icon**.

<ThemedImage
alt="Add Search Criteria icon"
Expand All @@ -72,7 +69,7 @@ The combination of object types and the search criteria you select for those obj
}}
/>

- Select an **Object Type** for the rule to target for example, **Devices**.
- Select an **Object Type** for the rule to target (for example, **Devices**).

<ThemedImage
alt="Object Type dropdown"
Expand All @@ -82,7 +79,7 @@ The combination of object types and the search criteria you select for those obj
}}
/>

Build search criteria for the selected object type using the basic dropdown filters and the advanced search option.
Build search criteria for the selected object type using the basic dropdown filters and the advanced search option.

- For the Devices object type, for example, you could select **physical** under the **Type** dropdown. Click **More Filters** to display more basic dropdown filters to select values from.

Expand All @@ -94,7 +91,7 @@ Build search criteria for the selected object type using the basic dropdown filt
}}
/>

- You can also use the [Advanced Search](/getstarted/using-device42/advanced-search-feature.mdx) feature to include search criteria.
- You can also use the [Advanced Search](/getstarted/using-device42/advanced-search-feature) feature to include search criteria.

<ThemedImage
alt="Advanced Search option"
Expand All @@ -104,7 +101,7 @@ Build search criteria for the selected object type using the basic dropdown filt
}}
/>

- Click **Add** to apply the search for the object type. You can click the **pencil icon** again to add another device and define search criteria for it.
- Click **Add** to apply the search for the object type. Click the **pencil icon** again to add another device and define search criteria for it.

<ThemedImage
alt="Added Devices object with Advanced criteria"
Expand All @@ -116,7 +113,7 @@ Build search criteria for the selected object type using the basic dropdown filt

### Auto Clean Rule Options

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.
Select the actions to perform on CIs matching the added object types and their criteria. The available **Action** options vary depending on which **Object type** you select for the rule. The example below shows the action options for Device objects.

<ThemedImage
alt="Auto Clean Rules Action options for Devices"
Expand All @@ -126,23 +123,23 @@ Select the actions to perform on CIs matching added object types and its criteri
}}
/>

- **Delete the data:** Delete the object.
- **Delete the data:** Delete the object.
- **Archive and delete the data:** Create an archive record for the object and delete the object. You can find archived records under **Analytics > Archived Objects**.
- **Clear all IPs:** Remove IPs from the Device.
- **Clear all IPs for this subnet:** Clear all device IPs from the entered or selected subnet.
- **Clear all Connectivity:** Clear all connectivity to the device.
- **Change to not in service:** Set the device status as not in service.
- **Clear all IPs:** Remove IPs from the device.
- **Clear all IPs for this subnet:** Clear all device IPs from the entered or selected subnet.
- **Clear all Connectivity:** Clear all connectivity to the device.
- **Change to not in service:** Set the device status to not in service.

<ThemedImage
alt="Auto Clean Rules Action options for Devices"
alt="Service level and email notification options"
sources={{
light: useBaseUrl('/assets/images/auto-clean-feature/service-level-emails-light.png'),
dark: useBaseUrl('/assets/images/auto-clean-feature/service-level-emails-dark.png'),
}}
/>

- **Change device service level to:** Choose a service level that the device will be set to when the rule is triggered.
- **Send email to:** Send notification when the rule is triggered.
- **Change device service level to:** Choose the service level to assign when the rule is triggered.
- **Send email to:** Send a notification when the rule is triggered.

<ThemedImage
alt="Webhook Auto Clean Endpoints box"
Expand All @@ -154,7 +151,6 @@ Select the actions to perform on CIs matching added object types and its criteri

- **Webhook AutoClean Endpoints:** Add or delete webhooks that will be sent when the rule is triggered.

:::info
The Auto Clean rules run once per day. If only an email or webhook is sent but no action is taken, the email or webhook will repeat each day until an action is taken that deletes or changes the object record.
:::info
Auto Clean rules run once per day. If only an email or webhook is sent but no action is taken, the email or webhook will repeat each day until an action is taken that deletes or changes the object record.
:::

Loading