Requirements for Discovery Console for OT installation
Summarize
Summary of Requirements for Discovery Console for OT installation
The Discovery Console for OT requires specific infrastructure, system, and network configurations for successful installation and operation. This guide outlines the essential requirements to prepare your environment for deployment, especially in remote facilities or networked environments, ensuring compatibility and connectivity with your ServiceNow instance.
Show less
Infrastructure and System Requirements
- Operating System: Must be Linux, capable of running on a virtual machine (VM) or bare-metal server.
- Virtual Machine Requirements: The VM should have at least 10 GB of free disk space after OS and Console installation.
- Hardware Resources: Minimum of 16 GB RAM, 100 GB hard drive space, and 2 CPUs are required.
- Dependency: .NET 10 is required, updated from the previous .NET 8 version.
Network Requirements
To ensure proper communication and functionality, the following inbound ports must be open:
- TCP 5671: Sensor communication to send data and receive configuration updates.
- TCP 8443: Access to the Console's web interface and API.
- TCP 5002: Sensor updates communication.
- TCP 443: Communication from Console to ServiceNow instance or MID Server via Service Graph Connector.
- UDP 123: Critical for time synchronization between Sensors and Console to maintain accurate event timestamps.
Note: Without UDP 123 open, sensor clocks may drift, causing features dependent on precise timing to malfunction. Firewall rules should be checked to unblock required IPs and ports if access issues occur.
Configuration and Licensing
- The Console includes an interactive configuration wizard to assist with initial setup, including license upload prompts.
- Before using the Console, a valid license must be obtained from your ServiceNow account representative and uploaded as a ZIP file containing
license.pemandpubkey.pem.
License-dependent features include:
- Running Auto Query and asset scans.
- Consumption of network connection data.
- Creation and viewing of API tokens.
- Exporting collections such as assets (note: exporting RAW XML results requires a valid license).
If the license expires, these features are disabled but no data is lost. Users are alerted via warning banners before and when the license expires, and reacquisition or renewal of the license restores full functionality.
Customer Support
If issues arise during installation or usage, customers should first verify firewall configurations and then contact ServiceNow Customer Service and Support for assistance.
For remote deployment at a facility or on a network, verify that the following requirements are met before installing the Discovery Console for OT.
Infrastructure requirements
You must have a Linux operating system installed that can operate in a virtualization environment or on a Bare-metal server. Install the Discovery Console for OT on a virtual machine.
System requirements
| Component | System Requirements |
|---|---|
| Discovery Console for OT |
|
Network requirements
| Ports | Description |
|---|---|
| TCP 5671 | Used by Discovery Sensor for OT to communicate with the Discovery Console for OT. This port is used by the Sensor to report data and receive configuration updates from the Console. |
| TCP 8443 | Used to connect to the Discovery Console for OT Web interface. This port is used by the API. |
| TCP 5002 | Enables Sensors to communicate with the Discovery Console for OT to receive updates. |
| TCP 443 | Used for network communication from the Console to a ServiceNow instance or MID Server via the Service Graph Connector for OT Discovery. |
| UDP 123 (Required) |
Enables Sensor devices to synchronize time (real-time clock) with the Discovery Console for OT to verify that the time associated with reported data and events is both precise and accurate. Note: Without port UDP 123 open on the firewall, the clocks of Sensors drift apart from the clock of the Console. When clock drift is present, various features that rely on precise clock synchronization don't work as expected. |
Discovery Console for OT configuration wizard
The Discovery Console for OT now provides a configuration wizard to guide you through your initial setup and configuration of the Console. If you choose to use the interactive configuration wizard after logging into the Console, it alerts you automatically to upload a Console license. See Use the Discovery Console for OT interactive configuration wizard for more information.
Discovery Console for OT license
- From the Home page, navigate to the Settings page.
- On the Settings page in the License section, select the Upload License button.
- Upload your license as a .zip file.
- Verify the ZIP file contains the license.pem and pubkey.pem files.
Once you have uploaded your license, you can use the Console.
Console features that require a license
It is important to understand that certain features are rendered inactive if the Discovery Console for OT license is expired. After the license expires, the locking mechanism is triggered and deactivates these features. No data is lost in the background. When a valid license is uploaded, the you can start or continue working. When the license is about to expire, the Console displays a warning banner as an alert.
The license:
- Enables the ability to run Auto Query and asset scans (inactive on expiration).
- Enables the consumption of network connection data (inactive on expiration).
- Enables the creation and viewing of API tokens (inactive on expiration).
- Enables the export of collections (for example, assets) to files (inactive on expiration).