Skip to content

Commit b8dfaef

Browse files
authored
Merge branch 'main' into 19.08.01
2 parents 9db4cb8 + b618578 commit b8dfaef

97 files changed

Lines changed: 2820 additions & 2856 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.

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@
1616
.env.production.local
1717
*.swp
1818
.vscode/
19-
CLAUDE.md
20-
/scripts
21-
.claude
19+
.claude/
2220

2321
npm-debug.log*
2422
yarn-debug.log*

docs/auto-discovery/active-directory-sync.mdx

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ sidebar_position: 2
66
import ThemedImage from '@theme/ThemedImage'
77
import useBaseUrl from '@docusaurus/useBaseUrl'
88

9+
This page is for Device42 administrators who need to synchronize Active Directory or LDAP users with Device42. Learn how to configure AD/LDAP settings and create discovery jobs to import and sync users as end users or administrators.
10+
911
The AD/LDAP auto-discovery tool performs one-way synchronization of your Active Directory (AD) and Lightweight Directory Access Protocol (LDAP) domain users to Device42.
1012

11-
You can add AD/LDAP users to Device42 as regular end users or administrators. To keep your Device42 users up to date with your directory, it's a good idea to schedule your AD/LDAP syncs using the Device42 scheduling option.
13+
Add AD/LDAP users as regular end users or administrators. Schedule regular syncs to keep users up to date with your directory.
1214

1315
:::note
14-
Changes to user accounts made in Device42 will not be sent to the AD/LDAP as the sync is one-way; from AD/LDAP to Device42 only.
16+
Changes to user accounts made in Device42 will not be sent to AD/LDAP. The sync is one-way from AD/LDAP to Device42.
1517
:::
1618

17-
## Prerequisites - The Settings Config
19+
## Configure Active Directory Settings
1820

1921
Before you create and run your AD/LDAP discovery jobs, configure the **Active Directory Settings** in Device42. These settings control authentication to AD, the servers to authenticate against, base DNs, and how to add discovered users to Device42.
2022

@@ -28,12 +30,14 @@ Before you create and run your AD/LDAP discovery jobs, configure the **Active Di
2830
}}
2931
/>
3032

31-
2. Click the **Create** button and enter values specific to your Active Directory (or LDAP) domain.
33+
2. Click the **Create** button and enter values specific to your Active Directory (or LDAP) domain.
34+
35+
### Configuration Options
3236

33-
**Explanation of the fields**
37+
Configure the following settings to connect Device42 to your AD or LDAP server.
3438

35-
- **LDAP Type**: Choose either **Active Directory** or **Open LDAP** for Lightweight directory access protocol for non-Microsoft directory servers.
36-
- **Server**: Enter the AD or LDAP server IP address. Only use FQDN if your DNS can resolve it. Rather enter an IP address if your Device42 server doesn't use AD-Aware DNS servers, as it may not be able to resolve your domain name if it hasn't been configured across all your DNS servers
39+
- **LDAP Type**: Choose either **Active Directory** or **OpenLDAP** for Lightweight directory access protocol for non-Microsoft directory servers.
40+
- **Server**: Enter the AD or LDAP server IP address. You can use the fully qualified domain name (FQDN) if your DNS can resolve it. Use an IP address if your Device42 server doesn't use AD-aware DNS servers, as the FQDN may not resolve correctly.
3741
- **Backup Server**: Add a secondary AD or LDAP server to use if the primary one isn't available.
3842

3943
<ThemedImage
@@ -44,7 +48,7 @@ Before you create and run your AD/LDAP discovery jobs, configure the **Active Di
4448
}}
4549
/>
4650

47-
- **Port**: Port for auth requests to your LDAP or Active Directory server. Note that **389** is the non-SSL default and **636** is the default SSL port. Ensure you change the port if you decide to enable SSL or run a non-standard port.
51+
- **Port**: Port for authentication requests to your LDAP or Active Directory server. Note that `389` is the non-SSL default and `636` is the default SSL port. Ensure you change the port if you decide to enable SSL or run a non-standard port.
4852
- **Base**: Enter the Base DN that points to your users.
4953

5054
<ThemedImage
@@ -55,15 +59,15 @@ Before you create and run your AD/LDAP discovery jobs, configure the **Active Di
5559
}}
5660
/>
5761

58-
- **SSL**: Check this box if you want to query AD or LDAP using SSL. Please change the port to **636** or your configured SSL port if you check this box.
59-
- **Username/Password**: This is the username a password that will be used for authentication against AD.
62+
- **SSL**: Check this box if you want to query AD or LDAP using SSL. Please change the port to `636` or your configured SSL port if you check this box.
63+
- **Username/Password**: The username and password for AD authentication.
6064
- **Username login style**: Choose how Device42 accounts created for AD users will be formatted both in Device42 and for login.
6165

6266
:::caution
63-
Changes to this setting only affects users imported after the change. To change the account and login format for all users, delete the existing Device42 accounts, change the login style setting, and then re-sync the accounts from AD.
67+
Changes to the **Username login style** setting only affect users imported after the change. To change the account and login format for all users, delete the existing Device42 accounts, change the login style setting, and then re-sync the accounts from AD.
6468
:::
6569

66-
- **Netbios name**: NetBIOS name is an up-to-15-character representation of your domain name, and may actually be entirely different from the domain name. Visit the [Microsoft Disjoint namespace scenarios](https://learn.microsoft.com/en-us/exchange/disjoint-namespace-scenarios-exchange-2013-help) article for help locating domain NetBIOS names.
70+
- **NetBIOS name**: NetBIOS name is an up-to-15-character representation of your domain name, and may be entirely different from the domain name. Visit the [Microsoft Disjoint namespace scenarios](https://learn.microsoft.com/en-us/exchange/disjoint-namespace-scenarios-exchange-2013-help) article for help locating domain NetBIOS names.
6771

6872
<ThemedImage
6973
alt="Active Directory Settings example values"
@@ -72,6 +76,7 @@ Before you create and run your AD/LDAP discovery jobs, configure the **Active Di
7276
dark: useBaseUrl('/assets/images/active-directory-sync/active-directory-username-dark.png'),
7377
}}
7478
/>
79+
7580
## Configure an AD/LDAP User Discovery Job
7681

7782
When you've configured the AD/LDAP settings, create an AD/LDAP sync job. From the main menu, go to **Discovery > AD/LDAP Users** and click **Create**.
@@ -88,7 +93,7 @@ Name the AD/LDAP sync job. Then choose the Device42 user **Type** to create from
8893
}}
8994
/>
9095

91-
- If you choose **End Users** as the user type, you may optionally choose AD/LDAP attributes to populate end user contact information, location, and notes. You'll also be able to choose and create **Departments**.
96+
- If you choose **End Users** as the user type, you can choose AD/LDAP attributes to populate end user contact information, location, and notes. You'll also be able to choose and create **Departments**.
9297

9398
<ThemedImage
9499
alt="User type attribute options"
@@ -100,7 +105,7 @@ Name the AD/LDAP sync job. Then choose the Device42 user **Type** to create from
100105

101106
- If you choose **Administrator** as the user type, you'll be able to choose and create **Permission Groups**, and the following options will become available:
102107
- **Add username in lowercase:** Convert all characters to lowercase when adding discovered users to Device42.
103-
- **Recursively search nested groups:** Select this option to add groups that are members of another group's users. By default, a group that already belongs to another group's users will not be added.
108+
- **Recursively search nested groups:** Select this option to add nested groups (groups that are members of other groups). By default, nested groups will not be added.
104109
- **Ignore existing Administrators:** Uncheck this option if you'd like administrators to continue to inherit permissions from multiple LDAP sync jobs.
105110
- **Clear any existing Administrator Permissions Groups:** Check to remove all group memberships from existing admins before adding newly discovered memberships.
106111

@@ -114,7 +119,7 @@ Name the AD/LDAP sync job. Then choose the Device42 user **Type** to create from
114119

115120
### Specify a Custom LDAP Filter
116121

117-
Specify a Custom LDAP Filter in the **Custom Filter** field to define which objects are synced.
122+
Use the **Custom Filter** field to define which objects are synced.
118123

119124
<ThemedImage
120125
alt="Custom Filter field"
@@ -127,24 +132,24 @@ Specify a Custom LDAP Filter in the **Custom Filter** field to define which obje
127132
By default, the LDAP filter is set to retrieve objects of type `group` or `user`, and is denoted by:
128133

129134
```
130-
(|(objectCategory=group)(|objectCategory=user))
135+
(|(objectCategory=group)(objectCategory=user))
131136
```
132137

133-
Similarly, the default LDAP filter for Open LDAP sync is `(objectClass=inetOrgperson)`, which gets the `inetOrgperson` object type.
138+
Similarly, the default LDAP filter for OpenLDAP sync is `(objectClass=inetOrgperson)`, which gets the `inetOrgperson` object type.
134139

135-
You can specify your own LDAP filter as follows to fetch all active users and groups as follows:
140+
You can specify your own LDAP filter to fetch all active users and groups:
136141

137142
```
138-
(&(|(objectCategory=group)(|objectCategory=user))(!(userAccountControl:1.2.840.113556.1.4.803:=2)))
143+
(&(|(objectCategory=group)(objectCategory=user))(!(userAccountControl:1.2.840.113556.1.4.803:=2)))
139144
```
140145

141-
The `userAccountControl` attribute uses a bitwise filter to look for specific flags and is set to `2` for disabled accounts. The preceding exclamation point `!` in the command excludes such accounts.
146+
The `userAccountControl` attribute uses a bitwise filter to look for specific flags and is set to `2` for disabled accounts. The preceding exclamation point (`!`) in the command excludes such accounts.
142147

143-
Now, disabled accounts will be ignored when Active Directory accounts are synced. You can use similar commands of LDAP attributes to filter which objects get synced.
148+
Now, disabled accounts will be ignored when Active Directory accounts are synced. You can use similar LDAP attribute filters to control which objects get synced.
144149

145150
### Select Config Settings and Add Credentials
146151

147-
Next, choose the settings configuration you created in the [Prerequisites section](#prerequisites---the-settings-config) and provide the AD/LDAP **Username** and **Password** to use for authentication.
152+
Next, choose the settings configuration you created in the [Prerequisites section](#configure-active-directory-settings) and provide the AD/LDAP **Username** and **Password** to use for authentication.
148153

149154
<ThemedImage
150155
alt="Settings and credential fields"
@@ -156,7 +161,7 @@ Next, choose the settings configuration you created in the [Prerequisites sectio
156161

157162
### Select Permission Groups for Administrators
158163

159-
If you chose **Administrators** as the **Type**, you'll have the option to grant Device42 permissions to selected admin groups. Note that the groups are not Active Directory groups, but Device42 admin groups.
164+
If you chose **Administrators** as the **Type**, you'll have the option to grant Device42 permissions to selected admin groups. Note that these permission groups are Device42 admin groups, not Active Directory groups.
160165

161166
Select from the available **Permission Groups** on the left and use the arrow button to move them to the **Chosen Permission Groups** side.
162167

@@ -168,7 +173,7 @@ Select from the available **Permission Groups** on the left and use the arrow bu
168173
}}
169174
/>
170175

171-
To create a new Admin group, click the **plus icon**, and in the popup that opens, name the new group, select the permissions, and click **Save**.
176+
To create a new Admin group, click the **plus icon**. In the dialog box, name the new group, select the permissions, and click **Save**.
172177

173178
<ThemedImage
174179
alt="Create new Admin Groups"
@@ -202,6 +207,8 @@ Click the **plus icon** to add a new customer, department, or end user that's no
202207

203208
## Example: Find a Group DN in Active Directory
204209

210+
To find the Distinguished Name (DN) of a group in Active Directory, use the attribute editor in Active Directory Users and Computers.
211+
205212
![](/assets/images/wpid5372-AD-group-DN.png)
206213

207-
Under the group properties with "Advanced features" enabled in Active Directory Users and Computers, go to the attribute editor and copy the "distinguishedName" as shown in the image above.
214+
Under the group properties with "Advanced features" enabled in Active Directory Users and Computers, go to the attribute editor and copy the `distinguishedName` as shown in the image above.

docs/auto-discovery/agent-based-discovery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ The agent can be run from the command line or can be scheduled using the relevan
180180

181181
## Schedule the Agent With Crontab on Linux
182182

183-
For best results, run the command with `sudo`. Make sure that `/home/system_dev42/bin/d42agent` is owned by `root` with `-rwx—— (0700)` permissions. This prevents the non-root user `system_dev42` from overwriting the agent or adding it to `root`’s crontab (or `cron.daily/hourly`) while allowing root to execute it.
183+
For best results, run the command with `sudo`. Make sure that `/home/system_dev42/bin/d42agent` is owned by `root` with `-rwx--- (0700)` permissions. This prevents the non-root user `system_dev42` from overwriting the agent or adding it to `root`’s crontab (or `cron.daily/hourly`) while allowing root to execute it.
184184

185185
### Use a Limited Account
186186

0 commit comments

Comments
 (0)