You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/auto-discovery/active-directory-sync.mdx
+32-25Lines changed: 32 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,17 @@ sidebar_position: 2
6
6
importThemedImagefrom'@theme/ThemedImage'
7
7
importuseBaseUrlfrom'@docusaurus/useBaseUrl'
8
8
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
+
9
11
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.
10
12
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.
12
14
13
15
:::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.
15
17
:::
16
18
17
-
## Prerequisites - The Settings Config
19
+
## Configure Active Directory Settings
18
20
19
21
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.
20
22
@@ -28,12 +30,14 @@ Before you create and run your AD/LDAP discovery jobs, configure the **Active Di
28
30
}}
29
31
/>
30
32
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
32
36
33
-
**Explanation of the fields**
37
+
Configure the following settings to connect Device42 to your AD or LDAP server.
34
38
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.
37
41
-**Backup Server**: Add a secondary AD or LDAP server to use if the primary one isn't available.
38
42
39
43
<ThemedImage
@@ -44,7 +48,7 @@ Before you create and run your AD/LDAP discovery jobs, configure the **Active Di
44
48
}}
45
49
/>
46
50
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.
48
52
-**Base**: Enter the Base DN that points to your users.
49
53
50
54
<ThemedImage
@@ -55,15 +59,15 @@ Before you create and run your AD/LDAP discovery jobs, configure the **Active Di
55
59
}}
56
60
/>
57
61
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.
60
64
-**Username login style**: Choose how Device42 accounts created for AD users will be formatted both in Device42 and for login.
61
65
62
66
:::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.
64
68
:::
65
69
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.
67
71
68
72
<ThemedImage
69
73
alt="Active Directory Settings example values"
@@ -72,6 +76,7 @@ Before you create and run your AD/LDAP discovery jobs, configure the **Active Di
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
88
93
}}
89
94
/>
90
95
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**.
92
97
93
98
<ThemedImage
94
99
alt="User type attribute options"
@@ -100,7 +105,7 @@ Name the AD/LDAP sync job. Then choose the Device42 user **Type** to create from
100
105
101
106
- 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:
102
107
-**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.
104
109
-**Ignore existing Administrators:** Uncheck this option if you'd like administrators to continue to inherit permissions from multiple LDAP sync jobs.
105
110
-**Clear any existing Administrator Permissions Groups:** Check to remove all group memberships from existing admins before adding newly discovered memberships.
106
111
@@ -114,7 +119,7 @@ Name the AD/LDAP sync job. Then choose the Device42 user **Type** to create from
114
119
115
120
### Specify a Custom LDAP Filter
116
121
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.
118
123
119
124
<ThemedImage
120
125
alt="Custom Filter field"
@@ -127,24 +132,24 @@ Specify a Custom LDAP Filter in the **Custom Filter** field to define which obje
127
132
By default, the LDAP filter is set to retrieve objects of type `group` or `user`, and is denoted by:
128
133
129
134
```
130
-
(|(objectCategory=group)(|objectCategory=user))
135
+
(|(objectCategory=group)(objectCategory=user))
131
136
```
132
137
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.
134
139
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:
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.
142
147
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.
144
149
145
150
### Select Config Settings and Add Credentials
146
151
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.
148
153
149
154
<ThemedImage
150
155
alt="Settings and credential fields"
@@ -156,7 +161,7 @@ Next, choose the settings configuration you created in the [Prerequisites sectio
156
161
157
162
### Select Permission Groups for Administrators
158
163
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.
160
165
161
166
Select from the available **Permission Groups** on the left and use the arrow button to move them to the **Chosen Permission Groups** side.
162
167
@@ -168,7 +173,7 @@ Select from the available **Permission Groups** on the left and use the arrow bu
168
173
}}
169
174
/>
170
175
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**.
172
177
173
178
<ThemedImage
174
179
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
202
207
203
208
## Example: Find a Group DN in Active Directory
204
209
210
+
To find the Distinguished Name (DN) of a group in Active Directory, use the attribute editor in Active Directory Users and Computers.
211
+
205
212

206
213
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.
Copy file name to clipboardExpand all lines: docs/auto-discovery/agent-based-discovery.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -180,7 +180,7 @@ The agent can be run from the command line or can be scheduled using the relevan
180
180
181
181
## Schedule the Agent With Crontab on Linux
182
182
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.
0 commit comments