diff --git a/docs/administration/advanced-routing.md b/docs/administration/advanced-routing.md index b90d51ca..b4bca091 100644 --- a/docs/administration/advanced-routing.md +++ b/docs/administration/advanced-routing.md @@ -3,17 +3,30 @@ title: "Advanced Routing" sidebar_position: 2 --- -You can add complex or advanced routing for your Device42 appliance or delete it using the console menu. +You can add complex or advanced routing for your Device42 appliance or delete it using the virtual machine (VM) console menu. -1. To configure advanced routing, choose option **15** from the **Device42 Setup/Troubleshooting Menu**. Log in to the console of the Device42 VM to access this menu: +To add a new route, follow these steps: - ![advanced-routing-option](/assets/images/advanced-routing/console-advanced-routing-option.png) +1. Log in to the Device42 VM console. +2. Choose **(u) Network, Connectivity and Utilities**. -2. To add a new route, enter option **a**. Print the routing table with option **b**. + ![Network options](/assets/images/advanced-routing/1-network.png) + +3. Select **(r) Routing**. + + ![Routing options](/assets/images/advanced-routing/2-routing.png) + +4. Select **(a) Add a new Route** from the **Routing Configuration Main Menu**. - ![Advanced routing options](/assets/images/advanced-routing/console-routing-submenu.png) + ![Add route option](/assets/images/advanced-routing/3-route-options.png) + +5. Fill in the new route details and click **Add Route**. Use the `Tab` key to navigate to the next field. + + ![Add route details](/assets/images/advanced-routing/4-route-details.png) -3. After configuring the new route, enter option **d** to apply changes. The Device42 VM must be manually rebooted to clear deleted routes. +6. After configuring the new route, enter option **(p) Apply Routes** from the previous menu to apply the changes. + +The Device42 VM must be manually rebooted to clear deleted routes. :::info Advanced routing instructions are also available [in video format here](how-to-videos/add-a-new-route-to-device42.md). diff --git a/docs/administration/updating-device42.mdx b/docs/administration/updating-device42.mdx new file mode 100644 index 00000000..3bea5559 --- /dev/null +++ b/docs/administration/updating-device42.mdx @@ -0,0 +1,114 @@ +--- +title: "Updating Device42" +sidebar_position: 0.5 +--- + +import ThemedImage from '@theme/ThemedImage' +import useBaseUrl from '@docusaurus/useBaseUrl' +import vmConsole from '/assets/images/updating-device42/vm-menu-options.png' + +Updating to the latest version of Device42 ensures you get the most out of your CMDB and benefit from the newest features, integrations, and security and performance improvements. + +## How to Update the Device42 Main Appliance + +To update your Main Appliance, follow these steps: + +1. Obtain the update file or URL via email. +2. Back up your Device42 data in the Appliance Manager. +3. Upload the update file or enter the update URL in the Appliance Manager. +4. Log in to the Virtual Machine (VM) console. +5. Apply the update from the VM console. +6. Verify the update from the Main Appliance. + +:::tip +Watch the quick [How To Update the Device42 Main Appliance](how-to-videos/update-device42-appliance-how-to.md) walkthrough video of the process. +::: + +### 1. Obtain the Upgrade File or URL + +To update the Main Appliance, you need to download the update file. In some cases, technical support may have emailed you an update URL to use instead of the update file. If you've received an email with an update URL, proceed to the next step: [Back Up Your Data](#back-up-your-data). + +- From the Main Appliance, navigate to **Tools > Update** and click the [**Check for latest version** link](https://www.device42.com/update/). + + You can visit [https://www.device42.com/update/](https://www.device42.com/update/) directly, but navigating to the link on the **Update Software** page allows you to take note of your current version, which is useful for verifying a successful update later. + + + +- Fill in the form on the website and click **Download update**. + + ![Website form](/assets/images/updating-device42/website-form.png) + +- You'll receive an automated email with several links to download the `.zip.enc` file. If your Main Appliance has already been updated to the latest [major](https://semver.org/) version and you're applying a minor or patch-release update, or if your MA's latest update was to a major version, choose the first link (in bold). + + If your Main Appliance is one or several releases behind the current major version, choose the second or third link, depending on your version, to first update it to the major version. When you've updated to the latest major version, you may need to perform a second update to the current minor or patch-release version afterward. + + ![Email with links](/assets/images/updating-device42/email.png) + +### 2. Back Up Your Data + +Head to the Appliance Manager by entering `http://your-device42-IP-or-FQDN:4242` or `https://your-device42-IP-or-FQDN:4343` into your browser. Optionally, you can take a virtual machine snapshot from your virtualization platform as a backup. + +:::note +The default credentials for the Appliance Manager are `d42admin / default`, or for AWS instances, `d42admin / AWS_INSTANCE_ID`. Please ensure you change the `default` password to your own secure credentials. +::: + +Navigate to **Backup/Restore > Backup Now** and select the **Main Appliance** checkbox. If you want to include users and settings, select the **Backup Meta Data** option. **Run** the backup. + +![Backup settings on the Appliance Manager](/assets/images/updating-device42/backup-appliance.png) + +### 3. Upload the Update File + +From the Main Appliance, navigate to **Application > Update Software** and **either** browse and upload the [`.zip.enc` file](#obtain-the-update-file-or-url) **or** enter the update URL. + +![Upload file or enter URL in the Appliance Manager](/assets/images/updating-device42/upload-file.png) + +A green status bar indicates the upload progress. + +![Green upload status bar](/assets/images/updating-device42/status-bar.png) + +When the file has been uploaded, log in to the VM console. + +### 4. Log In to the VM Console + +There are two ways to log in to the VM console: + +1. Access the VM console through your virtual platform. +2. **Via SSH:** + + - Use port 404 on the Device42 IP address. + - If you're using a power appliance, use port 442. + - For AWS deployments, SSH in to the device using `device42` as your username and `AWS-KEYFILE` as your password. For example: + + ```shell + ssh -i /path/to/your/private-key.pem -p port_number username@hostname + ``` + +### 5. Apply the Update + +Select option **a** in the console to apply the update. It usually takes 15 to 30 minutes to apply the update. + +VM console menu options + +### 6. Verify the Update + +Return to the **Update Software** page of the Main Appliance to confirm that the new version has been applied. + + + +## Updating the Remote Collectors + +As long as your Remote Collectors are connected to a Device42 Main Appliance, any updates will be automatically applied to the Remote Collectors when the Main Appliance is updated. diff --git a/docs/auto-discovery/cloud-auto-discovery/other-cloud-autodiscoveries.mdx b/docs/auto-discovery/cloud-auto-discovery/other-cloud-autodiscoveries.mdx index c6daafef..4f1c866e 100644 --- a/docs/auto-discovery/cloud-auto-discovery/other-cloud-autodiscoveries.mdx +++ b/docs/auto-discovery/cloud-auto-discovery/other-cloud-autodiscoveries.mdx @@ -33,9 +33,7 @@ Device42 discovery supports the following cloud types, as listed in the dropdown /> ## Alibaba Cloud Autodiscovery -What does Alibaba Cloud Discovery gather? In addition to standard discovery methods, the discovery monitors network traffic to see all routes during discovery execution for Application Dependency Mapping. - -A read-only Alibaba role can be provided, as the discovery does not change the cloud infrastructure during execution. Device42 needs an Alibaba account with the built-in permission set to `ReadOnlyAccess`. +What does Alibaba Cloud Discovery gather? In addition to standard discovery methods, the discovery monitors network traffic to see all routes during discovery execution for Application Dependency Mapping. A read only Alibaba role can be provided as the discovery performs no changes to the cloud infrastructure during execution. **Alibaba Discovery Items** diff --git a/docs/auto-discovery/d42-ping-sweep.md b/docs/auto-discovery/d42-ping-sweep.md deleted file mode 100644 index 25341982..00000000 --- a/docs/auto-discovery/d42-ping-sweep.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -title: "Ping Sweep" -sidebar_position: 23 ---- - -![](/assets/images/WEB_695_PS1.png) - -* * * - -## Built-in Ping Sweep Autodiscovery - -Select _Discovery > Ping Sweep_ from the Device42 main menu to display the view Ping Sweep page. - -Device42's Ping Sweep autodiscovery performs a series of pings against the specified network(s), performing a quick initial discovery of which IPs are live (respond to pings) and which are not. - -For the time being, an external stand-alone Ping Sweep utility is also still available (may be deprecated in the future). Scroll to the _Using the_ _External Ping Sweep Utility_ section below for information on using the stand-alone tool. - -## Adding a New Ping Sweep Autodiscovery - -Click **Add Ping Sweep** on the view Ping Sweep page. To edit an existing job, click its name to display its details, and then click **Edit**. - -![](/assets/images/WEB_695_PS2.png) - -1. Enter a name for the job, and specify your target network(s) in the **Networks:** field. -2. Enter a network range using mask bits in slash notation or hyphenated IP ranges (nmap-style syntax). _Examples:_ 192.168.11.0/24 (slash notation), 192.168.11.1-254 (hyphenated range): - - Multiple ranges can be separated via commas, spaces, or new lines. - - If you want to use reverse DNS values as device names, select the **Add devices by reverse DNS of discovered IP** check box. (The default is unchecked – we recommend leaving it unchecked unless your DNS is perfect to avoid creation of duplicate devices.) - - Other options include **Strip domain name suffix** and an option to **Create new subnet for networks not found**. -3. Configure a schedule for the job in the **Auto Discovery Schedule** section, and then save the job. You can select **Run Now** in the Ping Sweep jobs list to run the job right away. - -### Viewing Ping Sweep Data in Device42 - -Select Resources > IP Addresses from the Device42 menu to display the IP Address list page. - -  - -![](/assets/images/WEB_695_PS3.png) - -### General Ping Sweep Usage Considerations - -Please make sure to add the respective subnets in Device42 before discovering and uploading IP information – otherwise all IPs will go to an "undefined" subnet. - -**Other Ping Sweep considerations and best practices:** - -- MAC address discovery works only for local LANs. -- If the reverse DNS option is selected, discovery will take longer. -- Depending on the behavior of your network devices, some subnets / IP addresses will show up as used. For example, some networks that live behind load balancers, as some LBs will reply to pings for every IP on a given range. -- Doing a discovery using a wireless card would only discover itself. -- Please note that there are both a built-in Ping Sweep tool and a stand-alone external version of the tool (see the following section) that runs as a stand-alone Windows application. - -## Using the External Ping Sweep Utility - -The External Ping Sweep utility is a stand-alone tool that will do a ping sweep on specified networks, and upload the results to the Device42 appliance. It runs on Windows or Linux platforms and has no external dependencies. - -![External Ping Sweep Tool](/assets/images/Scanning_a_network_range.png) - -### Download and Install - -1. Download the ping sweep .zip file from [https://www.device42.com/autodiscovery/](https://www.device42.com/autodiscovery/). -2. Unzip the downloaded d42-ping-sweep .zip  – you'll see 5 files: - - d42\_pingsweep\_windows\_386.exe (32bit version - - d42\_pingsweep\_windows\_64.exe (64bit version) - - d42\_pingsweep\_linux - - ping.cfg.sample - - version.txt -3. For Windows, you'll need to download the .exe. On Linux, you'll need to set the \*\_linux file to executable. Do this by setting the executable bit via _$ chmod +x._ -4. Copy or move ping.cfg.sample to ping.cfg and add your settings as described below. -5. Run the appropriate Windows .exe or Linux executable. You're all set! - -### Configuring Ping Sweep Settings - -Use the ping.cfg.sample file to select your settings. Make a copy of this file and rename it to “ping.cfg” - -1. In the **\[settings\]** section, enter the base URL (FQDN or IP) for the Device42 appliance on your network, including credentials. Make sure the credentials have the required access permissions. Minimum required for the user are - - Ping Sweep | Can add Ping Sweep - - Ping Sweep | Can change Ping Sweep - - IP Address | Can add IP Address - - IP Address | Can change IP Address - - IP Address | Can view IP Address - - Subnet | Can add Subnet - - Subnet | Can change Subnet - - Subnet | Can view Subnet - - Device | Can add Device - - Device | Can change Device - -2. In the **\[targets\]** section, enter a network range using mask bits or you can use hyphen ranges (per nmap syntax). **Examples:** 192.168.11.0/24 for subnet range or 192.168.11.1-254 (for hyphenated range). Multiple ranges can be separated by spaces. -3. The **\[0ptions\]** section provides the following options, with explanations and examples. - -Below is an example of the `ping.cfg` file: - -```ini -[settings] -# base_url points to your Device42 server -# For example: base_url = https://192.168.1.50 -base_url = https://192.168.1.100 -# Device42 username and password -username = username -secret = password - -[targets] -# targets can be specified as: -# single: 192.168.1.125 -# range: 192.168.1.101-192.168.1.150 -# cidr block: 192.168.1.0/24 -# any combination of above: 192.168.3.0/24,192.168.4.1-192.168.4.10,192.168.55.22,10.0.0.0/24 -targets = 192.168.1.1/24 -``` - option_name: explanation = default value - -- **get\_mac\_address**: Try to get MAC address for found IP _\= False_ -- **get\_hostname**: Try to get hostname for found IP via DNS (if there are multiple domains using the same IP, only the first is used) _\= False_ -- **threads**: Number of ping threads _\= 128_ -- **timeout**: Timeout for each ping _\= 2000_ -- **retries**: Number of retries (better to keep it greater than 2) _\= 4_ -- **print\_ips**: Print all found IPs _\= False_ -- **debug**: Print all debug messages _\= False_ -- **nameservers**: Custom nameservers = 8.8.8.8,8.8.4.4 - -4\. The **\[discovery\_options\]** section provides the following options, with explanations and examples. - - option_name: explanation = default value - -- **strip\_domain\_suffix**: Strip everything after first dot = _False_ -- **category**: Category for discovered subnets = _String_ -- **create\_new\_subnet**: New subnet for networks not found = _False_ -- **overwrite\_subnet\_categories**: Overwrite existing subnet categories = _False_ -- **vrfgroup**: VRF group for discovered subnets = _String_ -- **type**: Static/DHCP/Reserved = _String_ - -### Running and Scheduling Ping Sweep jobs - -You can start the process by running the executable from the command line – root or administrator privileges required. You can also schedule runs this using operating system task scheduler (like crontab or at). - -### During / After an External Ping Sweep - -You'll see a command prompt after you launch the ping sweep. When completed, the Status will change to _Finished_. If successful, you will see _Success_ messages in the status box, and also see new and updated subnet/IP information within Device42. - -![](/assets/images/WEB_695_PS41.png) diff --git a/docs/auto-discovery/d42-ping-sweep.mdx b/docs/auto-discovery/d42-ping-sweep.mdx new file mode 100644 index 00000000..152ba169 --- /dev/null +++ b/docs/auto-discovery/d42-ping-sweep.mdx @@ -0,0 +1,173 @@ +--- +title: "Ping Sweep" +sidebar_position: 23 +--- + +import ThemedImage from '@theme/ThemedImage' +import useBaseUrl from '@docusaurus/useBaseUrl' + + +## Built-in Ping Sweep Autodiscovery + + +Device42's Ping Sweep autodiscovery performs a series of pings against the specified network(s) for a quick initial discovery of which IPs are live and respond to pings and which are not. + +For the time being, an external standalone [Device42 Ping Sweep utility](https://www.device42.com/autodiscovery/) is still available, but it may be deprecated in the future. See the [Using the External Ping Sweep Utility](#using-the-external-ping-sweep-utility) section below for information on using the standalone tool. + +## Add or Edit a Ping Sweep Autodiscovery Job + +Navigate to **Discovery > Ping Sweep** from the Device42 main menu to display the Ping Sweep list page. + +To edit an existing job, click a job name to display its details, and then click **Edit**. + +Click **Add Ping Sweep** to create a new job. + + + +Fill in the job details: + +1. Enter a name for the job. +2. In the **Networks:** field, enter a network range using mask bits in slash notation (for example, `192.168.11.0/24`) or hyphenated IP ranges (`192.168.11.1-254`) in Nmap-style syntax. Multiple ranges can be separated via commas, spaces, or new lines. + - By default, the **Add devices by reverse DNS of discovered IP** checkbox is unchecked and unless your DNS setup is perfect, we recommend leaving it unchecked to avoid creating duplicate devices. If you want to use reverse DNS values as device names, check this option. + - Other options include **Strip domain name suffix** and an option to **Create new subnet for networks not found**. + + + +Optionally, you can automatically run the job by configuring a schedule in the **Auto Discovery Schedule** section. To run the job right away, click **Run Now** on the Ping Sweep list page. + + + +### View Ping Sweep Data in Device42 + +Select **Resources > All IP Addresses** from the Device42 menu to display the IP Addresses list page. You can narrow down the list using the available filters. Click **IP Address** for options to filter the results by IP address values. + + + +### General Ping Sweep Usage Considerations + +Please add the respective subnets in Device42 before discovering and uploading IP information, otherwise, all IPs will go to an "undefined" subnet. + +**Ping Sweep considerations and best practices:** + +- MAC address discovery works only for local LANs. +- If the reverse DNS option is selected, discovery will take longer. +- Depending on the behavior of your network devices, some subnets or IP addresses will show up as used. For example, as some load balancers reply to pings for every IP on a given range, networks that live behind these load balancers may show up as used. +- Doing a discovery using a wireless card would only discover itself. +- Please note that there's both a built-in Ping Sweep tool and a standalone [external Ping Sweep utility](#using-the-external-ping-sweep-utility) version of the tool that runs as a standalone Windows application. + +## Using the External Ping Sweep Utility + +The external Ping Sweep utility is a standalone tool that does a ping sweep on specified networks and uploads the results to the Device42 appliance. It runs on Windows or Linux platforms and has no external dependencies. + +![External Ping Sweep Tool](/assets/images/Scanning_a_network_range.png) + +### Download and Install + +1. Download the ping sweep `.zip` file from the [Device42 Autodiscovery Tools](https://www.device42.com/autodiscovery/) page. +2. Unzip the downloaded `d42-ping-sweep.zip` file containing five files: + - `d42_pingsweep_windows_386.exe` (32-bit version) + - `d42_pingsweep_windows_x64.exe` (64-bit version) + - `d42_pingsweep_linux` + - `ping.cfg.sample` + - `version.txt` +3. For Windows, you'll need to download the `.exe` file. For Linux, set the `d42_pingsweep_linux` file as executable by running the command: + ```bash + $ chmod +x d42_pingsweep_linux + ``` +4. Copy or move `ping.cfg.sample` to `ping.cfg` and add your settings as described below. +5. Run the appropriate Windows `.exe` or Linux executable. You're all set! + +### Configure the Ping Sweep Settings + +Use the `ping.cfg.sample` file to select your settings. Make a copy of this file and rename it to `ping.cfg`. + +Below is a sample of the `ping.cfg` file: + +```ini +[settings] +# base_url points to your Device42 server +# For example: base_url = https://192.168.1.50 +base_url = https://192.168.1.100 +# Device42 username and password +username = username +secret = password + +[targets] +# targets can be specified as: +# single: 192.168.1.125 +# range: 192.168.1.101-192.168.1.150 +# cidr block: 192.168.1.0/24 +# any combination of above: 192.168.3.0/24,192.168.4.1-192.168.4.10,192.168.55.22,10.0.0.0/24 +targets = 192.168.1.1/24 +``` + +1. In the **`[settings]`** section, enter the base URL (FQDN or IP) for the Device42 appliance on your network, including credentials. Make sure the credentials have the required access permissions. The minimum required for the user are: + - Ping Sweep | Can add Ping Sweep + - Ping Sweep | Can change Ping Sweep + - IP Address | Can add IP Address + - IP Address | Can change IP Address + - IP Address | Can view IP Address + - Subnet | Can add Subnet + - Subnet | Can change Subnet + - Subnet | Can view Subnet + - Device | Can add Device + - Device | Can change Device + +2. In the **`[targets]`** section, enter a network range using mask bits or you can use hyphen ranges (per Nmap syntax). For example, `192.168.11.0/24` for the subnet range or `192.168.11.1-254` for the hyphenated range. Multiple ranges can be separated by spaces. +3. The **`[options]`** section provides the following options, with explanations in the format + + **option_name**: explanation = default value + +- **`get_mac_address`**: Try to get MAC address for found IP = `False` +- **`get_hostname`**: Try to get hostname for the found IP via DNS (if there are multiple domains using the same IP, only the first is used) = `False` +- **`threads`**: Number of ping threads = `128` +- **`timeout`**: Timeout for each ping = `2000` +- **`retries`**: Number of retries (better to keep it greater than 2) = `4` +- **`print_ips`**: Print all found IPs = `False` +- **`debug`**: Print all debug messages = `False` +- **`nameservers`**: Custom nameservers = `8.8.8.8,8.8.4.4` + +4. The **`[discovery_options]`** section provides the following options, with explanations in the format + + **discovery_option_name**: explanation = default value + +- **`strip_domain_suffix`**: Strip everything after first dot = `False` +- **`category`**: Category for discovered subnets = `String` +- **`create_new_subnet`**: New subnet for networks not found = `False` +- **`overwrite_subnet_categories`**: Overwrite existing subnet categories = `False` +- **`vrfgroup`**: VRF group for discovered subnets = `String` +- **`type`**: Static/DHCP/Reserved = `String` + +### Run and Schedule Ping Sweep jobs + +You can start the process by running the executable from the command line – root or administrator privileges are required. You can also schedule runs using an operating system task scheduler (like `crontab` or `at`). + +### During and After an External Ping Sweep + +You'll see a command prompt after you launch the ping sweep. When completed, the status will change to "Finished". If successful, you will see "Success" messages in the status box, and new and updated subnet and IP information in Device42 + +![](/assets/images/WEB_695_PS41.png) diff --git a/docs/auto-discovery/netflow-collector.md b/docs/auto-discovery/netflow-collector.md index 01cceaf0..6a928986 100644 --- a/docs/auto-discovery/netflow-collector.md +++ b/docs/auto-discovery/netflow-collector.md @@ -5,72 +5,81 @@ sidebar_position: 19 # NetFlow Collector - Device42 -Device42's NetFlow Collector is a powerful tool used to add continuously discovered network communications details to the autodiscovered information from your environment. +The Device42 NetFlow Collector is a powerful tool that adds continuously discovered network communications details to autodiscovered information from your environment. -Both the Device42 Remote Collector (RC) and the Standalone NetFlow Collector are available to collect NetFlow data. If you're just now setting up your first Device42 collector, we recommend setting up an RC – you don't need both – see _Installation_ below. +Both the Device42 Remote Collector (RC) and the standalone NetFlow Collector can collect NetFlow data. If you're setting up your first Device42 collector, we recommend setting up an RC first because you don't need both. + +The sections below detail [installing the Device42 RC for NetFlow collection](#install-the-device42-rc-for-netflow-collection) and [installing the standalone NetFlow Collector](#install-the-device42-standalone-netflow-collector). ## Supported NetFlow Versions -Device42 supports NetFlow data in any of the following versions: v1, v5, v6, v7, v9, and IPFIX (an IETF-defined, open-flow standard). +Device42 supports NetFlow data for versions v1, v5, v6, v7, v9, and IPFIX (an IETF-defined, open-flow standard). ## Installation -Both the Device42 RC and the standalone NetFlow collector are available for downloaded on the autodiscovery tools download page at [https://www.device42.com/autodiscovery/](https://www.device42.com/autodiscovery/). Choose one or the other to get started. If you're just now setting up your first Device42 collector, a Device42 Remote Collector is the recommended option (you don't need both). +Download the Device42 RC or the standalone NetFlow collector from the Autodiscovery tools page at [https://www.device42.com/autodiscovery/](https://www.device42.com/autodiscovery/). + +If you haven't set up a Device42 RC yet, we recommend installing the RC for Netflow collection. Proceed to Step 1 in the next section. -If you already have one or more Device42 remote collectors running, you may want to simply enable NetFlow collection on an existing RC instance; If this is the case, start with Step 2 in the next section. +If you already have one or more Device42 remote collectors running, simply enable NetFlow collection on an existing RC instance. Proceed to Step 2 in the next section. -### Installing the Device42 RC for NetFlow Collection +### Install the Device42 RC for NetFlow Collection -1. To **install the Device42 Remote Collector for NetFlow collection**, see the "RC Installation and Configuration" section of the [Device42 RC documentation page.](auto-discovery/remote-collector-rc.md) After installation, return to this page to complete NetFlow Configuration for your RC. -2. Enable NetFlow collection on your newly installed Device42 RC from the Device42 main menu, _Discovery > Remote Collectors_ and clicking the Name of the Remote Collector you want to use for NetFlow collection: +1. To install the Device42 Remote Collector for NetFlow collection, follow the [RC Installation and Configuration](remote-collector-rc.md#rc-installation-and-configuration/) instructions on the [Remote Collector (RC) page](remote-collector-rc.md). After installation, return to this page to complete NetFlow Configuration for your RC. +2. Enable NetFlow collection on your newly installed Device42 RC from the Device42 main menu under **Discovery > Remote Collectors**. Click the name of the RC you want to use for NetFlow collection. ![](/assets/images/WEB-808_1.png) -3. You should now be at the "View remote collector" screen. Click the "Edit" button in the upper-right hand corner to edit the options for your RC, and expand the section labeled "NetFlow Options" by clicking pm "Show", as pictured: +3. From the **View remote collector** screen, click the **Edit** button on the upper right-hand corner. Scroll to the **NetFlow options** and click **Show**. ![](/assets/images/WEB-808_2.png) -4. To enable NetFlow, Check the "Enable Netflow" checkbox \[Labeled #1 below\]. Choose a "Default Protocol" (either TCP or UDP, labeled #2 below\] if you'll be using one or the other _(otherwise traffic without a protocol will be ignored)_. You may optionally configure IPs to ignore, ports to ignore, or a NetFlow Forwarding IP address by utilizing the other available options on this screen, but this will not be necessary for many setups. Choose "Save" in the lower-right hand corner, and your RC is now configured for NetFlow collection! +4. Configure the NetFlow options: + - Check the **Enable NetFlow** checkbox. + - **Default Protocol:** Choose TCP or UDP if you'll be using one or the other, otherwise traffic without a protocol will be ignored. + - You may optionally configure IPs to ignore, ports to ignore, or a NetFlow Forwarding IP address, but this will not be necessary for many setups. + - Click **Save** in the lower right-hand corner and your RC is now configured for NetFlow collection. ![](/assets/images/WEB-808_3.png) -5. The final step is the ensure all your NetFlow generating devices are sending their NetFlows to the Device42 RC you just configured. If you haven't configured that already, do that now. This procedure will differ depending on the hardware you are using. Consult the manufacturer's directions for help should you need it. +5. Finally, ensure all your NetFlow generating devices are sending their NetFlows to the Device42 RC you just configured. If you haven't configured that already, do that now. This procedure will differ depending on the hardware you are using. Consult the manufacturer's directions for help should you need it. -### Installing the Device42 Standalone NetFlow Collector +### Install the Device42 Standalone NetFlow Collector -**The Standalone NetFlow Collector** doesn't require any installation; it can simply be run from the command line. +The Standalone NetFlow Collector doesn't require any installation; it can simply be run from the command line. -## Running the Standalone NetFlow Collector +## Run the Standalone NetFlow Collector To run the collector, open a command prompt and navigate to the directory it's stored in. Run the collector as follows: `d42-netflow-collector-windows-v100.exe -h https://yourdevice42url -u D42UserName -p D42Password` -This will start the listener on port 2055 (unless a different port is specified) and will begin collecting the data sent to this device from your NetFlow-enabled devices. Ensure you've pointed your switches and/or other NetFlow enabled devices you are using at this NetFlow collector. Each device's NetFlow _output_ should be the IP address of the server you have running the Device42 NetFlow collector. +This will start the listener on port 2055 (unless a different port is specified) and will begin collecting the data sent to this device from your NetFlow-enabled devices. Ensure you've pointed your switches and/or other NetFlow-enabled devices you are using at this NetFlow collector. Each device's NetFlow _output_ should be the IP address of the server you have running the Device42 NetFlow collector. ### Standalone NetFlow Collector Options The following options are available to augment the behavior of `d42-netflow-collector-windows-v100.exe`: ``` --addr string | netflow listen address (default "0.0.0.0:2055") --debug | show netflow info --h string | D42 host name --i int | interval in seconds between sends data to D42 (default 300) --ignore-ip string | ignore IPs --ignore-port string | ignore ports --live-entries | display live entries --live-entries-nok | display OK live entries --live-entries-ok | display NOK live entries --p string | D42 password --print-data | prints data --u string | D42 username +-addr string | netflow listen address (default "0.0.0.0:2055") +-debug | show netflow info +-h string | D42 hostname +-i int | interval in seconds between sends data to D42 (default 300) +-ignore-ip string | ignore IPs +-ignore-port string | ignore ports +-live-entries | display live entries +-live-entries-nok | display OK live entries +-live-entries-ok | display NOK live entries +-p string | D42 password +-print-data | prints data +-u string | D42 username ``` -The NetFlow collector will capture and send data to Device42 in 5-minute increments _\[by default\]_. You may customize this interval using the _\-i_ command switch. +The NetFlow collector will capture and send data to Device42 in 5-minute increments by default. You may customize this interval using the `-i` command switch. -Device42 will attempt to associate the data it receives with known services _(services known to Device42)_. If there are no services with which to associate the collected data, Device42 will retain one million rows of the most recent data, discarding the oldest information as needed. The data in this million-row buffer is matched against as new services are discovered. +Device42 will attempt to associate the data it receives with services known to Device42. If there are no services with which to associate the collected data, Device42 will retain one million rows of the most recent data, discarding the oldest information as needed. As new services are discovered, data is matched against this million-row buffer. ## Licensing Please contact Device42 today for a demo license. Email [support@device42.com](mailto:support@device42.com) to **take NetFlow for a spin today!** + diff --git a/docs/auto-discovery/network-auto-discovery.mdx b/docs/auto-discovery/network-auto-discovery.mdx index 9e8b831e..dc8cf93c 100644 --- a/docs/auto-discovery/network-auto-discovery.mdx +++ b/docs/auto-discovery/network-auto-discovery.mdx @@ -6,32 +6,42 @@ sidebar_position: 27 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -The following steps explain configuring and running SNMP discovery against your network. Please see our [list of vendors supported by Device42 for SNMP autodiscovery](auto-discovery/vendors-supported-in-snmp-auto-discovery.md) for a list of supported hardware vendors. Please let us know if you have a device that needs additional support! +This guide provides instructions for configuring and running Simple Network Management Protocol (SNMP) discovery across your network. -## Intro to SNMP-based discovery +Please see our [list of supported hardware vendors for SNMP autodiscovery](auto-discovery/vendors-supported-in-snmp-auto-discovery.md) and let us know if you have a device that needs additional support! -SNMP, or Simple Network Management Protocol, is a protocol and a standard that is supported by just about any managed network-connected hardware. There are three widely deployed versions: SNMP v1, v2c _(most commonly used)_, and v3. SNMP is typically utilized read-only, but supports read/write and by default utilizes port 161. SNMP exposes management data in the form of 'variables', which are organized in what is known as a MIB, or "Management Information Base". A MIB essentially describes the variables available on a given system, each of which can be remotely queried via SNMP. +## Introduction to SNMP-Based Autodiscovery -**Note**: SNMP autodiscovery now supports IPv6 addresses for device discovery. +SNMP is a widely supported protocol and standard for managing network-connected hardware. There are three broadly deployed versions: SNMP v1, v2c (most commonly used), and v3. -### What can be autodiscovered using SNMP? +SNMP is typically used in a read-only capacity, but it can support read and write permissions. By default, it uses port 161. SNMP exposes management data in the form of variables, which are organized in a Management Information Base (MIB). An MIB essentially describes the variables available on a given system, each of which can be remotely queried via SNMP. Network devices can be discovered by Device42 using SNMP v1, v2c, or v3. If you're looking to do [Storage discovery](storage-arrays-autodiscovery/snmp-san-server-auto-discovery.mdx) via SNMP, you may want to visit the dedicated [SNMP SAN/Server Auto-Discovery](storage-arrays-autodiscovery/snmp-san-server-auto-discovery.mdx) page. SNMP discovery will pull in CDP/LLDP neighbors as long as SNMP credentials are the same across all neighbors. Should the credentials \*not\* be the same, you may instead add devices using different credentials separately, as their own discovery job. -### Specific categories of data SNMP can discover +:::Note +SNMP autodiscovery supports IPv6 addresses for device discovery. +::: + +### SNMP Autodiscovery Items + +Network devices can be discovered by Device42 using SNMP v1, v2c, or v3. If you're looking to do [Storage discovery](storage-arrays-autodiscovery/snmp-san-server-auto-discovery.md) via SNMP, you may want to visit the dedicated [SNMP SAN/Server Autodiscovery](storage-arrays-autodiscovery/snmp-san-server-auto-discovery.md) page. + +SNMP discovery will pull in CDP/LLDP neighbors as long as SNMP credentials are the same across all neighbors. If the credentials are **not** the same, you can add those devices using separate discovery jobs. + +### Categories of Discovered SNMP Data Depending on device type and compatibility matrix linked above, the following data is discovered: -- **Switch inventory:** Switch name, serial #, model and manufacturer. +- **Switch inventory:** Switch name, serial number, model and manufacturer. - **Stacked switches:** For stacked switches, it will add the stack as a cluster device and all physical devices as part of the cluster. -- **Access Points**: Access points will be added as device type other than Controller device as the device host. -- **VLANs**: L2 vlans. -- **Subnets:** L3 subnets. +- **Access Points**: Access points will be added as device type other than controller device as the device host. +- **VLANs**: Layer 2 VLANs. +- **Subnets:** Layer 3 subnets. - **Switch IP and MAC address**: IP address and MAC address belonging to the switch. - **IP to MAC address association:** Basically the ARP table, if available. So all IPs that are available with MAC association. -- **MAC address to switch port association:** Switch ports and MAC addresses found on that port. (MAC table) +- **MAC address to switch port association:** Switch ports and MAC addresses found on that port (MAC table). -MAC to switch port association brings only switch ports that have MAC addresses associated. Using the "Get all switch ports" option you can get: +The MAC to switch port association brings only switch ports with MAC addresses. Use the **Get all switch ports** option to get: - **Port name** - **Port description** @@ -39,11 +49,12 @@ MAC to switch port association brings only switch ports that have MAC addresses - **Port administratively up/down status** - **Remote port connectivity, if any** -* * * ## SNMP discovery jobs -### Create or edit an SNMP discovery job +### Create or Edit an SNMP Discovery Job + +Go to **Discovery > SNMP** to add a new network autodiscovery job. -**Note**: when creating an SNMP job for Cisco Nexus, you must set up an SNMP server context for the management VRF (this actually needs to be done for any Cisco VRF contexts that you want to query over SNMP): snmp\-server context mymgmt vrf management +When creating an SNMP job for Cisco Nexus, you must set up an SNMP server context for the management VRF. This actually needs to be done for any Cisco VRF contexts that you want to query over SNMP: -Go to _Discovery > SNMP_ to add a new network autodiscovery job. +```shell +snmp-server context mymgmt vrf management +``` + +Job configuration fields: - **IP Address**: Enter the IP address of a switch or an IP range. - **Port**: Leave at 161 if you are unsure - **SNMP Version**: Choose SNMP v1, v2c, or v3 -- **Community String**: Save your community string(s) as passwords, and select them for v1 or v2c. See below for v3. +- **Community String**: Save your community strings as passwords, and select them for v1 or v2c. See below for v3. - **Run Autodiscovery on CDP/LLDP Neighbors**: Find all CDP/LLDP neighbors that are reachable. - **Strip Domain Name**: Strip domain name from discovered switch name. - **Get all Switch Ports**: Retrieve all switch ports. - **Delete Switch Ports Not Found**: Delete any switch ports in Device42 that were not found in this discovery. - **Use Alias/Name for port description**: Choose if you prefer the Alias/Name for the port description. -- **Delete older MAC association after**: Delete any MAC addresses not found for the specified number of days. -- **ICMP/TCP Port Check**: If you experience any issues with multicast IPs, then you will need to uncheck the ICMP/TCP Port Check option. +- **Delete older MAC association after**: Specify the number of days after which unfound MAC addresses are deleted. +- **ICMP/TCP Port Check**: If you experience any issues with multicast IPs, uncheck this option. SNMP_ to add a new network autodiscovery job. /> -### Device-specific SNMP v3 info +### Vendor-Specific SNMP v3 Information -Note on Cisco Nexus 7K switches: -- The user for SNMP v3 autodiscovery may need to be in the network-operator / vdc-operator group. +**Cisco Nexus 7K switches:** +- The user for SNMP v3 autodiscovery may need to be in the `network-operator` or `vdc-operator` group. -Note on Huawei Switches: -- By default, some Huawei devices ship with LLDP (link layer discovery protocol) via SNMP off. +**Huawei Switches:** +- By default, some Huawei devices ship with LLDP (Link Layer Discovery Protocol) via SNMP disabled. - You must switch it on by creating a new 'mib-view' and attaching the 'ISO tree' containing the Huawei LLDP MIB to the community. -- Consult Huawei's documentation for complete setup & management details. +- Consult the Huawei documentation for complete setup and management details. -Note on Cisco Switches: +**Cisco Switches:** - Changing from SNMP v1 or v2c to v3 on many Cisco switches can cause SNMP polling of Netdisco to stop functioning, preventing the collection of the per-VLAN MAC tables. - You will likely see an authorization error in the Macsuck log if this is happening. - To fix this authentication error on Cisco hardware, an additional SNMP-server configuration is required on these switches that enables access to the per-VLAN/per-context MAC address table: Switches running newer versions of Cisco IOS: - Simply run this command once: -``` +```shell snmp-server group v3group v3 auth context vlan- match prefix ``` -Switches with older IOS releases (versions that don't support "match prefix wildcard"): +Switches with older IOS releases (that don't support "match prefix wildcard"): - Issue the above command for newer IOS releases on EACH VLAN configured for the switch. - Use `show snmp context` to list configured VLANs. - -* * * - ### Preferred Credentials You can enter preferred community string credentials when you create an SNMP discovery job. When the job runs, it will use the credentials in the order in which you enter them, stopping at the first successful authentication. Subsequent job runs use the last successful credential and then the remaining credentials in the ordered list. -Click on the **+ Add another community string** button at the bottom of the **Credentials** section. Then select the secret for the community string by clicking on the **magnifying glass icon**. +Click on the **+ Add another community string** button at the bottom of the **Credentials** section. Then select the secret for the community string by clicking the **magnifying glass icon**. -Reorder the credentials by clicking on the **up** and **down** arrow buttons to the right of the screen. +Reorder the credentials by clicking the **up** and **down** arrow buttons to the right of the screen. -If you select _Get all switch ports_, you will see 6 extra form items: +If you select **Get all switch ports**, you will see six extra form items: -1. **Port name prefix to ignore macs**: Ignore mac addresses from ports that start with this prefix. +1. **Port name prefix to ignore macs**: Ignore MAC addresses from ports that start with this prefix. 2. **VLANs to ignore**: Do not discover MAC addresses on these VLANs. 3. **Give precedence to hostname**: Check this option to give precedence to the discovered hostname in the network device discovery. -4. **Delete older mac association after**: To keep your mac addresses and switch port connectivity up-to-date leave this at 0. This will delete all stale MAC addresses not discovered on the switch port anymore. Otherwise, you can choose the # of days after you want to delete the stale MAC association with a switch port. +4. **Delete older mac association after**: To keep your mac addresses and switch port connectivity up to date, leave this at "0". This will delete all stale MAC addresses not discovered on the switch port anymore. Otherwise, you can choose the number of days after you want to delete the stale MAC association with a switch port. 5. **Discovered port types to ignore**: You might not want to see certain port types in your switch port list. Here you can choose what port types to ignore. For the first time: - - You will have to let it find the port types the first time, - - and if you want to ignore some, you will have to delete the switch ports manually(you can filter by discovered type on IPAM > Switch Ports), - - add the ports to ignore list on the discovery page -6. **Discovered port types not to count:** Similar to above. This will still bring the ports in, but selected port types will not be included in the count. + - You will have to let it find the port types the first time. + - If you want to ignore specific port types, you must manually delete the corresponding switch ports. You can filter by discovered type under **IPAM > Switch Ports**. + - Add the ports to ignore list on the discovery page +6. **Discovered port types not to count:** Similar to above. This will still bring the ports in, excluding selected port types from the count. ## Run Now or Schedule @@ -209,11 +221,11 @@ Select **Run Now** from the list page to run the job right away. Select **Add another Autodiscovery Schedule** from when editing the job to create a run schedule for the job. -A note on autodiscovery scheduling behavior: newly created jobs will not run on the first day they are created, to prevent an unintended large amount of jobs from running initially. If you would like to run a job after its initial creation, simply select the "Run Now" button next to the job after creation. +A note on autodiscovery scheduling behavior: newly created jobs will not run on the first day they are created, to prevent an unintended large amount of jobs from running initially. If you would like to run a job after its initial creation, simply select the **Run Now** button next to the job after creation. ## Status -You can view the status and/or results of a discovery job during or after the job has run by visiting the job edit screen: +You can view the status and results of a discovery job during or after the job has run by visiting the job edit screen: -You can also see a real-time report of all running jobs and their statuses by visiting _Reports > Job Status:_ +You can also see a real-time report of all running jobs and their statuses by visiting **Reports > Job Status**: -Once you have saved the network switch for autodiscovery, you will need to kick off the autodiscovery process. If not scheduled, click on the "Run now" button on the list, view, or edit page. +When you have saved the network switch for autodiscovery, you will need to run the autodiscovery process. If not scheduled, click on the **Run now** button on the list, view, or edit page. diff --git a/docs/auto-discovery/nmap-autodiscovery.md b/docs/auto-discovery/nmap-autodiscovery.md deleted file mode 100644 index 8b587ec4..00000000 --- a/docs/auto-discovery/nmap-autodiscovery.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "Nmap Autodiscovery" -sidebar_position: 20 ---- - -## Nmap Autodiscovery - -Nmap (network mapper) is a tool primarily used for security scanning. However, it can be used to “guess” which services are running on which ports. Device42 uses Nmap to discover which services are running on which ports and automatically marries this data to [NetFlow](auto-discovery/netflow-collector.md) data to automatically create a map of services and application dependencies. - -## Add an Nmap Autodiscovery Job - -Select _Discovery > Nmap_ to display the Nmap autodiscovery page, then click _Add Nmap autodiscovery spec_ to display the Add Nmap autodiscovery page.  - -![](/assets/images/D42-22946_nmap-ad-add-page.jpg) - -The following fields are required for an Nmap job: - -- **Name** – name of the job -- **Remote Collector** – the D42 ID for the remote collector to use for the job -- **Target Host(s) and Network(s)** – IP list (comma separated), IP range, CIDR block(s), or hostname(s) to use for Nmap discovery - -Available Nmap job options: - -- **Exclude Target Host(s) and Network(s)** – IP list (comma separated), IP range, CIDR block(s), or hostname(s) to exclude from the discovery -- **Nameserver to use for reverse DNS** – the IP/FQDN of the nameserver -- **OS Detection** – detect operating system(s) and versions (default on) -- **Services Detection** – detect running services (default on) -- **Object Category for discovered devices** – select an existing object category or add a new category -- **VRF Group for discovered IP addresses and subnets** – select an existing group or add a new group -- **Overwrite existing object categories** – overwrite the object categories for existing discovered devices and child devices. -- **Tags for discovered devices** – comma separated list of device tags - -You can also create an Auto Discovery Schedule for the job – click _Add another Auto Discovery Schedule_ at the bottom of the page. Click _Save_ to save the job and add it to the jobs list. You can then run the job immediately if you want.  - -![](/assets/images/D42-22946_nmap-ad-list-page.jpg) - -## Nmap / NetFlow Autodiscovery Notes - -In Device42, NetFlow and Nmap can be used by themselves, together, or in combination with point-in-time discovery. Using NetFlow and Nmap data together but without point-in-time discovery results in a good services dependency mapping capability. However, just using these two sources of data is still limited in the following ways. - -1. A map of service inter-dependencies and interrelationships can be created. However, many services often combine to form an application. For example, there might be multiple Oracle services plus configuration files that together form the Oracle application. Applications and associated information (e.g., installed apps on a web server and instances and named pipes on a database) cannot be discovered by the NetFlow/Nmap combination. -2. The services that Nmap finds are guesses and the guessed version number is probably wrong as often as it is right. -3. Some enterprises have such restrictive firewall rules that Nmap will discover few if any services. -4. NetFlow can’t “see” application interactions inside a physical/virtual/cloud server. NetFlow can only see interactions that go through the router. So, many dependencies will be missed. -5. While NetFlow works well for physical routers and switches, it is not great for the virtual routers and switches found in hyper-visors because many hyper-visors do not support NetFlow. -6. On routers and switches, NetFlow must be setup for every segment. If some segments are not setup, the application interactions will not be found. - -To overcome these limitations, it is better to use NetFlow/Nmap in conjunction with point-in-time discovery. - -## Run Now or Schedule - -![](/assets/images/image-700x115.png) - -Select **Run Now** from the list page to run the job right away. - -![](/assets/images/AD_Blade-Discovery-Run-Schedule.png) - -Select **Add another Auto Discovery Schedule** from the when editing the job to create a run schedule for the job. - -A note on autodiscovery scheduling behavior: newly created jobs will not run on the first day they are created, to prevent an unintended large amount of jobs from running initially. If you would like to run a job after its initial creation, simply select the "Run Now" button next to the job after creation. diff --git a/docs/auto-discovery/nmap-autodiscovery.mdx b/docs/auto-discovery/nmap-autodiscovery.mdx new file mode 100644 index 00000000..3627f0e2 --- /dev/null +++ b/docs/auto-discovery/nmap-autodiscovery.mdx @@ -0,0 +1,80 @@ +--- +title: "Nmap Autodiscovery" +sidebar_position: 20 +--- + +import ThemedImage from '@theme/ThemedImage' +import useBaseUrl from '@docusaurus/useBaseUrl' + +## Nmap Autodiscovery + +Nmap (network mapper) is a tool primarily used for security scanning. However, it can be used to “guess” which services are running on which ports. Device42 uses Nmap to discover which services are running on which ports and automatically combines this data with the [NetFlow](auto-discovery/netflow-collector.md) data to automatically create a map of services and application dependencies. + +## Add a Nmap Autodiscovery Job + +Navigate to the **Discovery > Nmap** list page and click **Add Nmap autodiscovery spec** to create a new Nmap autodiscovery job.  + +Enter the following required fields for the Nmap job: + +- **Name:** Unique name for the job +- **Remote Collector:** The Device42 ID for the remote collector to use for the job. +- **Target Host(s) and Network(s):** A comma-separated list of IP addresses, IP ranges, CIDR block(s), or hostname(s) to use for Nmap discovery. + + + +You can optionally configure these Nmap job options: + +- **Exclude Target Host(s) and Network(s):** A comma-separated list of IP addresses, IP ranges, CIDR block(s), or hostname(s) to exclude for Nmap discovery. +- **Nameserver to use for reverse DNS:** The IP address or FQDN of the nameserver. +- **OS Detection**: On by default. Detect operating systems and versions. +- **Service and Version Detection**: On by default. Detect running services. +- **Object Category for discovered devices:** Select an existing object category or add a new category. +- **VRF Group for discovered IP addresses and subnets:** Select an existing VRF group or add a new group. +- **Overwrite existing object categories:** Overwrite the object categories for existing discovered devices and child devices. +- **Tags for discovered devices:** Add a comma-separated list of device tags. + + + +## Run Now or Schedule + +Select **Add another Auto Discovery Schedule** when creating or editing the job to add a schedule for the job. + + +

+ +Save the job to add it to the jobs list. Click **Run Now** from the list page to run the job right away. + +![](/assets/images/D42-22946_nmap-ad-list-page.jpg) + +Note that newly created jobs will not run on the first day they are created to prevent an unintentionally large amount of jobs from initially running. If you would like to run a job after its initial creation, click the **Run Now** button next to the job after creation. + +## Nmap and NetFlow Autodiscovery Notes + +In Device42, NetFlow and Nmap can be used by themselves, together, or in combination with point-in-time discovery. Using NetFlow and Nmap data together but without point-in-time discovery results in a good services dependency mapping capability. However, just using these two sources of data is still limited in the following ways: + +1. A map of service inter-dependencies and interrelationships can be created. However, many services often combine applications and associated information to form the entire application. For example, there might be multiple Oracle services plus configuration files that together form the Oracle application. Installed apps on a web server and instances and named pipes on a database cannot be discovered by the NetFlow/Nmap combination. +2. The services that Nmap finds are guesses and the guessed version number is probably wrong as often as it is right. +3. Some enterprises have such restrictive firewall rules that Nmap will discover few if any services. +4. NetFlow can’t “see” application interactions inside a physical, virtual, or cloud server. NetFlow can only see interactions that go through the router. So, many dependencies will be missed. +5. While NetFlow works well for physical routers and switches, it's not great for the virtual routers and switches found in hyper-visors because many hyper-visors do not support NetFlow. +6. On routers and switches, NetFlow must be set up for every segment. If some segments are not set up, the application interactions will not be found. + +To overcome these limitations, it is better to use NetFlow and Nmap in conjunction with point-in-time discovery. diff --git a/docs/auto-discovery/operating-systems-supported-in-auto-discovery.md b/docs/auto-discovery/operating-systems-supported-in-auto-discovery.md index 59ad4b64..61f61642 100644 --- a/docs/auto-discovery/operating-systems-supported-in-auto-discovery.md +++ b/docs/auto-discovery/operating-systems-supported-in-auto-discovery.md @@ -3,18 +3,109 @@ title: "Operating Systems Supported in Autodiscovery" sidebar_position: 21 --- -## Background: The Device42 Test Lab +## Background on the Device42 Test Lab -We test on as many operating systems as we can get our hands on for agentless autodiscovery. This list is by no means exhaustive or exclusive but should provide a good starting point. As a general rule - _if there's an OS giving a customer trouble, we're happy to try to build in support for it._ Note all discoveries can be run without agents via the Device42 main appliance or can optionally utilize one or more remote collectors. Agentless Windows discovery requires that at least one instance of the Windows Discovery Service (WDS) be deployed somewhere on your network that can reach your desired discovery targets. +We test on as many operating systems as we can get our hands on for agentless autodiscovery. This list is by no means exhaustive or exclusive but should provide a good starting point. As a general rule, if there's an OS giving you trouble, we're happy to try and build in support for it. You can [email support](mailto:support@device42.com) or [submit a request](https://support.device42.com/) on our website. -**Major Linux distributions** should all work well with autodiscovery, including: **Debian / Ubuntu, Redhat / CentOS / Fedora, SuSe, OpenSuSE**, etc. **Most UNIX distros** are well supported including **AIX, OpenBSD, FreeBSD, HP-UX, and Solaris**; other UNIX distros should also be autodiscovered (via SSH). +:::note +All discoveries can be run without agents on the Device42 Main Appliance with the option of using one or more remote collectors. Agentless Windows discovery requires at least one instance of the Windows Discovery Service (WDS) to be deployed on your network, where it can reach your desired discovery targets. +::: -Major **Windows releases (7, 8, 10, Server 2000+) are all supported**, and should all work well with autodiscovery (via WMI/WinRM). +## Supported Distros and Operating Systems -If you are running at least Device42 v15.14.02+, discovery of the **IBM i powered mid-range** line and IBM z/OS powered mainframes is also supported. +**Major Linux distributions** work well with autodiscovery, including: +- Debian +- Ubuntu +- Red Hat +- CentOS +- Fedora +- SUSE +- OpenSUSE + +**Most UNIX distros** are well supported, including: +- AIX +- OpenBSD +- FreeBSD +- HP-UX +- Solaris -  +Other UNIX distros should also work well with autodiscovery (via SSH). -## Tested distros / operating systems +Major **Windows releases (7, 8, 10, Server 2000+) are all supported** and should all work well with autodiscovery (via WMI/WinRM). -
  • AIX 5
  • AIX 6
  • AIX 7
  • CentOS 5.11
  • CentOS 6.5
  • CentOS 6.7
  • CentOS 6.8
  • CentOS 6.9
  • CentOS 7.2
  • CentOS 8
  • Debian 7.10
  • Debian 7.11
  • Debian 8.4
  • Debian 8.5
  • Debian 9
  • Fedora
  • FreeBSD 10.3-RELEASE
  • FreeBSD 9.3-RELEASE
  • HP-UX 11
  • IBM i v7.1 (English & Spanish locales)
  • IBM z/OS 2.1, 2.3
  • Microsoft Windows 7
  • Microsoft Windows 8
  • Microsoft Windows 10
  • Microsoft Windows(R) Server 2003, Enterprise Edition SP2
  • Microsoft Windows(R) Server 2003 Standard x64 Edition SP2
  • Microsoft Windows Server 2008 Enterprise SP1
  • Microsoft Windows Server 2008 R2 Datacenter SP1
  • Microsoft Windows Server 2008 R2 Standard SP1
  • Microsoft Windows Server 2012
  • Microsoft Windows Server 2012 R2
  • Microsoft Windows Server 2016
  • Microsoft Windows Server 2019
  • Microsoft Windows Server 2022
  • Miracle Linux 8.4
  • OpenVMS 8.4
  • Oracle Linux Server 6.7
  • Oracle Linux Server 6.8
  • Oracle Linux Server 7.2
  • Oracle Linux Server 8
  • Redhat 5.x, 6.x, 7.x, 8.x
  • Red Hat Enterprise Linux Server 5.x, 6.x, 7.x, 8.x, 9.x
  • Solaris Sparc/x86 6
  • Solaris Sparc/x86 7
  • Solaris Sparc/x86 8
  • Solaris Sparc/x86 9
  • Solaris Sparc/x86 10
  • Solaris Sparc/x86 11
  • SuSE 11
  • SuSE 12
  • SUSE Linux Enterprise 11
  • SUSE Linux Enterprise 12
  • Ubuntu 12.04
  • Ubuntu 14.04
  • Ubuntu 16.04
  • Ubuntu 18.04
  • Ubuntu 20.04
  • Ubuntu 22.04
` +If you are running Device42 v15.14.02+, discovery of the **IBM i powered mid-range** line and **IBM z/OS** powered mainframes are also supported. + +## Tested Distros and Operating Systems + + + + + + + + +
+
    +
  • AIX 5
    • +
  • AIX 6
    • +
  • AIX 7
    • +
  • CentOS 5.11
    • +
  • CentOS 6.5
    • +
  • CentOS 6.7
    • +
  • CentOS 6.8
    • +
  • CentOS 6.9
    • +
  • CentOS 7.2
    • +
  • CentOS 8
    • +
  • Debian 7.10
    • +
  • Debian 7.11
    • +
  • Debian 8.4
    • +
  • Debian 8.5
    • +
  • Debian 9
    • +
  • Fedora
    • +
  • FreeBSD 10.3-RELEASE
    • +
  • FreeBSD 9.3-RELEASE
    • +
  • HP-UX 11
    • +
  • IBM i v7.1 (English & Spanish locales)
    • +
  • IBM z/OS 2.1, 2.3
    • +
  • Microsoft Windows 7
    • +
  • Microsoft Windows 8
    • +
  • Microsoft Windows 10
    • +
  • Microsoft Windows(R) Server 2003, Enterprise Edition SP2
    • +
  • Microsoft Windows(R) Server 2003 Standard x64 Edition SP2
    • +
  • Microsoft Windows Server 2008 Enterprise SP1
    • +
  • Microsoft Windows Server 2008 R2 Datacenter SP1
    • +
  • Microsoft Windows Server 2008 R2 Standard SP1
    • +
+ 		+
    +
  • Microsoft Windows Server 2012
    • +
  • Microsoft Windows Server 2012 R2
    • +
  • Microsoft Windows Server 2016
    • +
  • Microsoft Windows Server 2019
    • +
  • Microsoft Windows Server 2022
    • +
  • Miracle Linux 8.4
    • +
  • OpenVMS 8.4
    • +
  • Oracle Linux Server 6.7
    • +
  • Oracle Linux Server 6.8
    • +
  • Oracle Linux Server 7.2
    • +
  • Oracle Linux Server 8
    • +
  • Redhat 5.x, 6.x, 7.x, 8.x
    • +
  • Red Hat Enterprise Linux Server 5.x, 6.x, 7.x, 8.x, 9.x
    • +
  • Solaris Sparc/x86 6
    • +
  • Solaris Sparc/x86 7
    • +
  • Solaris Sparc/x86 8
    • +
  • Solaris Sparc/x86 9
    • +
  • Solaris Sparc/x86 10
    • +
  • Solaris Sparc/x86 11
    • +
  • SuSE 11
    • +
  • SuSE 12
    • +
  • SUSE Linux Enterprise 11
    • +
  • SUSE Linux Enterprise 12
    • +
  • Ubuntu 12.04
    • +
  • Ubuntu 14.04
    • +
  • Ubuntu 16.04
    • +
  • Ubuntu 18.04
    • +
  • Ubuntu 20.04
    • +
  • Ubuntu 22.04
    • +
+
diff --git a/docs/auto-discovery/packet-capture.md b/docs/auto-discovery/packet-capture.md index 85739bac..1f386e8c 100644 --- a/docs/auto-discovery/packet-capture.md +++ b/docs/auto-discovery/packet-capture.md @@ -3,151 +3,162 @@ title: "Packet Capture" sidebar_position: 22 --- -The [Device42 Packet Capture tool](https://www.device42.com/autodiscovery/) enables packet capture to be leveraged as a means of discovery \[v16.00+\]. Packet capture is capable of discovering service communication happening in real-time for any service listeners that are known to Device42, and therefore with packet capture, users can discover even those service communications that happen too infrequently to have been otherwise captured by scheduled discovery jobs. +The [Device42 Packet Capture tool](https://www.device42.com/autodiscovery/) enables packet capture to be leveraged as a means of discovery. Packet capture discovers service communication happening in real-time for any service listeners known to Device42. It lets you discover service communications that are too infrequent for scheduled discovery jobs to catch. -Device42 Packet capture supports both individual and Promiscuous interfaces allowing you the flexibility to deploy and leverage packet capture in whatever way makes the most sense for your IT environment. +Device42 packet capture supports both individual and promiscuous interfaces, allowing you the flexibility to deploy and use packet capture in the way that makes the most sense for your IT environment. ## Prerequisites -- A functioning Device42 MA _(destination for captured data), running v16.00.00+ or newer_ +You need the following to use the Device42 Packet Capture tool: + +- A Device42 Main Appliance (MA) running v16.00.00 or above. - Network communication allowed from the machine you'll be capturing packets on to your Device42 MA. -- An active network adapter connected to the target traffic capture network -- If using **Windows**, a _WinPcap-compatible library (like_ [_npcap_](https://npcap.com/)_)_ must be installed - **_Be sure to select the option “install in API-Compatible mode”during setup!_** -- If using **Linux**_, libpcap_ must be installed to support packet capture. -- OPTIONAL: Promiscuous mode _\[aka ‘monitor’ mode\]_ enabled for the network and/or the interface of interest. +- An active network adapter connected to the target traffic capture network. +- A packet capture library installed on your operating system: + - On **Windows**, use a WinPcap-compatible library like [Npcap](https://npcap.com/). Be sure to select the **Install in API-Compatible mode** option during setup. + - On **Linux**, use `libpcap`. + +You can optionally enable promiscuous mode (aka 'monitor' mode) for the network or the interface of interest. -Reference the [Packet Capture 101 video](https://www.youtube.com/watch?v=y1U37Xc9V2k) for a quick overview of D42 Packet Capture setup and usage. +:::tip +Watch our [Intro to Packet Capture video](https://www.youtube.com/watch?v=y1U37Xc9V2k) for a quick overview of how to set up and use packet capture with Device42. +::: ## Configuration -1. Download the appropriate version of the utility _\[Windows or \*nix\],_ and extract to the destination of your choice. -2. Place the configuration file _d42pcap.json_ into the directory you extracted the utility into. -3. On **Linux**, symlink _libpcap_ as required by the application, as the application is searching for the filename _libpcap.so.1_: - - `sudo ln -s /usr/lib/x86_64-linux-gnu/libpcap.so.1.8.1 /usr/lib/x86_64-linux-gnu/libpcap.so.1` +1. [Download](https://www.device42.com/autodiscovery/) the compressed `d42-packet-capture.zip` utility file and extract the contents to a directory of your choice. +2. Place the `d42pcap.json` config file into the directory with the utility. +3. On **Linux**, create a symlink for `libpcap` as required by the application, as it searches for the filename `libpcap.so.1`: + ```bash + sudo ln -s /usr/lib/x86_64-linux-gnu/libpcap.so.1.8.1 /usr/lib/x86_64-linux-gnu/libpcap.so.1 + ``` -4. On **Windows:** _no extra configuration needed._ -5. Configure the utility by editing `d42pcap.json`. At minimum, configure the following sections to run the Packet Capture utility: + On **Windows**, no extra configuration is needed. +4. Configure the utility by editing the `d42pcap.json`file. At minimum, configure the following sections to run the Packet Capture utility: - 1. **Point the utility at your Device42 instance** by inputting its IP, user, and PW into the ‘device42’ section of the config; save the file. - 2. Enter the name of your capture interface in the device property of the pcap section _(use name as shown under \`ipconfig\` on windows, or \`ifconfig\` on Linux, e.g. \`ens32\`)_ - 3. Adjust the interval property of the common section; default is to relay 60-second chunks of capture data to Device42 so as not to overwhelm the MA if not using filtering and/or capturing traffic from many devices. + - **Point the utility at your Device42 instance** by inputting its IP address, username, and password in the `device42` section of the config file. Save the file. + - Enter the name of your capture interface in the `device` property of the `pcap` section. Use the name as shown under `ipconfig` on Windows or `ifconfig` on Linux. For example, `ens32`. + - Adjust the interval property of the common section. The default is to relay 60-second chunks of capture data to Device42 to not overwhelm the MA, especially if filtering isn't used or you're capturing traffic from many devices. -6. The utility may be installed to run as a Windows or Linux Service as desired. See “installing as a service” section of this document. +5. The utility may be installed to run as a Windows or Linux Service as desired. See the [Installing Device42 Packet Capture as a System Service](#installing-device42-packet-capture-as-a-system-service) section. ## Executing the Packet Capture Utility -1. Ensure all _prerequisites_ are met as described in the section of this document by the same name. -2. Configure the utility as described in the "Configuration" section above. -3. Execute the utility: +1. Ensure all [Prerequisites](#prerequisites) are met. +2. Configure the utility as described in the [Configuration](#configuration) section above. +3. Execute the utility by running: - Windows:     `c:\>  d42pcap.exe` - Linux:     `$ sudo ./d42pcap_linux_64` -4. Optional runtime parameters are as follows: +4. Optionally configure the following runtime parameters: | Parameter | Description | | ------------------- | ---------------------------------------------------------------------------------- | -| list-devices | Lists all network adapters on the host | -| version | Prints the version of the utility | -| logs-dir | Overrides the directory to which log files are written | -| settings-dir | The directory containing the utility’s JSON configuration file | -| settings-name | The name of the utility’s JSON configuration file | -| debug | Turns on debug logging | -| install-win-service | Installs the utility as a Windows service (Windows executable only) | -| remove-win-service | Removes the utility from the installed Windows services. (Windows executable only) | +| `list-devices` | Lists all network adapters on the host | +| `version` | Prints the version of the utility | +| `logs-dir` | Overrides the directory to which log files are written | +| `settings-dir` | The directory containing the utility’s JSON configuration file | +| `settings-name` | The name of the utility’s JSON configuration file | +| `debug` | Turns on debug logging | +| `install-win-service` | Installs the utility as a Windows service (Windows executable only) | +| `remove-win-service ` | Removes the utility from the installed Windows services. (Windows executable only) | ## Configuration File Definitions | Section | Description | | -------- | ----------------------------------------------------------------------------------------------------------- | -| device42 | Contains settings required to interact with Device42. | -| common | Contains common application settings. | -| pcap | Contains settings that affect how raw network packets are handled. | -| capture | Settings affect D42 Netflow/Packet Capture engine event processing. Note: Section intended for D42 support. | +| `device42` | Contains settings required to interact with Device42. | +| `common` | Contains common application settings. | +| `pcap` | Contains settings that affect how raw network packets are handled. | +| `capture` | Settings affect Device42 Netflow and Packet Capture engine event processing. Note: Section intended for Device42 support. | ### Device42 Configuration | Property | Description | Required | | -------- | --------------------------------- | -------- | -| Host | Base URL of the Device42 Web site | yes | -| User | User name | yes | -| Password | Password | yes | +| `Host` | Base URL of the Device42 website | yes | +| `User` | Username | yes | +| `Password` | Password | yes | -### COMMON configuration +### Common configuration | Property | Description | Required | | -------- | -------------------------------------------------------------------------- | -------- | -| Interval | The number of seconds to collect network events before sending to Device42 | yes | -| logs-dir | The directory to which log files are written | no | +| `Interval` | The number of seconds to collect network events before sending to Device42 | yes | +| `logs-dir` | The directory to which log files are written | no | ### PCAP Configuration Section | Property | Description | Required | | ----------------------------- | ---------------------------------------------------------------------------- | -------- | -| Device | Specify network capture interface | yes | -| include-source-tcp-ports | TCP source ports to include | no | -| include-destination-tcp-ports | TCP destination ports to include | no | -| include-source-udp-ports | UDP source ports to include | no | -| include-destination-udp-ports | UDP destination ports to include | no | -| include-source-tcp-ips | TCP source IPs to include | no | -| include-dest-tcp-ips | TCP destination IPs to include | no | -| include-source-udp-ips | UDP source IPs to include | no | -| include-dest-udp-ips | UDP destination IPs to include | no | -| ignore-tcp | Ignore all TCP network events | no | -| ignore-udp | Ignore all UDP network events | no | -| promiscuous-mode | true captures all packets passed & received rather than just host packets | yes | -| sniff-timeout | Duration in nanoseconds to wait for network events to be read. (Default = 2) | yes | -| snap-length | Length of raw network packets to collect. (Default = 1600) | yes | - -### CAPTURE Configuration Section +| `Device ` | Specify network capture interface | yes | +| `include-source-tcp-ports` | TCP source ports to include | no | +| `include-destination-tcp-ports` | TCP destination ports to include | no | +| `include-source-udp-ports` | UDP source ports to include | no | +| `include-destination-udp-ports`| UDP destination ports to include | no | +| `include-source-tcp-ips ` | TCP source IPs to include | no | +| `include-dest-tcp-ips` | TCP destination IPs to include | no | +| `include-source-udp-ips` | UDP source IPs to include | no | +| `include-dest-udp-ips` | UDP destination IPs to include | no | +| `ignore-tcp` | Ignore all TCP network events | no | +| `ignore-udp` | Ignore all UDP network events | no | +| `promiscuous-mode` | `true` captures all packets passed and received rather than just host packets | yes | +| `sniff-timeout` | Duration in nanoseconds to wait for network events to be read. (Default = 2) | yes | +| `snap-length` | Length of raw network packets to collect. (Default = 1600) | yes | + +### Capture Configuration Section | Property | Description | Required | | ------------------- | ------------------------- | -------- | -| live-entries | Display live entries | no | -| live-entries-ok | Display OK live entries | no | -| live-entries-nok | Display NOK live entries | no | -| print-data | Print data | no | -| ignore-ips | Ignored IPs | no | -| ignore-ports | Ignored Ports | no | -| pass-to | Reserved for Device42 use | no | -| default-protocol | Reserved for Device42 use | no | -| only-stats | Reserved for Device42 use | no | -| report-any-ip | Reserved for Device42 use | no | -| report-src-ip | Reserved for Device42 use | no | -| report-dst-ip | Reserved for Device42 use | no | -| unprocessed-packets | Reserved for Device42 use | no | - -## Installing D42 Packet Capture as a System Service +| `live-entries` | Display live entries | no | +| `live-entries-ok` | Display OK live entries | no | +| `live-entries-nok` | Display NOK live entries | no | +| `print-data` | Print data | no | +| `ignore-ips` | Ignored IPs | no | +| `ignore-ports` | Ignored Ports | no | +| `pass-to` | Reserved for Device42 use | no | +| `default-protocol` | Reserved for Device42 use | no | +| `only-stats` | Reserved for Device42 use | no | +| `report-any-ip` | Reserved for Device42 use | no | +| `report-src-ip` | Reserved for Device42 use | no | +| `report-dst-ip` | Reserved for Device42 use | no | +| `unprocessed-packets` | Reserved for Device42 use | no | + +## Installing Device42 Packet Capture as a System Service **On Windows:** -Simply execute with the ‘install-win-service’ flag or follow the instructions to create a new Linux service daemon. +Simply execute with the `install-win-service` flag or follow the instructions to create a new Linux service daemon. -``` +```shell C:\\> d42pcap -install-win-service ``` **On Linux Daemon** -1. To run the utility as a Linux daemon, create a service file like the following example in /etc/systemd/system: +1. To run the utility as a Linux daemon, create a service file like the following example in the `/etc/systemd/system` directory: -``` -[Unit] -Description=Device42 Packet Capture Utility - -[Service] -PIDFile=/tmp/d42pcap.pid -User=root -Group=root -WorkingDirectory=/usr/bin -ExecStart=/usr/bin/d42pcap -Restart=always - -[Install] -WantedBy=multi-user.target -``` + ``` + [Unit] + Description=Device42 Packet Capture Utility -5. Enable and then start the service: + [Service] + PIDFile=/tmp/d42pcap.pid + User=root + Group=root + WorkingDirectory=/usr/bin + ExecStart=/usr/bin/d42pcap + Restart=always -`sudo systemctl enable d42pcap.service` + [Install] + WantedBy=multi-user.target + ``` -`sudo systemctl start d42pcap.service` +2. Enable and then start the service: + +```bash +sudo systemctl enable d42pcap.service +``` + +```bash +sudo systemctl start d42pcap.service +``` diff --git a/docs/getstarted/faqs/index.mdx b/docs/getstarted/faqs/index.mdx index 0128cc46..07b77a60 100644 --- a/docs/getstarted/faqs/index.mdx +++ b/docs/getstarted/faqs/index.mdx @@ -1,19 +1,22 @@ --- -title: "FAQ's" +title: "FAQs" --- import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Whether you're new to Device42 or a seasoned pro, this list of **Device42 frequently asked questions** probably has information you'll find useful. This list is updated pretty regularly, and contains a selection of the questions most often asked about Device42. +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 are looking for help getting up and running, please refer to our [getting started guide](getstarted/index.md) if you're looking for help getting your instance up and running. The getting started guide is tailored to new users, specifically. +If you've just downloaded Device42 for the first time and want help getting your instance up and running, our [Getting Started](getstarted/index.md) guide is specifically tailored for users who are new to our software. -## How do I log into my Device42 instance? +## How Do I Log In to My Device42 Instance? -With a default configuration, visit: `https://IP_or_fqdn_for_device42_vm` in your favorite web browser, and then log in by entering the following \[default\] credentials: Default user: `admin` Default pass: `adm!nd42` +With a default configuration, visit `https://IP_or_fqdn_for_device42_vm` in your favorite web browser, and log in using the following default credentials: -## Which browser should I use? +- Username: `admin` +- Password: `adm!nd42` + +## Which Browser Should I Use? Device42 recommends using the web browsers (or more recent versions) listed below. @@ -22,44 +25,63 @@ Device42 recommends using the web browsers (or more recent versions) listed belo - Firefox — 72.0.1 - Safari — 13.1.2 (13609.3.5.1.5) -## How do I get my current data into Device42? +## How Do I Get My Current Data Into Device42? + +You can use any of the following tools to import your data to Device42: + +- [**Device42 autodiscovery**](auto-discovery/index.mdx): Device42 features a variety of autodiscovery methods for different user needs, including SNMP network device discovery, VMware autodiscovery, ping sweep, Windows and Linux autodiscovery, and more. You may also use individual Python or PowerShell scripts to customize and automate your discovery and inventory processes. + + :::note + Review the [recommended initial discovery sequence](auto-discovery/autodisc-best-practices.md) to learn more. + ::: -**There are many ways to get your data into Device42**: +- [**Microsoft Excel / CSV (spreadsheet) import**](integration/imports/index.md): 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). +- [**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 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.md) to create PDUs, [switch port templates](infrastructure-management/ipam/switch-templates.md) to create switches and ports, and [patch panel models](infrastructure-management/power-units/defining-pdu-models.md) to create patch panel ports and bulk backport connectivity for patch panels. -- [**Device42 Auto-discovery**](auto-discovery/index.mdx): D42 features a variety of autodiscovery methods, the best of which depends on your needs: SNMP network device discovery, VMware auto-discovery, ping sweep, Windows and Linux auto-discovery, and more; you may also use individual python/powershell scripts to customize & automate your discovery and/or inventory process. Read about the [recommended initial discovery sequence](auto-discovery/autodisc-best-practices.md) here, as well! -- [**Microsoft Excel / CSV (spreadsheet) import**:](integration/imports/index.md) _Tools > Imports/Exports (xls)_ has options for MS Excel spreadsheet import, including sample Excel sheets that will help you format your existing spread sheets to make bringing your existing data into Device42 as easy as possible. -- The [**Device42 Generic Import Tool**](https://www.device42.com/blog/2018/06/19/new-features-added-to-the-generic-import-tool/) is another way to import data from existing spreadsheets of just about any format, mapping fields as appropriate via the Device42 generic import tool. For manual spreadsheet import, see this [walkthrough on how to best format an existing spreadsheet for import into Device42.](getstarted/importing-data-from-existing-spreadsheets.mdx) -- [**RESTful APIs**](https://api.device42.com): Programatically automate your network documentation and/or leverage your asset data for scripts & automation! Add these to your regular work flow to leverage Device42 as single source of truth for systems such as provisioning and monitoring. -- The **Device42 Web UI**: Of course, you can always use the web-UI _(user interface)_ to add data :) -- **Templates/bulk operations**: Certain types of objects are easier to add using templates or models. For example, [PDU models](infrastructure-management/power-units/defining-pdu-models.md) to create PDUs, [Switch port templates](infrastructure-management/ipam/switch-templates.md) to create switches and ports, [Patch panel models](infrastructure-management/power-units/defining-pdu-models.md) to create patch panel ports and bulk back port connectivity for patch panels. +## What Is the Recommended Order for Running Different Discoveries? -## 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. -See the "Recommended Initial Discovery Sequence" section of the [autodiscovery best practices](/auto-discovery/autodisc-best-practices/) page for a full detailed rundown. +**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. -**In short**: run network discovery first to build your Layer 2 network landscape. Discovered devices, going forward, are added to their appropriate subnets as they are discovered -- _Note that if device discoveries are run before the subnets for those devices exist in Device42, you might run into issues and/or create extra work for yourself!_ +:::note +If device discoveries are run before the subnets for devices that exist in Device42, you might run into issues or create extra work for yourself! +::: -## How do I set up an RC / Remote collector? +## How Do I Set Up a Remote Collector? -Setting up a remote collector is easy! See the [RC Setup Instructions](auto-discovery/remote-collector-rc.md) which include deployment examples. +Easily set up a Remote Collector (RC) by referring to the instructions and deployment examples on the Device42 [Remote Collector](auto-discovery/remote-collector-rc.md) page. -## How do I migrate my existing data from other tools? +## How Do I Migrate My Existing Data From Other Tools? -We provide few ready to use scripts to migrate your data from tools like RackTables, Rackmonkey, OpenDCIM, Solarwinds IPAM, Aperture etc. and the download links can be found at [Device42 Migration page](https://www.device42.com/migrations/) or at [Device42 github repository](https://github.com/device42). +The Device42 [Migrations](https://www.device42.com/migrations/) page provides a few ready-to-use scripts for migrating your data from tools like RackTables, Rackmonkey, OpenDCIM, SolarWinds IPAM, Aperture, etc. The download links for these scripts can also be found in the [Device42 GitHub repository](https://github.com/device42). -## What discovery jobs can I run from a Remote Collector / RC? +## Which Discovery Jobs Can I Run From a Remote Collector? -Current releases of Device42 support ALL discovery jobs, now including WMI & Power SNMP from RC's. If you are reading this, all of them! [Setup your RC](auto-discovery/remote-collector-rc.md) today! (RC will only automatically update when it coincides with an MA update) +Current releases of Device42 support **all** discovery jobs, including WMI and Power SNMP from RCs. [Set up your RC](auto-discovery/remote-collector-rc.md) today! -## How do I Migrate Existing Power Appliance Jobs to a Remote Collector (RC)? +:::note +RCs will only automatically update when an RC update coincides with an MA update. +:: -Migrating jobs that were created for the original standalone power appliance is possible with existing tools. Simply follow the [existing power job migration guide here](infrastructure-management/power-and-environmental-monitoring/power-rc-setup-job-migration.md) to migrate jobs to the new RC of your choice. +## How Do I Migrate Existing Power Appliance Jobs to a Remote Collector? -## How do I add blade servers to Device42? +You can use existing tools to migrate jobs that were created for the original standalone power appliance to a new RC of your choosing. Simply follow the [Power RC Setup and Existing Job Migration](infrastructure-management/power-and-environmental-monitoring/power-rc-setup-job-migration.md) guide. -This topic has been discussed on support portal : [How to represent blade servers in Device42?](https://support.device42.com/hc/en-usentries/23369387) tldr; Add a new device with "blade chassis" selected. Then you add devices, type "blade", and choose the blade chassis device as the host device. _Note that blade chassis accept blades in "blade slots", which you can custom-configure to match your chassis & port layout!_ +## How Do I Add Blade Servers to Device42? -## How do I handle unknown device types? +The Device42 Support Portal article, [How to represent blade servers in Device42](https://support.device42.com/hc/en-us/articles/222221468-How-to-represent-blade-servers-in-device42#:~:text=When%20adding%20a%20new%20device,the%20blade%20server%20belongs%20to.), discusses this in detail. + +**In short**: Add a new device with "blade chassis" selected. When you add devices, type "blade" and choose the blade chassis device as the host device. + +:::note +Blade chassis accept blades in "blade slots" that you can custom-configure to match your chassis and port layout! +::: + +## How Do I Handle Unknown Device Types? -During initial device discovery, some devices will show up as type "unknown". This can be fixed by: +During initial device discovery, some devices will show up as type "unknown". This can be fixed using the following methods: + +- From **Infrastructure > [Hardware Models](/infrastructure-management/devices/hardware-models-templates.mdx)**, change the associated hardware model. This will change all current and future associated devices. +- From **Devices > All Devices**, filter for type "unknown" and bulk change the device type. +- Export unknown devices in Excel format by clicking the **Report** button in the top right corner of the device list page. Edit the Excel file to match **Tools > Imports/Exports (xls)**. Change the type and re-import the Excel file. +- Make the change using RESTful APIs. -- Changing the associated hardware model (this will change all associated devices - current and future). Do this from **Infrastructure > [Hardware Models](/infrastructure-management/devices/hardware-models-templates.mdx)**. -- From **Devices > All Devices**, you can filter for type "unknown" and bulk change the device type. -- You can export unknown devices in Excel format by clicking the **Report** button on the top right corner of the device list page. Edit the Excel file to match **Tools > Imports/Exports (xls)**. Change the type and re-import the Excel file. -- Make the change using REST APIs. +## How Can I Create Reports? -## How can I create reports? +Data can be exported in Excel or CSV format by downloading current data from the following locations: -Data can be exported in excel or csv format using: +- **Reports > Reports > Add Report** +- **Reports > Generate Run Book** +- **Tools > Exports (CSV)** +- **Tools -> Imports/Exports** -- Reports > Reports > Add Report. -- Reports > Generate Run Book -- Tools > Exports (CSV) -- Tools -> Imports/Exports to download current data. +## How Do I Back Up My Data? -## How do I backup my data? +Log in to the Device42 appliance manager at `https://your\_device42\_ip\_or\_FQDN:4242/` using the following default credentials: -Device42 appliance manager runs at https://your\_device42\_ip\_or\_FQDN:4242/ Default username password is d42admin/default You can create backup from Backup/Restore > Backup now. +- Username:`d42admin` +- Password: `default` -This is also discussed under section : [appliance manager.](/administration/appliance-manager/) +Create a backup from **Backup/Restore > Backup now**. -## How do I update to the latest release? +This is also discussed on the [Appliance Manager](/administration/appliance-manager/) page. -1. Download the latest release update file from [Device42 update page](https://www.device42.com/update/) -2. From the D42 main menu: _Tools > Update;_ Click _"Link to Appliance Manager"_, then browse to the downloaded update file ; Click "Upload". -3. Choose Option #3 on the Main Appliance's VM console to apply the update; follow the on-screen prompts. +## How Do I Update to the Latest Release? -This is also detailed on the support portal: [D42 Upgrade steps.](https://support.device42.com/hc/en-usentries/21783332) +1. Download the latest release update file from the Device42 [Update](https://www.device42.com/update/) page. +2. From the Device42 main menu, navigate to **Tools > Update**, click **Link to Appliance Manage**, browse to the downloaded update file, and click **Upload**. +3. Choose **Option 3** on the Main Appliance (MA) virtual machine (VM) console to apply the update, and follow the on-screen prompts. -For more information about Main Appliance and Remote Collector updates, see the  [Main Appliance and Remote Collector](/administration/appliance-manager/) page. +The [Device42 Upgrade Steps](https://support.device42.com/hc/en-us/articles/222221228-Upgrade-Steps-Device42) are also detailed on our Support Portal. -You can subscribe to the [Device42 Blog rss feed](https://www.device42.com/blog/feed/) or follow us on [twitter](https://twitter.com/device42) to get immediate notifications for new releases. +Learn more about MA and RC updates on the [Appliance Manager](/administration/appliance-manager/) page. -## How do I Install Device42 xen/kvm appliance if import existing disk image option is missing? +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. -If you are trying to install the Device42 appliance on Xen or KVM based platforms, but the import disk image option is missing, see our page [Installing Device42 Appliance but Import to disk is missing](/getstarted/installation/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing/) +## How Do I Install the Device42 Appliance on Xen/KVM if the Import Existing Disk Image Option Is Missing? -## Where can I get help with something not covered here? +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. -We always recommend searching the [Device42 support portal](https://support.device42.com/hc/en-us) when faced with a question that doesn't seem to be addressed in our documentation. That said, if you do find one, or get stuck, go ahead and open a support ticket. Send a note to support@device42.com or visit the 'support' tab at the top of this page. +## Where Can I Get Help With Something Not Covered Here? +We always recommend searching the [Device42 Support Portal](https://support.device42.com/hc/en-us) when faced with a question that doesn't seem to be addressed in our documentation. That said, if you cannot find a solution or get stuck, please open a support ticket by sending a note to [support@device42.com](mailto:support@device42.com) or visiting the **Support** tab at the top of this page. diff --git a/docs/getstarted/index.md b/docs/getstarted/index.md index d76a4c93..98ec064e 100644 --- a/docs/getstarted/index.md +++ b/docs/getstarted/index.md @@ -3,18 +3,20 @@ title: "The Hitchhiker's Guide to Device42" sidebar_postion: 1 --- -Welcome to _"The Hitchhiker's Guide to Device42"_, AKA the Device42 Docs site. The following pages contain answers to the ultimate questions about infrastructure, the data-center, and everything _(and of course, answers to many common Device42 questions, as well)_. +Welcome to **The Hitchhiker's Guide to Device42**, AKA the Device42 docs site. -**Navigate through the D42 documentation topics using either the navigation bar to your left, and/or search for help using the search box found hanging out at the top right of the page - _much in the same way that bricks don't._** +The following pages contain answers to the ultimate questions about infrastructure, the data center, and everything _(and the answers to many common Device42 questions, too)_. + +**Navigate through the Device42 documentation topics using the left-hand navigation bar or the search box found hanging out at the top right of the page - _much the same way that bricks don't_.** * * * ## What is Device42? -Device42 is a comprehensive IT infrastructure management software suite with powerful agentless autodiscovery and application dependency mapping tools, a configuration management database (CMDB), a complete data center infrastructure management (DCIM) suite, full IT asset & inventory management (ITAM) functionality, plus IP address management (IPAM), password management and lots more -- all _in a single tool_. +Device42 is a comprehensive IT infrastructure management software suite with powerful, agentless autodiscovery and application dependency mapping tools, a configuration management database (CMDB), a complete data center infrastructure management (DCIM) suite, full IT asset and inventory management (ITAM) functionality, plus IP address management (IPAM), password management and lots more - all in a single tool. * * * -If you aren't able to find an answer to your question in the menu or using search, click  [here](https://support.device42.com) to open a support ticket. If you'd prefer, send us a note at [support@device42.com](mailto:support@device42.com). Our support team _loves_ hearing from customers, and are all especially fond of a good challenge! +If you don't find an answer to your question in the menu or using search, click  [here](https://support.device42.com) to open a support ticket or send us a note at [support@device42.com](mailto:support@device42.com). Our support team _loves_ hearing from customers, and they're all especially fond of a good challenge! diff --git a/docs/getstarted/installation/resource-and-deployment-architecture-overview.md b/docs/getstarted/installation/resource-and-deployment-architecture-overview.md index af28be11..099ca50a 100644 --- a/docs/getstarted/installation/resource-and-deployment-architecture-overview.md +++ b/docs/getstarted/installation/resource-and-deployment-architecture-overview.md @@ -6,35 +6,32 @@ Learn about the Device42 core resources and how they fit into our deployment arc ## Device42 Resources -**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 pre-configured virtual -appliance (built on Linux) that is hosted by the end customer, enabling full protection under the -client’s data center security architecture and policies. +### Main Appliance -Device42 operates with only 5 ports open to the virtual appliance: -- Port 80: redirects to 443 -- Port 443: web (HTTPS) -- Port 4242: redirects to 4343 -- Port 4343: appliance manager (HTTPS) -- Port 404: SSH for limited console menu operations +The Device42 Main Appliance (MA) 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 the end customer, enabling full protection under the client’s data center security architecture and policies. -**Remote Collector:** The Remote Collector (RC), is a much 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. We require that you -install at least 1 RC with any deployment of Device42. +Device42 operates with only five ports open to the virtual appliance: -**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 will need to deploy at least 1 WDS instance and -connect it to an RC. +- **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 -## Deployment Architecture +### Remote Collector -Device42 deployment architecture is similar to a hub and spoke model, with each RC/WDS -collecting data and syncing back to the centralized MA. It is typically recommended for RCs -and WDS instances to be deployed in pairs, if Windows discovery is required. +The Remote Collector (RC) is a much lighter preconfigured virtual appliance (built on Linux) used to perform agentless discovery across network segments. It also provides scalability by offloading discovery workloads from the MA. We require you to install at least one RC with any deployment of Device42. -Device42 Deployment Example: Segmented Network +### Windows Discovery Service -![](/assets/images/deployment-architecture.png) +The Windows Discovery Service (WDS) is a `.net` service that 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 will need to deploy at least one WDS instance and connect it to an RC. + +## Deployment Architecture + +Device42 deployment architecture is similar to a hub-and-spoke model, with each RC/WDS collecting data and syncing back to the centralized MA. It is typically recommended that RCs and WDS instances are deployed in pairs if Windows discovery is required. +### 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/installation/security-posture-and-high-level-permissions.md b/docs/getstarted/installation/security-posture-and-high-level-permissions.md index 0a3424de..34997cd8 100644 --- a/docs/getstarted/installation/security-posture-and-high-level-permissions.md +++ b/docs/getstarted/installation/security-posture-and-high-level-permissions.md @@ -7,10 +7,12 @@ The section outlines how Device42 ensures data security in transit and at rest, ## Security Posture -- All data in transit from WDS to RC and RC to MA is over SSL or HTTPS. +- All data in transit from Windows Discovery Service (WDS) to Remote Collector (RC), and RC to Main Appliance (MA) is transferred via Secure Sockets Layer (SSL) or HTTPS. - All data stays at rest within the MA in an end-user environment. - Only data voluntarily shared by the end user leaves the premises. ## Required Permissions -Device42 uses the principle of least privilege in it’s agentless discovery. For a detailed overview of permissions, please reference our Pre-requisites guide or please see the discovery section on our website and locate the relevant jobs for clarity on required permissions. \ No newline at end of file +Device42 uses the principle of least privilege in its agentless discovery. + +For a detailed overview of permissions, please reference our prerequisites guide or use the **Discovery** section on our website to locate the relevant jobs and view their required permissions. diff --git a/docs/how-to-videos/update-device42-appliance-how-to.md b/docs/how-to-videos/update-device42-appliance-how-to.md index 85661727..9e8fc0a0 100644 --- a/docs/how-to-videos/update-device42-appliance-how-to.md +++ b/docs/how-to-videos/update-device42-appliance-how-to.md @@ -1,13 +1,20 @@ --- -title: "Update Device42 Appliance How To" +title: "How To Update the Device42 Main Appliance" sidebar_position: 18 --- import ReactPlayer from 'react-player' -A quick walkthrough of the very simple Device42 update process. If you've never updated before, follow right along and enjoy all the new features updating Device42 always brings! +The walkthrough video demonstrates how to update the Device42 Main Appliance by following these steps: +1. Download the `.zip.enc` update file. +2. Perform the backup in the Appliance Manager. +3. Upload the `.zip.enc` update file in the Appliance Manager. +4. Apply the update from the Virtual Machine (VM) console. +5. Verify the update from the Main Appliance. - +Visit [Updating Device42](administration/updating-device42.mdx) for detailed instructions on each step, including links, default credentials for the Appliance Manager, and the SSH command needed to access the VM console deployed on AWS or another cloud server. + +

-Please e-mail support@device42.com with any questions, comments, or requests for more how-to's and say you saw it on our docs site! +Please email [support@device42.com](mailto:support@device42.com) with any questions, comments, and requests for more how-to videos. diff --git a/docs/infrastructure-management/ipam/index.md b/docs/infrastructure-management/ipam/index.md index f5b8d4e4..1eea1b1f 100644 --- a/docs/infrastructure-management/ipam/index.md +++ b/docs/infrastructure-management/ipam/index.md @@ -12,7 +12,7 @@ There are multiple ways Device42 can discover IP Addresses and related informati - [Network SNMP Discovery](/auto-discovery/network-auto-discovery.mdx): Configuring and running SNMP autodiscovery to gather subnets, IP to MAC Address relationships, and MAC Address to Switch Port relationship information. - [Device42's Auto Discovery](/auto-discovery/windows-and-hyper-v-auto-discovery.mdx): Using the autodiscovery client to discover Microsoft Windows and Linux and/or UNIX devices on your network, including their IP and MAC Address details. -- [Device42's Ping Sweep Tool](/auto-discovery/d42-ping-sweep.md): This page details usage of the ping sweep utility to keep your IP Address information up-to-date. +- [Device42's Ping Sweep Tool](/auto-discovery/d42-ping-sweep.mdx): This page details usage of the ping sweep utility to keep your IP Address information up-to-date. ## Importing IP addresses into Device42 diff --git a/docs/infrastructure-management/software/index.md b/docs/infrastructure-management/software/index.md index 5568949c..d3407fb6 100644 --- a/docs/infrastructure-management/software/index.md +++ b/docs/infrastructure-management/software/index.md @@ -2,12 +2,34 @@ title: "Software" --- -## Software +import ThemedImage from '@theme/ThemedImage' +import useBaseUrl from '@docusaurus/useBaseUrl' -Select _Resources > Software Components_ to select the following items: All Software Components, Software License Models, Software in Use, or EOL / EOS. +The Software License Management (SLM) module allows you to create and maintain a comprehensive, accurate profile of software deployed across all Windows and Linux machine instances within your IT infrastructure. -![](/assets/images/Software_menu.png) +Navigate to **Resources > Software Components** and select the relevant page for viewing or managing your software: -When you create a discovery job, remember to select the _Discover Software_ option to discover software information. +* [All Software Components](software-components.mdx) +* [Software License Models](software-license-management.mdx) +* [Software in Use](software-in-use.mdx) +* [EOL / EOS](software-eol-eos.mdx) -![](/assets/images/WEB-293_SoftwareServices-Discover-Options.png) + + +## Discover Software + +When creating a discovery job, select the **Discover Software** option under **Software and Applications** to ensure that all software information is found. + + diff --git a/docs/infrastructure-management/software/merge-and-assign-software-components.mdx b/docs/infrastructure-management/software/merge-and-assign-software-components.mdx index c932477b..f855a3f1 100644 --- a/docs/infrastructure-management/software/merge-and-assign-software-components.mdx +++ b/docs/infrastructure-management/software/merge-and-assign-software-components.mdx @@ -6,70 +6,52 @@ sidebar_position: 4 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -### Merge Software Components and Assign Them to a Suite +## Merge and Assign Software Components to a Suite -You can merge software components and assign them to a component suite. +You can merge software components and assign them to a component suite as follows: -- Select _Resources > Software Components > All Software Components_ to display the Software Component list. -- Select the components you want to merge, select _Assign Software to Suite_ from the _Actions_ menu, and then click the lightning button to run the action. +- Navigate to **Resources > Software Components > All Software Components** to view the **Software Components** list page. +- Select the components you want to merge, choose **Assign Software to Suite** from the **Select an action** dropdown, and click the **hammer icon** to run the action. - + -Device42 displays the Assign Software to Suite page listing the software components you selected. +- In the **Assign Software to Suite** dialog, click **Select Software Suite** and search for an existing software component to create the suite that the selected components will be assigned to, then click **Assign** to confirm. - + -- Click _Select Software Suite_ to chose an existing software component to create the suite and assign the selected components to it, or select _Add Software Component_ to create a new component for the suite. +## View Assigned Components in a Suite - - -- After you select or add the suite component, click _Assign_. - -Device opens the View Software Component page and displays the new component suite. The assigned software components are listed in the _Software Components in the Suite_ section. - - +To view the software components in a suite, select the suite **Name** from the **Software Components** list page. The assigned software components are listed in the **Software Components in this Suite** box. +## Merging Software Components with the Same Name -### Merging Software Components with the Same Name +To merge software components with the same name into a suite, you must first merge them together, then merge them into a suite. A new component suite cannot have the same **name + vendor** combination as an existing software component; it must have a unique **name + vendor** combination. -To merge software components that have the same name into a suite, merge them together before merging them into a suite. A new component suite cannot have the same _name + vendor_ combination as an existing software component; it must have a unique _name + vendor_ combination. -For example: +For example, if you had: -- software component ABC with vendor Cisco (**ex. 1**) -- software component ABC with vendor MS (**ex. 2**) -- software component ABC-Suite with vendor None (**ex. 3**) +1. A software component `ABC`, with the vendor `Cisco`. +2. A software component `ABC`, with the vendor `MS`. +3. A software component `ABC-Suite`, with the vendor `None`. -You can merge ex. 1 into ex. 3, or merge ex. 2 into ex. 3, with no problem – however, trying to merge ex. 1 AND ex. 2 into ex. 3 will result in a validation error, prompting you to merge ex. 1 with ex. 2 before trying to merge them with ex. 3. +You could merge either `1.` **or** `2.` into `3.` without problem. However, if you tried to merge `1.` **and** `2.` into `3.`, you would receive a validation error prompting you to merge `1.` with `2.` before trying to merge them into `3.`. diff --git a/docs/infrastructure-management/software/software-components.mdx b/docs/infrastructure-management/software/software-components.mdx index 36f25633..4647f821 100644 --- a/docs/infrastructure-management/software/software-components.mdx +++ b/docs/infrastructure-management/software/software-components.mdx @@ -6,43 +6,58 @@ sidebar_position: 3 import ThemedImage from '@theme/ThemedImage'; import useBaseUrl from '@docusaurus/useBaseUrl' -Select _Resources > Software Components > All Software Components_ to view, edit, or add software component information. +## Discover Software Components + +When creating or editing a discovery job under **Discovery > Hypervisors / \*nix / Windows**, you will see the following autodiscovery form: -Click the software _Name_ to edit an existing component. - -When you create a discovery job, remember to select the _Discover Software_ option to discover software information. +Scroll down to the **Software and Applications** section. By default, **Discover Software** is enabled to facilitate the autodiscovery of software on Windows and Linux machines in the defined CIDR blocks, hostnames, domain servers, or IP range(s). -### Software Components Actions +All major Linux distributions are supported, and software registered across various package managers will be discovered. -Select one of more software components, and then select an Action to apply that action to the components. +### View Software Components + +To view the full list of discovered software, navigate to **Resources > Software Components > All Software Components**. -### Add a Software Component +As with other list views in Device42, you can sort the discovered software components using the column headers, the various **Advanced** filters on the right side of the page, the **search box** at the top of the page, or the bulk actions in the **Select an Action** dropdown. -Click _Add Software Component_ to add a new component. + + +Click the software **Name** to view and edit an existing component. + +## Manually Add a Software Component + +Click **Add Software Component** to add a new component. -Enter the software **Name**, **Software Type**, and the **License Model**. You can also enter Notes and Tags. Click **Save** at the bottom of the page to save the component. +Enter the **Name**, **Software Type**, and **License Model**. You can also enter **Notes** and **Tags**. Click **Save** at the bottom of the page to save the component. + +## Edit a Software Component + +Click on the name of a software component and then select **Edit** to add additional details to its record. For example, you can specify a **License Model**, select a **Vendor**, add and define a **Category**, and add **Notes** and **Tags**. + +Check the **Track Licensed Count by Keys** checkbox to base the software usage count on keys, rather than the total number of software component instances. + + + +You can also add **Software Component Aliases** and **Software License Keys**, view the actual instances of the discovered software under **Software In Use**, and add **Purchase/Support Info**. + + + + + +## Bulk Actions + +On the **All Software Components** list page, you can make bulk modifications to specific software components: + +- Use the checkbox to the left of each instance to choose records from the list. +- **Select an Action** from the dropdown. +- Click the **hammer icon** to execute the action. + + + +The available actions are: + +- **Delete with Detailed Confirmation** +- **Fast Background Delete** +- **Export selected items** +- **Assign Software to Suite** +- **Refresh/update Software counts** +- **Refresh/update OS counts** +- **Mark selected Software as Managed** +- **Mark selected Software as Prohibited** +- **Mark selected Software as Ignored** +- **Mark selected Software as Unmanaged** + +For example, you could select several software components and choose to: + +- **Mark selected Software as Ignored** and Device42 would remove the components from the list and ignore them in future discoveries. +- **Mark selected Software as Prohibited** and Device42 would send alerts whenever prohibited software was found on a user's machine (if the alert was configured). +_ **Refresh/update Software counts** and the software counts (but not the autodiscovery job) would be run immediately. + +:::note +The **Refresh/update Software counts** action is useful when you have changed the licensing or software count configuration and want to see the impact of the change immediately. +::: + +### Assign Software to Suite + +The **Assign Software to Suite** action is also useful, as it allows you to group selected software components into sets. + +For example, if you wanted to group Adobe products, you would create a suite and then assign Adobe software components to it. + +- To create the suite, you could either select an existing software component and define it as a suite or create a new software component using the **Add Software Component** button and call it something like "Adobe Software Suite". +- Then, you could select Adobe software components from the list, choose **Assign Software to Suite** from the **Select an Action** dropdown, and click the **hammer icon** to assign the selected software components to an Adobe suite. + + diff --git a/docs/infrastructure-management/software/software-eol-eos.mdx b/docs/infrastructure-management/software/software-eol-eos.mdx index 5ecca21a..38775472 100644 --- a/docs/infrastructure-management/software/software-eol-eos.mdx +++ b/docs/infrastructure-management/software/software-eol-eos.mdx @@ -6,7 +6,7 @@ sidebar_position: 6 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Select **Resources > Software Components > EOL / EOS** to view, edit, or add software end-of-life or end-of-service information. +Select **Resources > Software Components > EOL / EOS** to view, edit, or add software end-of-life or end-of-service (EOL / EOS) information. -Click on a name under the **Software** column to view and edit an existing software EOL / EOS. +Click on a name under the **Software** column to view and edit an existing software **End of Life Date** or **End of Service Date**. ### Software EOL / EOS Actions -Select one or more **Software** entries, and select an Action from the dropdown menu. Apply that action to the entries by clicking the **hammer icon**. +Select one or more **Software** entries, **Select an action** from the dropdown menu, and click the **hammer icon** to apply the action to the selected entries. -Click to select the **Software** you want to add as in use. Device42 displays the Select Software Component dialog. You can add a new component from this dialog. Click on the name of the component to add. Enter the software **Version**, then select the **End of Life** and **End of Service** dates. +Click the **magnifying glass icon** next to the **Software:** field to add an existing software component as in use. In the **Select Software Component** dialog, click the software component **Name** to add it to the **Software EOL / EOS** list page. Enter the software **Version**, **End of Life Date**, and **End of Service Date**. -Click one of the **Save** buttons at the bottom of the page to save the EOL / EOS information. The new entry will be added to the list. +Click one of the **Save** buttons at the bottom of the page to save the EOL / EOS information. Software Components > Software In Use_ to view, edit, or add software-in-use information. +## Software In Use List Page + +Navigate to **Resources > Software In Use** to see the individual instances found for each software component. In this view, you can filter by the **Name** of the software component, the **Device**, or the **End User**, and sort the results by **Device** or **End User**.
-Click the software _Name_ to edit existing software in use. +Click the software **Name** to view or edit the software in use. ### Software In Use Actions -Select one of more software-in-use entries, and then select an Action to apply that action to the entries. +Select one or more software-in-use entries, then **Select an action** and use the **hammer icon** to apply that action to the selected entries. ### Add a Software In Use Entry -Click _Add Software In Use_ to add a new software entry. +Click **+ Add Software In Use** to add a new software entry.

-Click **Software** to select the software you want to add as in use. Device42 displays the Select Software Component dialog – you can also add a new component from this dialog. Click on the name of the component you want to add. If necessary, also enter or update the **Raw License Count**. Click _Save_ at the bottom of the page to add the software in use. +Click **Software** to search for and select software already in Device42. Click the **magnifying glass icon** to add a new component from this dialog. If necessary, enter or update the **Raw License Count**. Click **Save** at the bottom of the page to add the software in use.
diff --git a/docs/infrastructure-management/software/software-license-management.mdx b/docs/infrastructure-management/software/software-license-management.mdx index 17fc6b50..6e7545f0 100644 --- a/docs/infrastructure-management/software/software-license-management.mdx +++ b/docs/infrastructure-management/software/software-license-management.mdx @@ -6,145 +6,7 @@ sidebar_position: 1 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -The Software License Management (SLM) module you to create and maintain a comprehensive, accurate profile of software deployed across all Windows and Linux machines or instances across your entire IT infrastructure. - -Easily create and manage software licensing models, and Device42 will automatically scan 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 can 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! - -## Discovering Software Components - -When adding a new discovery (or editing an existing one) under **Discovery > Hypervisors / \*nix / Windows**, you will see the following: - - - -Scroll down to the **Software and Applications** section. By default, **Discover Software** is enabled to auto-discover software on Windows and Linux machines in the defined CIDR blocks, Hostname, Domain servers, or IP range(s) provided. - - - -All major Linux distributions are supported, and software registered across various package managers will be discovered. - -### View Discovered Software - -To see the list of discovered software, head to **Resources > All Software Components**. - - - -You will see a list of the discovered software components. As with other list views in Device42, you can sort these components by their column headers, there are various filters on the right side of the page, there is a search box at the top and a bulk action pull-down. - - - -### Bulk Actions - -From the list view, you can make bulk modifications to these software components. Select records from the list, choose an action, and click the **hammer icon** to execute the action. - - - -The available actions are: -- Delete with Detailed Confirmation -- Fast Background Delete -- Export selected items -- Assign Software to Suite -- Refresh/update Software counts -- Refresh/update OS counts -- Mark selected Software as Managed -- Mark selected Software as Prohibited -- Mark selected Software as Ignored -- Mark selected Software as Unmanaged - -For example, you could select several software components and choose **Mark selected Software as Ignored**. This will cause Device42 to remove the components from the list and ignore these components in future discoveries. - -You could also choose **Mark selected Software as Prohibited**. This will cause Device42 to send alerts whenever prohibited software is found on a user's machine (if the alert is configured). - -If you select **Refresh/Update software counts**, the software counts (but not the autodiscovery job) will be run immediately. This can be useful if you make a change to licensing or the software count configuration and want to see the impact of the change immediately. - -### Assign Software to Suite - -Select a group of software components and choose **Assign Software to Suite** to define the selected components to be part of a set. For example, select a set of Adobe software components and click **Assign Software to Suite**. - -You can select an existing software component and define it as a suite to incorporate the selected Adobe software components. Or, a more likely scenario, you'll create a new software component using the **Add Software Component** button and call it something like "Adobe Software Suite" and then assign discovered Adobe software components to it. - - - -### Change Software Component - -Click on the name of a software component and then **Edit** to add additional details. For example, you can specify a **License Model**, select a **Vendor**, add and define categories, add **Notes**, and **Tags**. - -Check the **Track Licensed Count by Keys** checkbox to have the software usage count be based on keys, rather than the total number of instances of the software component. - - - -You can also add **Software Component Aliases**, add **License Keys**, view the actual instances of the software found by the discovery process under **Software In Use**, and add **Purchase/Support Info**. - - - - - -### Software In Use List Page - -Navigate to **Resources > Software In Use** to see the individual instances found for each software component. In this view, you can filter by the name of the software component, the device, or the user and sort the results by device or user. - - +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! ## Software License Models @@ -253,14 +115,6 @@ The **CPU count virtual** field defines how software found on virtual machines i - **Total # of cores on VM** - **Total sockets on VM** -## Alerts and Notifications - -Set up software alerts by navigating to **Analytics > Setup Alerts** and selecting **Software** as the **Rule Type**. You can view the alerts that were triggered under **Analytics > Notifications**. - -See [**Software Licensing Alerts and Notifications**](software-licensing-alerts-and-notifications.mdx) for details. - -For more details on alerts and notifications in Device42, including how to configure custom alert emails, visit [**Setup Alerts and Notifications**](/reports/reports/setup-alerts-and-notifications.mdx). - ## 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/infrastructure-management/software/software-licensing-alerts-and-notifications.mdx b/docs/infrastructure-management/software/software-licensing-alerts-and-notifications.mdx index 04a2dbf4..7d247ed8 100644 --- a/docs/infrastructure-management/software/software-licensing-alerts-and-notifications.mdx +++ b/docs/infrastructure-management/software/software-licensing-alerts-and-notifications.mdx @@ -6,18 +6,19 @@ sidebar_position: 2 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Set up alerts to trigger an email and Device42 notification, or have data sent to a third-party application when a software condition you define occurs. +Set up alerts to trigger an email and Device42 notification, or have data sent to a third-party application when a software condition you define occurs. -Alerts that have been triggered are called notifications. Manage notifications to indicate the action status taken to resolve the trigger condition to the rest of your team. +Alerts that have been triggered are called notifications. Manage notifications to indicate the action status taken to resolve the trigger condition to the rest of your team. ## Create Alerts Set up a software alert by navigating to **Analytics > Setup Alerts** and selecting **Software** as the **Rule Type**. Three **Trigger** types are available for software licensing. You can create a rule based on: -- **Count:** The absolute number of licenses. -- **License Percent Used:** The percentage of available licenses used. -- **Prohibited Software Installed** + +- **Count**: The absolute number of licenses. +- **License Percent Used**: The percentage of available licenses used. +- **Prohibited Software Installed**: Whether prohibited software has been installed on a machine. -Emails will be sent out to the address(es) specified under the **Escalation Profile** option. For example, whenever the percentage of the licenses used for any software component exceeds 85% for the selected software, those in "Alert Group 1" be notified by email. +When a rule is triggered, emails are sent to the address(es) specified under the **Escalation Profile** option. Consider the example in the screenshot above: When more than 85% of the license for a software component has been used, those in "Alert Group 1" are notified by email. -Select the **Apply To: All** checkbox to set the alert condition on all software components. Or search for specific software under **Available objects** and move them to **Chosen objects** using the right arrow button. +Select the **Apply To: All** checkbox to set the alert condition on all software components or search for specific software under **Available objects** and move them to **Chosen objects** using the **right arrow** button. Notifications**. +Each triggered alert rule creates a notification. Notifications for all rule types are listed under **Analytics > Notifications**. -An email will only be sent once and the alert will only appear as a notification once for the chosen software components. +Only one email and one alert notification will be sent for the chosen software components.