diff --git a/docs/administration/appliance-manager/device42-appliance-manager-login.mdx b/docs/administration/appliance-manager/device42-appliance-manager-login.mdx index 8f3bbfb3e..5bdd38993 100644 --- a/docs/administration/appliance-manager/device42-appliance-manager-login.mdx +++ b/docs/administration/appliance-manager/device42-appliance-manager-login.mdx @@ -39,6 +39,6 @@ Click your username at the top of the left sidebar and select **Change password* ## AWS Login -For **marketplace** AWS installations, use `d42admin` as the username and your **AWS Instance ID** as the default password. See [the AWS installation instructions](https://docs.device42.com/getstarted/installation/installation-amazon-web-services/#accessing-the-d42-appliance-manager---aws-marketplace-installs) for more information. +For **marketplace** AWS installations, use `d42admin` as the username and your **AWS Instance ID** as the default password. See [the AWS installation instructions](https://docs.device42.com/getstarted/deploy-device42/installation-amazon-web-services/#accessing-the-d42-appliance-manager---aws-marketplace-installs) for more information. If you **manually** installed AWS using a downloaded image, use the default Device42 username, `d42admin`, and password, `default`, to log in to the Appliance Manager. diff --git a/docs/administration/appliance-manager/device42-restore.mdx b/docs/administration/appliance-manager/device42-restore.mdx index b1810da38..b6017f1b8 100644 --- a/docs/administration/appliance-manager/device42-restore.mdx +++ b/docs/administration/appliance-manager/device42-restore.mdx @@ -18,7 +18,7 @@ If you are doing a restore and have only Active Directory users (no Device42-onl ## Restoring the MA and RC Backup Files -From the [Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login), navigate to **Backup/Restore > Restore**. +From the [Appliance Manager](/administration/appliance-manager/device42-appliance-manager-login.mdx), navigate to **Backup/Restore > Restore**. - Select **Main Appliance** or **Remote Collector**. You need separate backup `.enc` files for the MA and RC. - To restore the MA or RC, enter the passphrase you used for the backup. If you have forgotten the password encryption phrase, you can create a new backup: diff --git a/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx b/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx index 04b86b776..ac88e09dc 100644 --- a/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx +++ b/docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl' Follow the steps below to set up one-time and scheduled backups in the Device42 Appliance Manager. -For login instructions, see [Device42 Appliance Manager login](/administration/appliance-manager/device42-appliance-manager-login). +For login instructions, see [Device42 Appliance Manager login](/administration/appliance-manager/device42-appliance-manager-login.mdx). ## Set the Passphrase @@ -188,4 +188,4 @@ For Windows Servers, the following PowerShell script can be used to delete files ## Restore the Backup -See [Restore the Backup](/administration/appliance-manager/device42-restore). +See [Restore the Backup](/administration/appliance-manager/device42-restore.mdx). diff --git a/docs/administration/auto-clean-feature.mdx b/docs/administration/auto-clean-feature.mdx index 8c7c492ef..6c6e5767c 100644 --- a/docs/administration/auto-clean-feature.mdx +++ b/docs/administration/auto-clean-feature.mdx @@ -94,7 +94,7 @@ Build search criteria for the selected object type using the basic dropdown filt }} /> -- You can also use the [Advanced Search](getstarted/advanced-search-feature.mdx) feature to include search criteria. +- You can also use the [Advanced Search](/getstarted/using-device42/advanced-search-feature.mdx) feature to include search criteria. -- Clicking the **Advanced** button reveals a text box where you can query specific field values using conditionals and equality selectors. See the [Advanced Search Feature page](getstarted/advanced-search-feature.mdx) for details. +- Clicking the **Advanced** button reveals a text box where you can query specific field values using conditionals and equality selectors. See the [Advanced Search Feature page](/getstarted/using-device42/advanced-search-feature.mdx) for details. -See [Reports](/reports/) for more information about creating Device42 reports. +See [Reports](/reports/index.mdx) for more information about creating Device42 reports. diff --git a/docs/apps/application-components/application-component-templates.mdx b/docs/apps/application-components/application-component-templates.mdx index 56d8f4b4e..29f67c85f 100644 --- a/docs/apps/application-components/application-component-templates.mdx +++ b/docs/apps/application-components/application-component-templates.mdx @@ -8,12 +8,12 @@ import useBaseUrl from '@docusaurus/useBaseUrl' ## Introduction -You can use Application Component Templates to create and define your own Application Components based on services discovered by [Hypervisor/\*nix/Windows](/auto-discovery/windows-and-hyper-v-auto-discovery) autodiscovery jobs run against *nix and Windows platforms. +You can use Application Component Templates to create and define your own Application Components based on services discovered by [Hypervisor/\*nix/Windows](/auto-discovery/windows-and-hyper-v-auto-discovery.mdx) autodiscovery jobs run against *nix and Windows platforms. -Device42 adds the Application Components you create using templates to the [Application Components](/apps/application-components) list page. +Device42 adds the Application Components you create using templates to the [Application Components](/apps/application-components/index.mdx) list page. :::info -Application Components now automatically [suggest Application Groups](/apps/application-groups#application-group-list-page) that you can accept or ignore under **Applications > Application Groups > Application Group Suggestions** on the Main Appliance. +Application Components now automatically [suggest Application Groups](/apps/application-groups/index.mdx#application-group-list-page) that you can accept or ignore under **Applications > Application Groups > Application Group Suggestions** on the Main Appliance. ::: ## View Application Component Templates @@ -38,7 +38,7 @@ On the Application Component Templates list page, you can **Search by template }} /> -The Application Component Templates list page also includes an **Advanced Search** option you can use to construct more specific searches. See the [Advanced Search Feature](/getstarted/advanced-search-feature.mdx) page for instructions. +The Application Component Templates list page also includes an **Advanced Search** option you can use to construct more specific searches. See the [Advanced Search Feature](/getstarted/using-device42/advanced-search-feature.mdx) page for instructions. :::tip -Set up Application Groups by defining a Starting Point or accepting suggestions. See the [Application Groups Calculation Rules](/apps/application-groups/calculation-rules) page for more details. +Set up Application Groups by defining a Starting Point or accepting suggestions. See the [Application Groups Calculation Rules](/apps/application-groups/calculation-rules.mdx) page for more details. ::: diff --git a/docs/apps/application-groups/calculation-rules.mdx b/docs/apps/application-groups/calculation-rules.mdx index 120975010..7d6b44e27 100644 --- a/docs/apps/application-groups/calculation-rules.mdx +++ b/docs/apps/application-groups/calculation-rules.mdx @@ -15,7 +15,7 @@ In 19.05, AppFocus Filters were renamed **Application Group Calculation Rules** In 19.05, we updated our Application Dependency Mapping (ADM) workflow to make it easier to create and manage Application Groups, and ultimately, Business Services (previously known as Business Applications). -The [ADM workflow](/apps/enterprise-application-dependency-mapping) starts by defining Starting Points and setting traversal rules and stop points (using logic templates) to generate Application Groups. Use Application Groups (along with Application Components, resources, and devices) to build a complete and focused picture of your IT environment as a business service. +The [ADM workflow](/apps/enterprise-application-dependency-mapping/index.mdx) starts by defining Starting Points and setting traversal rules and stop points (using logic templates) to generate Application Groups. Use Application Groups (along with Application Components, resources, and devices) to build a complete and focused picture of your IT environment as a business service. ![ADM Workflow](/assets/images/calculation-rules/adm-flow.png) @@ -63,7 +63,7 @@ For each suggestion, you can click **Accept** or **Ignore** right in the list. I Process the accepted Application Groups. -Application Groups are generated based on Calculation Rules with outcomes set to **Auto-Create**. View charts of group dependencies and use the groups as components to build [Business Services](/apps/business-services). +Application Groups are generated based on Calculation Rules with outcomes set to **Auto-Create**. View charts of group dependencies and use the groups as components to build [Business Services](/apps/business-services/index.mdx). Application Groups**. -- Start by creating a new [**Calculation Rule**](calculation-rules)(1) to generate Application Group(s) and suggestions. +- Start by creating a new [**Calculation Rule**](calculation-rules.mdx)(1) to generate Application Group(s) and suggestions. Application Components**. @@ -55,7 +55,7 @@ To see the autodiscovered application dependencies, go to **Applications > Appli }} /> -A full list of currently supported applications is available at [Application Dependency Mapping Supported Applications](apps/enterprise-application-dependency-mapping/adm-supported-applications.mdx). +A full list of currently supported applications is available at [Application Dependency Mapping Supported Applications](/apps/enterprise-application-dependency-mapping/adm-supported-applications.mdx). When you view the details page for an application component, you will see the device it was discovered on, as well as any other application components that it depends on. You'll also see any services that have been associated with the application component. From here, you can also edit the application to assign responsible and/or affected departments, describe what's impacted by downtime, and edit any custom fields. @@ -90,7 +90,7 @@ With Application Dependency Mapping, you can create Application Groups to group You can create an Application Group using one of the discovered Application Components as a starting point which will serve as one of the focus items for that group. Automatically, Device42 will suggest Application Groups based on the discovered Application Components. Accept the groups that most accurately describe significant dependencies in your environment and ignore the others. :::tip -After configuring ADM sampling on the autodiscovery job, see the [Application Group Calculation Rules](/apps/application-groups/calculation-rules) page for a further explanation of how Starting Points are used to generate Application Groups. +After configuring ADM sampling on the autodiscovery job, see the [Application Group Calculation Rules](/apps/application-groups/calculation-rules.mdx) page for a further explanation of how Starting Points are used to generate Application Groups. ::: ## Turning Off Application Discovery diff --git a/docs/apps/enterprise-application-dependency-mapping/index.mdx b/docs/apps/enterprise-application-dependency-mapping/index.mdx index dcad3c7db..f2300d61d 100644 --- a/docs/apps/enterprise-application-dependency-mapping/index.mdx +++ b/docs/apps/enterprise-application-dependency-mapping/index.mdx @@ -3,7 +3,7 @@ title: "Application Dependency Mapping" --- :::info -Get started – visit the [Calculation Rules](/apps/application-groups/calculation-rules/) page and set up a Calculation Rule. +Get started – visit the [Calculation Rules](/apps/application-groups/calculation-rules.mdx) page and set up a Calculation Rule. ::: ## What is Application Dependency Mapping? @@ -12,9 +12,9 @@ The goal of Application Dependency Mapping (ADM) is to build insightful models o After configuring and running autodiscovery jobs, the Device42 dependency mapping module picks up on communication patterns, which you shape via Application Groups. -[Application Groups](/apps/application-groups) are generated using [sets of rules](/apps/application-groups/calculation-rules) that define the starting points for your applications, and [Logic Templates](apps/application-groups#calculation-logic-templates) define how discovery traverses the network and when it stops for each application. +[Application Groups](/apps/application-groups/index.mdx) are generated using [sets of rules](/apps/application-groups/calculation-rules.mdx) that define the starting points for your applications, and [Logic Templates](/apps/application-groups/index.mdx#calculation-logic-templates) define how discovery traverses the network and when it stops for each application. -Add Application Groups to your [Business Services](/apps/business-services) to visualize and organize the results in a way that makes sense for your business. +Add Application Groups to your [Business Services](/apps/business-services/index.mdx) to visualize and organize the results in a way that makes sense for your business. On upgrade to v19.05, you'll find that ADM is easier and faster to configure and consists of a more natural flow. The logic used to calculate Application Groups has been significantly enhanced to show the most relevant relationships, and your existing applications will now better model shared infrastructure. diff --git a/docs/apps/index.mdx b/docs/apps/index.mdx index 6c8f5d437..10020777f 100644 --- a/docs/apps/index.mdx +++ b/docs/apps/index.mdx @@ -19,13 +19,13 @@ After you have performed a successful autodiscovery of your environment, you can These sections cover the following entries found in the **Applications** menu of the Device42 Main Appliance. Explore these categories in the docs using the sidebar on the left. -- **[Application Dependency Mapping](enterprise-application-dependency-mapping/)** provides information about the autodiscovery of application and service dependencies throughout a network. -- **[Application Components](application-components/)** are discovered components such as databases, web servers, and load balancers. See a complete list of Device42’s supported applications here: **[ADM supported applications](apps/enterprise-application-dependency-mapping/adm-supported-applications)**. +- **[Application Dependency Mapping](enterprise-application-dependency-mapping/index.mdx)** provides information about the autodiscovery of application and service dependencies throughout a network. +- **[Application Components](application-components/index.mdx)** are discovered components such as databases, web servers, and load balancers. See a complete list of Device42’s supported applications here: **[ADM supported applications](/apps/enterprise-application-dependency-mapping/adm-supported-applications.mdx)**. - **[Application Groups](/apps/application-groups/index.mdx)** (previously known as Affinity Groups) offer an opinionated view of the impactful applications and their dependencies in your environment. :::tip -Get started with Application Groups by defining the Starting Point in a [Calculation Rule](application-groups/calculation-rules), running one of the predefined rules, and accepting Application Group Suggestions. +Get started with Application Groups by defining the Starting Point in a [Calculation Rule](application-groups/calculation-rules.mdx), running one of the predefined rules, and accepting Application Group Suggestions. ::: -- **[Business Services](business-services/)** allow you to design and customize your map of critical business functions. +- **[Business Services](business-services/index.mdx)** allow you to design and customize your map of critical business functions. The [Services](services/index.mdx) section provides details on each of the **Services** options available in the Main Appliance **Resources** menu. diff --git a/docs/auto-discovery/agent-based-discovery.mdx b/docs/auto-discovery/agent-based-discovery.mdx index e653039b5..409079e42 100644 --- a/docs/auto-discovery/agent-based-discovery.mdx +++ b/docs/auto-discovery/agent-based-discovery.mdx @@ -6,25 +6,15 @@ sidebar_position: 3 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -# Device42 Discovery Agent - -:::tip -To learn about using the agent for **offline** discovery, see [Agent-Based Offline Discovery](agent-based-offline-discovery.mdx). -::: - 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). 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). -:::warning -**Discovery Account warning: Please do _not_ set up an autodiscovery scan using critical or production account credentials! Please create a separate, dedicated account to use _only_ for discovery** - -Doing so, depending on permissions granted and configured password policies could result in account lock-out, therefore causing an otherwise completely avoidable outage. -::: +To learn about using the agent for **offline** discovery, see [Agent-Based Offline Discovery](agent-based-offline-discovery.mdx). ## Supported Platforms -**Device42 autodiscovery agents are available for deployment on the following platforms:** +Device42 autodiscovery agents are available for deployment on the following platforms: - Windows 64-bit (Recommended) - Windows 32-bit @@ -39,8 +29,12 @@ Doing so, depending on permissions granted and configured password policies coul - Solaris Sparc 64-bit - Encrypted config file for Agent -:::info -See **[Windows Discovery Agent Service Wrapper](/getstarted/installation/windows-service-installation)** and **[Mac Agent Service Launcher](/auto-discovery/mac-agent-service-launcher)** for information on installing versions of the Windows and Mac discovery agent as a service. +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. + +:::warning +Do not set up an autodiscovery scan using critical or production account credentials. Please create a separate, dedicated account to use only for discovery. + +Doing so, depending on permissions granted and configured password policies could result in account lock-out, therefore causing an otherwise completely avoidable outage. ::: ## Proxy Environment Variables @@ -73,6 +67,8 @@ The agent can be run from the command line or can be scheduled using the relevan ```bash -capture-host-files capture hosts files + -config-file string + reads the config from an encrypted file (Only works for signed binaries. Ignored Otherwise) -debug prints the data being sent and result of post operation -device-customer string @@ -91,8 +87,6 @@ The agent can be run from the command line or can be scheduled using the relevan doesn't do a post, just prints the data to be sent -extended-logs enables extended logs - -host string - specifies the Main Appliance or Remote Collector target (overrides built-in host) -hostname-precedence sets device name as 'new name' to prevent creation of new device if only hostname was changed -ignore-domain @@ -113,24 +107,28 @@ The agent can be run from the command line or can be scheduled using the relevan default IP VRF group -light-mode reduces CPU utilization by cost of discovery speed - -new-device-object-category - updates/overwrites the object category for the device + -new-device-object-category string + new device object category -offline doesn't connect with Device42, just prints the encrypted data to be sent + -prioritize-dns-name + Prioritize DNS domain name -quiet disables all logs -service-ports-only returns only service ports data -skip-aws-instance-info - disables AWS instance info discovery (default true) + disables AWS instance info discovery (deprecated) -skip-bios disables bios discovery -skip-cluster-info - disables cluster info discovery (Windows only) (default true) + disables cluster info discovery (Windows only) -skip-cpu-info disables CPU info discovery -skip-database-info - disables database discovery (default true) + disables database discovery + -skip-gpu-info + disables GPU info discovery -skip-hardware-info disables hardware discovery -skip-hba @@ -145,8 +143,12 @@ The agent can be run from the command line or can be scheduled using the relevan disables network discovery -skip-os-details disables OS discovery + -skip-other-data + disables other data -skip-parts disables parts discovery + -skip-provider-unique-identifier + disables instance unique identifier lookup -skip-serials disables serial numbers discovery -skip-service-ports @@ -155,30 +157,26 @@ The agent can be run from the command line or can be scheduled using the relevan disables services discovery -skip-software disables software discovery + -skip-tpm-info + disables TPM info discovery -skip-virtual-machines disables VM discovery -software-initial-group string default software group -store-config-files store configuration files - -store-filesystem-info - store filesystem information - -store-registry-info - store registry information - -store-software-config-files - store software configuration files -sudo-password string sudo password used in some OSes (Mac, Linux) to get information about the system -use-aws-token - use generated token to get AWS instance info + use generated token to get AWS instance info (deprecated) -use-global-ignore-software-file use global ignore software file -use-global-ignore-software-pattern-file use global ignore software pattern file + -use-provider-token + use generated token to get instance info -version print version number and exit - --wmi-timeout - timeout for Windows WMI calls (default is 120 seconds if not supplied) ``` diff --git a/docs/auto-discovery/auto-discovery-system-requirements.mdx b/docs/auto-discovery/auto-discovery-system-requirements.mdx index 08a84e8fb..413967a93 100644 --- a/docs/auto-discovery/auto-discovery-system-requirements.mdx +++ b/docs/auto-discovery/auto-discovery-system-requirements.mdx @@ -40,23 +40,4 @@ Contact [support@device42.com](mailto:support@device42.com) with any questions r ## Ports and Protocols Used By Discovery -Device42 uses the following ports and protocols for discovery. Ensure the appropriate ones are allowed through main and target machine firewalls for proper discovery functionality: - -- **UDP/161 - Device42 Appliance** - - Networking (SNMP) - - Blade Systems (SNMP) - - Power (SNMP) -- **TCP/443 - Device42 Appliance and Communication between RC and Main Appliance** - - vServers (VMware, OVirt/Redhat, Citrix/Xen) - - Cisco UCS Manager -- **TCP/22 - Standalone Discovery Tool and Device42 Appliance** - - SSH for *nix and select hypervisor discovery - - KVM/libvirt -- **ICMP - Device42 Appliance or Standalone Discovery Tool** -- **UDP/623 - Device42 Appliance - IPMI** -- **TCP/389 or TCP/636 - Device42 Appliance** - - Active Directory or AD SSL - - LDAP: Default is port 389 or 636 for LDAPs or LDAPs with SSL -- **TCP/135 and 445 - Standalone Discovery Tool - WMI** - - Random ephemeral TCP port(s) between 1024 and 65535 may also be used -- **TCP/5985 and 5986 - Device42 Appliance - WinRM HTTP & HTTPS Discovery** +See [Discovery Port Configurations](/getstarted/deploy-device42/discovery-port-configurations.mdx) for a complete list. \ No newline at end of file diff --git a/docs/auto-discovery/cloud-auto-discovery/aws-autodiscovery.mdx b/docs/auto-discovery/cloud-auto-discovery/aws-autodiscovery.mdx index 6bf543f6b..0ad5c908b 100644 --- a/docs/auto-discovery/cloud-auto-discovery/aws-autodiscovery.mdx +++ b/docs/auto-discovery/cloud-auto-discovery/aws-autodiscovery.mdx @@ -289,7 +289,7 @@ Device42 includes an editor to define or edit the AWS Roles displayed for Amazon /> -- Use the **AWS Role** dropdown to select a role to display or click **Advanced** to construct more specific searches. See [Advanced Search Feature](/getstarted/advanced-search-feature.mdx) for instructions. +- Use the **AWS Role** dropdown to select a role to display or click **Advanced** to construct more specific searches. See [Advanced Search Feature](/getstarted/using-device42/advanced-search-feature.mdx) for instructions. Reports**. diff --git a/docs/auto-discovery/resources/index.mdx b/docs/auto-discovery/resources/index.mdx index ed530fab4..968724410 100644 --- a/docs/auto-discovery/resources/index.mdx +++ b/docs/auto-discovery/resources/index.mdx @@ -50,7 +50,7 @@ sources={{ }} /> -Use the **Advanced** search option to construct more specific searches. See the [Advanced Search Feature](/getstarted/advanced-search-feature.mdx) documentation for instructions. +Use the **Advanced** search option to construct more specific searches. See the [Advanced Search Feature](/getstarted/using-device42/advanced-search-feature.mdx) documentation for instructions. ### View Resource Details @@ -86,7 +86,7 @@ sources={{ }} /> -The tab displays a visualization of the Application Group calculation data for the selected resource, with a single [Starting Point](/apps/application-groups/), and the resource's related dependencies and impact objects in the diagram. +The tab displays a visualization of the Application Group calculation data for the selected resource, with a single [Starting Point](/apps/application-groups/index.mdx), and the resource's related dependencies and impact objects in the diagram. ### Resource Map @@ -132,7 +132,7 @@ sources={{ ## Bulk Resource Actions -You can perform bulk actions if your user account has permission to edit resources. Check with your administrator to ensure that your account has the ['Resources | Can change Resource' permission](/administration/role-based-access-control/role-based-permissions-and-access) enabled. +You can perform bulk actions if your user account has permission to edit resources. Check with your administrator to ensure that your account has the ['Resources | Can change Resource' permission](/administration/role-based-access-control/role-based-permissions-and-access.mdx) enabled. - Export Selected items as CSV - Add tags to selected items diff --git a/docs/auto-discovery/storage-arrays-autodiscovery/storage-arrays.mdx b/docs/auto-discovery/storage-arrays-autodiscovery/storage-arrays.mdx index 1a745d04d..15dab32c4 100644 --- a/docs/auto-discovery/storage-arrays-autodiscovery/storage-arrays.mdx +++ b/docs/auto-discovery/storage-arrays-autodiscovery/storage-arrays.mdx @@ -31,7 +31,7 @@ On this page, you can **Search by name**, filter the list by **Type**, and add /> :::note -The **Storage Arrays** list page also includes an **Advanced Search** option you can use to construct more specific searches. See the [Advanced Search Feature](/getstarted/advanced-search-feature.mdx) documentation page for instructions. +The **Storage Arrays** list page also includes an **Advanced Search** option you can use to construct more specific searches. See the [Advanced Search Feature](/getstarted/using-device42/advanced-search-feature.mdx) documentation page for instructions. ::: Click on an array **Name** to see details about that array. You can use the links in the panel on the right to see details about that related resource. diff --git a/docs/auto-discovery/tcp-port-scan-auto-discovery.mdx b/docs/auto-discovery/tcp-port-scan-auto-discovery.mdx index f9a122fd8..03c4870d8 100644 --- a/docs/auto-discovery/tcp-port-scan-auto-discovery.mdx +++ b/docs/auto-discovery/tcp-port-scan-auto-discovery.mdx @@ -68,7 +68,7 @@ Under **Settings for auto-created Hypervisors/\*nix/win AD Task**, provide the s }} /> - - **Store Application Components Config Files**: Visit the [Application Components](/apps/application-components) page for more information on application components. + - **Store Application Components Config Files**: Visit the [Application Components](/apps/application-components/index.mdx) page for more information on application components. - Apply naming conventions to the discovered devices. Select **Strip domain suffix** to drop everything after the first period (`server.domain.com` becomes `server`), and optionally, elect to **Use the server as the device name**. @@ -100,7 +100,7 @@ Under **Settings for auto-created Hypervisors/\*nix/win AD Task**, provide the s }} /> -- Configure the metadata settings by selecting an **Object Category for discovered devices** and entering **Tags for discovered devices**. Tags are particularly useful to use with the Device42 [Application Dependency Mapping](/apps/enterprise-application-dependency-mapping/) feature. +- Configure the metadata settings by selecting an **Object Category for discovered devices** and entering **Tags for discovered devices**. Tags are particularly useful to use with the Device42 [Application Dependency Mapping](/apps/enterprise-application-dependency-mapping/index.mdx) feature. -Enhanced matching also uses heuristics to determine if a potential match from [Application Dependency Mapping (ADM)](/apps/enterprise-application-dependency-mapping) is correct or incorrect. +Enhanced matching also uses heuristics to determine if a potential match from [Application Dependency Mapping (ADM)](/apps/enterprise-application-dependency-mapping/index.mdx) is correct or incorrect. ### Device Attributes Used in Matching diff --git a/docs/auto-discovery/virtual-machine-auto-discovery.mdx b/docs/auto-discovery/virtual-machine-auto-discovery.mdx index dc94647d8..168acbe76 100644 --- a/docs/auto-discovery/virtual-machine-auto-discovery.mdx +++ b/docs/auto-discovery/virtual-machine-auto-discovery.mdx @@ -67,7 +67,7 @@ You need to add each vCenter server you wish to discover. Device42 does not auto **Port:** This is 443 by default. Only change if you have changed it. -**Enable Resource Utilization Tracking for Device(s):** This option enables the periodic collection and examination of server resource usage metrics. See [Resource Utilization](/auto-discovery/resource-utilization-overview/) for more information. +**Enable Resource Utilization Tracking for Device(s):** This option enables the periodic collection and examination of server resource usage metrics. See [Resource Utilization](/auto-discovery/resource-utilization-overview.mdx) for more information. **Discovery Target(s) Credential(s):** Specify username and password (account credentials) with permission to view all the hosts and VM inventory info. For oVirt, the username is most probably in the format of `username@domain`, for example, `admin@internal`. diff --git a/docs/auto-discovery/warranty-autodiscovery.mdx b/docs/auto-discovery/warranty-autodiscovery.mdx index 5f5614c70..dfefc6cfa 100644 --- a/docs/auto-discovery/warranty-autodiscovery.mdx +++ b/docs/auto-discovery/warranty-autodiscovery.mdx @@ -3,10 +3,8 @@ title: "Warranty Autodiscovery" sidebar_position: 37 --- -import ThemedImage from '@theme/ThemedImage' -import useBaseUrl from '@docusaurus/useBaseUrl' - -## Discover Warranty Details With Device42 +import ThemedImage from "@theme/ThemedImage"; +import useBaseUrl from "@docusaurus/useBaseUrl"; Device42 supports the autodiscovery of hardware warranties, making tracking within Device42 a breeze. @@ -15,15 +13,19 @@ The Device42 warranty autodiscovery and management tools find and help you track To configure automatic warranty discovery, you need to request API keys from the vendors that require them (currently Dell and Meraki). Once you've provided Device42 with the API access keys, machine IDs, and CI model and serial numbers, the warranty autodiscovery automatically discovers and populates your hardware's service contract information. -### Detailed Warranty Sync Instructions +## Supported Vendors Device42 supports warranty autodiscovery for the following vendors: @@ -33,23 +35,42 @@ Device42 supports warranty autodiscovery for the following vendors: - Meraki - Cisco (Preview) +## API Keys, Configuration, and Prerequisites -### API Keys, Configuration, and Prerequisites +For the script to successfully retrieve warranty information for a given device, the device model and serial number fields must be correctly filled out (entered or discovered). -1. For the script to successfully retrieve warranty information for a given device, the device model and serial number fields must be correctly filled out (entered or discovered). If you have more than one vendor entry for a given vendor, the best option is to merge them prior to discovery. +### Merge Vendors - For example, to merge lexical variations of "Amazon Web Services" into a single vendor, head to **Infrastructure > Vendors** and check the boxes next to all the relevant variations: +If you have multiple vendor entries for any of the supported warranty vendors (for example, "Dell", "Dell Inc.", "Dell Computers"), you should merge these into a single vendor using the vendor names (**Dell**, **IBM**, **Lenovo**, **Meraki**) prior to discovery. - -

+To merge multiple vendor names into a single vendor name, perform the following steps: + +1. Choose **Infrastructure > Vendors**. +2. Check the checkbox for the vendors you want to merge. +3. Choose **Actions > Merge**. +4. In the **Merge Vendor** dialog box, choose the vendor name you wish to assign to the selected vendor entries. +5. Optionally check the checkbox to automatically merge the vendor names for like-named software. +6. Click the **Merge** button. + + +
+
+ +### Set the Model Field -2. The Device42 **Model** field must be set 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: +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. + +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: -3. Get your API keys: +### Get Your API Key - **Dell API key**: Instructions for obtaining a Dell API key are now available from [TechDirect](https://tdm.dell.com/td-auth?lang=en_UShttps://techdirect.dell.com/Portal/Login.aspx?ReturnUrl=%2Fportal%2FAboutAPIs.aspxtdLegacyUrl=%2Fportal%2FAboutAPIs.aspx), which requires a valid Dell login. +**Dell API key**: Instructions for obtaining a Dell API key are now available from [TechDirect](https://tdm.dell.com/td-auth?lang=en_UShttps://techdirect.dell.com/Portal/Login.aspx?ReturnUrl=%2Fportal%2FAboutAPIs.aspxtdLegacyUrl=%2Fportal%2FAboutAPIs.aspx), which requires a valid Dell login. - **Meraki API keys**: Device42 requires you to [obtain a Meraki API key](https://developer.cisco.com/meraki/api-v1/#!authorization/obtaining-your-meraki-api-key) min order to retrieve warranty information. +**Meraki API keys**: Device42 requires you to [obtain a Meraki API key](https://developer.cisco.com/meraki/api-v1/#!authorization/obtaining-your-meraki-api-key) min order to retrieve warranty information. - **Lenovo API keys**: Lenovo provides a warranty lookup API key to customers who request it via Lenovo Sales or Support Account Representatives. +**Lenovo API keys**: Lenovo provides a warranty lookup API key to customers who request it via Lenovo Sales or Support Account Representatives. - **IBM API keys**: Log in to your [IBM account](https://login.ibm.com/authsvc/mtfim/sps/authsvc?PolicyId=urn:ibm:security:authentication:asf:basicldapuser&Target=https%3A%2F%2Flogin.ibm.com%2Foidc%2Fendpoint%2Fdefault%2Fauthorize%3FqsId%3D18d7b5a9-bbe1-4d66-9e31-57a48ef148c5%26client_id%3DOGMyMGQ1MzQtZDFhYi00) to access your warranty lookup information. +**IBM API keys**: Log in to your [IBM account](https://login.ibm.com/authsvc/mtfim/sps/authsvc?PolicyId=urn:ibm:security:authentication:asf:basicldapuser&Target=https%3A%2F%2Flogin.ibm.com%2Foidc%2Fendpoint%2Fdefault%2Fauthorize%3FqsId%3D18d7b5a9-bbe1-4d66-9e31-57a48ef148c5%26client_id%3DOGMyMGQ1MzQtZDFhYi00) to access your warranty lookup information. - :::note - If using the standalone warranty script (instructions in the **STANDALONE** section below), Python 2.7 must be installed along with the python library requests. - ::: +:::note +If using the standalone warranty script (instructions in the **STANDALONE** section below), Python 2.7 must be installed along with the python library requests. +::: -### Secure Communication Details +## Secure Communication Details Both the UI and the warranty script transmit the same information (relevant serial number(s)) to the appropriate vendor via port 443 SSL. This only includes the API key entered into Device42 if required by the vendor (Dell or Meraki). Payload looks as follows: @@ -93,11 +114,11 @@ Meraki - api.meraki.com https port 443 1. Select **Discovery > Warranty Sync** from the main menu, click **Create**, and **Name** your job. 2. Select a **Vendor**: - - For Dell or Meraki, be sure to enter your matching API key (see the **API Keys** section above for details on obtaining a Dell or Meraki API key). If you select Dell, ensure you choose the API version from the dropdown. - - For IBM or Lenovo, you are required to be a large enterprise customer and need to contact a sales representative who will put you in contact with the correct team for the API key. - + + For Dell or Meraki, be sure to enter your matching API key (see the **API Keys** section above for details on obtaining a Dell or Meraki API key). If you select Dell, ensure you choose the API version from the dropdown. + + For IBM or Lenovo, you are required to be a large enterprise customer and need to contact a sales representative who will put you in contact with the correct team for the API key. + 3. Add your API key right by clicking the magnifying glass on the **Access Key** field, clicking **Add Password** in the upper-right corner of the popup, and add your key as shown below. Repeat these steps for the **Secret Key** if necessary. 4. Choose your **Order Number Type** and **Debug level** options. 5. Set a schedule if desired and save the job. @@ -106,42 +127,48 @@ Meraki - api.meraki.com https port 443 As long as your API key is active, and devices have a valid model, vendor, and serial number, the sync will gather warranty information. On each device in the **Life Cycle** tab or under **Infrastructure > Purchases**, you will find past and present warranty information. This includes order details, contract and service types, and dates. - - ### Configuring the STANDALONE Warranty Script 1. Create a working directory. Copy the files from [Device42’s `warranty_check` GitHub repo](https://github.com/device42/warranty_check/). 2. Copy the file `warranty.cfg.example` to `warranty.cfg`. 3. Set the required parameters in `warranty.cfg` **[D42 instance info & API keys]**: - + 4. Run the script! - ``` - $ python starter.py - ``` + ``` + $ python starter.py + ``` ### Obtaining the STANDALONE Script diff --git a/docs/auto-discovery/windows-and-hyper-v-auto-discovery.mdx b/docs/auto-discovery/windows-and-hyper-v-auto-discovery.mdx index 81ead92e6..8fa977534 100644 --- a/docs/auto-discovery/windows-and-hyper-v-auto-discovery.mdx +++ b/docs/auto-discovery/windows-and-hyper-v-auto-discovery.mdx @@ -10,7 +10,7 @@ Device42 discovery uses multiple protocols to communicate with the target device ## Prerequisites -When using WMI, you need to install the Windows Discovery Service (WDS) and connect to your Remote Collectors (RCs) before setting up your Windows discovery job. For WDS installation instructions and information, visit the [Windows Discovery Service Installation](/getstarted/installation/windows-discovery-service-installation.mdx) documentation. +When using WMI, you need to install the Windows Discovery Service (WDS) and connect to your Remote Collectors (RCs) before setting up your Windows discovery job. For WDS installation instructions and information, visit the [Windows Discovery Service Installation](/getstarted/deploy-device42/windows-discovery-service-installation.mdx) documentation. ### WinRM Network Requirements diff --git a/docs/auto-discovery/windows-discovery-troubleshooting.mdx b/docs/auto-discovery/windows-discovery-troubleshooting.mdx new file mode 100644 index 000000000..91f37050d --- /dev/null +++ b/docs/auto-discovery/windows-discovery-troubleshooting.mdx @@ -0,0 +1,108 @@ +--- +title: "Windows Discovery Troubleshooting" +sidebar_position: 39 +--- + +## Purpose + +Use this checklist when your Device42 Windows Discovery jobs are failing due to authentication, WMI/WinRM, or connectivity issues. + +## 1. Basic Environment and Discovery Setup + +| Item | Notes | +|------|-------| +| Device42 Windows Discovery Job created | Use the correct discovery type (Windows/Hyper-V) | +| At least one **Windows Discovery Service (WDS)** is installed and online | WDS should be registered in Device42 | +| Correct **WDS** selected in job (if applicable) | Job → Advanced Options | +| Target hosts specified (IPs or FQDNs resolve properly) | Use valid DNS names or IPs | +| Valid **Windows credentials** assigned to job | Either manual, or WDS "Service Account Credentials" | +| Job logs show which credentials were attempted | Use debug mode if needed | + +## 2. Network Connectivity Checks + +Run from WDS or discovery machine: + +| Test | Command / Notes | +|------|-----------------| +| Ping/Netstat Windows host | `ping HOSTNAME` or IP
`netstat HOSTNAME` or IP | +| Test port 135 (for WMI) | PowerShell: `Test-NetConnection -ComputerName HOST -Port 135` | +| If using WinRM, test port 5985 (HTTP) or 5986 (HTTPS) | `Test-NetConnection -ComputerName HOST -Port 5985` | +| Hostname resolves correctly | `nslookup HOSTNAME` | +| If using IPs, DNS isn't required | Ensure IPs are pingable | + +## 3. Authentication Validation + +| Check | Notes | +|-------|-------| +| Credentials are valid and **not expired/locked** | Try login via RDP to confirm | +| Domain credentials are fully qualified (e.g. `DOMAIN\user`) | Required for remote auth | +| If using gMSA, WDS service is running as the gMSA | Check Windows Service "Log On As" | +| For gMSA, discovery job set to "Use Service Account Credentials" | Only works with WDS | + +## 4. Firewall and Port Configuration + +On **target** Windows host: + +| Item | Command / Notes | +|------|-----------------| +| Port 135 allowed (for WMI/DCOM) | Windows Firewall inbound rule: "WMI (DCOM-In)" | +| WMI rule enabled | "Windows Management Instrumentation (WMI-In)" | +| Ephemeral port range not blocked | Allow dynamic ports or set custom port range for WMI | +| WinRM enabled and allowed (if using WinRM) | Run: `winrm quickconfig` on target | +| WinRM listener exists | `winrm enumerate winrm/config/listener` | +| WinRM firewall rule enabled | "Windows Remote Management (HTTP-In)" | + +## 5. WMI / WinRM Functionality Tests + +From WDS or discovery system: + +### WMI Test + +```powershell +Get-WmiObject -Class Win32_OperatingSystem -ComputerName TARGET -Credential (Get-Credential) +``` + +### WinRM Test + +```powershell +Test-WSMan TARGET +``` + +Or: + +```powershell +winrm id -r:TARGET +``` + +| Result | Expect | +|--------|--------| +| WMI command succeeds | Returns OS info | +| WinRM test returns 200 OK | WinRM properly set up | + +## 6. Permission / Namespace Access + +| Item | Notes | +|------|-------| +| Account has remote WMI permissions | Can use Device42 WMI Tester | +| Can connect to `\\TARGET\root\cimv2` | Use Device42 WMI Tester | +| Account is in **Distributed COM Users** | Or granted DCOM launch permissions manually | +| Account is in **Performance Monitor/Log Users** (optional) | For perf counters | +| Account is in **Event Log Readers** (optional) | For Windows events | + +## 7. Device42 Job-Specific Settings + +| Check | Notes | +|-------|-------| +| Discovery job set to correct **protocol** (WMI or WinRM) | WinRM recommended where possible | +| Selected WDS is online and has connectivity | Test from same system | +| Job runs with **Debug** enabled for verbose logs | Review log output in Job History | +| Device42 not behind proxy blocking outbound port 443 | For job report / updates | + +## 8. If the Job Still Fails + +| Step | Notes | +|------|-------| +| Use Device42 **WMI Test Tool** | [Download from Device42](/how-to-videos/wmi-authentication-testing-tool-how-to.mdx) | +| Use WBEMTest locally | Connect to `\\TARGET\root\cimv2` with credentials | +| Review Device42 job logs for authentication errors | Check for "Access Denied" vs "RPC Unavailable" vs other | +| [Open support ticket with Device42](https://support.device42.com/hc/en-us)| Include logs, test results, account details, and network path info | diff --git a/docs/getstarted/additional-customer-resources.mdx b/docs/getstarted/additional-customer-resources.mdx new file mode 100644 index 000000000..542f494a4 --- /dev/null +++ b/docs/getstarted/additional-customer-resources.mdx @@ -0,0 +1,19 @@ +--- +title: "Additional Customer Resources" +sidebar_position: 8 +--- + +Below are links to commonly used customer resources. We recommend you bookmark these links for easy access. + +- [Device42 Website](https://www.device42.com/) +- [Device42 Support Portal](https://support.device42.com/hc/en-us) (for ticket requests, access to the Knowledgebase, and more) +- [Device42 Release Notes](https://support.device42.com/hc/en-us/sections/204925588-Announcements) +- [Device42 Integrations Page](https://www.device42.com/integrations/) +- [Device42 API Guide](https://api.device42.com/) +- [Device42 Github](https://github.com/device42) +- [Device42 Product Upgrade download site](https://www.device42.com/update/) +- [Device42 Upgrade Steps](https://support.device42.com/hc/en-us/articles/222221228) +- [Device42 Academy](http://academy.device42.com) +- [Device42 Blog](https://blog.device42.com/) +- [Device42 YouTube Channel](https://www.youtube.com/user/godevice42) +- [Device42 LinkedIn Page](https://www.linkedin.com/company/device42/posts/?feedView=all) \ No newline at end of file diff --git a/docs/getstarted/critical-success-factors.mdx b/docs/getstarted/critical-success-factors.mdx new file mode 100644 index 000000000..dfe2af631 --- /dev/null +++ b/docs/getstarted/critical-success-factors.mdx @@ -0,0 +1,36 @@ +--- +title: "Critical Success Factors" +sidebar_position: 2 +--- + +We have helped thousands of customers implement Device42, and have not only learned the best way to implement Device42 but have also learned customer best practices that help ensure a quick and successful implementation. Please give careful consideration to each of the critical success factors below. + +## Have Clarity of Purpose + +Gain internal consensus regarding your initial Device42 implementation goals, defining what "success" means. This will help focus the Device42 implementation. + +## Identify Supporting Departments and Persons + +Your Device42 implementation will likely require support from persons residing in various other departments within your organization. This document details the information and tasks required to implement Device42, and it is your responsibility to determine who to enlist for support and to help ensure their timely support. + +## Leverage Executive Sponsors + +Have Project Stakeholders and Executive Sponsors reach out to the leaders of departments from which you require assistance and convey the following: + +- An overview of the project, including its goals +- The value the project will provide to the business +- The role their department will play in the project's success + +This step will help ensure you get the support you require. + +## Share Information and Documentation + +Device42 provides a wealth of documentation at https://docs.device42.com/, including documentation and videos linked to in this guide. Encourage others to access this online documentation as it will likely include answers to questions they have. Device42 users also have access to Device42 Academy, which includes a variety of courses, including courses in implementing Device42. We encourage you to contact us and sign up for classes. + +## Get Project Management Assistance if Necessary + +It can sometimes be difficult to manage an implementation that requires coordination between different departments or persons, particularly when you are also the implementation Technical Lead. Project Managers can help facilitate meetings, can help hold persons accountable for deliverables, and can escalate to management when required. + +## Contact Device42 Support if You Get Stuck + +You can contact Support via email, phone, or our Support Portal. Note that you can contact a Device42 Support agent Monday through Friday from 7am through 6pm ET, and again from 11pm through 6am ET. You can also access our Support Portal and Knowledge Base Portal at https://support.device42.com/hc/en-us, can email support at support@device42.com, and can call us at 1 (844) 424-2422. diff --git a/docs/getstarted/data-validation.mdx b/docs/getstarted/data-validation.mdx new file mode 100644 index 000000000..7f129d473 --- /dev/null +++ b/docs/getstarted/data-validation.mdx @@ -0,0 +1,89 @@ +--- +title: "Data Validation" +sidebar_position: 5 +--- + +In the Data Validation phase you will verify the quality and reliability of the discovered data. You will compare discovered data against existing reliable data sources in order to confirm the discovered data is accurate, complete, and consistent. If you find data that is missing (for example, missing devices), blank (for example, missing Model Name), or incorrect (for example, incorrect hostname), we recommend you contact Device42 Support at [https://support.device42.com/](https://support.device42.com/) for help. + +:::tip +This is the third phase (Data Validation) in the Device42 implementation process. See [How is Device42 Implemented?](/getstarted/how-is-device42-implemented.mdx) for an overview of all four phases. +::: + +## Data Validation Methods + +There are three primary methods for reviewing discovered Device42 data, so that it can be compared against other data sources—viewing individual records, exporting data in bulk, and generating reports. + +### Viewing Individual Records + +To view individual records, perform the following steps: + +1. Hover over **Resources**, then click the item you wish to view (for example, **All Devices**) +2. Click on the name of the item whose data you wish to view + +### Exporting Data in Bulk + +To export data in bulk that can later be reviewed, perform the following steps: + +1. Hover over **Tools**, then click **Exports (CSV)** +2. Click the name of the item whose data you want to export (for example, **Device**) + +### Generating Reports + +There are several useful reports to validate discovered data. To run these reports, perform the following steps: + +1. Click **Insights+** +2. Click the folder and report you want to use; for example: + - **Modernization > Compute** to review Utilization, Hardware, and Operating System information + - **Compliance/Audit > Environmental Summary** to review physical and virtual devices, OS and version information, and installed software package information + - **IT Service Delivery > Insights+ Overview** to see an overall view of your IT enterprise + +## Data Validation and Data Import + +While Device42's CMDB is primarily updated through discovery jobs, it can also be updated by way of manual entry, data import, or via API. + +### Manual Entry + +To add or update data manually, perform the following steps: + +1. Hover over **Resources**, click on the category of items you want to update (for example, **All Devices**). +2. Click the item you want to update. +3. Click the **Edit** button. +4. Enter the information. +5. Click the **Save** button. + +### Data Import + +To bulk import data, perform the following steps: + +1. Hover over **Tools**, then choose **Imports/Exports (xls)** under the **Templates & Bulk Operations** section. +2. Either click the Sample File you want to use for import or download the Current Data for that data category. +3. Open the downloaded file and add or update the data. +4. Click the **Choose File** button and select the file containing the data you want to import. +5. Click the **Import** button. + +**Note:** You can also bulk import your existing data from different spreadsheet formats by mapping columns to D42 fields using the tool linked [here](https://www.device42.com/bulk-data-management/). + +### API Import + +Restful APIs are supported in Device42 as one of the primary methods of entering, editing and retrieving data. Click [here](https://api.device42.com/) to access the Device42 API Guide. + +## Data Validation Phase Checklist + +The Data Validation phase is considered complete when: + +- You have reviewed the discovered data by reviewing individual records, by exporting data in bulk and reviewing this data, and/or by running reports +- You have compared the discovered data against existing, trusted data sources in an effort to confirm all data instances were discovered and that all data field values are as expected +- You have investigated and resolved any inconsistencies between the discovered data and your existing, trusted data sources +- You have imported any data you want in Device42 that was not able to be discovered. + +## Data Validation Phase Support + +At the conclusion of Phase 3 you should have confirmed the accuracy of your discovered data. + +You may access the Device42 Support page [here](https://support.device42.com/hc/en-us), where you can submit a request, access our Knowledge Base, or access other general information. + +## Data Validation and Data Integration + +Customers often want to integrate Device42 discovered data with other systems, like Freshservice, Jira Service Management, ServiceNow, or others. We recommend you establish these integrations after you have completed the Data Validation phase. Once you have established these integrations, we recommend you use available mapping/schema data source information to confirm all relevant Device42 data has been successfully transferred to the destination platform. + +Click [here](https://www.device42.com/integrations/) to navigate to the Device42 Integrations page, where you can view and access integration connectors to a variety of applications. diff --git a/docs/getstarted/deploy-device42/_category_.yml b/docs/getstarted/deploy-device42/_category_.yml new file mode 100644 index 000000000..707080a53 --- /dev/null +++ b/docs/getstarted/deploy-device42/_category_.yml @@ -0,0 +1,4 @@ +position: 3 +label: 'Deploy Device42' +collapsible: true +collapsed: true diff --git a/docs/getstarted/deployment-best-practices.mdx b/docs/getstarted/deploy-device42/deployment-best-practices.mdx similarity index 97% rename from docs/getstarted/deployment-best-practices.mdx rename to docs/getstarted/deploy-device42/deployment-best-practices.mdx index 5b652c13b..fa52debe3 100644 --- a/docs/getstarted/deployment-best-practices.mdx +++ b/docs/getstarted/deploy-device42/deployment-best-practices.mdx @@ -1,5 +1,6 @@ --- title: "Device42 Deployment Best Practices & Recommendations" +sidebar_position: 16 --- ## Device42 Application Hardening @@ -22,9 +23,9 @@ For the Main Appliance (MA), this means changing the following sets of credentia If you are deploying through the AWS or Azure marketplaces, then the passwords above are not the default values used. Review the below documentation for more information: -- [Amazon Web Services – Installation](getstarted/installation/installation-amazon-web-services.mdx) +- [Amazon Web Services – Installation](installation-guides/installation-amazon-web-services.mdx) -- [Microsoft Azure – Installation](getstarted/installation/installation-microsoft-azure.mdx) +- [Microsoft Azure – Installation](installation-guides/installation-microsoft-azure.mdx) For the Remote Collector (RC), this means changing the System Console User (Default Credentials: client | device42). diff --git a/docs/getstarted/installation/discovery-port-configurations.mdx b/docs/getstarted/deploy-device42/discovery-port-configurations.mdx similarity index 100% rename from docs/getstarted/installation/discovery-port-configurations.mdx rename to docs/getstarted/deploy-device42/discovery-port-configurations.mdx diff --git a/docs/getstarted/deploy-device42/index.mdx b/docs/getstarted/deploy-device42/index.mdx new file mode 100644 index 000000000..29d5975e0 --- /dev/null +++ b/docs/getstarted/deploy-device42/index.mdx @@ -0,0 +1,246 @@ +--- +title: "Deploy Device42" +--- + +The Deploy phase contains a series of tasks, and each of these tasks requires steps to complete. + +:::tip +This is the first phase (Deploy) in the Device42 implementation process. See [How is Device42 Implemented?](../how-is-device42-implemented.mdx) for an overview of all four phases. +::: + +## About the Deploy Tasks + +For each task you may find one or more of the following: +- A simplified list of steps to enable you to **understand** the steps, but may in some +cases lack all the detail to complete the tasks. +- A link to a web page that includes all the detail you will need to **perform** the task, including options you may or may not choose to enable. +- A link to a video to **see** the task performed, along with related commentary. + +## Device42 Components + +In the Deploy phase you will install and configure: +- The **Device42 Main Appliance (MA)** +- **Remote Collectors (RCs)** +- **Windows Discovery Service (WDS) instances** +- (optionally) **Device42 Discovery Agents** + +Prior to performing these tasks you must understand each of these components, their prerequisites, +and how they interoperate. + +### Component Descriptions + +**Main Appliance:** The Device42 Main Appliance (MA) is a self-contained and self-maintaining +virtual appliance that serves as the core component of the Device42 system. It is a +pre-configured virtual appliance (built on Linux) that your organization hosts, enabling full +protection under your data center security architecture and policies. + +**Remote Collector:** The Remote Collector (RC), is a lighter pre-configured virtual appliance (built +on Linux), used to perform agentless discovery across network segments. It also provides +scalability by offloading discovery workloads from the MA. The RC will connect to your +non-Windows targets for discovery as well as hand Windows discovery jobs off to the WDS, if +applicable. We require that you install at least one RC for any Device42 deployment. + +**Windows Discovery Service:** The Windows Discovery Service (WDS) is a .NET service which +runs on a Windows system and makes WMI queries on behalf of the Linux-based RC and MA. If +you’ll be running Windows discoveries, you must deploy at least one WDS instance and connect it to +an RC. + +**Discovery Agent:** The Device42 Discovery Agent can be optionally deployed into your +environment. It is typically deployed either on devices like laptops that are not consistently +connected to your corporate network or in segmented network environments where agentless +discovery is not permitted or possible. The Device42 Agent can run on Windows, macOS, Linux, +and other Unix-based operating systems. + +## Review Information + +Before you continue: +- Understand the [Device42 architecture](resource-and-deployment-architecture-overview.mdx). +- See the [discovery port configurations](discovery-port-configurations.mdx) for network requirements. +- Visit the [security posture and high-level permissions](security-posture-and-high-level-permissions.mdx) page. +- Review the [sizing recommendations](sizing-recommendations.mdx) to ensure your environment is properly provisioned. + +## Task 1: Deploy the Main Appliance + +### 1.1 Size the Main Appliance Server + +Device42 Main Appliance server sizing is based on the quantity of devices to be discovered. Refer to the [Component Sizing Recommendations](sizing-recommendations.mdx) to properly size your Device42 Main Appliance server. + +### 1.2 Install and Configure the Main Appliance + +**Main Appliance Prerequisites** + +Device42 operates with only five ports open to the virtual appliance: +- **Port 80**: Redirects to port 443 +- **Port 443**: Web (HTTPS) +- **Port 4242**: Redirects to port 4343 +- **Port 4343**: Appliance manager (HTTPS) +- **Port 404**: SSH for limited console menu operations + +Make sure the appropriate network personnel are made aware of these requirements. + +**Main Appliance Installation and Configuration** + +The MA can be installed on virtual environments like VCenter, Microsoft HyperV, and Citrix Xen server, as well as cloud platforms like Amazon Web Services and Microsoft Azure. + +Select the platform-specific installation guide that matches your environment: + +- [VMware vCenter Server](installation-guides/installation-vcenter-server.mdx) +- [Microsoft Hyper-V](installation-guides/installation-microsoft-hyperv.mdx) +- [Citrix Xen Server](installation-guides/installation-citrix-xen-server.mdx) +- [Xen or KVM](installation-guides/installation-xen-or-kvm-using-virt-manager.mdx) +- [Amazon Web Services (AWS)](installation-guides/installation-amazon-web-services.mdx) +- [Microsoft Azure](installation-guides/installation-microsoft-azure.mdx) + +### 1.3 Apply Your License + +After installing the MA you will be prompted to apply for your new license file. Perform these steps: +1. Click the **Choose File** button. +2. Select the file and click **Open**. +3. Click the **Upload & Apply** button. + +### 1.4 Register the MA + +You have 30 days after MA installation to register. When prompted, click the **Register Now** button. + +### 1.5 Create a Passphrase to Encrypt Device42 Passwords + +You must create a passphrase that will encrypt passwords within Device42. To create a passphrase, perform these steps: +1. Choose **Tools > Password Security**. +2. Enter a passphrase and click the checkbox stating you will save the passphrase in a secure location. +3. Click the **Save** button. + +:::tip +To view a video on installing and configuring the MA, click [here](https://device42.wistia.com/medias/sleift9zbj). +::: + +## Task 2: Deploy the Remote Collectors + +### 2.1 Size the Remote Collectors + +Device42 Remote Collector server sizing is based on the quantity of workloads to be discovered. Refer to the [Sizing Recommendations table](sizing-recommendations.mdx) to properly size your Device42 Remote Collector servers. + +### 2.2 Install and Configure the Remote Collectors + +The Remote Collectors can be installed on the Hypervisor of your choice. Click [here](https://www.device42.com/autodiscovery/) to link to the page where you can download the RC installer. + +Note that while the above linked page includes an **Initial (First-Boot) Network Configuration** section for configuring the Remote Collector, we recommend you instead reference the [Remote Collector Configuration](remote-collector-rc-installation.mdx) guide. + +:::tip +To view a video on configuring the RCs, click [here](https://device42.wistia.com/medias/3rtti4gtgx). +::: + +## Task 3: Deploy the Windows Discovery Service + +### 3.1 Size the Windows Discovery Service Servers + +Windows Discovery Services server sizing is based on the quantity of workloads to be discovered. Refer to [Sizing Recommendations table](sizing-recommendations.mdx) to properly size your Device42 Remote Collector servers. + +### 3.2 Install the Windows Discovery Service + +Click [here](https://www.device42.com/autodiscovery/) to link to the page where you can both download the WDS installer and access WDS installation documentation. + +:::tip +To view a video on installing the WDS, click [here](https://device42.wistia.com/reviews/cvt3qzahea). +::: + +## Task 4: Deploy the Discovery Agent + +We recommend you use agentless discovery whenever possible, as it makes deployment easier, minimizes impact on target systems, and reduces operational overhead for most environments. However, as mentioned, you may choose to install the Discovery Agent on devices like laptops that are not consistently connected to your corporate network or in segmented network environments where agentless discovery is not permitted or possible. + +### 4.1 Discovery Agent Supported Platforms + +Device42 autodiscovery agents are available for deployment on the following platforms: +- Windows 64-bit (Recommended) +- Windows 32-bit +- Mac—Intel +- Mac—ARM +- Linux 32-bit +- Linux 64-bit +- FreeBSD 32-bit +- FreeBSD 64-bit +- OpenBSD 32-bit +- OpenBSD 64-bit +- Solaris Sparc 64-bit + +### 4.2 Install the Discovery Agent + +The agent can be downloaded from the Main Appliance and can either be run from the command line or can be scheduled using a scheduling program. Click [here](/auto-discovery/agent-based-discovery.mdx) to access the Device42 Discovery Agent main page that provides these instructions as well as additional agent information. + +You can also install versions of the Windows and Mac discovery agent as a service. Click [here](/getstarted/deploy-device42/windows-service-installation.mdx) for more information about the Windows Discovery Agent Service Wrapper. + +The Windows or Linux Discovery Agent can also be leveraged in an offline mode, where it creates a log of discovered data, which is uploaded to a machine for processing, and is finally uploaded to your Device42 Main Appliance. Click [here](/auto-discovery/agent-based-offline-discovery.mdx) for more information about this option. + +## Optional Deploy Tasks + +Below is a list of tasks that can be performed either now or in the future. + +### Task 5: Back up Your Deployed Environment + +You should back up your deployed environment so you can quickly restore a configuration in case of emergency. + +To back up your environment, perform the following steps: +1. Hover over **Tools**, then choose **Appliance Manager** from the Settings section. This will take you to the Device42 Appliance Manager login screen. +2. Enter the Username and Password to log in (default Username is d42admin and default Password is default). We recommend changing these credentials once logged in. +3. Follow the steps listed [here](/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx) to configure your backup. + +### Task 6: Add Users + +Adding users will help you better track user changes and define user permission levels. + +To add new administrators, perform the following steps: +1. Hover over **Tools**, then choose **Administrators** from the Admins & Permissions section. +2. Click either **Create Local Admin** or **Create Active Directory Admin** (if AD is connected to the Main Appliance). +3. Fill out the Add Admin User page and click the **Save** button. + +Click [here](/administration/add-an-active-directory-user-as-a-device42-administrator.mdx) for more information to add an Active Directory User as a Device42 Administrator. For information on setting up an Active Directory/LDAP User Sync click [here](/auto-discovery/active-directory-sync.mdx), and for information on configuring Device42 Role-Based Access Control click [here](/administration/role-based-access-control/index.mdx). + +### Task 7: Configure Audit Logs + +Every change made to Device42 Configuration Items (CIs), via the user interface, autodiscovery jobs, RESTful API calls, or imports, is recorded as history, and this history is maintained in Audit Logs. + +To change the log settings, perform the following steps: +1. Hover over **Tools**, then choose **Log Settings** from the Settings section. +2. Click the **Edit** button. +3. Edit the settings. +4. Click the **Save** button. + +Note the longer the duration, the more disk space will be used. For long term storage, you may leverage webhooks (click [here](/integration/external-integrations/webhooks-generic-integration.mdx) for more information about webhooks). + +Click [here](/reports/reports/object-history-aka-audit-log.mdx) for more information about Audit Logs. + +### Task 8: Set up a Mail Server + +Setting up a mail server enables automated email notifications and alerts for events like discovery scans, system updates, backup completions, reports, and custom workflow actions. + +Click [here](/reports/reports/save-and-schedule-reports.mdx#mail-server-settings-for-scheduling-reports) for instructions on adding mail server settings. + +## Deploy Phase Checklist + +The Deploy phase is considered complete when: +- Device42 Infrastructure Installation is complete: The Device42 MA and RCs are properly +deployed and configured; WDS/WMI is selected as the preferred path forward and WDS is +installed on RCs (if Windows is in scope for the deployment); and the Discovery Agent is +installed if required. +- Network Configuration is complete: Network settings and firewall rules are properly +configured to allow Device42 to communicate with all relevant infrastructure components in +scope for the deployment. +- Access and Permissions are granted: Appropriate access permissions are granted to +Device42, ensuring it can access all necessary systems and devices across the various +in-scope jobs the customer will be running. +- Initial Connectivity Checks have passed: Initial connectivity tests confirm that Device42 can +communicate with key infrastructure components without errors. +- Device42 environment is backed up and scheduled for future backups. Main Appliance Meta +Data, SSH key pair, System Configuration Files are backed up; Remote Collector Meta Data, +TLS Key Pair, Configuration files, and Data Files are backed up. Future backups are scheduled +to occur. +- Additional Admin users have been defined. +- Audit Log configuration is configured as desired. +- Mail Server is configured. + +## Deploy Phase Support + +At the conclusion of Phase 1 your Device42 Main Appliance, Remote Collectors, and Windows Discovery Service should be deployed and configured. Your network should be configured with the proper access granted, and initial connectivity checks to your infrastructure components should be successful. + +You may also access the Device42 Support page [here](https://support.device42.com/hc/en-us), where you can submit a request, access our Knowledge Base, or access other general information. + + diff --git a/docs/getstarted/deploy-device42/installation-guides/_category_.yml b/docs/getstarted/deploy-device42/installation-guides/_category_.yml new file mode 100644 index 000000000..967912fc3 --- /dev/null +++ b/docs/getstarted/deploy-device42/installation-guides/_category_.yml @@ -0,0 +1,4 @@ +position: 5 +label: 'Installation Guides' +collapsible: true +collapsed: true diff --git a/docs/getstarted/installation/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing.mdx b/docs/getstarted/deploy-device42/installation-guides/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing.mdx similarity index 85% rename from docs/getstarted/installation/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing.mdx rename to docs/getstarted/deploy-device42/installation-guides/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing.mdx index 5351abc4a..344232189 100644 --- a/docs/getstarted/installation/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing.mdx +++ b/docs/getstarted/deploy-device42/installation-guides/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing.mdx @@ -1,10 +1,10 @@ --- title: "Xen or KVM - Import Disk Alternate Install" -sidebar_position: 9 +sidebar_position: 5 --- :::info -These are **special case** installation instructions for installing the Device42 appliance on Xen- or KVM-based platforms if the **Import existing disk image** option is missing. Otherwise, please refer to the Device42 [guide to Xen and KVM installation](getstarted/installation/installation-xen-or-kvm-using-virt-manager.mdx). +These are **special case** installation instructions for installing the Device42 appliance on Xen- or KVM-based platforms if the **Import existing disk image** option is missing. Otherwise, please refer to the Device42 [guide to Xen and KVM installation](installation-xen-or-kvm-using-virt-manager.mdx). ::: ## Outline of Alternative Installation @@ -16,7 +16,7 @@ These are **special case** installation instructions for installing the Device42 ## Illustrated Installation Steps -The following alternative installation steps are similar to the [standard Virt-Manager installation](getstarted/installation/installation-xen-or-kvm-using-virt-manager.mdx), except that you select the **Network Boot** option instead of importing the Device42 image and then disable the network boot. +The following alternative installation steps are similar to the [standard Virt-Manager installation](installation-xen-or-kvm-using-virt-manager.mdx), except that you select the **Network Boot** option instead of importing the Device42 image and then disable the network boot. ### Download and Uncompress with bunzip2 @@ -40,7 +40,7 @@ Choose **Linux** as the **OS type** and the latest Ubuntu version in the **Versi ![Choosing OS and version](/assets/images/wpid2480-Choosing_OS_and_version.png) -Allocate at least 8 GB RAM and 2 vCPUs for production appliances. See [Sizing Recommendations](sizing-recommendations.mdx). +Allocate at least 8 GB RAM and 2 vCPUs for production appliances. See [Sizing Recommendations](../sizing-recommendations.mdx). ![](/assets/images/wpid2484-media_1326264722468.png) diff --git a/docs/getstarted/installation/installation-amazon-web-services.mdx b/docs/getstarted/deploy-device42/installation-guides/installation-amazon-web-services.mdx similarity index 92% rename from docs/getstarted/installation/installation-amazon-web-services.mdx rename to docs/getstarted/deploy-device42/installation-guides/installation-amazon-web-services.mdx index 434c4ef78..6409731b8 100644 --- a/docs/getstarted/installation/installation-amazon-web-services.mdx +++ b/docs/getstarted/deploy-device42/installation-guides/installation-amazon-web-services.mdx @@ -1,6 +1,6 @@ --- title: "Amazon Web Services - Installation" -sidebar_position: 10 +sidebar_position: 6 --- import ThemedImage from '@theme/ThemedImage' @@ -24,7 +24,7 @@ The Device42 RC is only available via manual installation only. To request acces Each Device42 AWS offering comes with a pre-installed limited license. To make use of Device42's full capabilities, we recommend you obtain a more comprehensive license from a Device42 sales representative or business partner. -Refer to the Device42 [Licensing](administration/licensing.mdx#upload-a-new-license) page for more information on managing licenses. +Refer to the Device42 [Licensing](/administration/licensing.mdx#upload-a-new-license) page for more information on managing licenses. Device42 on AWS operates using the **Bring Your Own License (BYOL)** model, meaning you can run on AWS with no additional charge from Device42. Other than the yearly fee for your Device42 license, the only costs you will incur via AWS are the charges Amazon bills you for the use of your instances. These are usually hourly fees, depending on the instance size you select. Larger instances generally cost more. @@ -38,7 +38,7 @@ The configuration will only allow you to **Launch** successfully using one of th Customers must regularly view and manage the quotas for AWS services using the AWS Service Quotas dashboard. -Refer to our [Sizing Recommendations](getstarted/installation/sizing-recommendations.mdx) page for sizing recommendations. +Refer to our [Sizing Recommendations](../sizing-recommendations.mdx) page for sizing recommendations. ## Regional Availability @@ -113,9 +113,11 @@ Update the appliance license key, because the included key has expired: light: useBaseUrl('/assets/images/installation-amazon-web-services/upload-license-light.png'), dark: useBaseUrl('/assets/images/installation-amazon-web-services/upload-license-dark.png'), }} - style={{ width: '90%' }} + style={{ width: '90%' }} /> +[Set the time zone and configure NTP](/administration/setting-time-zone-and-ntp.mdx) to ensure autodiscovery scheduling and log history work correctly. + Make sure your AMI is running the latest version of Device42 and update it if necessary: - From the Device42 web UI, head to **Tools > Update**. @@ -129,10 +131,12 @@ Make sure your AMI is running the latest version of Device42 and update it if ne light: useBaseUrl('/assets/images/installation-amazon-web-services/update-software-light.png'), dark: useBaseUrl('/assets/images/installation-amazon-web-services/update-software-dark.png'), }} - style={{ width: '70%' }} + style={{ width: '70%' }} /> -And you're all set! Now is a good time to check out our documentation for [Getting Started](getstarted/index.mdx) with Device42. If you have any questions or issues that the documentation doesn't address, visit the [Device42 Support page](https://support.device42.com) or email [support@device42.com](mailto:support@device42.com) to open a ticket. +And you're all set! + +If you have any questions or issues that the documentation doesn't address, visit the [Device42 Support page](https://support.device42.com) or email [support@device42.com](mailto:support@device42.com) to open a ticket. * * * @@ -203,13 +207,13 @@ For additional visibility, Device42 recommends users enable [AWS CloudTrail](htt Security patches are bundled with Device42 software updates. There is no need to manually apply patches to your Device42 instances outside of software updates. Software updates can be downloaded from the [Device42 Update page](https://www.device42.com/update/). -Watch the [How To Update the Device42 Appliance](/how-to-videos/update-device42-appliance-how-to) walkthrough video to discover our quick update process. +Watch the [How To Update the Device42 Appliance](/how-to-videos/update-device42-appliance-how-to.mdx) walkthrough video to discover our quick update process. ### Backing Up and Restoring Device42 Data on AWS The Device42 backup facilities are accessible through the AM. Backups can be executed immediately. You can download a backup file immediately or schedule automatic saving to an SFTP, NFS, or AWS S3 destination. -For more information on backing up and restoring Device42 data, see our guide to [setting up backups](administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx). +For more information on backing up and restoring Device42 data, see our guide to [setting up backups](/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx). ### Monitoring and Health Checks for Device42 on AWS @@ -223,7 +227,7 @@ The built-in health check monitors the following: ### Configuring High Availability for Device42 on AWS -If a High Availability (HA) deployment of Device42 is desired or required for a Device42 instance running on AWS, Device42 offers a supported **Warm HA** solution. To configure your deployment to run Warm HA, failover, and (if desired) automatic backups, follow the instructions in the Device42 [Warm HA](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) documentation. +If a High Availability (HA) deployment of Device42 is desired or required for a Device42 instance running on AWS, Device42 offers a supported **Warm HA** solution. To configure your deployment to run Warm HA, failover, and (if desired) automatic backups, follow the instructions in the Device42 [Warm HA](/administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) documentation. The documentation also includes an example configuration that leverages Nagios to automatically initiate a failover of the instance in the event of a failure. @@ -319,5 +323,5 @@ The following is a sample IAM policy (with minimum appropriate permissions) that - The Device42 AWS offering does not require AWS data encryption to operate properly. - Customer data resides on the instance itself. Customer passwords and secrets are encrypted with AES-256 encryption. - Refer to the Device42 [Secrets, Security, and Permissions](administration/passwords/password-security-and-permissions.mdx) page for additional information on how passwords and secrets are stored. + Refer to the Device42 [Secrets, Security, and Permissions](/administration/passwords/password-security-and-permissions.mdx) page for additional information on how passwords and secrets are stored. - The Device42 AWS offering does not require the storage of any secrets in AWS Secrets Manager. diff --git a/docs/getstarted/installation/installation-citrix-xen-server.mdx b/docs/getstarted/deploy-device42/installation-guides/installation-citrix-xen-server.mdx similarity index 86% rename from docs/getstarted/installation/installation-citrix-xen-server.mdx rename to docs/getstarted/deploy-device42/installation-guides/installation-citrix-xen-server.mdx index ad1161761..6bbb9b4dd 100644 --- a/docs/getstarted/installation/installation-citrix-xen-server.mdx +++ b/docs/getstarted/deploy-device42/installation-guides/installation-citrix-xen-server.mdx @@ -1,6 +1,6 @@ --- title: "Citrix XenServer - Installation" -sidebar_position: 7 +sidebar_position: 3 --- import ThemedImage from '@theme/ThemedImage' @@ -16,7 +16,8 @@ This guide walks you through installing the Device42 Main Appliance on Citrix Xe 4. Power on the newly deployed Device42 virtual appliance. 5. Log in to the Device42 console using the default credentials and update the credentials. 6. Configure the static IP address from the console. -7. Log in to the Device42 web interface from a browser: `https://FQDN (Fully Qualified Domain Name) or IP address`. Update the login credentials here as well. +7. Set the time zone and configure NTP. +8. Log in to the Device42 web interface from a browser: `https://FQDN (Fully Qualified Domain Name) or IP address`. Update the login credentials here as well. ## Illustrated Steps of Installing Device42 on Citrix XenServer @@ -82,6 +83,10 @@ From the console, configure the IP address. Use a **static IP** for all producti This is an optional step: Create a DNS entry for the new IP address of the virtual appliance. +### Set the Time Zone and Configure NTP + +After setting a static IP address, [set the time zone and configure NTP](/administration/setting-time-zone-and-ntp.mdx) to ensure autodiscovery scheduling and log history work correctly. + ### Log In to the Web Interface Point your browser to `https://FQDN (Fully Qualified Domain Name) or IP address`. @@ -110,6 +115,6 @@ You can apply updates and do other menu-related work using SSH port 404. Please ## Next Steps -Install the Device42 [Remote Collector](remote-collector-rc-installation.mdx) and [Windows Discovery Service](windows-discovery-service-installation.mdx) before creating your first discovery job. +Install the Device42 [Remote Collector](../remote-collector-rc-installation.mdx) and [Windows Discovery Service](../windows-discovery-service-installation.mdx) before creating your first discovery job. -You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool. +You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/using-device42/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool. diff --git a/docs/getstarted/installation/installation-microsoft-azure.mdx b/docs/getstarted/deploy-device42/installation-guides/installation-microsoft-azure.mdx similarity index 90% rename from docs/getstarted/installation/installation-microsoft-azure.mdx rename to docs/getstarted/deploy-device42/installation-guides/installation-microsoft-azure.mdx index 67fd9b9a4..2f9ad874e 100644 --- a/docs/getstarted/installation/installation-microsoft-azure.mdx +++ b/docs/getstarted/deploy-device42/installation-guides/installation-microsoft-azure.mdx @@ -1,6 +1,6 @@ --- title: "Microsoft Azure - Installation" -sidebar_position: 11 +sidebar_position: 7 --- Install the Device42 Main Appliance on Microsoft Azure using the virtual appliance from the Azure Marketplace. @@ -12,6 +12,7 @@ To install Device42 within your Microsoft Azure environment, you need to: 1. Download the Device42 virtual appliance from the Azure Marketplace. 2. Configure the virtual machine with proper resources and set up networking and deployment. 3. Log in to the Device42 instance using the vmID as the default password and configure the setup. +4. Set the time zone and configure NTP. ## Detailed Installation Steps @@ -29,7 +30,7 @@ As a prerequisite, install the [Azure CLI](https://learn.microsoft.com/en-us/dot Fill in the virtual machine details: - Specify the resource group, virtual machine name, networking, and disks. -- For the size-of-VM field, choose at least 8 GB RAM and 2 vCPUs (16 GB RAM and 4 vCPUs recommended) to avoid out-of-memory errors. See [Sizing Recommendations](sizing-recommendations.mdx). +- For the size-of-VM field, choose at least 8 GB RAM and 2 vCPUs (16 GB RAM and 4 vCPUs recommended) to avoid out-of-memory errors. See [Sizing Recommendations](../sizing-recommendations.mdx). - For the administrator account, choose **Password** as the **Authentication Type** and enter a random value, as this field has no bearing on the Device42 deployment. - Click **Review & Create**. After validation, the deployment will start. @@ -69,6 +70,8 @@ Use the value of **vmId** as a password with the following default account user ![](/assets/images/WEB-316_Az-Install-Az-shell-2.png) -Change the **device42** console user password to something of your own choosing from the console.. +Change the **device42** console user password to something of your own choosing from the console. + +[Set the time zone and configure NTP](/administration/setting-time-zone-and-ntp.mdx) to ensure autodiscovery scheduling and log history work correctly. You should now have a fully functioning Device42 Main Appliance hosted on Microsoft Azure. You can run updates on this instance to get it to the latest version. You have to supply your license to get full functionality. diff --git a/docs/getstarted/installation/installation-microsoft-hyperv.mdx b/docs/getstarted/deploy-device42/installation-guides/installation-microsoft-hyperv.mdx similarity index 75% rename from docs/getstarted/installation/installation-microsoft-hyperv.mdx rename to docs/getstarted/deploy-device42/installation-guides/installation-microsoft-hyperv.mdx index 124bdd672..2feb77f5f 100644 --- a/docs/getstarted/installation/installation-microsoft-hyperv.mdx +++ b/docs/getstarted/deploy-device42/installation-guides/installation-microsoft-hyperv.mdx @@ -1,6 +1,6 @@ --- title: "Microsoft HyperV - Installation" -sidebar_position: 6 +sidebar_position: 2 --- import ThemedImage from '@theme/ThemedImage' @@ -15,8 +15,9 @@ After you [download the Device42 virtual appliance file](https://www.device42.co 1. Use 7-Zip to unzip the downloaded file. 2. Create a virtual machine with a **minimum** of 2 vCPU, 8 GB RAM for production use, and one network card. Configure the new VM to use the attached virtual disk file. 3. Power on the new machine and log in to the console using the default credentials, then update the credentials. -4. On the console, configure the IP and choose your settings. Please use a static (non-DHCP) IP address for all Device42-related appliances. Create a DNS entry that points to the IP address of the new virtual appliance. -5. Point your browser to `https://FQDN (Fully Qualified Domain Name) or IP address` and log in to the **web interface** using the default credentials. Update the login credentials here as well. +4. On the console, configure the IP and choose your settings. Please use a static (non-DHCP) IP address for all Device42-related appliances. +5. Set the time zone and configure NTP. +6. Point your browser to `https://FQDN (Fully Qualified Domain Name) or IP address` and log in to the **web interface** using the default credentials. Update the login credentials here as well. You are now ready to start discovering and documenting your IT infrastructure! @@ -30,7 +31,7 @@ Download the compressed [Device42 virtual appliance](https://www.device42.com/do ### Create a New Microsoft VM -Create a VM with a **minimum** of 2 vCPU, 8 GB RAM, and 1 network card, and configure the new VM to use the attached virtual disk file. See the [Sizing Recommendations](sizing-recommendations.mdx) for more details. +Create a VM with a **minimum** of 2 vCPU, 8 GB RAM, and 1 network card, and configure the new VM to use the attached virtual disk file. See the [Sizing Recommendations](../sizing-recommendations.mdx) for more details. :::note Only Hyper-V Gen1 VMs are currently supported. In our experience, users have issues deploying Linux VMs as Generation 2 in Hyper-V. We recommend deploying Device42 only as a Gen1 VM. @@ -61,7 +62,7 @@ Please change these credentials as soon as you've logged in. ### Configure a Static IP and Networking Options -Configure an IP address for the Device42 appliance. Use a static IP or a DHCP address reservation. Ensure that DNS entries are created for every appliance to be used in a production setting. DNS server configuration is a necessary step. +Configure an IP address for the Device42 appliance using either a static IP or a DHCP reservation. Ensure that DNS server settings are configured on the appliance for production use, as these are required for autodiscovery to resolve hostnames. ![Device42 VM console menu v19.05](/assets/images/vm-main-menu.png) @@ -69,7 +70,9 @@ Configure an IP address for the Device42 appliance. Use a static IP or a DHCP ad Change the default password for the user `device42` from the console menu before proceeding. -You can apply updates and perform other menu-related work using SSH **port 404**. Please note that root login has been disabled via SSH. Attempting to access the root will cause the VM to disable itself permanently and is not supported. +### Set the Time Zone and Configure NTP + +After setting a static IP address, [set the time zone and configure NTP](/administration/setting-time-zone-and-ntp.mdx) to ensure autodiscovery scheduling and log history work correctly. ### Log In to the Web Interface @@ -82,7 +85,7 @@ Log in to the **web interface** using the default credentials: Please change these credentials as soon as you've logged in. -You are now ready to start discovering your IT infrastructure! +You are now ready to start discovering your IT infrastructure! +## Using SSH + +You can apply updates and perform other menu-related work using SSH **port 404**. Please note that root login has been disabled via SSH. Attempting to access the root will cause the VM to disable itself permanently and is not supported. + ## Next Steps -Install the Device42 [Remote Collector](remote-collector-rc-installation.mdx) and [Windows Discovery Service](windows-discovery-service-installation.mdx) before creating your first discovery job. +Install the Device42 [Remote Collector](../remote-collector-rc-installation.mdx) and [Windows Discovery Service](../windows-discovery-service-installation.mdx) before creating your first discovery job. -You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool. +You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/using-device42/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool. diff --git a/docs/getstarted/installation/installation-vcenter-server.mdx b/docs/getstarted/deploy-device42/installation-guides/installation-vcenter-server.mdx similarity index 83% rename from docs/getstarted/installation/installation-vcenter-server.mdx rename to docs/getstarted/deploy-device42/installation-guides/installation-vcenter-server.mdx index 67475897d..d5dc3fd9b 100644 --- a/docs/getstarted/installation/installation-vcenter-server.mdx +++ b/docs/getstarted/deploy-device42/installation-guides/installation-vcenter-server.mdx @@ -1,6 +1,6 @@ --- title: "vCenter Server - Installation" -sidebar_position: 5 +sidebar_position: 1 --- import ThemedImage from '@theme/ThemedImage' @@ -11,12 +11,13 @@ This guide walks you through installing the Device42 Main Appliance on the VMwar ## Outline of Installation Steps 1. Download and unzip the compressed Device42 virtual appliance. -2. From the vCenter Server interface, select the unzipped `.ovf` file. +2. From the vCenter Server interface, select the unzipped `.ovf` file. 3. Follow the VMware prompts and choose your location, datastore, and NIC. -4. Power on the newly deployed Device42 virtual appliance. +4. Power on the newly deployed Device42 virtual appliance. 5. Log in to the Device42 console using the default credentials and update the credentials. 6. Configure the static IP address from the console. -7. Log in to the Device42 web interface from a browser: `https://FQDN (Fully Qualified Domain Name) or IP-address`. Update the login credentials here as well. +7. Set the time zone and configure NTP. +8. Log in to the Device42 web interface from a browser: `https://FQDN (Fully Qualified Domain Name) or IP-address`. Update the login credentials here as well. ## Illustrated Steps for Installing Device42 on vCenter Server @@ -64,10 +65,10 @@ Log in using the default credentials and change them once you've logged in: ### Configure the Static IP Address From the console, configure the IP address. Use a **static IP** for all production Device42 VMs to avoid connectivity issues. - + ![Device42 VM console menu v19.05](/assets/images/vm-main-menu.png) - Enter your settings on the Device42 IP address configuration screen: + Enter your settings on the Device42 IP address configuration screen: ![IP config options](/assets/images/vm-ip-settings.png) @@ -75,6 +76,10 @@ From the console, configure the IP address. Use a **static IP** for all producti This is an optional step: Create a DNS entry for the new IP address of the virtual appliance. +### Set the Time Zone and Configure NTP + +After setting a static IP address, [set the time zone and configure NTP](/administration/setting-time-zone-and-ntp.mdx) to ensure autodiscovery scheduling and log history work correctly. + ### Log In to the Web Interface Point your browser to `https://FQDN (Fully Qualified Domain Name) or IP-address`. @@ -103,6 +108,6 @@ You can apply Device42 updates and perform other menu-related work using **SSH** ## Next Steps -Install the Device42 [Remote Collector](remote-collector-rc-installation.mdx) and [Windows Discovery Service](windows-discovery-service-installation.mdx) before creating your first discovery job. +Install the Device42 [Remote Collector](../remote-collector-rc-installation.mdx) and [Windows Discovery Service](../windows-discovery-service-installation.mdx) before creating your first discovery job. -You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool. +You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/using-device42/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool. diff --git a/docs/getstarted/installation/installation-xen-or-kvm-using-virt-manager.mdx b/docs/getstarted/deploy-device42/installation-guides/installation-xen-or-kvm-using-virt-manager.mdx similarity index 79% rename from docs/getstarted/installation/installation-xen-or-kvm-using-virt-manager.mdx rename to docs/getstarted/deploy-device42/installation-guides/installation-xen-or-kvm-using-virt-manager.mdx index e691c12bc..f70363940 100644 --- a/docs/getstarted/installation/installation-xen-or-kvm-using-virt-manager.mdx +++ b/docs/getstarted/deploy-device42/installation-guides/installation-xen-or-kvm-using-virt-manager.mdx @@ -1,6 +1,6 @@ --- title: "Xen or KVM Using Virt-Manager - Installation" -sidebar_position: 8 +sidebar_position: 4 --- import ThemedImage from '@theme/ThemedImage' @@ -12,8 +12,9 @@ Install the Device42 Main Appliance on Xen- or KVM-based platforms by following 1. Download the Device42 image and unzip the image using bunzip2. 2. Import the disk image and follow the wizard to create a new virtual machine. -3. Log in to the Device42 console and configure the Main Appliance. -4. Log in to the Device42 Main Appliance from the browser. +3. Log in to the Device42 console and configure the Main Appliance. +4. Set the time zone and configure NTP. +5. Log in to the Device42 Main Appliance from the browser. ## Illustrated Steps of Installing Device42 using Virt-Manager @@ -39,7 +40,7 @@ bunzip2 device42--raw.img.bz2 ![Choosing OS and version](/assets/images/wpid6121-Choosing_OS_and_version.png) -3. Allocate at least 8 GB RAM and 2 vCPUs for production appliances. See [Sizing Recommendations](sizing-recommendations.mdx). +3. Allocate at least 8 GB RAM and 2 vCPUs for production appliances. See [Sizing Recommendations](../sizing-recommendations.mdx). ![](/assets/images/wpid6124-media_1326264722468.png) @@ -57,17 +58,17 @@ bunzip2 device42--raw.img.bz2 Change the default password after signing in to the appliance console. -![IP config options v19.05](/assets/images/vm-ip-settings.png) +3. Configure a static IP address for the Device42 appliance. -You can apply updates and perform other menu-related tasks using SSH. Please note that root login has been disabled. +![IP config options v19.05](/assets/images/vm-ip-settings.png) -* * * +4. (Optional) Create a DNS entry for the new IP address for the new virtual appliance. -You can also create a DNS entry for the new IP address for the new virtual appliance. +You can apply updates and perform other menu-related tasks using SSH. Please note that root login has been disabled. -Access the Device42 web UI by pointing your browser to `https://FQDN(Fully Qualified Domain Name) or IP-address` and logging in with the default credentials: +### Set the Time Zone and Configure NTP -4. (Optional) Create a DNS entry for the new IP address for the new virtual appliance. +After setting a static IP address, [set the time zone and configure NTP](/administration/setting-time-zone-and-ntp.mdx) to ensure autodiscovery scheduling and log history work correctly. ### Log in to the Web Interface @@ -89,6 +90,6 @@ Access the Device42 web UI by pointing your browser to `https://FQDN(Fully Quali ## Next Steps -Install the Device42 [Remote Collector](remote-collector-rc-installation.mdx) and [Windows Discovery Service](windows-discovery-service-installation.mdx) before creating your first discovery job. +Install the Device42 [Remote Collector](../remote-collector-rc-installation.mdx) and [Windows Discovery Service](../windows-discovery-service-installation.mdx) before creating your first discovery job. -You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool. \ No newline at end of file +You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/using-device42/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool. \ No newline at end of file diff --git a/docs/getstarted/installation/installing-the-d42-netflow-collector-as-a-service.mdx b/docs/getstarted/deploy-device42/installing-the-d42-netflow-collector-as-a-service.mdx similarity index 100% rename from docs/getstarted/installation/installing-the-d42-netflow-collector-as-a-service.mdx rename to docs/getstarted/deploy-device42/installing-the-d42-netflow-collector-as-a-service.mdx diff --git a/docs/getstarted/deploy-device42/remote-collector-rc-installation.mdx b/docs/getstarted/deploy-device42/remote-collector-rc-installation.mdx new file mode 100644 index 000000000..46dd12e48 --- /dev/null +++ b/docs/getstarted/deploy-device42/remote-collector-rc-installation.mdx @@ -0,0 +1,50 @@ +--- +title: "Device42 Remote Collector - Installation" +sidebar_position: 12 +--- + +The Remote Collector (RC) is shipped as a virtual appliance and can be downloaded from our [**Autodiscovery** software download page](https://www.device42.com/autodiscovery/). + +This guide provides step-by-step instructions for configuring your Remote Collector after initial deployment. + +## Step 1: Change User Password + +1. Navigate to the Virtual Machine console of the Remote Collector Appliance. +2. Log in using the default credentials (Username is `client` and Password is `device42`). +3. Choose option **(p)** to enter the **Change Password (user client)** menu. +4. Enter and verify the new password. +5. Choose the **Save** button. + +## Step 2: Specify Hostname + +1. Choose option **(s)** to enter the **Server Settings** menu. +2. Enter a hostname. +3. Choose the **Save** button. + +## Step 3: Configure the Network Interface + +1. Choose option **(u)** to enter the **Network, Connectivity and Utilities** menu. +2. Choose option **(n)** to enter the **Network Interfaces** menu. +3. Select the default interface (highlighted in white) and press Enter. +4. If using a Static IP, deselect **Use DHCP** and enter the IP Address, Subnet, Gateway, and DNS server(s). If using IPv6, specify the IPv6 Address and Gateway. +5. Choose **Save**, then **Exit**, then **Exit**. + +## Step 4: Configure the NTP Settings + +1. Choose option **(n)** to enter the **NTP Client Settings** menu. +2. Ensure **Daily sync** is chosen. +3. Optionally choose to sync on reboot (this enables an admin to reboot the RC within the Device42 interface, which can help resolve unusual RC behavior). +4. Choose **Manual Sync** should you choose to perform a manual sync now, else choose the **Save** button. + +## Step 5: Connect the Remote Collector to the Main Appliance + +1. Choose option **(r)** to enter the **Remote Collector Setup** menu. +2. Enter the name of the Remote Collector. +3. Enter either the Hostname or IP Address of the Main Appliance. +4. Generate a One Time Password (OTP) from the Main Appliance, which will be entered later into this menu: + - Log into the Main Appliance. + - Choose **Discovery > Remote Collectors**. + - Click the **Generate OTP** button. +5. Enter the OTP. +6. Choose the **Register** button. Note the green acknowledgement text at the top of the main Appliance Management menu. +7. Navigate back to the Main Appliance and confirm the RC in the Remote Collectors menu shows a State of "connected". diff --git a/docs/getstarted/deploy-device42/resource-and-deployment-architecture-overview.mdx b/docs/getstarted/deploy-device42/resource-and-deployment-architecture-overview.mdx new file mode 100644 index 000000000..48e36a222 --- /dev/null +++ b/docs/getstarted/deploy-device42/resource-and-deployment-architecture-overview.mdx @@ -0,0 +1,35 @@ +--- +title: "Resource and Deployment Architecture Overview" +sidebar_position: 1 +--- + +The Main Appliance (MA), Remote Collectors (RCs), and Windows Discovery Service (WDS) all play a role in discovering your IT environment. + +Device42 is deployed in a hub-and-spoke architecture; each RC/WDS collects data and syncs it back to the centralized MA. It is typically recommended for RCs and WDS instances to be deployed in pairs, if Windows discovery is required. + +Device42 consists of the Main Appliance, one or more Remote Collectors (RCs), and a Windows Discovery Service (WDS). The Main Appliance is an interface for configuring and running discovery jobs, viewing and managing discovered Configuration Items (CIs), generating reports, and managing any third-party integrations. + +The image below depicts a Production environment consisting of one Main Appliance and two sets +of Remote Collectors and Windows Discovery Service instances. + +![](/assets/images/deployment-architecture.png) + +:::tip +Click [here](https://device42.wistia.com/medias/o5rvpixfmw) to view a video describing the architecture depicted in the above image. +::: + +It is critical that network settings are correctly configured and firewall rules properly enabled +to grant appropriate access permissions while adhering to the principle of least privilege. +Once configured, we strongly recommend you perform connectivity tests to confirm these +changes were successfully made. + +A reference list of all ports used to gain access to targets to be discovered can be found [here](/getstarted/deploy-device42/discovery-port-configurations.mdx). It is **critical to provide this link to network personnel** so they can ensure the necessary ports are open so Device42 can discover your infrastructure. + +### Where do I put this stuff? + +:::caution +Device42 is delivered as a virtual appliance. Root access to the appliance is not supported, and the VM will cease to function if you attempt to break into the root account. +::: + +Manage the Main Appliance using the [Appliance Manager (AM)](/administration/appliance-manager/index.mdx), from which you can restart and stop the Device42 application, generate logs or SNMP walks for tech support, and more. + diff --git a/docs/getstarted/installation/security-posture-and-high-level-permissions.mdx b/docs/getstarted/deploy-device42/security-posture-and-high-level-permissions.mdx similarity index 100% rename from docs/getstarted/installation/security-posture-and-high-level-permissions.mdx rename to docs/getstarted/deploy-device42/security-posture-and-high-level-permissions.mdx diff --git a/docs/getstarted/installation/sizing-recommendations.mdx b/docs/getstarted/deploy-device42/sizing-recommendations.mdx similarity index 74% rename from docs/getstarted/installation/sizing-recommendations.mdx rename to docs/getstarted/deploy-device42/sizing-recommendations.mdx index a6559b7be..7a6c83f3f 100644 --- a/docs/getstarted/installation/sizing-recommendations.mdx +++ b/docs/getstarted/deploy-device42/sizing-recommendations.mdx @@ -12,3 +12,10 @@ The sizing requirements depend on the size of the environment and the Device42 f | One Main Appliance (virtual appliance) | **Small to medium environments (\<2500 devices):**
- Four vCPU
- 16GB RAM
- 150GB vDisk (SSD or flash disk recommended)

**Medium to large environments (>2500 devices):**
- 16 vCPU
- 64GB RAM
- 150GB vDisk (SSD or flash disk recommended)

For any environments that include Application Dependency Mapping (ADM), Resource Utilization (RU), or Storage discovery, follow the medium to large environment guidelines | | Remote Collector(s) (virtual appliance) | **One RC per 1000 workloads:**
- Two vCPU
- 4GB RAM
- 50GB vDisk | | Windows Discovery Service (.NET installer) | **One WDS per 1000 workloads:**
- Two vCPU
- 8GB RAM
- 50GB vDisk (minimum) | + +Depending on your environment, we may recommend a dedicated resource pool for the virtual appliance to ensure there is no resource contention. + +Device42 utilizes a database within the virtual appliance we recommend solid-state storage, or similar storage optimized for database operations. + +For Windows infrastructure, Device42 requires a WDS to be installed on one machine per discovery +segment/Remote Collector. diff --git a/docs/getstarted/installation/windows-discovery-service-installation.mdx b/docs/getstarted/deploy-device42/windows-discovery-service-installation.mdx similarity index 100% rename from docs/getstarted/installation/windows-discovery-service-installation.mdx rename to docs/getstarted/deploy-device42/windows-discovery-service-installation.mdx diff --git a/docs/getstarted/installation/windows-service-installation.mdx b/docs/getstarted/deploy-device42/windows-service-installation.mdx similarity index 98% rename from docs/getstarted/installation/windows-service-installation.mdx rename to docs/getstarted/deploy-device42/windows-service-installation.mdx index 4f3fbf7af..a135043eb 100644 --- a/docs/getstarted/installation/windows-service-installation.mdx +++ b/docs/getstarted/deploy-device42/windows-service-installation.mdx @@ -12,7 +12,7 @@ The Device42 Windows Service Wrapper is an executable (available separately for You will need three separate files to install the service. -1. **The service executable itself**: This is named `d42_winservice_P_V.exe`. Its default path is `C:\Program Files\Device42`. +1. **The service executable itself**: This is named `d42_winservice_x64_v1_0_0.exe`. Its default path is `C:\Program Files\Device42`. 2. **The d42config.json file**: This dictates the various settings needed to run the service. Its default path is `C:\ProgramData\Device42`. 3. **The agent executable**: This is called `d42_winagent_x(bit).exe`. It can be downloaded from the Device42 MA under **Discovery > Agent Based Scans (Win7+)**. diff --git a/docs/getstarted/display.mdx b/docs/getstarted/display.mdx new file mode 100644 index 000000000..d128b8d1c --- /dev/null +++ b/docs/getstarted/display.mdx @@ -0,0 +1,78 @@ +--- +title: "Display" +sidebar_position: 6 +--- + +In the Display phase you will translate your validated, discovered data into actionable intelligence through various reporting and visualization capabilities, empowering users to make informed business decisions and integrate Device42 into their operational workflows. + +:::tip +This is the fourth and final phase (Display) in the Device42 implementation process. See [How is Device42 Implemented?](/getstarted/how-is-device42-implemented.mdx) for an overview of all four phases. +::: + +## Report and Dashboard Overview + +There are two main types of Device42 reporting: Standard and Insights+. + +### Standard Reports + +Standard Reports is the first place you will look for information. You can use and modify pre-defined reports, list reports, guided reports, and even use our Device42 Object Query Language (DOQL) if you are so inclined. You can export and schedule Standard Reports. + +Click [here](/reports/reports/standard-reports.mdx) for more information about Standard Reports. + +:::tip +To view a video on ensuring success with Standard Reports, click [here](https://device42.wistia.com/medias/fm3qxr3oxw). +::: + +### Insights+ + +Device42's Insights+ provides integrated analytics that leverage the breadth and depth of Device42 discovery to help you make sense of your data through visuals and dashboards so that you can make better, more informed business decisions. + +Insights+ identifies patterns, trends, and outliers in data sets across your entire estate, elevating your performance with data understanding. + +Click [here](/reports/reports/insights-plus.mdx) for more information about Insights+. + +:::tip +To view a video on ensuring success with Insights+, click [here](https://device42.wistia.com/medias/v1l5vahmem). +::: + +### Reports Summary + +Below is a summary of each of the three Device42 reporting mechanisms: + +- Standard Reports likely represent fundamental, day-to-day reporting +- Insights+ offers advanced visualizations and out-of-the-box dashboards to deliver comprehensive IT operational intelligence and support strategic business decisions + +## Reporting Reference Material + +In addition to the above report links, below are links to additional reporting documentation: + +- We have created a [Data Building Blocks Cookbook](/reports/dbb-cookbook/index.mdx) that provides the 'recipes' to more easily create and run report-based queries. +- The [Database Viewer Schema](/reports/device42-doql/db-viewer-schema.mdx) page explains how to view Device42's Entity Relationship Diagram and Data Dictionary. +- The [InsightsAI Chat](/reports/device42-doql/insightsai.mdx) page explains how to use natural language descriptions to generate DOQL queries and tailored reports. + +## Key Customer Reporting Responsibilities + +You and/or others in your organization will be responsible for completing specific tasks in order to ensure your organization receives tangible value from the data Device42 discovers. These responsibilities include the following: + +- **Complete Device42 Reporting Course:** It is critical that you and/or others complete the Device42 Reporting course so you understand Device42's reporting capabilities and methods. +- **Define and Document Reporting Needs:** Your organization invested in Device42 so it can provide visibility to address specific needs. By understanding those business needs, coupled with the knowledge of the data Device42 has discovered and the Device42 reporting capabilities, you or others must define and document the specific reports that will provide your organization with the required visibility. This is critical, whether these reports will be created by your organization, by Device42 Customer Success, or by a certified Device42 partner. +- **Create and Customize Dashboards/Reports:** Once your organization's reporting needs are identified, you must facilitate the creation of these Dashboards and Reports. +- **Review and Confirm Dashboards/Reports:** You are responsible for reviewing the configured dashboards and reports to verify all necessary data visualizations (charts, graphs, maps) accurately represent the discovered infrastructure data. + +## Display Phase Checklist + +The Display phase is considered complete when: + +- You have a comprehensive understanding of Device42's reporting capabilities through the Device42 Academy's reporting training courses and by reviewing online Device42 reporting documentation. +- You have educated key stakeholders and main users regarding both Device42's standard reports plus its reporting capabilities +- You have defined and documented the key reporting requirements to address your organization's business needs. +- You have configured existing dashboards/reports and/or created new dashboards/reports to meet your organization's business needs. +- You have verified all dashboards (including charts, graphs, maps, and so on) and reports accurately reflect your discovered infrastructure. + +## Conclusion + +Congratulations, You have completed the base Device42 implementation! Based on our experience working with customers, we expect you may have additional requirements, including integrating Device42 with other applications and systems, as well as expanding the use of Device42 to help your organization achieve additional objectives. + +Please contact [Device42 Support](https://support.device42.com/) should you encounter any issues, and please contact your Account Representative or your Customer Success Manager should you require assistance with any non-support matters. + +Please also use [Additional Customer Resources] for a list of links that can assist you with your Device42 journey. diff --git a/docs/getstarted/faqs/_category_.yml b/docs/getstarted/faqs/_category_.yml deleted file mode 100644 index ad968574f..000000000 --- a/docs/getstarted/faqs/_category_.yml +++ /dev/null @@ -1,4 +0,0 @@ -position: 0.5 -label: 'FAQs' -collapsible: true -collapsed: true diff --git a/docs/getstarted/getting-started-with-auto-discovery.mdx b/docs/getstarted/getting-started-with-auto-discovery.mdx index 81808f11e..066e88c94 100644 --- a/docs/getstarted/getting-started-with-auto-discovery.mdx +++ b/docs/getstarted/getting-started-with-auto-discovery.mdx @@ -1,32 +1,100 @@ --- -title: "Getting Started with Autodiscovery" -sidebar_position: 2 +title: "Discover" +sidebar_position: 4 --- import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -The following guide briefly walks you through creating various network objects with Device42 Autodiscovery. +In the Discover phase you will configure, execute, and schedule jobs that discover your IT landscape and collect and store the associated data. These discovery jobs systematically scan and inventory your IT infrastructure, using Device42's automatic discovery capabilities to populate the database. This includes everything from network devices to software, applications, and storage. + +:::tip +This is the second phase (Discover) in the Device42 implementation process. See [How is Device42 Implemented?](/getstarted/how-is-device42-implemented.mdx) for an overview of all four phases. +::: + +This phase is broken down into four tasks: +- **Task 1:** Prepare for Discovery Jobs +- **Task 2:** Create and Run Discovery Jobs +- **Task 3:** Verify Discovery Jobs +- **Task 4:** Schedule Discovery Jobs + +Note that the Verify and Schedule tasks can be performed immediately following Task 2 (Create and Run Discovery Jobs for each discovery job) instead of validating and scheduling after running all the discovery jobs. ## Getting Started with Device42 Videos If you're new to Device42, begin with our [**Getting Started videos**](https://www.youtube.com/playlist?list=PLJ9je_qSNumJ-rMzIXUufY-XsbrwWfeCR). In under five minutes, you'll learn how to set up your Remote Collector (RC), connect a Windows Discovery Service (WDS) instance to it, and run your first discovery job. [Watch them now](https://www.youtube.com/watch?v=ClkvR9zLQUU&t=0s&list=PLJ9je_qSNumJ-rMzIXUufY-XsbrwWfeCR&index=2) and you'll be an expert in no time! -Ready to learn more? If you prefer videos, visit the [Device42 **How To** playlist on YouTube](https://www.youtube.com/playlist?list=PLJ9je_qSNumJ4HuNVS75wzRgBRrtCh6_q) or the [How-To Videos](how-to-videos/index.mdx) in the documentation. +Ready to learn more? If you prefer videos, visit the [Device42 **How To** playlist on YouTube](https://www.youtube.com/playlist?list=PLJ9je_qSNumJ4HuNVS75wzRgBRrtCh6_q) or the [How-To Videos](/how-to-videos/index.mdx) in the documentation. -If you can't find the answer you're looking for, please email [support@device42](mailto:support@device42) and let us know. There's a good chance other people are wondering the same thing, and we'll be happy to create a new video. +If you can't find the answer you're looking for, please email [support@device42.com](mailto:support@device42.com) and let us know. There's a good chance other people are wondering the same thing, and we'll be happy to create a new video. -## Autodiscovery Account Notice +## Discovery Job Best Practices -:::caution -Please **do not** set up an autodiscovery scan using critical production account credentials. Instead, create a separate, dedicated account to use only for discovery. -::: +Below is a list of basic discovery job best practices. While [this list](/auto-discovery/autodisc-best-practices.mdx) is long, discovery is the foundation of Device42, and it is therefore important that you understand and implement these best practices. We recommend you refer back to this list often. + +### Discovery Job Best Practices: Discovery Job Planning + +1. **Limit your discovery focus:** There are a variety of discovery jobs and it is tempting to immediately run as many as possible. Focus on the jobs that will deliver the maximum value to your organization; these typically include jobs like SNMP, Virtualization, Windows, Linux and Unix, Cloud, Storage, and Certificate. You can run additional discovery jobs once the core jobs have been created and scheduled. + +2. **Organize your discovery jobs:** There are different discovery job types (for example SNMP, Hypervisor, Windows, Linux, Cloud, Storage, and so on) and each of these will likely have multiple jobs based on location, Data Center, Region, and so on, or due to the large number of items to be discovered. Consider how you want to organize each discovery job type. For example, you may conclude it is best to have a separate Windows discovery job for each location or Data Center. Take into account the recommended maximum number of devices a Remote Collector supports when organizing your jobs. + +3. **Adopt a standard discovery job naming convention:** Name each discovery job so they are easily understandable, are consistent, and can be sorted in a way that will be useful. + + +### Discovery Job Best Practices: Discovery Job Configuration + +1. **Do not set up an autodiscovery scan using critical production account credentials**; create a separate, dedicated account used only for discovery. Account lock-out could result in an otherwise avoidable outage depending on your permissions and configured password policies. You as a customer are responsible for any such behavior. + +2. **Always leverage a Remote Collector** when performing discovery jobs. Note this is required when scanning networks larger than `/24`, using Nmap and leveraging any of our modular offerings such as: Application Dependency Mapping (ADM), Resource Utilization (RU), Storage Discovery, and Power and Environmental Monitoring. + +3. For each discovery job, **be as specific as possible** in terms of defining your discovery targets (for example, your devices), excluding any targets that should not be discovered. Doing so will reduce the number of discovery failures. + +4. **Do not exceed the largest recommended network range of `/16`**, which includes 65,534 IP addresses. Adding more than the recommended range may either yield inconsistent discovery results or lengthen the time required for the discovery job to complete. + +5. Break down larger subnets into smaller subnets, and leverage additional RCs to optimize discovery performance for larger environments. + +### Discovery Job Best Practices: Discovery Job Scheduling + +1. **Schedule your discovery jobs**. Discovery jobs that are created, run once, and never scheduled to run again result in stale information and an inaccurate inventory. + +2. **Confirm job health before scheduling**. Make sure your discovery jobs return the expected data before you schedule them to run. + +3. **Schedule discovery jobs to run with the level of frequency required** to keep your data current. Different jobs will require different frequencies based on their rate of data change. + +4. **Confirm that scheduled discovery jobs are complete before they are scheduled to run next**. For example, a discovery job scheduled to run every four hours completes in less than four hours. + +5. **Avoid running jobs during high network traffic hours**; this can reduce impact to network performance. + +6. When running multiple jobs during a day, **schedule them to run evenly throughout the day**. If you cannot run jobs during primary business or production hours, spread them across non-peak, non-business hours as evenly as possible. + +7. Regularly view the **Scheduled Job Distribution Status** report to ensure your jobs are not overloaded (**Insights+ > System Administration > Scheduled Job Distribution Status**). + +## Task 1: Prepare for Discovery Jobs -Depending on the permissions granted and your configured password policies, account lockout could result in an otherwise completely avoidable outage. You, the customer, are responsible for any such behavior that might result. +### 1.1 Collect and Store Discovery Credentials -## Creating Subnets +Credentials ([Secrets](/administration/passwords/password-security-and-permissions.mdx)) are frequently required when performing agentless Discovery; you specify them when creating discovery jobs. It is important to store the correct credentials in Device42 so you can reference them for jobs that require them. -Go to **Resources > Networks > All Subnets** and click **Create** in the top-right corner. +Incorrect credentials is a common reason why discovery jobs do not successfully complete. Make sure you have the correct credentials and that you enter them correctly. + +Here are some examples of credentials required for common discovery jobs: +- **SNMP Discovery:** Requires SNMP Community String (SNMP GET read account) +- **Linux Discovery:** Requires SSH Login +- **Windows Discovery:** Requires Windows Services Account (WMI access to devices) + +Secrets are centrally stored in **Resources > Secrets > All Secrets**; note they are only visible to the user who created them but can be shared. + +### 1.2 Create Subnets + +Adding subnets helps you define the network scope as you discover your network(s) and also reduces the number of `undefined 0.0.0.0` network types. + +To add your Subnets, perform the following steps: +1. Go to **Resources > Networks > All Subnets** and click **Create** in the top-right corner. +2. Enter an IPv4 or IPv6 address into the **Network** field. +3. Enter the **Mask Bits** (omit the `/`). +4. Enter the **Service Level**. +5. Review the remaining options and choose the items that best fit your needs. +6. Click the **Save** button. SNMP** and click **Create** to create a [SNMP/Network discovery job](auto-discovery/network-auto-discovery.mdx). This will build out a base for the rest of your network. +| Order | Discovery | Description | +|-------|-----------|-------------| +| 1 | Network (SNMP) | Uses Simple Network Management Protocol (SNMP) to build your L2 Network landscape by discovering and gathering information from network devices such as switches, routers, and printers, collecting hardware and connectivity details. Use [this document](/auto-discovery/network-auto-discovery.mdx) to help get you started. | +| 2 | Virtual Machine | V-Server autodiscovery collects data from hypervisors such as VMware, Citrix Xen, libvirt, and oVirt. Use [this document](/auto-discovery/virtual-machine-auto-discovery.mdx) to help get you started. | +| 3 | Windows/Hyper-V | Brings in Windows and Hyper-V machines, performing deep discovery on Hypervisors, and Windows OS using WMI and WinRM protocols. It collects comprehensive hardware and software details and discovers virtualization platforms such as VMware, Hyper-V, and others. It gathers information about virtual machines, hosts, and their configurations. Use [this document](/auto-discovery/windows-and-hyper-v-auto-discovery.mdx) to help get you started. | +| 4 | Linux | Brings in host information, parts, OS, Service processes, and installed software and applications and configuration files for Linux and Unix machines. Use [this document](/auto-discovery/linux-unix-server-auto-discovery.mdx) to help get you started. | +| 5 | Cloud | Brings in virtual machines and storage in Amazon Web Services, Microsoft Azure, Cloudstack, Openstack, and numerous other platforms. Discovers infrastructure and resources in various cloud environments such as AWS, Azure, Google Cloud, and Alibaba Cloud. It collects detailed information about the cloud assets and their configurations. Use [this document](/auto-discovery/cloud-auto-discovery/index.mdx) to help get you started. | +| 6 | Storage | Discovers Storage Arrays for on premise storage solutions, using the appropriate API for the vendors required. Detailed information of Controllers, LUNs, Storage Pools and Disks in use. Connected to the appropriate hypervisors and file servers with a breakdown of usage. Use [this document](/auto-discovery/storage-arrays-autodiscovery/index.mdx) to help get you started. | +| 7 | Certificate | Scans and discovers SSL certificates across your network. It gathers information about the certificates and alerts you before they expire. Use [this document](/infrastructure-management/certificate-management.mdx) to help get you started. | +| 8 | Warranty Sync | Syncs with vendors like Dell, IBM, Lenovo, and Meraki to pull in warranty information for discovered devices using their service tags and serial numbers. This helps in tracking device warranties and managing end-of-life replacements. Use [this document](/auto-discovery/warranty-autodiscovery.mdx) to help get you started. | +| 9 | UCS/Load Balancer | Discovers Cisco Unified Computing System (UCS) and Application Centric Infrastructure (ACI) environments, as well as load balancers like F5. It collects detailed configuration and performance data. Use [this document](/auto-discovery/load-balancer-f5-autodiscovery/#load-balancer-discovery) to help get you started. | -Then, move on to vServer discovery, followed by Windows/Linux server discovery, and more. +### 2.1 Create SNMP Discovery Jobs -:::info -See the [Autodiscovery Best Practices](auto-discovery/autodisc-best-practices.mdx) for recommendations on the order in which to run initial discoveries. If you're already familiar with these practices, jump right into [SNMP/Network discovery](auto-discovery/network-auto-discovery.mdx). -::: +SNMP discovery jobs capture network equipment data per unique IP Address, CIDR block, or IP Range responding to SNMP get requests on Port 161. + +SNMP discovery will discover network switches, storage switches, basic SAN details, management interfaces (iLO, iDRAC, and so on) and load balancer details. The Main Appliance will then federate newly discovered devices and details with other configuration items in Device42 allowing you to map connectivity across the network. The SAN discovery will also allow you to see which SANs are attached to a fiber switch when their WWNs are discovered. Discovery of various management interfaces will bring in BMC details and associate them with their affiliated hypervisor/bare-metal servers in Device42. + +Device42 supports SNMP v1, v2c and v3. + +**Port and Credential Requirements** + +**Ports:** UDP Port 161 should be accessible on any of the SNMP targets from the Device42 Remote Collectors. + +**Credentials:** Read-only credentials are required for SNMP discovery jobs. + +**Steps to Create and Run an SNMP Discovery Job** + +To create and run an SNMP Discovery Job, perform the following steps: +1. Navigate to **Discovery > SNMP**. +2. Click the **Create** button. +3. Enter the **Job name**. +4. Select the **Remote Collector**. +5. Enter the **Server or Servers**, **CIDR Block**, or **IP Range**. +6. Review the remaining options and choose the items that best fit your needs. +7. Add the credentials. +8. Click the **Save** button. +9. Click the checkbox next to the discovery job(s) and choose **Actions > Run Selected Jobs**. -## The Unknown Device Type +Click [here](/auto-discovery/network-auto-discovery.mdx) for more detail regarding SNMP Network Autodiscovery. This should be your first place to look when troubleshooting SNMP discovery job issues. + +:::tip +To view a video on creating an SNMP discovery job, click [here](https://device42.wistia.com/medias/z6ax2z6hwm). +::: + +### 2.2 Create Hypervisor Discovery Jobs + +Hypervisor discovery jobs discover the Virtual Systems on the Hypervisor Platform, including ESX and ESXi, Citrix XenServer, HyperV, oVirt, Redhat, KVM/libvirt, OpenVZ, AIX HMC, Nutanix Prism, Nutanix Prism Central, Docker, and LXC. + +Click [here](/auto-discovery/hypervisors-and-containers-supported-in-auto-discovery.mdx) for a full list of supported Platforms. + +**Port and Credential Requirements** + +**Ports:** For **VMWare**, TCP port 443 should be accessible from the Remote Collectors to the Hypervisors. **Other Hypervisors** leverage APIs over HTTPS, or SSH over a user-definable port for discovery. + +**Credentials:** For **VMWare**, Read-only API account with access to vCenter or the target infrastructure is sufficient. + +**Steps to Create and Run a Hypervisor Discovery Job** + +To create and run a Hypervisor discovery job, perform the following steps: +1. Choose **Discovery > HyperVisors / \*nix / Windows**. +2. Click the **Create** button. +3. Enter the **Job name**. +4. Select the **Remote Collector**. +5. Select the **Hypervisor Platform** (for example, VMWare). +6. Select the **URL prefix** (for example, HTTP or HTTPS). +7. Enter the **Server or Servers**, **CIDR Block**, or **IP Range**. +8. Add the Discovery Target(s) Credential(s) (that is, Username and Password). +9. Review the remaining options and choose the items that best fit your needs. +10. Click the **Save** button. +11. Click the checkbox next to the discovery job(s) and choose **Actions > Run Selected Jobs**. + +Click [here](/auto-discovery/hypervisors-and-containers-supported-in-auto-discovery.mdx) for more detail regarding Hypervisor Autodiscovery. This should be your first place to look when troubleshooting Hypervisor discovery job issues. + +:::tip +To view a video that discusses Best Practices for Hypervisor discovery jobs, click [here](https://device42.wistia.com/medias/m4m5pvper8). +::: + +### 2.3 Create Windows Discovery Jobs + +Windows discovery jobs provide an accurate inventory of the Windows devices on your target network. + +While your virtual infrastructure can be discovered via VMWare, Hypervisor, etc. discovery jobs, Windows discovery jobs perform an OS-level discovery of your Windows devices, including your virtual Windows servers. Windows Discovery of physical infrastructure can be done either via Windows Management Instrumentation (WMI), an older and less secure discovery method, or Windows Remote Management (WinRM), which is newer and more secure. + +**Port and Credential Requirements** + +There are a number of prerequisites and requirements for Windows discovery jobs to run properly, including WinRM Network Requirements, WMI Network Requirements, WMI and Windows Permissions, and Port Requirements. **It is imperative that the prerequisites and the requirements are met prior to running Windows discovery jobs.** + +Click [here](/auto-discovery/windows-and-hyper-v-auto-discovery.mdx#permission-requirements-for-wmi-and-windows) for these requirements and prerequisites, and also for more detailed instructions on creating and running Windows discovery jobs. This should be your first place to look when troubleshooting Windows discovery job issues. + +**Steps to Create and Run a Windows Discovery Job** + +To create and run a Windows discovery job, perform the following steps: +1. Choose **Discovery > HyperVisors / \*nix / Windows**. +2. Click the **Create** button. +3. Enter the **Job name**. +4. Select the **Remote Collector**. +5. Select the **Windows Platform**. +6. Enter the **Server or Servers**, **CIDR Block**, or **IP Range**. +7. Add the Discovery Target(s) Credential(s) (that is, Username and Password). +8. Review the remaining options and choose the items that best fit your needs. +9. Click the **Save** button. +10. Click the checkbox next to the discovery job(s) and choose **Actions > Run Selected Jobs**. + +**Note:** + +- There are sometimes failures when discovering Windows operating system-based devices. Use the [Windows Discovery Troubleshooting](/auto-discovery/windows-discovery-troubleshooting.mdx) guide to help you investigate and resolve these failures. If you are unable to resolve these failures, please contact Device42 Support for assistance. +- Organizations that have purchased the Software License Management module can include Software discovery when running Windows discovery jobs by clicking the **Discover Software** checkbox within the Software and Applications section of the job. For more information regarding Software License Management with Device42, see the Software License Management Discovery Jobs section later in this document. +- Do not initially configure Windows discovery jobs to collect ADM information. There are two reasons for this: **1)** You may inadvertently consume your ADM licenses by discovering the wrong devices. **2)** We recommend you wait ~30 days before enabling ADM. + + - Set **ADM Sampling** to **Off**. Note: This is enabled by default when licensed for Enterprise Application Discovery and Services Discovery. If you do not set ADM Sampling to **Off** you will have to perform multiple 'cleanup' steps. + + + + - In **Software and Applications**, click **Show** and make sure that **Discover Services** and **Discover Applications** checkboxes are unchecked. + + + + +:::tip +To view a video on creating a Windows discovery job, click [here](https://device42.wistia.com/medias/mbiz7vjio4). + +To view a video on troubleshooting common Windows discovery job issues, click [here](https://device42.wistia.com/medias/olx0ryzrf2). +::: + +### 2.4 Create Linux and Unix Discovery Jobs + +Linux and Unix discovery jobs provide an accurate inventory of the Linux and Unix devices on your target network and discover your \*nix physical and virtual infrastructure. + +**Port and Credential Requirements** + +**Ports:** Device42 will, by default, use the standard SSH port 22 to target your Linux and Unix infrastructure. If your organization uses a non-standard SSH port you can specify this port in the discovery job. + +**Credentials:** Several of the commands that are run invoke `sudo` for escalated privileges. This is avoided when possible, but is sometimes necessary to determine certain information for a comprehensive discovery. + +Click [here](/auto-discovery/linux-unix-server-auto-discovery.mdx) for more detail regarding Linux and Unix Autodiscovery. This should be your first place to look when troubleshooting Linux and Unix discovery job issues. + +**Steps to Create and Run a Linux or \*nix Discovery Job** + +To create and run a Linux or \*nix discovery job, perform the following steps: +1. Choose **Discovery > HyperVisors / \*nix / Windows**. +2. Click the **Create** button. +3. Enter the **Job name**. +4. Select the **Remote Collector**. +5. Select the **\*nix Platform**. +6. Enter the **Server or Servers**, **CIDR Block**, or **IP Range**. +7. Enter the **Port** (if default port 22 is not being used). +8. Add the Discovery Target(s) Credential(s) (that is, Username and Password). +9. Review the remaining options and choose the items that best fit your needs. +10. Click the **Save** button. +11. Click the checkbox next to the discovery job(s) and choose **Actions > Run Selected Jobs**. + +**Note:** Organizations that have purchased the Software License Management module can include Software discovery when running *nix discovery jobs (as well as other platforms like Classic WinRM, IBM i/AS400, IBM z/OS, and SCCM) by clicking the **Discover Software** checkbox within the Software and Applications section of the job. For more information regarding Software License Management with Device42, see the [Software License Management Discovery Jobs](#software-license-management-discovery-jobs) section later in this document. + +:::tip +To view a video on creating a Linux discovery job, click [here](https://device42.wistia.com/medias/rfsh34oii8). +::: + +### 2.5 Create Cloud Discovery Jobs + +Cloud discovery jobs discover your infrastructure in AWS, Azure, Google Cloud, and other cloud providers and inventory your cloud infrastructure from available cloud solutions: AWS, Azure, GCP, Alibaba Cloud, Amazon API, Digital Ocean, Intune, Linode, Open stack, Oracle Cloud and Standalone Kubernetes. + +**Port and Credential Requirements** + +**Ports:** Cloud infrastructure discovery is performed using HTTPS over port 443. + +**Credentials:** Required credentials vary by Cloud Provider. + +- **AWS** + - Dynamic and Static Account Discovery are supported using both IAM users and EC2 instance Profiles +- **Microsoft Azure** + - Require Subscription ID (not required when performing Tenant wide discovery) + - Tenant ID Credentials (Username/Password or Service Principle ClientID/Client Secret Value) +- **Google Cloud** + - Project ID (leave blank if doing multi project discovery) + - Service Account with viewer role and a Service Account key (JSON key file) +- **Kubernetes Cluster** + - Basic Authentication (Username/Password) OR + - Bearer Token (Username and token string) OR + - The User or Service Account will need view permissions to any desired pods or applications or view cluster wide. + +Click [here](/auto-discovery/cloud-auto-discovery/index.mdx) for more detail regarding Cloud Autodiscovery. This should be your first place to look when troubleshooting Cloud discovery job issues. + +Click the following links for discovery details for [AWS](/auto-discovery/cloud-auto-discovery/aws-autodiscovery.mdx), [MS Azure](/auto-discovery/cloud-auto-discovery/azure-autodiscovery.mdx), [Google Cloud](/auto-discovery/cloud-auto-discovery/google-cloud-platform-autodiscovery.mdx), and [Kubernetes](/auto-discovery/cloud-auto-discovery/kubernetes-autodiscovery.mdx) Cloud discovery jobs. Regarding Kubernetes, click [here](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#service-account-permissions) for information regarding provisioning a Service Account. + +**Steps to Create and Run a Cloud Discovery Job** + +To create and run a Cloud discovery job, perform the following steps: +1. Choose **Discovery > Cloud**. +2. Click the **Create** button. +3. Enter the **Job name**. +4. Select the **Cloud Type** and **Vendor(s)**. +5. Select the **VRF Group**. +6. Select the **Remote Collector**. +7. Enter the appropriate cloud credentials (varies depending on platform). +8. Enter the **Server or Servers**, **CIDR Block**, or **IP Range**. +9. Review the remaining options and choose the items that best fit your needs. +10. Click the **Save** button. +11. Click the checkbox next to the discovery job(s) and choose **Actions > Run Selected Jobs**. + +### 2.6 Create Storage Array Discovery Jobs + +Storage Array discovery jobs identify and return Storage Array resource details, related resources, and topology maps for a wide range of storage platforms. + +Click [here](/auto-discovery/storage-arrays-autodiscovery/index.mdx) for more detail regarding Storage Arrays Autodiscovery, including the list of supported platforms. This page also contains links to additional information about access protocols and minimum permissions for [Dell/EMC Arrays](/auto-discovery/storage-arrays-autodiscovery/dell-emc-autodiscovery.mdx), [HP Arrays](/auto-discovery/storage-arrays-autodiscovery/hp-autodiscovery.mdx), [IBM Arrays](/auto-discovery/storage-arrays-autodiscovery/ibm-autodiscovery.mdx), as well as [All Other Storage Arrays](/auto-discovery/storage-arrays-autodiscovery/all-other-storage-autodiscovery.mdx). It also contains more detail on creating new Storage Array discovery jobs. This should be your first place to look when troubleshooting Storage Array discovery job issues. + +**Steps to Create and Run a Storage Arrays Discovery Job** + +To create and run a Storage Arrays discovery job, perform the following steps: +1. Choose **Discovery > Storage Arrays**. +2. Click the **Create** button. +3. Enter the **Job name**. +4. Select the **Remote Collector**. +5. Select the **Platform** (e.g. Netapp). +6. Enter the **Server or Servers**, **CIDR Block**, or **IP Range**. +7. Select the **Target Type** (values dependent on selected Platform). +8. Select the **Protocol Type** (values dependent on selected Platform). +9. Check or uncheck **Enable Performance Data Collection**. +10. Select the **Performance Data Sampling Interval**. +11. Select the **Action for Storage Array not found** (keep or delete Array Resource). +12. Add the Discovery Target(s) Credential(s) (that is, Username and Password). +13. Review the remaining options and choose the items that best fit your needs. +14. Click the **Save** button. +15. Click the checkbox next to the discovery job(s) and choose **Actions > Run Selected Jobs**. + +Click [here](/auto-discovery/storage-arrays-autodiscovery/storage-arrays.mdx) to view more information about Storage Arrays, including viewing and editing storage arrays, viewing arrays mapped to devices, viewing storage resource maps and trend graphs, and importing and exporting Storage Array discovery jobs. + +### 2.7 Create Certificates Discovery Jobs + +Certificates discovery jobs provide detailed information on https SSL certificates, including expiration dates, which is helpful for business continuity. + +Click [here](/auto-discovery/certificate-auto-discovery.mdx) for more detail regarding Certificates Autodiscovery, including creating a Certificates discovery job, SSL Certificate Cipher Suite Discovery, and discovery risks when multitenancy is enabled. This should be your first place to look when troubleshooting Certificates discovery job issues. + +**Steps to Create and Run a Certificates Discovery Job** + +To create and run a Certificates discovery job, perform the following steps: +1. Choose **Discovery > Certificates**. +2. Click the **Create** button. +3. Enter the **Job name**. +4. Select the **Remote Collector**. +5. Provide the **Server or Servers**, **CIDR Block** or **IP Range**. +6. Review the remaining options and choose the items that best fit your needs. +7. Click the **Save** button. +8. Click the checkbox next to the discovery job(s) and choose **Actions > Run Selected Jobs**. + +Click [here](/infrastructure-management/certificate-management.mdx) for information on managing discovered certificates. + +:::tip +To view a video on viewing the results from Certificates discovery jobs, click [here](https://device42.wistia.com/medias/3fbivne7bp). +::: + +### 2.8 Create Warranty Discovery Jobs + +Warranty discovery jobs enable you to discover and document your hardware warranties. Device42 currently supports warranty autodiscovery for the following vendors: Dell, IBM, Lenovo, Meraki, and Cisco (Preview). + +**Warranty Discovery Job Prerequisites** + +**Device Field Prerequisites** + +The warranty discovery API requires both the device model and serial number fields be correctly entered, either manually or via discovery. + +The Device42 **Hardware** field must include a vendor name that exactly equals a value of "Dell", "IBM", "Meraki", and "Lenovo". You can add vendor aliases if you choose. If you have multiple vendor entries for any of these vendors (e.g. "Dell", "Dell Inc.") we recommend merging these into a single vendor, using the above-mentioned vendor names (see the [Merge Vendor Section of the Warranty Autodiscovery page](/auto-discovery/warranty-autodiscovery.mdx#merge-vendors) for instructions to merge multiple vendors). + +**API Prerequisites** + +Warranty Discovery requires vendor API keys. See the information below on how to receive API keys from each vendor. + +- **Dell API key:** Register or log in at [Dell TechDirect portal](https://techdirect.dell.com) and choose **Services > APIs** to request an API key; you will be provided with a Client ID and Client Secret for API access. +- **Meraki API key:** Click [here](https://meraki-cli.readthedocs.io/en/latest/getting-your-api-key/) for Meraki instructions to receive your API key. +- **Lenovo API key:** Large enterprise customers can request a warranty lookup API key from Lenovo Sales or Support Account Representatives. +- **IBM API key:** Click [here](https://login.ibm.com/authsvc/mtfim/sps/authsvc?PolicyId=urn:ibm:security:authentication:asf:basicldapuser&Target=https%3A%2F%2Flogin.ibm.com%2Foidc%2Fendpoint%2Fdefault%2Fauthorize%3FqsId%3D18d7b5a9-bbe1-4d66-9e31-57a48ef148c5%26client_id%3DOGMyMGQ1MzQtZDFhYi00) to log in to your IBM account to access your warranty lookup information. + +**Steps to Create and Run a Warranty Discovery Job** + +To create and run a Warranty discovery Job, perform the following steps: +1. Choose **Discovery > Warranty Sync**. +2. Click the **Create** button. +3. Enter the **Job name**. +4. Select the **Remote Collector**. +5. Select the **Vendor**: + - For Dell, then specify the **API Version** then specify the **Access Key** and **Secret Key** + - For Meraki, then specify the **Access Key** + - For IBM or Lenovo, then specify the **Access Key** +6. Select the **Order Number Type**. +7. Select the **Debug level**. +8. Click the **Save** button. +9. Click the checkbox next to the discovery job(s) and choose **Actions > Run Selected Jobs**. + +Click [here](/auto-discovery/warranty-autodiscovery.mdx) for more detail regarding Warranty Autodiscovery, including API Key details, configuration information, and prerequisites. It also includes information to configure the warranty script, as well as documenting the secure communication details between the Device42 UI and warranty script to the hardware vendor, and other information. This should be your first place to look when troubleshooting Warranty discovery job issues. + +### 2.9 Create UCS/Load Balancer Discovery Jobs + +UCS/Load Balancer discovery jobs map out virtual servers, pools, and their relationships to backend devices. Once you have run SNMP and Windows/*nix discovery jobs, you can create UCS/Load Balancer jobs to collect connectivity and dependency data. + +**Prerequisites** + +For F5 discovery, ensure you have the **username for a local account** with access to the F5 API. The API calls work with read-only access and do not require administrative privileges. + +Note that F5 devices do not support username and password authentication for accounts that use external authentication providers, such as Active Directory, which uses token-based authentication. + +**Steps to Create and Run a Load Balancer and Cluster Device (UCS) Discovery Job** + +Given the variety of Discovery platforms, we recommend you click [here](/auto-discovery/load-balancer-f5-autodiscovery.mdx) to follow the steps to create these jobs. This page also includes prerequisites and discovery options. To run the created job, click the checkbox next to the discovery job(s) and choose **Actions > Run Selected Jobs**. + +## Task 3: Verify Discovery Jobs + +There are a variety of ways for you to evaluate the success of a discovery job. These include: +- **Discovery Job Results Status:** Provides a status of the overall job, displaying successes, failures, warnings, and other results. +- **Discovery Scores:** Provides a score for one or all discovery jobs. +- **Discovery Target Details:** Provides discovery results and scores for individual targets (e.g. server). + +### 3.1 Discovery Job Results + +After running a discovery job you will be presented with the Job Status. + + + +It will include: +- The **Job Status** section provides the **Last Job Status**, as well as **Basic Discovery** and **Detailed Discovery** results. +- You can click the **Show** link next to the **Job Run Report** to see the Job Report Log. +- You can see the **Discover Breakdown** (e.g. Port Check Failed, Auth Failed, and so on) and click the quantity value for these to link to the Discovery Scores for these items. From here you can link to the Discovery Target Details for each discovered item. + +### 3.2 Discovery Scores + +The Discovery Scores page enables you to view the success of your discovery jobs on a granular level. It provides an overall view of discovery success, discovery scores, and discovery queues. You can see each discovered device, the target IP it was discovered from (which is also a link to that job's page), the job name, cumulative score, and more. + + + +Discovery Scores can be accessed in a variety of ways, including **Analytics > Discovery Scores**. + +**Access Discovery Score Steps** + +To access Discovery Scores, perform the following steps: +1. Choose **Analytics > Discovery Scores**. +2. Hover over the pie charts to view summary data for each category. You can also click on a legend entry to filter in or out from the summary. +3. View the scrollable list of discovered devices, sorted from newest to oldest by default. Each device is displayed on its own line and provides information such as Discovery Target, Job Name, Job Timestamp, and a red or green Success indicator. +4. Click on any of the Discovered Targets to view the Discovery Target Details for that target. +5. Click on the Job Name to navigate to the discovery job to which that device was a part. Here you can see the status of the overall job. + +Click [here](/reports/reports/discovery-quality-scores.mdx) for more information about Discovery Scores. + +### 3.3 Discovery Target Details + +Discovery Target Details provide discovery information for a single Discovery target (e.g. an IP Address) within a specific discovery job (e.g. a specific Cloud discovery job). You can access Discovery Target Details by clicking on a Discovery Target within Discovery Scores. + + + + + +- The **Details** section provides the Discovery Target, Job Name, Discovery Status (e.g. Port Check, Auth, etc.), and other information. +- You can click the **Show** link next to **Advanced Status**, **Detailed Discovery Scores**, and **Detailed Queue Scores** sections for additional details. + +## Task 4: Schedule Discovery Jobs + +### 4.1 Scheduling a Discovery Job + +Once a discovery job has been run and validated, it can be scheduled to automatically run. In the **Autodiscovery Schedule** section of each job, you can set as many different autodiscovery schedules as required to cover your environment. You can choose specific times and days of the week to run the autodiscovery job. + +**Steps to Schedule a Discovery Job** + +To schedule an existing discovery job, perform the following steps: +1. Choose **Discovery**, then choose the type of discovery job you want to schedule. +2. Click the name of the job you want to schedule. +3. Click the **Edit** button. +4. Scroll to the **Autodiscovery Schedule** section and click the **+ Add another Autodiscover Schedule** link. +5. Specify the schedule you want. +6. Click the **Save** button. + + + +## Discovery and Unprocessed Device Records + +Unprocessed device records are discovered devices that could not be confidently matched to any existing device records based on the system's device matching criteria. This most commonly happens when using "Moderate" or "Conservative" matching levels, in which the system considers multiple data points (such as hostname, IP address, MAC address, serial number, and UUID) and requires a certain combined score to merge with an existing record. If this threshold is not met, the discovered device ends up as "unprocessed" and requires manual review or action. + +Users can review these records and either merge them with existing assets, create a new record, or delete them if they are outdated or incorrectly discovered. + +To view Unprocessed Device Records, hover over **Discovery**, then choose **Unprocessed Device Records**. + +**Unprocessed Device Records Best Practices** + +1. Regularly check the **Unprocessed Device Records** page. +2. Merge records that clearly belong to existing assets, and delete old or stale records. Implement Auto Clean rules to delete old or stale records when appropriate. +3. Update discovery credentials and methods if frequent unprocessed records indicate incomplete data collection or matching failures. +4. In environments where matching is challenging, switching to "classic" device matching level can reduce the incidence of unprocessed records. + +Click [here](/auto-discovery/unprocessed-device-records.mdx) for more information about Unprocessed Device Records, including defining matching levels, enabling Enhanced Device Matching, and other information. + +:::tip +To view a video providing more information about Unprocessed Device Records, click [here](https://device42.wistia.com/medias/7gkkt458yo). +::: + +## Discovery and Auto Clean Rules + +AutoClean Rules enable you to automatically manage old and possibly stale data based on specific criteria you set. Data pertaining to objects (e.g a device or an IP address) that is not found in subsequent autodiscovery jobs can be automatically deleted, architect, or otherwise modified. Auto Clean rules are particularly relevant for cleaning up IP Addresses, Devices, and Software. Click [here](/administration/auto-clean-feature.mdx) for more information on adding Auto Clean rules, including instructions to create new rules. + +:::tip +To view a video on using Auto Clean rules, click [here](https://device42.wistia.com/medias/2z87thtqh3). +::: + +## Additional Discovery Information + +Click [here](/auto-discovery/index.mdx) to view the Autodiscovery main page, where you will find a wealth of autodiscovery information. This should be the first place to look for autodiscovery questions you may still have. It also includes a long list of sub-pages for each job discovery type. + +## Software License Management Discovery Jobs + +### Overview + +As mentioned earlier in this document, Software License Management (SLM) is a separate Device42 module that among other things, scans Windows, Linux, and other device instances to detect installed software. + +SLM is configured by enabling certain options within **HyperVisors / \*nix / Windows** discovery jobs, specifically when the following **Platform** values are chosen: + +- *nix +- Classic WinRM +- IBM i/AS400 +- IBM z/OS +- SCCM +- Windows + +To enable software discovery for these discovery jobs, click the **Software** checkbox within the **Software and Applications** section of the job. + +Click [here](/infrastructure-management/software/software-license-management.mdx) to link to a page providing information on how to configure the SLM module, view discovered software, enable software alerting, run software reports, and more. + +## The Unknown Device Type All non-virtual devices will initially be assigned the **unknown** device type during discovery. These devices have a hardware model. The appliance categorizes them as **unknown** because it has not yet been instructed which of the following types the hardware models belong to: @@ -86,13 +610,13 @@ All non-virtual devices will initially be assigned the **unknown** device type d Once you change a hardware type, all the corresponding devices that refer to that hardware and have been assigned the **unknown** type will automatically be categorized accordingly. -The hardware bulk edit feature allows you to change hardware properties in bulk for all undefined hardware types. It automatically categorizes all devices belonging to a specific category. See the [Bulk Edit video](how-to-videos/add-and-bulk-edit-hardware-models-how-to.mdx) or [Bulk Edit documentation](infrastructure-management/devices/hardware-models-templates.mdx) for more information. +The hardware bulk edit feature allows you to change hardware properties in bulk for all undefined hardware types. It automatically categorizes all devices belonging to a specific category. See the [Bulk Edit video](/how-to-videos/add-and-bulk-edit-hardware-models-how-to.mdx) or [Bulk Edit documentation](/infrastructure-management/devices/hardware-models-templates.mdx) for more information. Once a hardware type has been defined, any newly imported or discovered devices will go into the correct category. ## Viewing the Details of Discovered Items -To view the details of a discovered item type, navigate to that item type's list page and select an item from the table. +To view the details of a discovered item type, navigate to that item type's list page and select an item from the table. For example, you can go to **Resources > All Devices** and click on a device name to view that device's details. Depending on the device and information available, fields like **Hardware**, **Serial #**, **Total CPUs**, **RAM**, **OS**, and **IP Addresses** may be populated. @@ -103,3 +627,21 @@ sources={{ dark: useBaseUrl('/assets/images/getting-started-with-auto-discovery/view-ci-details-19.06-dark.png'), }} /> + +## Discover Phase Checklist + +The Discover phase is considered complete when: + +- You have defined your subnets. +- You have defined the discover jobs that will deliver the maximum return to your organization. +- You have determined how you want to organize and name your discovery jobs. +- You have created and run your discovery jobs, making sure to include only those targets relevant to each job, and making sure to limit the quantity of targets to ensure the jobs successfully complete. +- You have viewed your Unprocessed Device Records and have taken the appropriate actions (e.g. delete records, merge records). +- You have verified your discovery jobs were successful by reviewing Discovery Job results, Discovery Scores, and Discover Target Details. +- You have scheduled your discovery jobs, making sure to run them only as frequently as is needed, to schedule them during times when it will have minimal network impact, and to schedule jobs to run on different days and at different times so as to not overwhelm the Main Appliance. + +## Discover Phase Support + +At the conclusion of the Discover phase you should have created and configured your relevant discovery jobs, validated that the jobs ran successfully, and scheduled those jobs to automatically run at specific intervals. + +You may access the [Device42 Support page](https://support.device42.com) where you can submit a request, access our Knowledge Base, or access other general information. diff --git a/docs/getstarted/how-is-device42-implemented.mdx b/docs/getstarted/how-is-device42-implemented.mdx new file mode 100644 index 000000000..0eb957b25 --- /dev/null +++ b/docs/getstarted/how-is-device42-implemented.mdx @@ -0,0 +1,30 @@ +--- +title: "How is Device42 Implemented?" +sidebar_position: 1 +--- + +We view a Device42 implementation as occurring in four phases, what we refer to as "The 4 Ds of Device42". This structured approach is based upon best practices from thousands of implementations. These four phases are: +- Deploy +- Discover +- Data Validation +- Display + +![The 4 Ds of Device42](/assets/images/4-ds-flow-v2.png) + +## Deploy + +The Deploy phase ensures you install and properly configure the required Device42 components to discover your infrastructure. You will install and configure the Device42 Main Appliance (MA), Remote Collectors (RCs), and the Windows Discovery Service (WDS) instances if Windows systems are in scope. While Device42 primarily performs agentless discovery, you may optionally install Device42 Discovery Agents onto your machines running Windows, Linux, and UNIX operating systems. + +The Deploy phase also includes you properly configuring network settings and firewall rules to enable communication with all your relevant infrastructure components. Appropriate access permissions need to be granted to Device42, adhering to the principle of least privilege, after which you should perform connectivity tests to confirm proper functionality. + +## Discover + +Once the Deploy phase is complete, as part of the Discover phase you will configure and execute discovery jobs to discover your IT environment. You will configure discovery job settings, including IP ranges, credentials, and schedules, for various components such as SNMP devices, Hypervisors, Windows and Linux servers, and cloud resources. At the beginning of this phase you will execute discovery jobs to identify and inventory your infrastructure. Then you will review discovery scores that provide you insight into the success and accuracy of these jobs. You will use these discovery scores to identify any discovery job issues that you will then remedy. Finally, you will schedule these discovery jobs to automatically run at specified time intervals. + +## Data Validation + +The Data Validation phase follows the Discover phase, where you will ensure the discovered data is complete and accurate. You will perform sample checks comparing discovered data against other existing data sources to verify data accuracy, completeness, and consistency. You will resolve any data errors or inconsistencies. + +## Display + +Once your discovered data is validated, you will make sure it is consumable by users and provides actionable insights so you and others can make impactful business decisions. You will verify the accuracy of all relevant data visualizations (charts, graphs, maps, and so on). You will configure reports or custom dashboards to display key metrics, and create and schedule reports that provide insights into infrastructure status, changes, and performance. In short, you will ensure you and others can leverage the data Device42 discovered about your IT environment to make better IT and business decisions. diff --git a/docs/getstarted/index.mdx b/docs/getstarted/index.mdx index 8a91fd324..023f31166 100644 --- a/docs/getstarted/index.mdx +++ b/docs/getstarted/index.mdx @@ -1,6 +1,6 @@ --- title: "The Hitchhiker's Guide to Device42" -sidebar_position: 1 +sidebar_position: 3 --- Welcome to **The Hitchhiker's Guide to Device42**, AKA the Device42 docs site! diff --git a/docs/getstarted/installation/_category_.yml b/docs/getstarted/installation/_category_.yml deleted file mode 100644 index 8de8e8c34..000000000 --- a/docs/getstarted/installation/_category_.yml +++ /dev/null @@ -1,4 +0,0 @@ -position: 1 -label: 'Installation' -collapsible: true -collapsed: true diff --git a/docs/getstarted/installation/index.mdx b/docs/getstarted/installation/index.mdx deleted file mode 100644 index e151f4608..000000000 --- a/docs/getstarted/installation/index.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "Installation" ---- - -Welcome to the Device42 installation guide. This page outlines installing Device42 for the purposes of mapping and gaining insight into your IT environment. - -## Getting Started - -Device42 is delivered as a virtual appliance, which you install on a virtualization platform. - -Before you begin: -- Review the [sizing recommendations](sizing-recommendations.mdx) to ensure your environment is properly provisioned. -- Visit the [security posture and high-level permissions](security-posture-and-high-level-permissions.mdx) page. -- See the [discovery port configurations](discovery-port-configurations.mdx) for network requirements. - -## Installation Process Overview - -Device42 consists of three components to install. First, install the Device42 Main Appliance (the Device42 application and user interface), followed by the Remote Collector (RC) and Windows Discovery Service (WDS). - -When you run a discovery, the Device42 MA uses the WDS to collect information about Windows environments and uses the RC to collect information about all other IT environments. - -See the next [Resource and Deployment Architecture](resource-and-deployment-architecture-overview.mdx) page for more information about these core Device42 components and how they fit together. - -After you install the Main Appliance, RC, and WDS, you can install the [Device42 NetFlow Collector](installing-the-d42-netflow-collector-as-a-service.mdx) to improve [Application Dependency Mapping](/apps/enterprise-application-dependency-mapping/index.mdx) discovery. - -## Choose Your Platform - -Select the platform-specific installation guide from the sidebar that matches your environment: - -- [VMware vCenter Server](installation-vcenter-server.mdx) -- [Microsoft Hyper-V](installation-microsoft-hyperv.mdx) -- [Citrix Xen Server](installation-citrix-xen-server.mdx) -- [Xen or KVM](installation-xen-or-kvm-using-virt-manager.mdx) -- [Amazon Web Services (AWS)](installation-amazon-web-services.mdx) -- [Microsoft Azure](installation-microsoft-azure.mdx) - -## Try Device42 - -Sign up for a [free trial of Device42](https://www.device42.com/try-device42/) or [join us in a live demo](https://www.device42.com/weekly-demo/?nab=0) to see the platform in action. diff --git a/docs/getstarted/installation/remote-collector-rc-installation.mdx b/docs/getstarted/installation/remote-collector-rc-installation.mdx deleted file mode 100644 index 32096f6e5..000000000 --- a/docs/getstarted/installation/remote-collector-rc-installation.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Device42 Remote Collector - Installation" -sidebar_position: 12 ---- - -The Remote Collector (RC) is shipped as a virtual appliance and can be downloaded from our [**Autodiscovery** software download page](https://www.device42.com/autodiscovery/). - -## Installation Instructions - -The [**Installation and Configuration**](/auto-discovery/remote-collector-rc/#installation-and-configuration.mdx) section of the [**Remote Collector**](/auto-discovery/remote-collector-rc.mdx) page provides detailed instructions for installing an RC. - -## Default RC Credentials - -The default Device42 RC login credentials are as follows: - -**Username:** - -``` -client -``` - -**Password:** - -``` -device42 -``` diff --git a/docs/getstarted/installation/resource-and-deployment-architecture-overview.mdx b/docs/getstarted/installation/resource-and-deployment-architecture-overview.mdx deleted file mode 100644 index e2101a6aa..000000000 --- a/docs/getstarted/installation/resource-and-deployment-architecture-overview.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "Resource and Deployment Architecture Overview" -sidebar_position: 1 ---- -Learn about the Device42 core resources and how they fit into the deployment architecture. - -## Device42 Resources - -Device42 consists of the Main Appliance, one or more Remote Collectors (RCs), and a Windows Discovery Service (WDS). The Main Appliance is an interface for configuring and running discovery jobs, viewing and managing discovered Configuration Items (CIs), generating reports, and managing any third-party integrations. - -During discovery, the RC and WDS collect data of your IT environment. - -### Main Appliance - -The Device42 Main Appliance is the kick-off point for all the discovery and insights that will proliferate through your environment. It is a preconfigured virtual appliance (built on Linux) hosted by you, for full protection under your organization's data center security architecture and policies. - -Device42 operates with only five ports open to the virtual appliance: - -- **Port 80:** Redirects to port 443 -- **Port 443:** Web (HTTPS) -- **Port 4242:** Redirects to port 4343 -- **Port 4343:** Appliance Manager (HTTPS) -- **Port 404:** SSH for limited console menu operations - -:::caution -Device42 is delivered as a virtual appliance. Root access to the appliance is not supported, and the VM will cease to function if you attempt to break into the root account. -::: - -Manage the Main Appliance using the [Appliance Manager (AM)](/administration/appliance-manager/index.mdx), from which you can restart and stop the Device42 application, generate logs or SNMP walks for tech support, and more. - -### Remote Collector - -The Remote Collector is a much lighter preconfigured virtual appliance (built on Linux) used to perform agentless discovery across network segments. It provides scalability by offloading discovery workloads from the MA. You need to install at least one RC with any deployment of Device42. - -### Windows Discovery Service - -The Windows Discovery Service is a .NET service that runs on a Windows system and makes WMI queries on behalf of the Linux-based RC and MA. To run Windows discoveries, you need to deploy at least one WDS instance and connect it to an RC. - -## Deployment Architecture - -The Device42 deployment architecture is similar to a hub-and-spoke model, with each RC/WDS collecting data and syncing back to the centralized MA. If you require Windows discovery, we recommend you deploy RCs and WDS instances in pairs. - -### Device42 Deployment Example - -The following image illustrates the segmented network structure used for Device42 deployments. - -![](/assets/images/deployment-architecture.png) diff --git a/docs/getstarted/tutorials/index.mdx b/docs/getstarted/tutorials/index.mdx deleted file mode 100644 index abe18ee52..000000000 --- a/docs/getstarted/tutorials/index.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Tutorials" ---- - -Welcome to Device42! Explore the tutorials in this section to learn the fundamentals of using the Device42 Main Appliance (MA). - -Start with the [Introduction to Device42](/getstarted/tutorials/device42-tutorial.mdx), which explains the terminology, object types, and object hierarchy used in Device42 and covers the various ways IT data can be added to and exported from the Device42 MA. - -Next, learn how to add sample data to your new Device42 instance using either of the following: - -- The [spreadsheets tutorial](getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx) shows you how to access and add data to a sample `.xls` file, then re-upload it to add the data to Device42. -- The [API tutorial](getstarted/tutorials/tutorial-loading-data-using-the-api.mdx) demonstrates how to execute a bash script of several curl commands that call the Device42 API to add sample data to Device42. - -Complete your introduction with the [UI tutorial](getstarted/tutorials/tutorial-navigating-the-device42-user-interface.mdx). Explore the sample data in the Device42 UI to familiarize yourself with the menu options and data organization. - -Once you've completed the tutorials, you can discover more Device42 features in the rest of the [Get Started](/getstarted/) section. If you have any questions, comments, or feature requests, please let us know at [support@device42.com](mailto:support@device42.com). diff --git a/docs/getstarted/using-device42/_category_.yml b/docs/getstarted/using-device42/_category_.yml new file mode 100644 index 000000000..678469c25 --- /dev/null +++ b/docs/getstarted/using-device42/_category_.yml @@ -0,0 +1,4 @@ +position: 7 +label: 'Using Device42' +collapsible: true +collapsed: true diff --git a/docs/getstarted/advanced-search-feature.mdx b/docs/getstarted/using-device42/advanced-search-feature.mdx similarity index 99% rename from docs/getstarted/advanced-search-feature.mdx rename to docs/getstarted/using-device42/advanced-search-feature.mdx index c3bd6f61d..061b83319 100644 --- a/docs/getstarted/advanced-search-feature.mdx +++ b/docs/getstarted/using-device42/advanced-search-feature.mdx @@ -1,6 +1,6 @@ --- title: "Advanced Search Feature" -sidebar_position: 7 +sidebar_position: 5 --- import ThemedImage from "@theme/ThemedImage"; diff --git a/docs/getstarted/arrange-and-save-list-page-column-layout.mdx b/docs/getstarted/using-device42/arrange-and-save-list-page-column-layout.mdx similarity index 99% rename from docs/getstarted/arrange-and-save-list-page-column-layout.mdx rename to docs/getstarted/using-device42/arrange-and-save-list-page-column-layout.mdx index f3c2ec848..ee16c2dce 100644 --- a/docs/getstarted/arrange-and-save-list-page-column-layout.mdx +++ b/docs/getstarted/using-device42/arrange-and-save-list-page-column-layout.mdx @@ -1,6 +1,6 @@ --- title: "Arrange and Save List Page Column Layout" -sidebar_position: 8 +sidebar_position: 4 --- import ThemedImage from '@theme/ThemedImage' diff --git a/docs/getstarted/basic-navigation-tips-for-adding-editing.mdx b/docs/getstarted/using-device42/basic-navigation-tips-for-adding-editing.mdx similarity index 99% rename from docs/getstarted/basic-navigation-tips-for-adding-editing.mdx rename to docs/getstarted/using-device42/basic-navigation-tips-for-adding-editing.mdx index b2c5cf352..25968afd9 100644 --- a/docs/getstarted/basic-navigation-tips-for-adding-editing.mdx +++ b/docs/getstarted/using-device42/basic-navigation-tips-for-adding-editing.mdx @@ -1,6 +1,6 @@ --- title: "Basic Navigation Tips for Adding and Editing" -sidebar_position: 9 +sidebar_position: 3 --- import ThemedImage from '@theme/ThemedImage' diff --git a/docs/getstarted/discovery-hub.mdx b/docs/getstarted/using-device42/discovery-hub.mdx similarity index 96% rename from docs/getstarted/discovery-hub.mdx rename to docs/getstarted/using-device42/discovery-hub.mdx index 9c7e3fdc6..18168a6d7 100644 --- a/docs/getstarted/discovery-hub.mdx +++ b/docs/getstarted/using-device42/discovery-hub.mdx @@ -1,6 +1,6 @@ --- title: "Discovery Hub: Scoping and Onboarding" -sidebar_position: 3.5 +sidebar_position: 1 --- import ThemedImage from '@theme/ThemedImage' @@ -29,15 +29,15 @@ Log in to the Device42 UI and navigate to **Discovery > Discovery Hub**. />

-To set up a Discovery Hub scan, name the scan and select the [Remote Collector](getstarted/installation/remote-collector-rc-installation.mdx) to use. You need to know the IPs, IP ranges, or CIDR blocks for your target environment. +To set up a Discovery Hub scan, name the scan and select the [Remote Collector](getstarted/deploy-device42/remote-collector-rc-installation.mdx) to use. You need to know the IPs, IP ranges, or CIDR blocks for your target environment. Enter the IP information in the box highlighted in the image below and click on the **up arrow** button. You can enter as many targets as you like, but the more targets you include, the longer the scan will likely take.

diff --git a/docs/getstarted/faqs/index.mdx b/docs/getstarted/using-device42/faqs.mdx similarity index 94% rename from docs/getstarted/faqs/index.mdx rename to docs/getstarted/using-device42/faqs.mdx index 7dfe5fec7..502ba1fd7 100644 --- a/docs/getstarted/faqs/index.mdx +++ b/docs/getstarted/using-device42/faqs.mdx @@ -1,5 +1,6 @@ --- title: "FAQs" +sidebar_position: 8 --- import ThemedImage from '@theme/ThemedImage' @@ -7,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl' The **Device42 frequently asked questions** list is regularly updated and includes information for both new users and seasoned professionals. -If you've just downloaded Device42 for the first time and want help getting your instance up and running, our [Getting Started](getstarted/index.mdx) guide is specifically tailored for users who are new to our software. +If you've just downloaded Device42 for the first time and want help getting your instance up and running, our [Getting Started](/getstarted/index.mdx) guide is specifically tailored for users who are new to our software. ## How Do I Log In to My Device42 Instance? @@ -31,14 +32,14 @@ You can use any of the following tools to import your data to Device42: ::: - [**Microsoft Excel / CSV (spreadsheet) import**](integration/imports/index.mdx): The **Tools > Imports/Exports (xls)** page outlines your options for importing MS Excel spreadsheets to Device42 and provides sample Excel sheets to help you format your existing spreadsheets so that uploading your existing data is as easy as possible. -- [**Device42 generic import tool**](https://www.device42.com/blog/2018/06/19/new-features-added-to-the-generic-import-tool/): You can use the Device42 generic import tool to add and map fields for existing data from most spreadsheet formats. Learn more about formatting best practices in the Device42 walkthrough for manually [Importing Data From Existing Spreadsheets](getstarted/importing-data-from-existing-spreadsheets.mdx). +- [**Device42 generic import tool**](https://www.device42.com/blog/2018/06/19/new-features-added-to-the-generic-import-tool/): You can use the Device42 generic import tool to add and map fields for existing data from most spreadsheet formats. Learn more about formatting best practices in the Device42 walkthrough for manually [Importing Data From Existing Spreadsheets](importing-data-from-existing-spreadsheets.mdx). - [**RESTful APIs**](https://api.device42.com): These enable you to programatically automate your network documentation and leverage your asset data for scripts and automation. Simply add RESTful APIs to your regular workflow to leverage Device42 as a single source of truth for systems such as provisioning and monitoring. - **Device42 web UI**: You can use the Device42 web interface to import your data. - **Templates/bulk operations**: Certain object types are easier to add using templates or models. For example, it is easier to use [PDU models](infrastructure-management/power-units/defining-pdu-models.mdx) to create PDUs, [switch port templates](infrastructure-management/ipam/switch-templates.mdx) to create switches and ports, and [patch panel models](infrastructure-management/power-units/defining-pdu-models.mdx) to create patch panel ports and bulk backport connectivity for patch panels. ## What Is the Recommended Order for Running Different Discoveries? -The recommended **Initial Discovery Sequence** section of the [**Autodiscovery Best Practices**](/auto-discovery/autodisc-best-practices/) provides a detailed rundown of how to order multiple discoveries. +The recommended **Initial Discovery Sequence** section of the [**Autodiscovery Best Practices**](/auto-discovery/autodisc-best-practices.mdx) provides a detailed rundown of how to order multiple discoveries. **In short**: Run network discovery first to build your layer-2 network landscape. Discovered devices will then be added to their appropriate subnets as they are discovered. @@ -111,7 +112,7 @@ Log in to the Device42 appliance manager at `https://your_device42_ip_or_FQDN:42 Create a backup from **Backup/Restore > Backup now**. -This is also discussed on the [Appliance Manager](/administration/appliance-manager/) page. +This is also discussed on the [Appliance Manager](/administration/appliance-manager/index.mdx) page. ## How Do I Update to the Latest Release? @@ -121,13 +122,13 @@ This is also discussed on the [Appliance Manager](/administration/appliance-mana The [Device42 Upgrade Steps](https://support.device42.com/hc/en-us/articles/222221228-Upgrade-Steps-Device42) are also detailed on our Support Portal. -Learn more about MA and RC updates on the [Appliance Manager](/administration/appliance-manager/) page. +Learn more about MA and RC updates on the [Appliance Manager](/administration/appliance-manager/index.mdx) page. You can subscribe to the [Device42 Blog RSS feed](https://www.device42.com/blog/feed/) or follow us on [X](https://x.com/device42) to get immediate notifications for new releases. ## How Do I Install the Device42 Appliance on Xen/KVM if the Import Existing Disk Image Option Is Missing? -If you are trying to install the Device42 appliance on Xen- or KVM-based platforms but the **Import Disk Image** option is missing, follow the instructions on our [Import Disk Alternate Install](/getstarted/installation/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing/) page. +If you are trying to install the Device42 appliance on Xen- or KVM-based platforms but the **Import Disk Image** option is missing, follow the instructions on our [Import Disk Alternate Install](/getstarted/deploy-device42/installation-guides/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing.mdx) page. ## Where Can I Get Help With Something Not Covered Here? diff --git a/docs/getstarted/home-page-widgets-and-global-search.mdx b/docs/getstarted/using-device42/home-page-widgets-and-global-search.mdx similarity index 95% rename from docs/getstarted/home-page-widgets-and-global-search.mdx rename to docs/getstarted/using-device42/home-page-widgets-and-global-search.mdx index becc5bcb9..f056379a8 100644 --- a/docs/getstarted/home-page-widgets-and-global-search.mdx +++ b/docs/getstarted/using-device42/home-page-widgets-and-global-search.mdx @@ -1,6 +1,6 @@ --- title: "Home Page Widgets and Global Search" -sidebar_position: 10 +sidebar_position: 2 --- import ThemedImage from "@theme/ThemedImage"; @@ -10,7 +10,7 @@ The Device42 home page Classic Dashboard has widgets that give you a quick, clea ## Dashboards and Widgets -- Use the dashboard dropdown menu to select one of the [Insights+](../reports/reports/insights-plus.mdx) dashboards to use for the home page. +- Use the dashboard dropdown menu to select one of the [Insights+](/reports/reports/insights-plus.mdx) dashboards to use for the home page. -If you've followed the [spreadsheets](/getstarted/tutorials/device42-tutorial.mdx) or [API](getstarted/tutorials/tutorial-loading-data-using-the-api.mdx) tutorial or run an autodiscovery job, your dashboard statistics will reflect the new CIs. +If you've followed the [spreadsheets](device42-tutorial.mdx) or [API](tutorial-loading-data-using-the-api.mdx) tutorial or run an autodiscovery job, your dashboard statistics will reflect the new CIs. DataCenter > Buildings** to view and enter information about the buildings that house your data centers. In Device42, a room is part of a building. You can add rooms, racks, and other asset details to a building's information. -Users with the [necessary permissions](/administration/role-based-access-control/) can access the [Room Layout View](#room-layout-view) to see how the room layout represents a room and its objects. +Users with the [necessary permissions](/administration/role-based-access-control/index.mdx) can access the [Room Layout View](#room-layout-view) to see how the room layout represents a room and its objects. ## Buildings List Page @@ -148,7 +148,7 @@ You can associate assets with server rooms from the Main Appliance or via the AP Access a **Room Layout** view from a room's detailed view or using the **Show** link next to the room name on the **Rooms** list page. -Use the zoom slider to increase or decrease the display size of the layout. Switch editing mode to on by clicking **Turn ON** in the sidebar. Only users with the [necessary permissions](/administration/role-based-access-control) can edit a room layout. +Use the zoom slider to increase or decrease the display size of the layout. Switch editing mode to on by clicking **Turn ON** in the sidebar. Only users with the [necessary permissions](/administration/role-based-access-control/index.mdx) can edit a room layout. Import/Export (xls)**](/integration/imports/spreadsheet-imports-and-exports) +2. By uploading Excel spreadsheets under [**Tools > Import/Export (xls)**](/integration/imports/spreadsheet-imports-and-exports.mdx) 3. [Via the Device42 API](https://api.device42.com) 4. [From the Rack Layout screen](#visually-add-assets-to-the-rack). @@ -99,7 +99,7 @@ There are three other ways to add devices, assets, and PDUs to racks: - **Where**: Indicate where the device is. - Devices must have a [Hardware Model](/infrastructure-management/devices/hardware-models-templates/) with a defined size to give them the **Rack Mounted** designation. You can add devices to the **Left**, **Right**, **Top**, or **Bottom** without a Hardware Model. + Devices must have a [Hardware Model](/infrastructure-management/devices/hardware-models-templates.mdx) with a defined size to give them the **Rack Mounted** designation. You can add devices to the **Left**, **Right**, **Top**, or **Bottom** without a Hardware Model. - **Start at**: Enter a starting U location for the device. - **Orientation**: Choose the orientation of the mounted device. Device depth is determined by the Hardware Model properties. @@ -231,7 +231,7 @@ In the physical connection layout, you can select a port for a device, and the d ### Add PDUs to the Rack -You can add PDUs in and around the rack. The steps for adding and displaying PDUs are discussed in detail on the [PDU Rack Display](/infrastructure-management/power-units/pdu-rack-display) page. +You can add PDUs in and around the rack. The steps for adding and displaying PDUs are discussed in detail on the [PDU Rack Display](/infrastructure-management/power-units/pdu-rack-display.mdx) page. ## Rack Actions @@ -387,7 +387,7 @@ Add and update racks in bulk [using the Device42 API](https://api.device42.com/) Additional information can be found here: - [The Device42 API reference website](https://api.device42.com) -- [The Device42 guide to importing data from existing spreadsheets](getstarted/importing-data-from-existing-spreadsheets.mdx) +- [The Device42 guide to importing data from existing spreadsheets](/getstarted/using-device42/importing-data-from-existing-spreadsheets.mdx) ### Bulk Add Devices, Assets, and PDUs to Racks diff --git a/docs/infrastructure-management/ipam/index.mdx b/docs/infrastructure-management/ipam/index.mdx index 1eea1b1f2..c3243be80 100644 --- a/docs/infrastructure-management/ipam/index.mdx +++ b/docs/infrastructure-management/ipam/index.mdx @@ -16,4 +16,4 @@ There are multiple ways Device42 can discover IP Addresses and related informati ## Importing IP addresses into Device42 -Importing existing IP addresses from [Microsoft Excel & CSV spreadsheets](getstarted/importing-data-from-existing-spreadsheets.mdx) is easy - Take advantage of this powerful feature to import existing IP Address data from MS Excel and/or .CSV _\[Comma Separated Value\]_ spreadsheets into Device42 IPAM. +Importing existing IP addresses from [Microsoft Excel & CSV spreadsheets](/getstarted/using-device42/importing-data-from-existing-spreadsheets.mdx) is easy - Take advantage of this powerful feature to import existing IP Address data from MS Excel and/or .CSV _\[Comma Separated Value\]_ spreadsheets into Device42 IPAM. diff --git a/docs/infrastructure-management/software/software-license-management.mdx b/docs/infrastructure-management/software/software-license-management.mdx index 4df17001c..a0873dc84 100644 --- a/docs/infrastructure-management/software/software-license-management.mdx +++ b/docs/infrastructure-management/software/software-license-management.mdx @@ -1,16 +1,181 @@ --- -title: "Software License Models and Management" +title: "Software License Management With Device42" sidebar_position: 1 --- import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -The Device42 Software License Management (SLM) module enables the easy creation and management of software licensing models by automatically scanning Windows and Linux machine instances for software; whether running or not. The SLM module can compare counts of running instances against purchased or licensed counts and detect prohibited software without any need for agents. There is absolutely no need to install software agents on each machine that you require monitoring on! +:::tip +This guide covers the complete software license management workflow in Device42, from discovery configuration through to reporting and alerts. +::: + +IT organizations use software license management systems to create and maintain a comprehensive, accurate profile of the software deployed across all systems in an entire IT infrastructure. Using a software license manager (SLM) has several benefits: + +- **Cost Savings:** SLMs help optimize software use, reducing unnecessary expenses on unused licenses. +- **License Compliance:** SLMs ensure an organization remains compliant with software license policies, which reduces the legal and financial risks associated with non-compliance. +- **Security Improvements:** SLMs help to promptly identify end-of-life and vulnerable software by maintaining an inventory of software versions and ensuring all are up to date. +- **Centralized Management:** SLMs offer a centralized platform for managing software licenses across an organization, which streamlines administrative tasks and reduces complexity. +- **Inventory Transparency:** In addition to centralized management, having software data in a central location unlocks the ability to report and alert on software in use for auditing and transparency purposes. + +The Device42 software license management system has powerful features designed to help you efficiently manage your software licenses with these goals in mind. Let's take a look at how the Device42 SLM can help you ensure compliance, reduce costs, and streamline the software license management process. + +## Overview of Capabilities + +Device42 automatically scans Windows and Linux machine instances to detect software, whether the software is running or not. The software license management system compares counts of running instances against purchased or licensed counts and detects prohibited software. What's more, this is all accomplished without any need for agents installed on the scanned systems. + +Specifically, Device42 can do the following: + +- Scan and automatically discover installed software on devices. +- Import these found software components into Device42. +- Manage these software components through licensing policies and by software suite. +- Track which software is in use on which devices. +- Track the licenses for these software components by various methods, as needed for varying licensing models. +- Configure alerts for when licenses are about to run out or when prohibited software is found. +- Generate reports and dashboards to visualize license data and software use. + +## How It Works + +At a high level, managing software licenses with Device42 involves following these steps: + +- Configure an autodiscovery job. +- Run the autodiscovery job to find and import software components (alternatively, you can manually import software components). +- View the imported software components and categorize the results based on your organization's needs. This step may include assigning a software type to a component or assigning software to suites. +- Configure licensing information for the imported software to establish license inventory. +- Set up alerts for license status and discovered software types. + +## What Is Supported + +For device scanning, all major Linux distributions are supported, and software registered across various package managers is discovered. + +Once software components are imported, Device42 supports the following features for software management: + +- Software component management +- Software-in-use tracking by device +- Software suite assignment +- License management of varying models +- End-of-life and end-of-service tracking +- Prohibited software detection +- Licensing usage alerts + +## Configuring Software Discovery + +To import software components into Device42 so that they can be inventoried, managed, and reported on, you first need to configure Device42 for software discovery. + +### Autodiscovery Job Configuration + +In Device42, configure an autodiscovery job to scan systems for installed software under **Discovery > Hypervisors/\*nix/Windows > Create**. + +Configure the autodiscovery job for the system's platform and network location. To enable software discovery, ensure the **Discover Software** option is selected under the **Software and Applications** section. + + + + + +Note that for this option to appear, you must first select a supported platform, such as **\*nix** or **Windows**, for the autodiscovery job. + +### Software Type + +A configuration item (CI) worth noting is **Software Type**. This field controls how newly discovered software is initially treated. There are four options for the initial **Software Type** field: + +- **Unmanaged:** Software that is present on the scanned hosts but not actively tracked or managed in Device42. Unmanaged software typically includes software that has been installed without formal IT approval or is not part of the standard operating system images. Select this software type to identify and control software not formally approved in your organization and gain visibility into software that may pose security or compliance issues. + +- **Managed:** Software that is actively tracked, monitored, and managed in Device42. The managed software type allows you to track use, versions, licenses, and compliance and ensure that critical software installations are up to date and compliant with licensing agreements. You can set up alerts and automate tasks for managed software. + +- **Prohibited:** Software that is disallowed within an organization. Prohibited software is blocked by IT policies and is actively monitored to ensure it is not installed or used in an environment. This helps enforce security and compliance policies by preventing the installation of software that poses security risks or violates licensing agreements. + +- **Ignored:** Software that is intentionally excluded from management in Device42. Select this software type for software that doesn't need active management or for which you want to reduce noise in a software inventory. + +**Unmanaged** is the default option. Select other options as required before saving the autodiscovery job. + +Finally, run the autodiscovery job to discover installed software components and import them into Device42. + +## Viewing and Managing Discovered Software + +Discovered software can be found under **Resources > Software Components > All Software Components**. + +It's worth understanding the difference between the **All Software Components** and **Software In Use** views in Device42. + +- **All Software Components:** This page lists all discovered software components, regardless of whether they are actively used. A given software component can be assigned to multiple devices, but this page only lists each software component once. +- **Software In Use:** This page lists the software components assigned to or in use on a particular device. A software component in use on multiple devices would appear multiple times on this page. + +The All Software Components view represents a library of all the software managed by an organization, whereas the Software In Use view is a record of one of those pieces of software in active use by some managed device. + +### All Software Components + +As with other list views in Device42, you can sort the Software Components table by the column headers, select filters for the view from the top-right of the page, search components using the search box in the top-left corner, and perform bulk actions on items in the list. + + + +Some of the bulk actions that can be taken here include: + +- **Change the software type:** A review of the found software components may include recategorizing components according to their software type. +- **Update software counts:** You might want to change the software counts if you're considering a licensing change and want to see the impact of this change immediately. +- **Assign software to suite:** Use this option to group related software components. For example, multiple Adobe products could be grouped under a single software suite for easier management and auditing. + +You can merge software components by assigning them to a suite. Select the components to merge from the list view, then select **Assign Software to Suite** from the **Actions** dropdown. Select the software suite from the list and submit the form. + + + +You can manually add software components in the All Software Components view. Click the **Add Software Component** button at the top-right. In the form that opens, enter the name of the component, type, license model, vendor, and other needed fields, then save the form. The newly created software component will be displayed in the list alongside any discovered software. + + + +### Software In Use + +The Software In Use page lists the software components assigned to or used by each device, including when it was first detected on the device and when it was last updated. As with the All Software Components page, this view can be sorted by column headers, filtered, and searched, and you can perform bulk or individual **Actions**. + + + +You can manually add a piece of software to the Software In Use page by clicking the **Create** button at the top-right of the page. In the form that opens, find and select the created software component that represents the software in use, any licensing information, and the device that it is used on, then save the form. The newly created software-in-use record will be displayed in the list alongside other records. + + ## Software License Models -The flexible Device42 license models enables you to track any type of licensing you use. Navigate to **Resources > Software License Models** and click **Create**. +The flexible Device42 license models enable you to track any type of licensing you use. Navigate to **Resources > Software License Models** and click **Create**. The **Track By** field enables you to specify whether the licenses should be tracked by **User**, **Device**, **Client Access** (CALs), or **Device CPU/Core**. @@ -29,9 +194,27 @@ The **Track By** field enables you to specify whether the licenses should be tra light: useBaseUrl('/assets/images/software-license-management/track-by-light.png'), dark: useBaseUrl('/assets/images/software-license-management/track-by-dark.png'), }} - style={{ width: '50%' }} + style={{ width: '50%' }} /> +With Device42, you can track software components by their licensing models. Licensing models are created as needed and customized to a particular piece of software. By matching a software component to its type of license, you can select to track software components and their associated licensing models by: + +- **User:** Documents whether a license is unlimited, purchased in bulk, or purchased individually. This field is only for documentation purposes and does not affect how Device42 counts the instances of software components with a license that it finds. +- **Client Access License (CAL):** The **Count CAL by** field captures whether licenses should be counted on a per-seat (device or user), per-server, per-processor, or per-mailbox basis. +- **Device:** The **Count Devices by** field captures how licenses are counted for each device, by volume, volume with a multiplier, single, unlimited, or OEM. This field is also used only for documentation purposes. +- **Device CPU:** Similar to the track-by-device option above, the **Count Devices by** field has the same options for how to count the number of devices with this software. However, this license type also allows you to configure how multiple CPUs factor into the count for both physical and virtual systems. Valid options here are number of CPU cores on the host, number of sockets on the host, number of cores on virtual machines, and number of sockets on virtual machines. + +Additionally, for each license type, the following options are configurable to further document and manage licenses: + +- **License Type:** Either subscription or perpetual. This field is only for documentation purposes and does not affect how Device42 counts the instances of software components with a license that it finds. +- **Node Locked:** If each licensed instance of a software component is restricted to a specific device. +- **User Locked:** If each licensed instance of a software component is restricted to a specific user. +- **Free Software:** If the software component is free or open source. +- **Concurrent Access:** If the software component is licensed by the number of concurrent users rather than by the total number of users with access to it. +- **Count Major Versions Separately:** If instances of the software component with different major versions should be counted separately. + +Device42 comes with the license models outlined above predefined in **Resources > Software Components > Software Licensing Models**. You can also define custom license models if none of the predefined models suit your needs by selecting **Create** from the Software Licensing Models list page. + ### Tracking By User If you choose to track by **User**, you will see the options: @@ -42,12 +225,12 @@ If you choose to track by **User**, you will see the options: light: useBaseUrl('/assets/images/software-license-management/track-by-user-light.png'), dark: useBaseUrl('/assets/images/software-license-management/track-by-user-dark.png'), }} - style={{ width: '50%' }} + style={{ width: '50%' }} /> -The **License Type** field lets you specify whether this is a **Perpetual** license or a **Subscription**. This is just a documentation field and doesn’t affect how Device42 counts the instances it finds of the software components. +The **License Type** field lets you specify whether this is a **Perpetual** license or a **Subscription**. This is just a documentation field and doesn't affect how Device42 counts the instances it finds of the software components. -The **Count Users by** field enables you to specify the purchase method. This is also just a documentation field and doesn’t affect how Device42 counts the instances it finds of the software components. +The **Count Users by** field enables you to specify the purchase method. This is also just a documentation field and doesn't affect how Device42 counts the instances it finds of the software components. The checkbox options do the following when enabled: @@ -69,12 +252,12 @@ The **Count CAL by** field specifies how the licenses should be counted; that is light: useBaseUrl('/assets/images/software-license-management/count-cal-by-light.png'), dark: useBaseUrl('/assets/images/software-license-management/count-cal-by-dark.png'), }} - style={{ width: '50%' }} + style={{ width: '50%' }} /> ### Tracking By Device -With the **Device** track by option, you see the **Count Devices by** field. This field is used solely for documentation and has five options: +With the **Device** track by option, you see the **Count Devices by** field. This field is used solely for documentation and has five options: - **Volume** - **Volume with a multiplier** - **Single** @@ -87,7 +270,7 @@ With the **Device** track by option, you see the **Count Devices by** field. Thi light: useBaseUrl('/assets/images/software-license-management/device-count-by-light.png'), dark: useBaseUrl('/assets/images/software-license-management/device-count-by-dark.png'), }} - style={{ width: '50%' }} + style={{ width: '50%' }} /> ### Tracking By Device CPU @@ -100,7 +283,7 @@ If you choose **Device CPU/Core** track by option, you will see four additional light: useBaseUrl('/assets/images/software-license-management/track-by-device-cpu-light.png'), dark: useBaseUrl('/assets/images/software-license-management/track-by-device-cpu-dark.png'), }} - style={{ width: '45%' }} + style={{ width: '45%' }} /> The **Count Devices by** field has five choices as listed above. @@ -110,11 +293,124 @@ The **CPU core factor field** is for the core factor rating used by some softwar The **CPU Count** field defines how CPUs are counted: **Total sockets** or **Total # of cores**. The **CPU count virtual** field defines how software found on virtual machines is counted: -- **Total # of cores on host** +- **Total # of cores on host** - **Total sockets on host** - **Total # of cores on VM** - **Total sockets on VM** +## Alerts and Notifications + +You can configure several automations to help you manage software components and their licenses. For instance, you might like to receive an alert when a given piece of software is reaching its number of available licenses. + +Device42 distinguishes between **alerts** and **notifications** for software components. An alert is configured to define a set of criteria that require attention and what actions to perform when those criteria are met. A notification is more or less a log of alert rules that were triggered. + +To create an alert, navigate to **Analytics > Alerts > Setup Alerts > Create**. Switch the **Rule Type** field to **Software**. The following alert types can be set in the **Trigger** field: + +- **Count:** When the count of a piece of software is greater than, less than, equal to, or not equal to an expected value. +- **License Percent Used:** When the number of licenses for a piece of software is greater than, less than, equal to, or not equal to an expected value. +- **Prohibited Software Installed:** Whenever any prohibited software is detected on a scanned system. + +The recipient for an alert is set in the **Escalation Profile** field. If a profile is already configured, you can select it from the prepopulated list. If not, click the plus icon next to the **Escalation Profile** field to open a form to configure one. + + + +Once an alert has been created and its criteria met, both open and acknowledged notifications for these alerts can be viewed at **Analytics > Reports > Notifications**. + +## End of Life and End of Service + +Manage end-of-life (EOL) and end-of-service (EOS) information for your software components in **Resources > Software Components > EOL / EOS**. + +EOL and EOS dates are imported manually. To define EOL or EOS for a software component, select **Create** at the top right of the page. In the Add Software EOL / EOS form, select the relevant software component and its corresponding EOL or EOS dates. + + + +Note that it's not necessary to specify both end-of-life and end-of-service dates. These are similar concepts, but not all software will have both. + +- **End of Life Date:** The date on which a software component will no longer be actively developed, maintained, or supported by its vendor. +- **End of Service Date:** The date on which a software vendor will stop providing customer support or technical assistance for a particular version of the software, even though the software itself may still receive updates and bug fixes. + +## Reporting + +Once your software components have been imported and categorized, the Device42 reporting system can be used to better visualize and analyze the software in use throughout your organization. + +Let's illustrate this by creating a simple report that finds all managed Adobe software. + +- First, create a new report via **Analytics > Standard Reports > Create**. Name the report. + +- Choose **Guided Report** and select **Software In Use** as the object of the report. + + + +- Under the **More Filters** dropdown, select **Software > Vendor** to add the vendor dropdown filter. + + + +- Search for the vendors (for example, **Adobe**) in the new **Software -> Vendor** dropdown filter and select the matching items. + + + +- Apply the **Managed** option from the **Software -> Software Type** dropdown filter. + + + +- Select the columns that match the previously selected filters to include them in the report, such as the **Software -> Software type** and **Software -> Vendor** columns. + + + +- Finally, click **Save and Display On Screen** to view the report immediately. You can also **Export** the report and configure a **Report Schedule** if you want regular updates. + + + +There are, of course, many other reporting configurations that Device42 supports. See the [full documentation on creating reports in Device42](https://docs.device42.com/reports/) for more details. + ## Licensing The software licensing module is licensed as an add-on to the core product. You can contact us about the pricing from the [Device42 website](https://www.device42.com/contact/). diff --git a/docs/integration/external-integrations/azure-migrate.mdx b/docs/integration/external-integrations/azure-migrate.mdx index df0fe6ddf..9ab4502ec 100644 --- a/docs/integration/external-integrations/azure-migrate.mdx +++ b/docs/integration/external-integrations/azure-migrate.mdx @@ -57,7 +57,7 @@ You’ll see confirmation the deployment has been initialized. ![Device42 download page](/assets/images/Click_for_D42_Download_FINAL.png) -For help installing Device42, head over to the Device42 documentation: [https://docs.device42.com](https://docs.device42.com). 1. The [Getting Started with Installation section is a great place to begin! [installation](getstarted/installation/index.mdx). +For help installing Device42, head over to the Device42 documentation: [https://docs.device42.com](https://docs.device42.com). 1. The [Getting Started with Installation section is a great place to begin! [installation](getstarted/deploy-device42/index.mdx). 2\. Once you’ve installed, you’ll want to begin discovering your environment. See the “Getting started with autodiscovery” section of the documentation here: [getstarted/getting-started-with-auto-discovery.mdx](/getstarted/getting-started-with-auto-discovery.mdx). diff --git a/docs/reports/reports/insights-plus.mdx b/docs/reports/reports/insights-plus.mdx index 6358eaa6c..348984871 100644 --- a/docs/reports/reports/insights-plus.mdx +++ b/docs/reports/reports/insights-plus.mdx @@ -22,7 +22,7 @@ Additional curated dashboards are available on our Insights+ GitHub page: [http Click on **Insights+** in the Device42 main menu to display the Insights+ home page, and then select the visualizations you want to see. -**Note**: You can also select and display Insights+ dashboards on the Device42 [home page](getstarted/home-page-widgets-and-global-search.mdx). +**Note**: You can also select and display Insights+ dashboards on the Device42 [home page](getstarted/using-device42/home-page-widgets-and-global-search.mdx). Hypervisors/\*nix/Windows > Create**. - -Configure the autodiscovery job for the system's platform and network location. To enable software discovery, ensure the **Discover Software** option is selected under the **Software and Applications** section. - - - - - -Note that for this option to appear, you must first select a supported platform, such as **\*nix** or **Windows**, for the autodiscovery job. - -### Software Type - -A configuration item (CI) worth noting is **Software Type**. This field controls how newly discovered software is initially treated. There are four options for the initial **Software Type** field: - -- **Unmanaged:** Software that is present on the scanned hosts but not actively tracked or managed in Device42. Unmanaged software typically includes software that has been installed without formal IT approval or is not part of the standard operating system images. Select this software type to identify and control software not formally approved in your organization and gain visibility into software that may pose security or compliance issues. - -- **Managed:** Software that is actively tracked, monitored, and managed in Device42. The managed software type allows you to track use, versions, licenses, and compliance and ensure that critical software installations are up to date and compliant with licensing agreements. You can set up alerts and automate tasks for managed software. - -- **Prohibited:** Software that is disallowed within an organization. Prohibited software is blocked by IT policies and is actively monitored to ensure it is not installed or used in an environment. This helps enforce security and compliance policies by preventing the installation of software that poses security risks or violates licensing agreements. - -- **Ignored:** Software that is intentionally excluded from management in Device42. Select this software type for software that doesn't need active management or for which you want to reduce noise in a software inventory. - -**Unmanaged** is the default option. Select other options as required before saving the autodiscovery job. - -Finally, run the autodiscovery job to discover installed software components and import them into Device42. - -## Viewing and Managing Discovered Software - -Discovered software can be found under **Resources > Software Components > All Software Components**. - -It's worth understanding the difference between the **All Software Components** and **Software In Use** views in Device42. - -- **All Software Components:** This page lists all discovered software components, regardless of whether they are actively used. A given software component can be assigned to multiple devices, but this page only lists each software component once. -- **Software In Use:** This page lists the software components assigned to or in use on a particular device. A software component in use on multiple devices would appear multiple times on this page. - -The All Software Components view represents a library of all the software managed by an organization, whereas the Software In Use view is a record of one of those pieces of software in active use by some managed device. - -### All Software Components - -As with other list views in Device42, you can sort the Software Components table by the column headers, select filters for the view from the top-right of the page, search components using the search box in the top-left corner, and perform bulk actions on items in the list. - - - -Some of the bulk actions that can be taken here include: - -- **Change the software type:** A review of the found software components may include recategorizing components according to their software type. -- **Update software counts:** You might want to change the software counts if you're considering a licensing change and want to see the impact of this change immediately. -- **Assign software to suite:** Use this option to group related software components. For example, multiple Adobe products could be grouped under a single software suite for easier management and auditing. - -You can merge software components by assigning them to a suite. Select the components to merge from the list view, then select **Assign Software to Suite** from the **Actions** dropdown. Select the software suite from the list and submit the form. - - - -You can manually add software components in the All Software Components view. Click the **Add Software Component** button at the top-right. In the form that opens, enter the name of the component, type, license model, vendor, and other needed fields, then save the form. The newly created software component will be displayed in the list alongside any discovered software. - - - -### Software In Use - -The Software In Use page lists the software components assigned to or used by each device, including when it was first detected on the device and when it was last updated. As with the All Software Components page, this view can be sorted by column headers, filtered, and searched, and you can perform bulk or individual **Actions**. - - - -You can manually add a piece of software to the Software In Use page by clicking the **Create** button at the top-right of the page. In the form that opens, find and select the created software component that represents the software in use, any licensing information, and the device that it is used on, then save the form. The newly created software-in-use record will be displayed in the list alongside other records. - - - -## License Models - -With Device42, you can track software components by their licensing models. Licensing models are created as needed and customized to a particular piece of software. By matching a software component to its type of license, you can select to track software components and their associated licensing models by: - -- **User:** Documents whether a license is unlimited, purchased in bulk, or purchased individually. This field is only for documentation purposes and does not affect how Device42 counts the instances of software components with a license that it finds. -- **Client Access License (CAL):** The **Count CAL by** field captures whether licenses should be counted on a per-seat (device or user), per-server, per-processor, or per-mailbox basis. -- **Device:** The **Count Devices by** field captures how licenses are counted for each device, by volume, volume with a multiplier, single, unlimited, or OEM. This field is also used only for documentation purposes. -- **Device CPU:** Similar to the track-by-device option above, the **Count Devices by** field has the same options for how to count the number of devices with this software. However, this license type also allows you to configure how multiple CPUs factor into the count for both physical and virtual systems. Valid options here are number of CPU cores on the host, number of sockets on the host, number of cores on virtual machines, and number of sockets on virtual machines. - -Additionally, for each license type, the following options are configurable to further document and manage licenses: - -- **License Type:** Either subscription or perpetual. This field is only for documentation purposes and does not affect how Device42 counts the instances of software components with a license that it finds. -- **Node Locked:** If each licensed instance of a software component is restricted to a specific device. -- **User Locked:** If each licensed instance of a software component is restricted to a specific user. -- **Free Software:** If the software component is free or open source. -- **Concurrent Access:** If the software component is licensed by the number of concurrent users rather than by the total number of users with access to it. -- **Count Major Versions Separately:** If instances of the software component with different major versions should be counted separately. - -Device42 comes with the license models outlined above predefined in **Resources > Software Components > Software Licensing Models**. You can also define custom license models if none of the predefined models suit your needs by selecting **Create** from the Software Licensing Models list page. The screenshot below demonstrates adding a new licensing model for open-source software. - - - -## Alerts and Notifications - -You can configure several automations to help you manage software components and their licenses. For instance, you might like to receive an alert when a given piece of software is reaching its number of available licenses. - -Device42 distinguishes between **alerts** and **notifications** for software components. An alert is configured to define a set of criteria that require attention and what actions to perform when those criteria are met. A notification is more or less a log of alert rules that were triggered. - -To create an alert, navigate to **Analytics > Alerts > Setup Alerts > Create**. Switch the **Rule Type** field to **Software**. The following alert types can be set in the **Trigger** field: - -- **Count:** When the count of a piece of software is greater than, less than, equal to, or not equal to an expected value. -- **License Percent Used:** When the number of licenses for a piece of software is greater than, less than, equal to, or not equal to an expected value. -- **Prohibited Software Installed:** Whenever any prohibited software is detected on a scanned system. - -The recipient for an alert is set in the **Escalation Profile** field. If a profile is already configured, you can select it from the prepopulated list. If not, click the plus icon next to the **Escalation Profile** field to open a form to configure one. - - - -Once an alert has been created and its criteria met, both open and acknowledged notifications for these alerts can be viewed at **Analytics > Reports > Notifications**. - -## End of Life and End of Service - -Manage end-of-life (EOL) and end-of-service (EOS) information for your software components in **Resources > Software Components > EOL / EOS**. - -EOL and EOS dates are imported manually. To define EOL or EOS for a software component, select **Create** at the top right of the page. In the Add Software EOL / EOS form, select the relevant software component and its corresponding EOL or EOS dates. - - - -Note that it's not necessary to specify both end-of-life and end-of-service dates. These are similar concepts, but not all software will have both. - -- **End of Life Date:** The date on which a software component will no longer be actively developed, maintained, or supported by its vendor. -- **End of Service Date:** The date on which a software vendor will stop providing customer support or technical assistance for a particular version of the software, even though the software itself may still receive updates and bug fixes. - -## Reporting - -Once your software components have been imported and categorized, the Device42 reporting system can be used to better visualize and analyze the software in use throughout your organization. - -Let's illustrate this by creating a simple report that finds all managed Adobe software. - -- First, create a new report via **Analytics > Standard Reports > Create**. Name the report. - -- Choose **Guided Report** and select **Software In Use** as the object of the report. - - - -- Under the **More Filters** dropdown, select **Software > Vendor** to add the vendor dropdown filter. - - - -- Search for the vendors (for example, **Adobe**) in the new **Software -> Vendor** dropdown filter and select the matching items. - - - -- Apply the **Managed** option from the **Software -> Software Type** dropdown filter. - - - -- Select the columns that match the previously selected filters to include them in the report, such as the **Software -> Software type** and **Software -> Vendor** columns. - - - -- Finally, click **Save and Display On Screen** to view the report immediately. You can also **Export** the report and configure a **Report Schedule** if you want regular updates. - - - -There are, of course, many other reporting configurations that Device42 supports. See the [full documentation on creating reports in Device42](https://docs.device42.com/reports/) for more details. diff --git a/docs/what-is-device42.mdx b/docs/what-is-device42.mdx index 1e04c2959..52648807a 100644 --- a/docs/what-is-device42.mdx +++ b/docs/what-is-device42.mdx @@ -17,27 +17,19 @@ Trusted by **over 1,000 customers** across **60+ countries**, including the top --- -## Why Choose Device42: Core Use Cases +## Device42 Solutions -### [Deep and Wide Infrastructure Discovery](auto-discovery/index.mdx) - -Gain visibility into your IT infrastructure with agentless, automatic discovery of your entire IT infrastructure. - -Discover physical servers, VMs, network devices, containers, end-user devices, storage arrays, and more — along with their critical relationships - across on-premises, virtual, and cloud environments. - -### [IT Inventory and Asset Management](infrastructure-management/index.mdx) +Device42 comprises several modules that can either be purchased together as part of a solution or individually based on your needs. -Device42 delivers robust IT asset management (ITAM) documentation for all infrastructure deployments. Its powerful tools ensure that IT teams have instant access to complete, accurate, and up-to-date inventories of their entire IT environments. - -### [Software License Management](solution-guides/software-license-management.mdx) +## Core Device42 Features -Organizations can create and maintain a comprehensive, accurate profile of the software deployed on Windows and Linux machines across their entire IT estates — from the server to desktop level. +Our main product includes: -### [Business Service Mapping](apps/business-services/index.mdx) +### [Deep and Wide Infrastructure Discovery](auto-discovery/index.mdx) -Business service mapping automatically uncovers application and service dependencies across your network, delivering unmatched insights. +Gain visibility into your IT infrastructure with agentless, automatic discovery of your entire IT infrastructure. -Device42 seamlessly maps communications between applications, services, and hybrid cloud or on-premise environments, giving you a complete view of your IT environment. +Discover physical servers, VMs, network devices, containers, end-user devices, storage arrays, and more — along with their critical relationships - across on-premises, virtual, and cloud environments. ### [Built-In CMDB](auto-discovery/resources/index.mdx) @@ -45,15 +37,19 @@ Centralize your IT data with our powerful Configuration Management Database (CMD Device42 maps and visualizes interdependencies, providing unmatched clarity with automated enrichment. -### [Data Center Infrastructure Management](infrastructure-management/buildings-rooms-and-racks/buildings-and-rooms.mdx) - -Leverage advanced data center infrastructure management (DCIM) and visualization tools to access dynamic, accurate diagrams of your IT environment. +### [IT Inventory and Asset Management](infrastructure-management/index.mdx) -Device42’s powerful DCIM features streamline data-center modeling with intuitive drag-and-drop editors for buildings, rooms, racks, and comprehensive cable management. +Device42 delivers robust IT asset management (ITAM) documentation for all infrastructure deployments. Its powerful tools ensure that IT teams have instant access to complete, accurate, and up-to-date inventories of their entire IT environments. ### [IP Address Management](infrastructure-management/ipam/ip-addresses.mdx) -Our built-in IP Address Management (IPAM) centralizes control of your IT infrastructure’s IP address space, providing unified visibility and management for IP tracking, assignments, and other critical functions. This ensures improved efficiency, enhanced oversight, and streamlined compliance across your network. +Our built-in IP Address Management (IPAM) centralizes control of your IT infrastructure's IP address space, providing unified visibility and management for IP tracking, assignments, and other critical functions. This ensures improved efficiency, enhanced oversight, and streamlined compliance across your network. + +### [Data Center Infrastructure Management](infrastructure-management/buildings-rooms-and-racks/buildings-and-rooms.mdx) + +Leverage advanced data center infrastructure management (DCIM) and visualization tools to access dynamic, accurate diagrams of your IT environment. + +Device42's powerful DCIM features streamline data-center modeling with intuitive drag-and-drop editors for buildings, rooms, racks, and comprehensive cable management. ### [Insights+](reports/reports/insights-plus.mdx) and [InsightsAI](reports/device42-doql/insightsai.mdx) @@ -63,20 +59,52 @@ Insights+ provides out-of-the-box reports and dashboards, plus the ability to ha EnrichAI uses artificial intelligence and third-party data to add to and improve your already discovered IT data, across vendors, operating systems, and software names, end-of-life (EOL) and end-of-support (EOS) dates, and other data. -### [Warranty](auto-discovery/warranty-autodiscovery.mdx) and [SSL Certificate Management](/auto-discovery/certificate-auto-discovery#add-ssl-certificate-discovery-job.mdx) +### [Warranty](auto-discovery/warranty-autodiscovery.mdx) and [SSL Certificate Management](/auto-discovery/certificate-auto-discovery.mdx#add-ssl-certificate-discovery-job) Discover, track, and manage warranty information and SSL certificates across your IT infrastructure. +## More Device42 Modules + +Choose one or more additional modules to meet your needs: + +### [Application Dependency Mapping ADM](/apps/enterprise-application-dependency-mapping/index.mdx) + +ADM is a powerful Advanced ITAM module that provides crucial visibility into how your IT assets interconnect, especially focusing on application relationships. See the intricate web of dependencies that power your business services. + +ADM is based on Service-to-Service communications, with information collected via Netstat, which enables Device42 to build relationships between your +servers over time. + +### [Business Service Mapping](/apps/business-services/index.mdx) + +Business service mapping automatically uncovers application and service dependencies across your network, delivering unmatched insights. + +Device42 seamlessly maps communications between applications, services, and hybrid cloud or on-premise environments, giving you a complete view of your IT environment. + +### [Resource Utilization and Cloud Recommendation Engine](auto-discovery/resource-utilization-overview.mdx) + +Resource Utilization (RU) gathers statistical data on a machine's disk, network I/O, CPU, and memory use over time. This data is used by Device42's Cloud Recommendation Engine (CRE) to provide the exact details needed to plan your next cloud migration. The CRE compares costs between different cloud service providers (CSPs) to rightsize your next cloud deployment. + +### [Software License Management](infrastructure-management/software/software-license-management.mdx) + +Organizations can create and maintain a comprehensive, accurate profile of the software deployed on Windows and Linux machines across their entire IT estates — from the server to desktop level. + ### [Storage Discovery](auto-discovery/storage-arrays-autodiscovery/index.mdx) -Storage discovery offers agentless, vendor-neutral visibility into leading storage vendors like EMC, NetApp, Pure Storage, Hitachi, IBM, and more. +Storage discovery offers agentless, vendor-neutral visibility into leading storage vendors like EMC, NetApp, Pure Storage, Hitachi, IBM, and more. Device42 gathers and normalizes performance, configuration, and capacity data across storage arrays, servers, switches, and everything from physical spindles to virtual machine file systems. +### [Netflow](/auto-discovery/netflow-collector.mdx) + +Netflow works hand-in-hand with Device42's ADM module to provide crucial additional connection information from network devices to your business applications. Capture ephemeral connections that might not be consistently identified through ADM's regular sampling intervals. + +Our Netflow module augments data gathered by Device42's other auto-discovery methods, such as +SNMP, WMI or WinRM for Windows, and SSH for Linux. + ### [DCIM Thermal and Power Management](infrastructure-management/power-and-environmental-monitoring/power-monitoring-and-control.mdx) The Power and Thermal Monitoring module tracks power and thermal metrics from supported SNMP-enabled devices, including PDUs, UPSs, and CRAC units. Access detailed device insights directly through the Room Layout View for streamlined monitoring. -### [Resource Utilization and Cloud Recommendation Engine](auto-discovery/resource-utilization-overview.mdx) +## Try Device42 -Resource Utilization (RU) gathers statistical data on a machine’s disk, network I/O, CPU, and memory use over time. This data is used by Device42’s Cloud Recommendation Engine (CRE) to provide the exact details needed to plan your next cloud migration. The CRE compares costs between different cloud service providers (CSPs) to rightsize your next cloud deployment. +Sign up for a [free trial of Device42](https://www.device42.com/try-device42/) or [join us in a live demo](https://www.device42.com/weekly-demo/?nab=0) to see the platform in action. \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 8e53472d1..a43a8f723 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -84,24 +84,124 @@ const config = { from: ['/getstarted/faqs/main-appliance-remote-collector-faq/'], }, { - to: '/getstarted/discovery-hub/', - from: ['/getstarted/getting-started-discovery-hub/'], + to: '/getstarted/using-device42/discovery-hub/', + from: ['/getstarted/getting-started-discovery-hub/', '/getstarted/discovery-hub/'], }, { - to: '/getstarted/deployment-best-practices/', - from: ['/public-deployment-best-practices/', '/getstarted/public-deployment-best-practices'], + to: '/getstarted/deploy-device42/deployment-best-practices/', + from: ['/public-deployment-best-practices/', '/getstarted/public-deployment-best-practices', '/getstarted/deployment-best-practices/'], }, { - to: '/getstarted/installation/installation-microsoft-hyperv/', - from: ['/getstarted/installation/installation-microsoft-hyper/'], + to: '/getstarted/deploy-device42/installation-guides/installation-microsoft-hyperv/', + from: ['/getstarted/installation/installation-microsoft-hyper/', '/getstarted/installation/installation-microsoft-hyperv/', '/getstarted/deploy-device42/installation-microsoft-hyperv/'], }, { - to: '/getstarted/installation/installation-xen-or-kvm-using-virt-manager/', - from: ['/getstarted/installation/installation-xen-kvm-virt-manager/'], + to: '/getstarted/deploy-device42/installation-guides/installation-xen-or-kvm-using-virt-manager/', + from: ['/getstarted/installation/installation-xen-kvm-virt-manager/', '/getstarted/installation/installation-xen-or-kvm-using-virt-manager/', '/getstarted/deploy-device42/installation-xen-or-kvm-using-virt-manager/'], }, { - to: '/getstarted/tutorials/device42-tutorial/', - from: ['/getstarted/tutorials/tutorials-overview/'], + to: '/getstarted/deploy-device42/', + from: ['/getstarted/installation/', '/getstarted/installation/index/'], + }, + { + to: '/getstarted/deploy-device42/discovery-port-configurations/', + from: ['/getstarted/installation/discovery-port-configurations/'], + }, + { + to: '/getstarted/deploy-device42/installation-guides/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing/', + from: ['/getstarted/installation/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing/', '/getstarted/deploy-device42/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing/'], + }, + { + to: '/getstarted/deploy-device42/installation-guides/installation-amazon-web-services/', + from: ['/getstarted/installation/installation-amazon-web-services/', '/getstarted/deploy-device42/installation-amazon-web-services/'], + }, + { + to: '/getstarted/deploy-device42/installation-guides/installation-citrix-xen-server/', + from: ['/getstarted/installation/installation-citrix-xen-server/', '/getstarted/deploy-device42/installation-citrix-xen-server/'], + }, + { + to: '/getstarted/deploy-device42/installation-guides/installation-microsoft-azure/', + from: ['/getstarted/installation/installation-microsoft-azure/', '/getstarted/deploy-device42/installation-microsoft-azure/'], + }, + { + to: '/getstarted/deploy-device42/installation-guides/installation-vcenter-server/', + from: ['/getstarted/installation/installation-vcenter-server/', '/getstarted/deploy-device42/installation-vcenter-server/'], + }, + { + to: '/getstarted/deploy-device42/installing-the-d42-netflow-collector-as-a-service/', + from: ['/getstarted/installation/installing-the-d42-netflow-collector-as-a-service/'], + }, + { + to: '/getstarted/deploy-device42/remote-collector-rc-installation/', + from: ['/getstarted/installation/remote-collector-rc-installation/'], + }, + { + to: '/getstarted/deploy-device42/resource-and-deployment-architecture-overview/', + from: ['/getstarted/installation/resource-and-deployment-architecture-overview/'], + }, + { + to: '/getstarted/deploy-device42/security-posture-and-high-level-permissions/', + from: ['/getstarted/installation/security-posture-and-high-level-permissions/'], + }, + { + to: '/getstarted/deploy-device42/sizing-recommendations/', + from: ['/getstarted/installation/sizing-recommendations/'], + }, + { + to: '/getstarted/deploy-device42/windows-discovery-service-installation/', + from: ['/getstarted/installation/windows-discovery-service-installation/'], + }, + { + to: '/getstarted/deploy-device42/windows-service-installation/', + from: ['/getstarted/installation/windows-service-installation/'], + }, + { + to: '/getstarted/using-device42/tutorials/device42-tutorial/', + from: ['/getstarted/tutorials/tutorials-overview/', '/getstarted/tutorials/device42-tutorial/'], + }, + { + to: '/getstarted/using-device42/tutorials/', + from: ['/getstarted/tutorials/', '/getstarted/tutorials/index/'], + }, + { + to: '/getstarted/using-device42/tutorials/tutorial-loading-data-using-spreadsheets/', + from: ['/getstarted/tutorials/tutorial-loading-data-using-spreadsheets/'], + }, + { + to: '/getstarted/using-device42/tutorials/tutorial-loading-data-using-the-api/', + from: ['/getstarted/tutorials/tutorial-loading-data-using-the-api/'], + }, + { + to: '/getstarted/using-device42/tutorials/tutorial-navigating-the-device42-user-interface/', + from: ['/getstarted/tutorials/tutorial-navigating-the-device42-user-interface/'], + }, + { + to: '/getstarted/using-device42/home-page-widgets-and-global-search/', + from: ['/getstarted/home-page-widgets-and-global-search/'], + }, + { + to: '/getstarted/using-device42/basic-navigation-tips-for-adding-editing/', + from: ['/getstarted/basic-navigation-tips-for-adding-editing/'], + }, + { + to: '/getstarted/using-device42/arrange-and-save-list-page-column-layout/', + from: ['/getstarted/arrange-and-save-list-page-column-layout/'], + }, + { + to: '/getstarted/using-device42/advanced-search-feature/', + from: ['/getstarted/advanced-search-feature/'], + }, + { + to: '/getstarted/using-device42/language-selection/', + from: ['/getstarted/language-selection/'], + }, + { + to: '/getstarted/using-device42/importing-data-from-existing-spreadsheets/', + from: ['/getstarted/importing-data-from-existing-spreadsheets/'], + }, + { + to: '/getstarted/using-device42/faqs/', + from: ['/getstarted/faqs/'], }, { to: '/auto-discovery/blade-systems-auto-discovery/', @@ -839,7 +939,7 @@ const config = { }, { to: '/infrastructure-management/software/software-license-management/', - from: ['/apps/software/software-license-management/'], + from: ['/apps/software/software-license-management/', '/solution-guides/software-license-management/'], }, { to: '/infrastructure-management/software/software-licensing-alerts-and-notifications/', diff --git a/static/assets/images/4-ds-flow-v2.png b/static/assets/images/4-ds-flow-v2.png new file mode 100644 index 000000000..6e3094424 Binary files /dev/null and b/static/assets/images/4-ds-flow-v2.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/adm-off-dark.png b/static/assets/images/getting-started-with-auto-discovery/adm-off-dark.png new file mode 100644 index 000000000..15ba47f39 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/adm-off-dark.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/adm-off-light.png b/static/assets/images/getting-started-with-auto-discovery/adm-off-light.png new file mode 100644 index 000000000..880149146 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/adm-off-light.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/discovery-score-details-dark.png b/static/assets/images/getting-started-with-auto-discovery/discovery-score-details-dark.png new file mode 100644 index 000000000..91dc3baed Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/discovery-score-details-dark.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/discovery-score-details-light.png b/static/assets/images/getting-started-with-auto-discovery/discovery-score-details-light.png new file mode 100644 index 000000000..dcbb1f2b3 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/discovery-score-details-light.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/discovery-scores-advanced-search-dark.png b/static/assets/images/getting-started-with-auto-discovery/discovery-scores-advanced-search-dark.png new file mode 100644 index 000000000..cda99baa6 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/discovery-scores-advanced-search-dark.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/discovery-scores-advanced-search-light.png b/static/assets/images/getting-started-with-auto-discovery/discovery-scores-advanced-search-light.png new file mode 100644 index 000000000..2ba92dee1 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/discovery-scores-advanced-search-light.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/discovery-scores-dark.png b/static/assets/images/getting-started-with-auto-discovery/discovery-scores-dark.png new file mode 100644 index 000000000..142bd3a17 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/discovery-scores-dark.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/discovery-scores-light.png b/static/assets/images/getting-started-with-auto-discovery/discovery-scores-light.png new file mode 100644 index 000000000..5fa417600 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/discovery-scores-light.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/job-run-report-dark.png b/static/assets/images/getting-started-with-auto-discovery/job-run-report-dark.png new file mode 100644 index 000000000..3928eaaa4 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/job-run-report-dark.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/job-run-report-light.png b/static/assets/images/getting-started-with-auto-discovery/job-run-report-light.png new file mode 100644 index 000000000..7db943b46 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/job-run-report-light.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/job-schedule-dark.png b/static/assets/images/getting-started-with-auto-discovery/job-schedule-dark.png new file mode 100644 index 000000000..ee8e64ab7 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/job-schedule-dark.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/job-schedule-light.png b/static/assets/images/getting-started-with-auto-discovery/job-schedule-light.png new file mode 100644 index 000000000..b4bb4b0e3 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/job-schedule-light.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/uncheck-apps-services-dark.png b/static/assets/images/getting-started-with-auto-discovery/uncheck-apps-services-dark.png new file mode 100644 index 000000000..71c681cb8 Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/uncheck-apps-services-dark.png differ diff --git a/static/assets/images/getting-started-with-auto-discovery/uncheck-apps-services-light.png b/static/assets/images/getting-started-with-auto-discovery/uncheck-apps-services-light.png new file mode 100644 index 000000000..d28a9893d Binary files /dev/null and b/static/assets/images/getting-started-with-auto-discovery/uncheck-apps-services-light.png differ