Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ From Device42, click **Create** on the Cloud Autodiscovery list page and then se

Optionally, you can:

- Add a **Vendor**. Vendors can be user-defined or populated by the EnrichAI feature as part of discovery.
- Add a **Vendor**. Vendors can be user-defined or populated by the data Normalization and Enrichment Service as part of discovery.
- Choose a **VRF Group**. All IPs found will be placed in subnets in the chosen VRF group. This is useful if you have duplicate IPs in your internal network.
- Select which **Action for Instance not found** you'd like Device42 to take. If you select **Delete Instance**, then each time this autodiscovery job is run, any devices previously created for this account that aren't found by the latest autodiscovery job will be deleted. This ensures that Device42 remains in sync with Linode. Otherwise, you could have Device42 Cloud Instances (cloud devices) that no longer exist in Linode.
- Set the **Service Level** of the job to be applied to the discovered items. For example, **Development**, **Deployment**, or **Production**.
Expand Down Expand Up @@ -225,7 +225,7 @@ If you disable **Discover all projects/tenants**, then the **Project Name** is r

Optionally, you can:

- Add a **Vendor**. Vendors can be user-defined or populated by the EnrichAI feature as part of discovery.
- Add a **Vendor**. Vendors can be user-defined or populated by the data Normalization and Enrichment Service as part of discovery.
- Choose a **VRF Group**. All IPs found will be placed in subnets in the chosen VRF group. This is useful if you have duplicate IPs in your internal network.
- Select which **Action for Instance not found** you'd like Device42 to take. If you select **Delete Instance**, then each time this discovery job is run, any devices previously created for this account that aren't found by the latest discovery job will be deleted. This ensures that Device42 remains in sync with Linode. Otherwise, you could have Device42 Cloud Instances (cloud devices) that no longer exist in Linode.
- Set the **Service Level** of the job to be applied to the discovered items. For example, **Development**, **Deployment**, or **Production**.
Expand Down Expand Up @@ -263,7 +263,7 @@ Name the discovery job and select **Oracle Cloud** from the **Type** dropdown me

Optionally, you can:

- Add a **Vendor**. Vendors can be user-defined or populated by the EnrichAI feature as part of discovery.
- Add a **Vendor**. Vendors can be user-defined or populated by the data Normalization and Enrichment Service as part of discovery.
- Choose a **VRF Group**. All IPs found will be placed in subnets in the chosen VRF group. This is useful if you have duplicate IPs in your internal network.
- Select a **Remote Collector**.
- Set the **Service Level** of the job to be applied to the discovered items. For example, **Development**, **Deployment**, or **Production**.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
position: 100
label: 'Enrich AI Data'
label: 'Enriched Data'
collapsible: true
collapsed: true
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: "EnrichAI Opt Out"
title: "Enriched Data Opt Out"
sidebar_position: 100
---

import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

This section demonstrates how to disable EnrichAI Data, the Device42 service that enhances data from device discoveries.
This section demonstrates how to disable the data Normalization and Enrichment Service, the Device42 service that enhances data from device discoveries.

:::note
Please note that if you rediscover previously enriched data, you will lose that data until you opt back in to the EnrichAI Data cloud service.
Please note that if you rediscover previously enriched data, you will lose that data until you opt back in to the Enriched Data cloud service.
:::

Take the following steps to opt out of the EnrichAI Data service:
Take the following steps to opt out of the Enriched Data service:

Select **Tools > Cloud Services** to display the Cloud Services page.

Expand All @@ -37,7 +37,7 @@ This page shows the status of your cloud services.
}}
/>

- In the Edit view, you are presented with the option to opt out of the EnrichAI Data service, as highlighted below. Click **disable** to do so.
- In the Edit view, you are presented with the option to opt out of the Enriched Data service, as highlighted below. Click **disable** to do so.

<ThemedImage
alt="Disable Button"
Expand All @@ -47,7 +47,7 @@ This page shows the status of your cloud services.
}}
/>

- The **Disable EnrichAI** dialog gives you the option to **Disable** or **Cancel**. Select **Disable** to opt out of the EnrichAI Data service and return to the Edit view.
- The **Disable EnrichAI** dialog gives you the option to **Disable** or **Cancel**. Select **Disable** to opt out of the Enriched Data service and return to the Edit view.

<ThemedImage
alt="Disable prompt"
Expand All @@ -68,4 +68,4 @@ This page shows the status of your cloud services.
}}
/>

You can follow the same steps to opt back in to the EnrichAI Data service. After re-enabling, we recommend rerunning your discovery jobs to ensure your data is enriched.
You can follow the same steps to opt back in to the Enriched Data service. After re-enabling, we recommend rerunning your discovery jobs to ensure your data is enriched.
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: "EnrichAI Data"
title: "Enriched Data"
sidebar_position: 99
---

import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

EnrichAI is a Device42 cloud-based service for enhancing discovered data. Device42 supports the enrichment of software applications, operating systems (OS), and vendor that are discovered by Device42 Autodiscovery.
The data Normalization and Enrichment Service is a Device42 cloud-based service for enhancing discovered data. Device42 supports the enrichment of software applications, operating systems (OS), and vendor that are discovered by Device42 Autodiscovery.

## Data Fields

The EnrichAI data service take the vendor name, product name, and version number fields as populated by the product vendor and uses it to replace those values with cleansed and normalized values. In addition, it adds values for an extended set of fields, like categories and support lifecycle dates. The enriched data is mined from validated, authoritative, public sources to ensure accuracy.
The Enriched Data service takes the vendor name, product name, and version number fields as populated by the product vendor and uses it to replace those values with cleansed and normalized values. In addition, it adds values for an extended set of fields, like categories and support lifecycle dates. The enriched data is mined from validated, authoritative, public sources to ensure accuracy.

The following is a partial list of enriched fields:

Expand All @@ -37,7 +37,7 @@ The following is a partial list of enriched fields:
| Service Pack | The service pack level of the OS release |
| Key Support Dates | See the details for the available date fields in the table below |

The **OS Architecture: 32 vs 64 bit** field is no longer part of EnrichAI Data. The 32- and 64-bit architectures have been coalesced into a single entry, since the architecture does not affect OS dates, licensing, patches, or risk profiles.
The **OS Architecture: 32 vs 64 bit** field is no longer part of Enriched Data. The 32- and 64-bit architectures have been coalesced into a single entry, since the architecture does not affect OS dates, licensing, patches, or risk profiles.

### Software Attributes

Expand Down Expand Up @@ -67,14 +67,14 @@ The **OS Architecture: 32 vs 64 bit** field is no longer part of EnrichAI Data.
| Extended End Of Maintenance Date | When non-security patches will no longer be released under extended maintenance agreement |

:::note
Depending on the vendor's published information, EnrichAI Data may not populate all or any of the date fields.
Depending on the vendor's published information, Enriched Data may not populate all or any of the date fields.
:::

## EnrichAI Data Collection
## Enriched Data Collection

When EnrichAI Data is enabled, the device data collected during discovery jobs is queued, batched, and sent via HTTPS to the EnrichAI Data service, where it is processed in background tasks to prevent negative system impact. When EnrichAI finds a match, it responds with enriched data. All enriched data is displayed on the Analytics > EnrichAI Data page; depending on the number of requests in the queue and system load, this data may not be immediately visible.
When the data Normalization and Enrichment Service is enabled, the device data collected during discovery jobs is queued, batched, and sent via HTTPS to the Enriched Data service, where it is processed in background tasks to prevent negative system impact. When the service finds a match, it responds with enriched data. All enriched data is displayed on the **Analytics > EnrichAI Data** page; depending on the number of requests in the queue and system load, this data may not be immediately visible.

When presented with a new or unique data entry, the EnrichAI service may need to perform a background check with authoritative sources to identify any new or changed data that can be displayed on the next discovery for that device. As such, each discovery is validated by the EnrichAI Data service to ensure the discovered values are correct and up to date. No data sent to EnrichAI contains identifiable information, such as hostnames, IP addresses, or MAC addresses. Below is a sample of the payload:
When presented with a new or unique data entry, the Enriched Data service may need to perform a background check with authoritative sources to identify any new or changed data that can be displayed on the next discovery for that device. As such, each discovery is validated by the Enriched Data service to ensure the discovered values are correct and up to date. No data sent to the service contains identifiable information, such as hostnames, IP addresses, or MAC addresses. Below is a sample of the payload:

<details>
<summary>Click to expand the code block</summary>
Expand Down Expand Up @@ -140,12 +140,12 @@ When presented with a new or unique data entry, the EnrichAI service may need to

</details>

## EnrichAI Data Connectivity
## Enriched Data Connectivity

Please do the following to ensure connectivity with EnrichAI Data:
Please do the following to ensure connectivity with the Enriched Data service:

1. Configure the Cloud Connector and check that it is reachable.
2. Make sure the EnrichAI Data endpoints are reachable, including the registration endpoint:
2. Make sure the Enriched Data endpoints are reachable, including the registration endpoint:

- `https://registration.device42.com`
- `https://crs.device42.io/`
Expand All @@ -156,20 +156,20 @@ Please do the following to ensure connectivity with EnrichAI Data:

Device42 [InsightsAI](/reports/device42-doql/insightsai.mdx) generates queries based on natural language prompts. The prompts you enter are sent to the `ai42.device42.io` endpoint.

## Using the EnrichAI Data Interface
## Using the Enriched Data Interface

Select **Analytics > EnrichAI Data** to display the EnrichAI Data list page.
Select **Analytics > EnrichAI Data** to display the Enriched Data list page.

<ThemedImage
alt="Enrich AI Menu"
alt="Enriched Data menu"
sources={{
light: useBaseUrl('/assets/images/enrichai-data/enrichai-data-menu-light.png'),
dark: useBaseUrl('/assets/images/enrichai-data/enrichai-data-menu-dark.png'),
}}
style={{ width: '90%' }}
/>

Click the **Enriched Value** link to view the data record. If desired, you can click the **Lock** button on an EnrichAI data record to prevent Device42 from updating it in the future.
Click the **Enriched Value** link to view the data record. If desired, you can click the **Lock** button on an Enriched Data record to prevent Device42 from updating it in the future.

<ThemedImage
alt="Data lock button"
Expand All @@ -179,10 +179,10 @@ Click the **Enriched Value** link to view the data record. If desired, you can
}}
/>

Device42 currently displays additional information generated by EnrichAI Data on enriched vendor and OS view pages. You can identify enriched vendors by the **AI icon** included next to their names on the vendor list page (under **Infrastructure > Vendors**).
Device42 currently displays additional information generated by the Enriched Data service on enriched vendor and OS view pages. You can identify enriched vendors by the **AI icon** included next to their names on the vendor list page (under **Infrastructure > Vendors**).

<ThemedImage
alt="EnrichAI symbol on Vendor list page"
alt="Enriched Data symbol on Vendor list page"
sources={{
light: useBaseUrl('/assets/images/enrichai-data/vendor-list-ai-icon-light.png'),
dark: useBaseUrl('/assets/images/enrichai-data/vendor-list-ai-icon-dark.png'),
Expand All @@ -201,8 +201,8 @@ The image below shows a vendor view page with enriched data. Enriched data is al

## Data Handling and Security Practices

1. No personal or personally identifiable data is maintained by the EnrichAI service.
2. Unmatched values (those without a corresponding match in EnrichAI Data) are stored for future mining and resolution.
1. No personal or personally identifiable data is maintained by the data Normalization and Enrichment Service.
2. Unmatched values (those without a corresponding match in Enriched Data) are stored for future mining and resolution.
3. Only Device42 personnel work with these non-identifiable data elements.
4. Data collected for future enrichment mining is stored in the United States.

Expand Down
2 changes: 1 addition & 1 deletion docs/auto-discovery/warranty-autodiscovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ To merge multiple vendor names into a single vendor name, perform the following

### Set the Model Field

The EnrichAI module has largely automated this requirement: Set the **Model** field to **Dell**, **IBM**, **Lenovo**, or **Meraki**. Hardware with different vendor name variations will not return a warranty.
The data Normalization and Enrichment Service has largely automated this requirement: Set the **Model** field to **Dell**, **IBM**, **Lenovo**, or **Meraki**. Hardware with different vendor name variations will not return a warranty.

You can easily add the proper **Vendor Aliases** to the vendors if your vendors are named differently. On the vendor edit screen, update the vendor entries. Enter `dell` for Dell, `ibm` for IBM, `meraki` for Meraki, and `lenovo` for Lenovo:

Expand Down
2 changes: 1 addition & 1 deletion docs/infrastructure-management/devices/device-add-edit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Consider the following example of a network switch:

### Non-Editable Fields

Fields populated through EnrichAI Data, like **End of Life** and **End of Support**, are not editable. To set these fields, you need to [disable EnrichAI Data](auto-discovery/enrichai-data/enrichai-opt-out.mdx) and disconnect the record from the EnrichAI Data record.
Fields populated through Enriched Data, like **End of Life** and **End of Support**, are not editable. To set these fields, you need to [disable the Enriched Data service](auto-discovery/enriched-data/enriched-data-opt-out.mdx) and disconnect the record from the Enriched Data record.

<ThemedImage
alt="Non-editable fields"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This section holds values for **Total CPUs**, **Cores/CPU**, **CPU Speed**, tota
/>
<br/><br/>

The **OS** name, **OS Version**, and **OS Version #** fields are the basic operating system (OS) details for each device. If EnrichAI is active and the data is available, these fields may be automatically populated by the autodiscovery client. The vendor support details, like the **End of Life** and **End of Support** fields, may also be autopopulated. If EnrichAI is disabled, you can manually enter the relevant data or execute scripts to populate the fields. Note that the **OS License Key** field can also be entered manually.
The **OS** name, **OS Version**, and **OS Version #** fields are the basic operating system (OS) details for each device. If the data Normalization and Enrichment Service is active and the data is available, these fields may be automatically populated by the autodiscovery client. The vendor support details, like the **End of Life** and **End of Support** fields, may also be autopopulated. If the Enriched Data service is disabled, you can manually enter the relevant data or execute scripts to populate the fields. Note that the **OS License Key** field can also be entered manually.

The **Count In Licensing** option is checked by default and can be unchecked if it doesn't count towards the OS licensing for the device OS. Check the **Don't change via api** option if you don't want the property values to be changed via autodiscovery.

Expand Down
16 changes: 8 additions & 8 deletions docs/infrastructure-management/operating-systems.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,43 +11,43 @@ Device42 tracks which devices are running which Operating Systems (OS). This mod
Navigate to **Resources > Operating Systems > All Operating Systems** to locate the Operating Systems list.

<ThemedImage
alt="Operating Systems list with EnrichAI icons"
alt="Operating Systems list with Enriched Data icons"
sources={{
light: useBaseUrl('/assets/images/operating-systems/operating-systems-enrichai-light.png'),
dark: useBaseUrl('/assets/images/operating-systems/operating-systems-enrichai-dark.png'),
}}
/>

If the OS is standardized and enriched by the EnrichAI Cloud Service, an **AI icon** will be displayed to the right of its name.
If the OS is standardized and enriched by the data Normalization and Enrichment Service, an **AI icon** will be displayed to the right of its name.

The Operating Systems list page shows all of your operating systems and includes the **Total Count** of devices running the OS, the **Discovered Licensed Count**, and the number of OSs that are not licensed (named **Discovered Non-Licensed Count**). If you click on one of the listed operating systems, you will see details including which machines are running the OS.

## EnrichAI Operating System Fields
## Enriched Data Operating System Fields

If the OS record has been enriched, key maintenance dates may be displayed in the **Enriched Data** section along with other OS details.

<ThemedImage
alt="Windows device EnrichAI data example"
alt="Windows device Enriched Data example"
sources={{
light: useBaseUrl('/assets/images/operating-systems/ai-hover-over-light.png'),
dark: useBaseUrl('/assets/images/operating-systems/ai-hover-over-dark.png'),
}}
/>

<ThemedImage
alt="Windows device EnrichAI data example"
alt="Windows device Enriched Data example"
sources={{
light: useBaseUrl('/assets/images/operating-systems/enriched-data-details-light.png'),
dark: useBaseUrl('/assets/images/operating-systems/enriched-data-details-dark.png'),
}}
/>

See the [Operating System Attributes](auto-discovery/enrichai-data/index.mdx#operating-system-attributes) and [Key Support Dates](auto-discovery/enrichai-data/index.mdx#key-support-dates) sections of the [EnrichAI Data](auto-discovery/enrichai-data/#operating-system-attributes) page for the list of fields that can be populated through EnrichAI.
See the [Operating System Attributes](auto-discovery/enriched-data/index.mdx#operating-system-attributes) and [Key Support Dates](auto-discovery/enriched-data/index.mdx#key-support-dates) sections of the [Enriched Data](auto-discovery/enriched-data/#operating-system-attributes) page for the list of fields that can be populated through the data Normalization and Enrichment Service.

Note that data will only be populated by EnrichAI if it's used by the OS vendor and if the data is available.
Note that data will only be populated by the Enriched Data service if it's used by the OS vendor and if the data is available.

:::info
Operating System fields that contain data from EnrichAI cannot be edited or changed.
Operating System fields that contain Enriched Data cannot be edited or changed.
:::

### Disable OS changes via API, Discovery, or EnrichAI
Expand Down
Loading