Merge pull request #484 from ritza-co/19.07.12

Docs 19.07.12 release (Week 49, 2025)

Author: sixhobbits

docs/auto-discovery/agent-based-discovery.mdx

@@ -6,25 +6,15 @@ sidebar_position: 3
 import ThemedImage from '@theme/ThemedImage'
 import useBaseUrl from '@docusaurus/useBaseUrl'
 
-# Device42 Discovery Agent
-
-:::tip
-To learn about using the agent for **offline** discovery, see [Agent-Based Offline Discovery](agent-based-offline-discovery.mdx).
-:::
-
 There are special situations where using an agent for discovery makes more sense. The IT environment may be unreachable from the network or security-hardened rules may be in place that limit traffic flow. Device42 offers many optional auto-discovery agents across several [supported platforms](#supported-platforms).
 
 As a best practice, we recommend using agentless discovery over agent-based discovery when possible. The information gathered is the same, but the agent does not support Resource Utilization (RU). 
 
-:::warning
-**Discovery Account warning: Please do _not_ set up an autodiscovery scan using critical or production account credentials! Please create a separate, dedicated account to use _only_ for discovery**
-
-Doing so, depending on permissions granted and configured password policies could result in account lock-out, therefore causing an otherwise completely avoidable outage.
-:::
+To learn about using the agent for **offline** discovery, see [Agent-Based Offline Discovery](agent-based-offline-discovery.mdx).
 
 ## Supported Platforms
 
-**Device42 autodiscovery agents are available for deployment on the following platforms:**
+Device42 autodiscovery agents are available for deployment on the following platforms:
 
 - Windows 64-bit (Recommended)
 - Windows 32-bit
@@ -39,8 +29,12 @@ Doing so, depending on permissions granted and configured password policies coul
 - Solaris Sparc 64-bit
 - Encrypted config file for Agent
 
-:::info
 See **[Windows Discovery Agent Service Wrapper](/getstarted/installation/windows-service-installation)** and **[Mac Agent Service Launcher](/auto-discovery/mac-agent-service-launcher)** for information on installing versions of the Windows and Mac discovery agent as a service.
+
+:::warning
+Do not set up an autodiscovery scan using critical or production account credentials. Please create a separate, dedicated account to use only for discovery.
+
+Doing so, depending on permissions granted and configured password policies could result in account lock-out, therefore causing an otherwise completely avoidable outage.
 :::
 
 ## Proxy Environment Variables
@@ -73,6 +67,8 @@ The agent can be run from the command line or can be scheduled using the relevan
   ```bash
     -capture-host-files
           capture hosts files
+    -config-file string
+          reads the config from an encrypted file (Only works for signed binaries. Ignored Otherwise)
     -debug
           prints the data being sent and result of post operation
     -device-customer string
@@ -91,8 +87,6 @@ The agent can be run from the command line or can be scheduled using the relevan
           doesn't do a post, just prints the data to be sent
     -extended-logs
           enables extended logs
-    -host string
-          specifies the Main Appliance or Remote Collector target (overrides built-in host)
     -hostname-precedence
           sets device name as 'new name' to prevent creation of new device if only hostname was changed
     -ignore-domain
@@ -113,24 +107,26 @@ The agent can be run from the command line or can be scheduled using the relevan
           default IP VRF group
     -light-mode
           reduces CPU utilization by cost of discovery speed
-    -new-device-object-category
-        updates/overwrites the object category for the device
+    -new-device-object-category string
+          new device object category
     -offline
           doesn't connect with Device42, just prints the encrypted data to be sent
+    -prioritize-dns-name
+          Prioritize DNS domain name
     -quiet
           disables all logs
     -service-ports-only
           returns only service ports data
-    -skip-aws-instance-info
-          disables AWS instance info discovery (default true)
     -skip-bios
           disables bios discovery
     -skip-cluster-info
-          disables cluster info discovery (Windows only) (default true)
+          disables cluster info discovery (Windows only)
     -skip-cpu-info
           disables CPU info discovery
     -skip-database-info
-          disables database discovery (default true)
+          disables database discovery
+    -skip-gpu-info
+          disables GPU info discovery
     -skip-hardware-info
           disables hardware discovery
     -skip-hba
@@ -145,8 +141,12 @@ The agent can be run from the command line or can be scheduled using the relevan
           disables network discovery
     -skip-os-details
           disables OS discovery
+    -skip-other-data
+          disables other data
     -skip-parts
           disables parts discovery
+    -skip-provider-unique-identifier
+          disables instance unique identifier lookup
     -skip-serials
           disables serial numbers discovery
     -skip-service-ports
@@ -155,30 +155,24 @@ The agent can be run from the command line or can be scheduled using the relevan
           disables services discovery
     -skip-software
           disables software discovery
+    -skip-tpm-info
+          disables TPM info discovery
     -skip-virtual-machines
           disables VM discovery
     -software-initial-group string
           default software group
     -store-config-files
           store configuration files
-    -store-filesystem-info
-          store filesystem information
-    -store-registry-info
-          store registry information
-    -store-software-config-files
-          store software configuration files
     -sudo-password string
           sudo password used in some OSes (Mac, Linux) to get information about the system
-    -use-aws-token
-          use generated token to get AWS instance info
     -use-global-ignore-software-file
           use global ignore software file
     -use-global-ignore-software-pattern-file
           use global ignore software pattern file
+    -use-provider-token
+          use generated token to get instance info
     -version
           print version number and exit
-    --wmi-timeout
-        timeout for Windows WMI calls (default is 120 seconds if not supplied)
   ```
 </details>
 

docs/auto-discovery/auto-discovery-system-requirements.mdx

@@ -40,23 +40,4 @@ Contact [[email protected]](mailto:[email protected]) with any questions r
 
 ## Ports and Protocols Used By Discovery
 
-Device42 uses the following ports and protocols for discovery. Ensure the appropriate ones are allowed through main and target machine firewalls for proper discovery functionality:
-
-- **UDP/161 - Device42 Appliance**
-    - Networking (SNMP)
-    - Blade Systems (SNMP)
-    - Power (SNMP)
-- **TCP/443 - Device42 Appliance and Communication between RC and Main Appliance**
-    - vServers (VMware, OVirt/Redhat, Citrix/Xen)
-    - Cisco UCS Manager
-- **TCP/22 - Standalone Discovery Tool and Device42 Appliance**
-    - SSH for *nix and select hypervisor discovery
-    - KVM/libvirt
-- **ICMP - Device42 Appliance or Standalone Discovery Tool**
-- **UDP/623 - Device42 Appliance - IPMI**
-- **TCP/389 or TCP/636 - Device42 Appliance**
-    - Active Directory or AD SSL
-    - LDAP: Default is port 389 or 636 for LDAPs or LDAPs with SSL
-- **TCP/135 and 445 - Standalone Discovery Tool - WMI**
-    - Random ephemeral TCP port(s) between 1024 and 65535 may also be used
-- **TCP/5985 and 5986 - Device42 Appliance - WinRM HTTP & HTTPS Discovery**
+See [Discovery Port Configurations](/getstarted/installation/discovery-port-configurations/) for a complete list. 

docs/auto-discovery/warranty-autodiscovery.mdx

@@ -49,7 +49,9 @@ Device42 supports warranty autodiscovery for the following vendors:
     />
     <br/><br/>
 
-2. The Device42 **Model** field must be set to  **Dell**, **IBM**, **Lenovo**, or **Meraki**. Hardware with different vendor name variations will not return a warranty. You can easily add the proper **Vendor Aliases** to the vendors if your vendors are named differently. On the vendor edit screen, update the vendor entries. Enter `dell` for  Dell, `ibm` for IBM, `meraki` for Meraki, and `lenovo` for Lenovo:
+2. The EnrichAI module has largely automated this requirement: Set the **Model** field to **Dell**, **IBM**, **Lenovo**, or **Meraki**. Hardware with different vendor name variations will not return a warranty.
+
+You can easily add the proper **Vendor Aliases** to the vendors if your vendors are named differently. On the vendor edit screen, update the vendor entries. Enter `dell` for  Dell, `ibm` for IBM, `meraki` for Meraki, and `lenovo` for Lenovo:
 
     <ThemedImage
       alt="Add vendor aliases"

docs/getstarted/installation/installation-amazon-web-services.mdx

@@ -113,9 +113,11 @@ Update the appliance license key, because the included key has expired:
       light: useBaseUrl('/assets/images/installation-amazon-web-services/upload-license-light.png'),
       dark: useBaseUrl('/assets/images/installation-amazon-web-services/upload-license-dark.png'),
   }}
-  style={{ width: '90%' }} 
+  style={{ width: '90%' }}
   />
 
+[Set the time zone and configure NTP](/administration/setting-time-zone-and-ntp/) to ensure autodiscovery scheduling and log history work correctly.
+
 Make sure your AMI is running the latest version of Device42 and update it if necessary:
 
 - From the Device42 web UI, head to **Tools > Update**.
@@ -129,10 +131,12 @@ Make sure your AMI is running the latest version of Device42 and update it if ne
         light: useBaseUrl('/assets/images/installation-amazon-web-services/update-software-light.png'),
         dark: useBaseUrl('/assets/images/installation-amazon-web-services/update-software-dark.png'),
     }}
-    style={{ width: '70%' }} 
+    style={{ width: '70%' }}
     />
 
-And you're all set! Now is a good time to check out our documentation for [Getting Started](getstarted/index.mdx) with Device42. If you have any questions or issues that the documentation doesn't address, visit the [Device42 Support page](https://support.device42.com) or email [[email protected]](mailto:[email protected]) to open a ticket.
+And you're all set!
+
+If you have any questions or issues that the documentation doesn't address, visit the [Device42 Support page](https://support.device42.com) or email [[email protected]](mailto:[email protected]) to open a ticket.
 
 * * *
 

docs/getstarted/installation/installation-citrix-xen-server.mdx

@@ -16,7 +16,8 @@ This guide walks you through installing the Device42 Main Appliance on Citrix Xe
 4. Power on the newly deployed Device42 virtual appliance.
 5. Log in to the Device42 console using the default credentials and update the credentials.
 6. Configure the static IP address from the console.
-7. Log in to the Device42 web interface from a browser: `https://FQDN (Fully Qualified Domain Name) or IP address`. Update the login credentials here as well.
+7. Set the time zone and configure NTP.
+8. Log in to the Device42 web interface from a browser: `https://FQDN (Fully Qualified Domain Name) or IP address`. Update the login credentials here as well.
 
 ## Illustrated Steps of Installing Device42 on Citrix XenServer
 
@@ -82,6 +83,10 @@ From the console, configure the IP address. Use a **static IP** for all producti
 
 This is an optional step: Create a DNS entry for the new IP address of the virtual appliance.
 
+### Set the Time Zone and Configure NTP
+
+After setting a static IP address, [set the time zone and configure NTP](/administration/setting-time-zone-and-ntp/) to ensure autodiscovery scheduling and log history work correctly.
+
 ### Log In to the Web Interface
 
 Point your browser to `https://FQDN (Fully Qualified Domain Name) or IP address`.

docs/getstarted/installation/installation-microsoft-azure.mdx

@@ -12,6 +12,7 @@ To install Device42 within your Microsoft Azure environment, you need to:
 1. Download the Device42 virtual appliance from the Azure Marketplace.
 2. Configure the virtual machine with proper resources and set up networking and deployment.
 3. Log in to the Device42 instance using the vmID as the default password and configure the setup.
+4. Set the time zone and configure NTP.
 
 ## Detailed Installation Steps
 
@@ -69,6 +70,8 @@ Use the value of  **vmId** as a password with the following default account user
 
 ![](/assets/images/WEB-316_Az-Install-Az-shell-2.png)
 
-Change the **device42** console user password to something of your own choosing from the console..
+Change the **device42** console user password to something of your own choosing from the console.
+
+[Set the time zone and configure NTP](/administration/setting-time-zone-and-ntp/) to ensure autodiscovery scheduling and log history work correctly.
 
 You should now have a fully functioning Device42 Main Appliance hosted on Microsoft Azure. You can run updates on this instance to get it to the latest version. You have to supply your license to get full functionality.

docs/getstarted/installation/installation-microsoft-hyperv.mdx

@@ -15,8 +15,9 @@ After you [download the Device42 virtual appliance file](https://www.device42.co
 1. Use 7-Zip to unzip the downloaded file.
 2. Create a virtual machine with a **minimum** of 2 vCPU, 8 GB RAM for production use, and one network card. Configure the new VM to use the attached virtual disk file.
 3. Power on the new machine and log in to the console using the default credentials, then update the credentials.
-4. On the console, configure the IP and choose your settings. Please use a static (non-DHCP) IP address for all Device42-related appliances. Create a DNS entry that points to the IP address of the new virtual appliance.
-5. Point your browser to `https://FQDN (Fully Qualified Domain Name) or IP address` and log in to the **web interface** using the default credentials.  Update the login credentials here as well.
+4. On the console, configure the IP and choose your settings. Please use a static (non-DHCP) IP address for all Device42-related appliances.
+5. Set the time zone and configure NTP.
+6. Point your browser to `https://FQDN (Fully Qualified Domain Name) or IP address` and log in to the **web interface** using the default credentials. Update the login credentials here as well.
 
 You are now ready to start discovering and documenting your IT infrastructure!
 
@@ -61,15 +62,17 @@ Please change these credentials as soon as you've logged in.
 
 ### Configure a Static IP and Networking Options
 
-Configure an IP address for the Device42 appliance. Use a static IP or a DHCP address reservation. Ensure that DNS entries are created for every appliance to be used in a production setting. DNS server configuration is a necessary step.
+Configure an IP address for the Device42 appliance using either a static IP or a DHCP reservation. Ensure that DNS server settings are configured on the appliance for production use, as these are required for autodiscovery to resolve hostnames.
 
 ![Device42 VM console menu v19.05](/assets/images/vm-main-menu.png)
 
 ![IP config options v19.05](/assets/images/vm-ip-settings.png)
 
 Change the default password for the user `device42` from the console menu before proceeding.
 
-You can apply updates and perform other menu-related work using SSH **port 404**. Please note that root login has been disabled via SSH. Attempting to access the root will cause the VM to disable itself permanently and is not supported.
+### Set the Time Zone and Configure NTP
+
+After setting a static IP address, [set the time zone and configure NTP](/administration/setting-time-zone-and-ntp/) to ensure autodiscovery scheduling and log history work correctly.
 
 ### Log In to the Web Interface
 
@@ -82,19 +85,23 @@ Log in to the **web interface** using the default credentials:
 
 Please change these credentials as soon as you've logged in.
 
-You are now ready to start discovering your IT infrastructure! 
+You are now ready to start discovering your IT infrastructure!
 
 <ThemedImage
   alt="Device42 Web Interface Login Screen v19.05"
   sources={{
     light: useBaseUrl('/assets/images/login-19.05-light.png'),
     dark: useBaseUrl('/assets/images/login-19.05-dark.png'),
   }}
-  style={{ width: '70%' }} 
+  style={{ width: '70%' }}
 />
 
+## Using SSH
+
+You can apply updates and perform other menu-related work using SSH **port 404**. Please note that root login has been disabled via SSH. Attempting to access the root will cause the VM to disable itself permanently and is not supported.
+
 ## Next Steps
 
-Install the Device42 [Remote Collector](remote-collector-rc-installation.mdx) and [Windows Discovery Service](windows-discovery-service-installation.mdx) before creating your first discovery job. 
+Install the Device42 [Remote Collector](remote-collector-rc-installation.mdx) and [Windows Discovery Service](windows-discovery-service-installation.mdx) before creating your first discovery job.
 
 You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool.

docs/getstarted/installation/installation-vcenter-server.mdx

@@ -11,12 +11,13 @@ This guide walks you through installing the Device42 Main Appliance on the VMwar
 ## Outline of Installation Steps
 
 1. Download and unzip the compressed Device42 virtual appliance.
-2. From the vCenter Server interface, select the unzipped `.ovf` file. 
+2. From the vCenter Server interface, select the unzipped `.ovf` file.
 3. Follow the VMware prompts and choose your location, datastore, and NIC.
-4. Power on the newly deployed Device42 virtual appliance. 
+4. Power on the newly deployed Device42 virtual appliance.
 5. Log in to the Device42 console using the default credentials and update the credentials.
 6. Configure the static IP address from the console.
-7. Log in to the Device42 web interface from a browser: `https://FQDN (Fully Qualified Domain Name) or IP-address`. Update the login credentials here as well.
+7. Set the time zone and configure NTP.
+8. Log in to the Device42 web interface from a browser: `https://FQDN (Fully Qualified Domain Name) or IP-address`. Update the login credentials here as well.
 
 ## Illustrated Steps for Installing Device42 on vCenter Server
 
@@ -64,17 +65,21 @@ Log in using the default credentials and change them once you've logged in:
 ### Configure the Static IP Address
 
 From the console, configure the IP address. Use a **static IP** for all production Device42 VMs to avoid connectivity issues.
-   
+
     ![Device42 VM console menu v19.05](/assets/images/vm-main-menu.png)
 
-    Enter your settings on the Device42 IP address configuration screen: 
+    Enter your settings on the Device42 IP address configuration screen:
 
     ![IP config options](/assets/images/vm-ip-settings.png)
 
 ### Create a DNS Entry
 
 This is an optional step: Create a DNS entry for the new IP address of the virtual appliance.
 
+### Set the Time Zone and Configure NTP
+
+After setting a static IP address, [set the time zone and configure NTP](/administration/setting-time-zone-and-ntp/) to ensure autodiscovery scheduling and log history work correctly.
+
 ### Log In to the Web Interface
 
 Point your browser to `https://FQDN (Fully Qualified Domain Name) or IP-address`.
@@ -103,6 +108,6 @@ You can apply Device42 updates and perform other menu-related work using **SSH**
 
 ## Next Steps
 
-Install the Device42 [Remote Collector](remote-collector-rc-installation.mdx) and [Windows Discovery Service](windows-discovery-service-installation.mdx) before creating your first discovery job. 
+Install the Device42 [Remote Collector](remote-collector-rc-installation.mdx) and [Windows Discovery Service](windows-discovery-service-installation.mdx) before creating your first discovery job.
 
 You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool.