Monitor device configurations
When a Network Collector or Platform-connected SolarWinds Observability Self-Hosted poll configuration data, you can see the configurations in SolarWinds Observability SaaS.
-
Configuration Management - Overview: A tab in the network area overview and in the device entity details view.
-
Config Explorer: A tab in the network area overview lists all monitored configurations (startup and running configurations and their conflicts) that changed within the specified time frame.
Configurations are displayed only for "NCM nodes". If no configurations for a node are displayed in the Config Management tab, log in to the web console for your Network Collector or Platform-connected SolarWinds Observability Self-Hosted and ensure that the node is an "NCM node". See Set up configuration monitoring (Network Collector) or Add nodes as NCM nodes.
Every 45 minutes, the system checks for outdated configurations. Configurations older than 30 days are deleted.
See individual sections:
Review configuration changes and conflicts
-
In SolarWinds Observability, click Network and then click Configuration Explorer.
-
Use the filter and time drop-down to review configuration changes on monitored devices.
The Config Explorer lists devices that received any metrics within the specified time. As a result, the list might include devices that do not have any config data as they received some metrics in the specified time.
If there is a conflict of a startup and running config, you can see Conflict in the Startup vs Running column.
-
Click the conflict to compare the startup and running config in an Inspector Panel.
View configurations
-
In the Entity Explorer, find a device for which you are gathering configurations.
-
Click the Config Management tab to see available configurations. They are saved and named after the time stamp when they were downloaded.
-
To view a configuration, click the download time.
Compare configurations
-
On the Config Management tab, select two items and click Compare.
-
Review the changes and click Close to close the content comparison.
Download configurations
-
In the Entity Explorer, find a device for which you are gathering configurations.
-
Click the Config Management tab to see available configurations. They are saved and named after the time stamp when they were downloaded.
-
To download a configuration, click the Download button.
-
To download the configuration the device started with, click Download Startup Config.
-
To download the configuration that is currently applied on the device, click Download Running Config.
Downloading the configuration starts. Click the Events link in the message to follow the download progress.
-
Sign scripts or upload jobs
Some actions, such as uploading configurations or running scripts, require a digital signature before they can be executed. This signature is generated using a pair of cryptographic keys: a private key and a public key. You must set up these keys before performing any signed action.
When prompted during an action, run a signing script and paste the output of it into the Signature field.
Set up signing
-
Ensure that you have OpenSSL installed on your computer and available in your system path. See OpenSSL Downloads and Path (Windows commands) for details.
-
Create a private key. Use the following script to create a 4096-bit RSA private key encrypted with AES-256.
openssl genpkey -algorithm RSA -out private_key.pem -aes256 -pkeyopt rsa_keygen_bits:4096
-
Create a public key. Use the following script to extract the public key from the private key.
openssl rsa -in private_key.pem -pubout -out public_key.pem
-
Create the following folder on your Network Collector, and paste the public key into it.
C:\ProgramData\SolarWinds\UAMSClient\plugin-storage\nim-actions\signature-public-keys
Sign actions
When you perform an action that requires a signature, run the provided signing script and paste the output into the Signature field.
Signature verification is enabled by default. If you encounter issues, ensure the following flag is set in the configuration file on the Network Collector.
--EnableSignatureVerificationFeature=true
Upload configurations
-
In the Entity Explorer, find a device for which you are gathering configurations.
-
Click the Config Management tab to see available configurations. They are saved and named after the time stamp when they were downloaded.
-
To upload a configuration, click the Upload Config button. This launches a wizard.
-
On Upload operation details, review the configuration you want to upload to the device and click Next. In this step, you can modify the configuration before uploading it to the device. The updates will only be part of the configuration that will be uploaded, the downloaded configuration will not be changed.
Additional options:
-
To write the configuration to non-volatile RAM, select the Write to NVRAM box.
-
To reboot the device after the upload, select Reboot.
-
-
On Signing, select your operating system. Copy and run the provided script. Paste the output into the Signature field and click Upload.
Uploading the configuration starts. Click the Events link in the message to follow the download progress.
Manage and run scripts
Click Network > Configuration Management, and then open the Script Management tab in the lower part of Configuration Management. You can view and manage available scripts via the vertical ellipsis at the end of the row.
Execute scripts
-
In Script Management, click Execute in the vertical ellipsis for a script to launch the Execute Script wizard.
-
On Script Details, review the script. You can change the script here. If you want to reboot the device after running the script, select the Reboot box.
-
On Select Network Devices, select one or more devices to run the script on.
-
On Signing, select the operating system of the devices, run the command line code and paste the output into Signature.
-
Click Execute to run the script.
Delete scripts
In Script Management, click Delete in the vertical ellipsis for a script and delete the script.
Edit scripts
In Script Management, click Edit in the vertical ellipsis for a script and make your changes.
Add scripts
You can add any scripts to run on devices with monitored configurations. For details on supported operations, see the device vendor's documentation.
-
In Script Management, click Add Script.
-
Enter a name for the script.
-
Type your script in the Content box.
-
Provide more details on why you created the script and what it does in the Comments box.
-
Save the script.
The script is added to the Script Management. You can execute or edit it there.
Schedule and manage configuration jobs
Schedule configuration jobs to automate the management of network devices and configuration files. Configuration jobs include regular downloads of device configurations.
You can define and run configuration jobs either in SolarWinds Observability SaaS, on the Network Collector/Platform-connected SolarWinds Observability Self-Hosted, or in both places.
SolarWinds Observability SaaS
- Supported job types: Download Configurations from Devices, Upload Change to Devices, Execute Command Script on Devices.
- There are no pre-defined jobs.
Network Collector /Platform-connected SolarWinds Observability Self-Hosted
- Supported job types: Download Configurations from Devices, Upload Change to Devices, Execute Command Script on Devices. See NCM job types for a comprehensive list.
- There are pre-defined daily jobs.
Before you create a new job in SolarWinds Observability SaaS, check whether a similar job already exists on the Network Collector/Platform Connect SolarWinds Observability Self-Hosted. If you find the job there, consider disabling the job to avoid duplication.
Create a configuration job
-
In SolarWinds Observability SaaS, go to Settings > Configuration Management > Job Management.
-
Click Create.
-
Name the job.
-
Select a Job Type:
-
Download Configs from Devices
-
Upload Changes to Devices
-
Execute Command Script on Devices
-
-
On the Schedule screen, specify when the job runs. Select the frequency (Daily, Weekly, Monthly, or Specific Date) and complete the schedule definition.
-
Select the nodes to target with this job, and click Next.
-
Specify how you want to be notified about the job:
-
Select an available email configuration. See Email notifications
Custom Trigger Notifications and Custom Reset Notifications are not supported. If you select a configuration where these options are enabled, the job will run but you will not receive any notification.
-
Click Add a new configuration, provide a name for the email configuration and enter recipients. Optionally, enter a description for the email configuration.
-
-
Configure job-specific details and click Next.
-
Download Configuration: Select the configuration to be downloaded - Startup or Running.
-
Upload Changes: Select a device and then select the configuration to upload to the device. Review the configuration, adjust it, or select an additional option if necessary. See Upload details.
-
Execute Command Script on Devices: select an existing script or write a script to run on the devices. When you select an existing script, the script is displayed. You can adjust the script.
-
-
If the job requires a signature (uploading changes or executing commands), sign it and click Next to continue. See Set up signing for configuration details.
-
On Signing, select the operating system of the device.
-
Copy and run the command line script.
-
Paste the output to the Signature field.
-
-
Review the summary and save the job. The job is added to the Job List. By default, new configuration jobs are enabled and run as scheduled. Review the Status column.
Enable/disable configuration jobs
Configuration jobs must be enabled to run. Jobs that are not enabled will not start.
-
In SolarWinds Observability SaaS, go to Settings > Configuration Management > Job Management.
-
Find the job you want to enable/disable, click the vertical ellipsis and select Enable/Disable.
Edit configuration jobs
-
In SolarWinds Observability SaaS, go to Settings > Configuration Management > Job Management.
-
Find the job you want to edit, click the vertical ellipsis and select Edit. This starts the Update Job wizard, where you can change the name, schedule, nodes, notification and job-specific details. See Create a configuration job for details about the wizard.
Monitor job execution
Review job details
-
In SolarWinds Observability SaaS, go to Settings > Configuration Management > Job Management.
-
Click a job to display more details in the Inspector Panel.
-
Click the Logs tab in the Inspector Panel to see the transfer history. If there are no records, select a longer time range in the Show drop-down list.
Review transfer status
-
In SolarWinds Observability SaaS, go to Network > Configuration Management > Configuration Management.
-
Click the Transfer Status tab in the lower part of the screen. The tab displays all transfers for all jobs.
Use the filters to find a specific job, or access the Transfer Status tab from a specific job.
If there are no records, select a longer time range in the upper right corner.
-
To view more details for a specific job, click the vertical ellipsis for the job and select View Details. For download jobs, this lists all downloaded configurations. If a script execution job fails, details include the failure reason.