Documentation forSolarWinds Observability SaaS

Configuration Management for network devices

To perform configuration management actions on network devices (such as downloading, uploading, or executing scripts), you must first enable the Configuration Management option for each device. See the following sections:

Enable Configuration Management for a network device

  1. In the left pane of SolarWinds Observability, click Explore to open the Entity Explorer.

  2. Select an existing network device that is already managed in SolarWinds Observability.

  3. Click the vertical ellipsis () at the end of the device row, and click Configuration Management.

  4. Select Enable Config Management.

  5. Select an existing set of CLI credentials, or create a new one.

    These credentials will be used to establish Telnet or SSH sessions with the device for configuration download, configuration upload, and script execution.

  6. Click Save.

    A toast message confirms that a request to assign credentials has been created. You can click the link in the message to track progress on the Events page.

    It might take up to 2 or 3 minutes for SolarWinds Observability to update the device information. During this time, reopening the Configuration Management dialog might still show Enable Config Management as disabled, even though the enable request is already completed.

Create new CLI credentials

When you enable Configuration Management for a network device, you can create new CLI credentials by selecting the New CLI Credentials option. You must provide the following information:

  • Display Name: A unique name to identify this credential set so it can be used across devices.

  • Username: The login username for Telnet or SSH access.

  • Password: The login password for Telnet or SSH access.

  • Enable Level: Select Enable if the device requires an additional command to elevate access for configuration backups, configuration uploads, or script execution.

  • Enable Mode Password: If Enable is selected, provide the password required for privileged mode.

Advanced settings:

  • Execute Script Protocol: The protocol used for script execution.

  • Request Config Protocol: The protocol used to initiate configuration download or upload operations.

  • Transfer Config Protocol: The protocol used to transfer the configuration file during download or upload.

  • Telnet Port: This port will be used for communication if any of the selected protocols use Telnet.

  • SSH Port: The port to be used for communication if any of the selected protocols use SSH (SSH1, SSH2, or SSH Auto).

Update CLI credentials for a device with Configuration Management enabled

  1. In the left pane of SolarWinds Observability, click Explore to open the Entity Explorer.

  2. Select a network device that has Configuration Management enabled.

  3. Click the vertical ellipsis () at the end of the device row, and click Configuration Management.

  4. Update the credentials by selecting an existing CLI credential set or creating a new one.

  5. Click Save.

    A toast message confirms that a request to update assigned credentials has been created. You can click the link in the message to track progress on the Events page.

    It might take up to 2 or 3 minutes for SolarWinds Observability to update the device information. During this time, reopening the Configuration Management dialog might still show the previously assigned credentials, even though the request to assign new credentials is already completed.

Disable Configuration Management

  1. In the left pane of SolarWinds Observability, click Explore to open the Entity Explorer.

  2. Select an existing network device that currently has Configuration Management enabled.

  3. Click the vertical ellipsis () at the end of the device row, and click Configuration Management.

  4. Click Enable Config Management to deselect it.

  5. Click Save.

    A toast message confirms that a request to unassign credentials has been created. You can click the link in the message to track progress on the Events page.

    It might take up to 2 or 3 minutes for SolarWinds Observability to update the device information. During this time, reopening the Configuration Management dialog might still show Enable Config Management as enabled, even though the unassign credentials request is already completed.

View devices with Configuration Management enabled

You can filter devices in the Entity Explorer based on their Configuration Management status:

  • To show devices with Configuration Management enabled, enter the following in the search bar:

    hcoCliPollingEnabled:true

  • To show devices without Configuration Management enabled, enter the following in the search bar:

    hcoCliPollingEnabled:false

It might take up to 2 to 3 minutes for the SolarWinds Observability interface to reflect changes made when you enable or disable Configuration Management. During this time, the information shown in this filter might not accurately reflect the device’s current status.