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/agent-based-discovery.mdx
+30-24Lines changed: 30 additions & 24 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: 3
6
6
importThemedImagefrom'@theme/ThemedImage'
7
7
importuseBaseUrlfrom'@docusaurus/useBaseUrl'
8
8
9
-
There are special situations where using an agent for discovery makes more sense. The IT environment may be unreachable from the network or security-hardened rules may be in place that limit traffic flow. Device42 offers many optional auto-discovery agents across several [supported platforms](#supported-platforms).
9
+
This page is for Device42 administrators who need to use agent-based discovery when their IT environment is unreachable from the network or security-hardened rules limit traffic flow.
10
10
11
-
As a best practice, we recommend using agentless discovery over agent-based discovery when possible. The information gathered is the same, but the agent does not support Resource Utilization (RU).
11
+
Device42 offers optional auto-discovery agents across several [supported platforms](#supported-platforms).
12
+
13
+
Use agentless discovery over agent-based discovery when possible. Both methods gather the same information, but the agent does not support Resource Utilization (RU) or database discovery.
12
14
13
15
To learn about using the agent for **offline** discovery, see [Agent-Based Offline Discovery](agent-based-offline-discovery.mdx).
14
16
15
17
## Supported Platforms
16
18
17
-
Device42 autodiscovery agents are available for deployment on the following platforms:
19
+
Device42 offers autodiscovery agents for the following platforms:
18
20
19
21
- Windows 64-bit (Recommended)
20
22
- Windows 32-bit
@@ -32,22 +34,22 @@ Device42 autodiscovery agents are available for deployment on the following plat
32
34
See **[Windows Discovery Agent Service Wrapper](/getstarted/deploy-device42/windows-service-installation.mdx)** and **[Mac Agent Service Launcher](/auto-discovery/mac-agent-service-launcher.mdx)** for information on installing versions of the Windows and Mac discovery agent as a service.
33
35
34
36
:::warning
35
-
Do not set up an autodiscovery scan using critical or production account credentials. Please create a separate, dedicated account to use only for discovery.
37
+
Do not set up an autodiscovery scan using critical or production account credentials. Create a separate, dedicated account to use only for discovery.
36
38
37
-
Doing so, depending on permissions granted and configured password policies could result in account lock-out, therefore causing an otherwise completely avoidable outage.
39
+
Account lockout could occur depending on permissions and password policies, causing an otherwise avoidable outage.
38
40
:::
39
41
40
-
## Proxy Environment Variables
42
+
## Configure Proxy Environment Variables
41
43
42
-
Proxy settings are not required, but if you need the agents to access your network via a proxy, you can set the following environment variables, which the agents will respect:
44
+
Proxy settings are not required, but if you need the agents to access your network via a proxy, set the following environment variables:
43
45
44
46
-**HTTP_PROXY:** Define the HTTP proxy server.
45
47
-**HTTPS_PROXY:** Define the HTTPS proxy server.
46
48
-**NO_PROXY:** A comma-separated list of IP addresses that should not go through the proxy.
47
49
48
50
On Windows, click the **Environmental Variables** button in the System Properties window to set environment variables.
49
51
50
-
## Installation
52
+
## Install the Agent
51
53
52
54
Download the client from **Discovery > Agent Based Scans**. Enter the URL as it will be accessed by the agent from the remote machine, and choose your **Platform** from the dropdown: Windows, Mac, Linux, FreeBSD, and so on.
53
55
@@ -68,7 +70,7 @@ The agent can be run from the command line or can be scheduled using the relevan
68
70
-capture-host-files
69
71
capture hosts files
70
72
-config-file string
71
-
reads the config from an encrypted file (Only works for signed binaries. Ignored Otherwise)
73
+
reads the config from an encrypted file (Only works for signed binaries. Ignored otherwise)
72
74
-debug
73
75
prints the data being sent and result of post operation
74
76
-device-customer string
@@ -176,13 +178,13 @@ The agent can be run from the command line or can be scheduled using the relevan
176
178
```
177
179
</details>
178
180
179
-
## Scheduling With Crontab in Linux
181
+
## Schedule the Agent With Crontab on Linux
180
182
181
-
For best results, we recommend running 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.
182
184
183
-
### Using a Limited Account
185
+
### Use a Limited Account
184
186
185
-
The Linux agent runs as `root` by default. However, it is possible to configure the agent to run with a limited, non-root account. Here's how you can create one:
187
+
The Linux agent runs as `root` by default. However, you can configure the agent to run with a limited, non-root account.
186
188
187
189
1.**Create a limited account**:
188
190
- Create a new Linux account (for example, `d42_limited`) without root access.
@@ -205,7 +207,7 @@ The Linux agent runs as `root` by default. However, it is possible to configure
Read the [Commands Required by the Discovery Agent](#commands-required-by-the-discovery-agent) section to see the full list of commands required by the agent.
210
+
Read the [Commands Required by the Discovery Agent](#required-agent-commands) section to see the full list of commands required by the agent.
209
211
210
212
3.**Configure the file ownership and permissions**:
211
213
- Make sure that the `d42agent` binary is still owned by `root` and has restricted permissions:
@@ -222,7 +224,7 @@ The Linux agent runs as `root` by default. However, it is possible to configure
@@ -263,14 +265,14 @@ The Linux agent runs as `root` by default. However, it is possible to configure
263
265
```
264
266
</details>
265
267
266
-
We need to ensure the limited account can execute all these commands through `sudo` without requiring a password.
268
+
Ensure the limited account can execute all these commands through `sudo` without requiring a password.
267
269
268
270
Here's a shell script that can be used to check whether the limited account has access to the commands:
269
271
270
272
<details>
271
273
<summary>Click to expand the code block</summary>
272
274
273
-
```py
275
+
```bash
274
276
#!/bin/bash
275
277
276
278
# List of commands required by the discovery agent
@@ -294,21 +296,21 @@ Here's a shell script that can be used to check whether the limited account has
294
296
295
297
You can run this script to verify that the limited account has access to all the required commands.
296
298
297
-
## Linux and Mac Note
299
+
## Run the Agent on Linux and Mac
298
300
299
301
After downloading the agent, make it executable by running the command `chmod +x <agentname>` and use `sudo` for best results. Use the command `--sudo-password="password"` to pass in the password.
300
302
301
303
You may experience an issue with opening the application on your Mac. If so, please use the following Apple support link to [open a Mac app from an unidentified developer](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac).
302
304
303
-
## Windows Note
305
+
## Schedule the Agent on Windows
304
306
305
-
After downloading the agent, use the Windows Task Scheduler to schedule the executable file (\*.exe) to run at the intervals you define.
307
+
After downloading the agent, use the Windows Task Scheduler to schedule the executable file (`*.exe`) to run at the intervals you define.
306
308
307
309
## View Agent Version and Agent Last Check-in Date
308
310
309
311
The Devices list page now includes two columns that display the **Agent Version** and the **Agent Last Check-in Date** for devices discovered by the agent.
310
312
311
-
- On the Devices list page under **Resources > Compute > All Devices**, click the **gear icon** below the Advanced button to display the column list.
313
+
- On the Devices list page under **Resources > Compute > All Devices**, click the **gear icon** below the **Advanced** button to display the column list.
312
314
313
315
<ThemedImage
314
316
alt="Gear icon on Devices list page"
@@ -329,9 +331,9 @@ The Devices list page now includes two columns that display the **Agent Version*
329
331
}}
330
332
/>
331
333
332
-
- If you want to define a new column view, type a name for the view in the field to the right of the **Table Columns** dropdown and **Save** the view. Device42 displays the agent information for devices discovered by the agent.
334
+
- If you want to define a new column view, type a name for the view in the field to the right of the **Table Columns** dropdown and **Save** the view. Device42 displays information for devices discovered by the agent.
333
335
334
-
### Filtering with Agent Columns
336
+
### Filter Devices Using Agent Columns
335
337
336
338
You can use Agent Version and Agent Last Check-in Date to filter the devices list to look for devices found by specific agents or during certain periods.
337
339
@@ -355,7 +357,7 @@ You can use Agent Version and Agent Last Check-in Date to filter the devices lis
355
357
}}
356
358
/>
357
359
358
-
- You can also use the agent columns in **Advanced search**. For example, the query below searches for devices discovered with a**Agent Last Check-in Date** less than 365 days ago.
360
+
- You can also use the agent columns in **Advanced search**. For example, the query below searches for devices discovered with an**Agent Last Check-in Date** less than 365 days ago.
359
361
360
362
<ThemedImage
361
363
alt="Advanced search"
@@ -364,3 +366,7 @@ You can use Agent Version and Agent Last Check-in Date to filter the devices lis
Copy file name to clipboardExpand all lines: docs/integration/external-integrations/cyberark-integration.mdx
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,3 +87,9 @@ The following note in the UI describes how passwords are retrieved and matched b
87
87
88
88
> By default, passwords are looked up by name in CyberArk by matching the Password label in Device42. If no label is provided then the username will be matched directly.
89
89
You may also customize the Folder or Safe from which the password is retrieved by utilizing the Password Custom fields named Folder and Safe.
90
+
91
+
### Long and Short Account Names
92
+
93
+
If your CyberArk account uses a long account name, enter it in the Secret label field for matching purposes.
94
+
95
+
If your CyberArk account uses a short username, enter it in the Secret username field for the discovery job.
Copy file name to clipboardExpand all lines: docs/integration/external-integrations/freshservice-integration/customize-freshservice.mdx
+17-22Lines changed: 17 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,33 +42,30 @@ To get started, download the default mapping XML file and view the current mappi
42
42
43
43
## The `mapping.xml` File Structure
44
44
45
-
Open the `mapping.xml` file in a text or code editor to view and edit the data mapping. Version 1.0 of the file has around 6010 lines. There are tasks for syncing data, tasks for syncing the relationships between Device42 CI types (by recreating them between the corresponding Freshservice types), and two cleanup tasks for deleting any assets or asset relationships from Freshservice that do not exist in Device42.
45
+
Open the `mapping.xml` file in a text or code editor to view and edit the data mapping; there are tasks for syncing data, tasks for syncing the relationships between Device42 CI types (by recreating them between the corresponding Freshservice types), and cleanup tasks for deleting any assets or asset relationships from Freshservice that do not exist in Device42.
46
46
47
-

47
+

48
48
49
49
You can customize the data mapping between Device42 and Freshservice by modifying and adding to these tasks. Refer to [The `mapping.xml` File Tasks](#the-mappingxml-file-tasks) table below for descriptions of the default mapping tasks, types, and their version requirements.
50
50
51
-
For example, the following `<task>` element copies product information from Device42 to Freshservice:
51
+
For example, the following `<task>` element copies software information from Device42 to Freshservice:
52
52
53
53
<details>
54
54
<summary>Click to expand the code block</summary>
55
55
```xml
56
56
<tasks>
57
-
<taskenable="true"name="Products"type="product"description="Copy Product info from Device42 to Freshservice"d42_min_version="16.19.00">
57
+
<taskenable="true"name="Software"type="software"description="Copy Softwares from Device42 to Freshservice using DOQL">
58
58
<api>
59
-
<targetasset-type="Hardware"/>
59
+
<target/>
60
60
<resource
61
-
doql="
62
-
select distinct
63
-
view_vendor_v1.name as manufacturer,
64
-
<!-- ... -->
65
-
"
61
+
doql="select * from (select trim(name) as name, 'discovered' as software_type, min(view_software_v1.notes) as notes, 'desktop' as application_type, min(last_changed) as last_changed from view_software_v1 group by trim(name)) a"
66
62
/>
67
63
</api>
68
-
<mappingkey="name"doql-suffix=" where GREATEST(view_hardware_v2.last_changed, view_vendor_v1.last_changed, view_device_v2.last_changed) >'%s'">
@@ -86,7 +83,7 @@ Let's take a closer look at the attributes and elements of the `<task>` elements
86
83
87
84
Note that if you turn off a task that has `asset` or `asset_relationship` as its corresponding Freshservice type (for example, devices, business services, and resources in Device42), you'll need to find and remove its corresponding query snippet in the `Delete` cleanup tasks. For an example, see [this answer in the FAQ section](#how-do-i-prevent-a-relationship-between-two-device42-asset-types-from-syncing-to-freshservice).
88
85
89
-
-`name`: You can edit the task name. Task names appear in the [integration app's **Data Mapping Chart**](#data-mapping-between-device42-and-freshservice).
86
+
-`name`: You can edit the task name. Task names appear in the integration app's **Data Mapping Chart**.
90
87
-`type`: Holds the [Freshservice classification](https://api.freshservice.com/) of the data. The valid types are:
91
88
92
89
-`product`
@@ -122,7 +119,7 @@ The `<mapping>` element contains:
122
119
Typically, the first `<field>` represents the Device42 data returned from the query put in a field. The second `<field>` element describes the equivalent field in Freshservice.
123
120
124
121
-`resource`: The same as the `target` value.
125
-
-`source-type`: Not functionally critical; this provides the data type displayed on the [integration app's **Data Mapping Chart**](#data-mapping-between-device42-and-freshservice).
122
+
-`source-type`: Not functionally critical; this provides the data type displayed on the integration app's **Data Mapping Chart**.
126
123
-`target`: The Device42 field to be mapped to Freshservice. The Freshservice convention is to use the display name in snake case, occasionally with the ID of the asset type as a suffix. For example, `memory_max_usage` and `memory_reservation_used`. The sync process determines the ID. Please look up which target field names to use in the [Freshservice API documentation](https://api.freshservice.com/).
127
124
-`escape`: This is used on field elements where `target="name"`. Some characters used in Device42 names aren't supported in Freshservice and need to be substituted. When creating a new task, you can set this to `true`, but disable it if mismatching issues occur.
128
125
@@ -433,12 +430,10 @@ If you can't find a task related to your custom field, you can create a new `<ta
433
430
434
431
4. Now it's time to map the custom field to Freshservice. Add a new `<field>` element in the `<mapping>` tag section of the XML file. You'll need to keep Freshservice open and follow the next step to get the exact Freshservice values to use in the new `<field>` element below.
435
432
436
-

@@ -615,7 +610,7 @@ To download the full logs, scroll down and click the **Download Full Log** butto
615
610
616
611
This section provides specific examples of how to edit the `mapping.xml` file to change the data synced from Device42 to Freshservice.
617
612
618
-
The line estimates in the examples are based on the default version 1.0 of the `mapping.xml` file and won't match your file exactly if you've customized the sync or used an updated version.
613
+
The line estimates in the examples are approximate and may vary based on your mapping file version.
619
614
620
615
### Example 1: How Can I Stop the Sync From Importing Contracts From Device42 to Freshservice?
621
616
@@ -624,7 +619,7 @@ The line estimates in the examples are based on the default version 1.0 of the `
624
619
Set the `enable` attribute to `false` on those `<task>` elements:
625
620
626
621
1. Find the task with the description `Copy contract info from Device42 to Freshservice` (around line `2372`):
@@ -724,7 +719,7 @@ By default, Device42 does not update `asset_state` values in Freshservice (in De
724
719
725
720
The mapping file includes `<field>` elements with `asset_state` as the target. The `skip-update` attribute is set to `"true"` to prevent the overwriting of values that may trigger Freshservice workflow automations.
726
721
727
-
If you want Device42 to update `asset_state` values, set `skip-update` to `"false"`. There are three `<field>` elements to update in version 2.0 of the default `mapping.xml` file:
722
+
If you want Device42 to update `asset_state` values, set `skip-update` to `"false"`. There are three `<field>` elements to update in the default `mapping.xml` file:
0 commit comments