Credentials and Connectivity Test

Description

Netreo requires connectivity to, and working credentials for, any given device it monitors to perform tasks such as polling for statistical data and managing the device's configuration. The Credentials & Connectivity Test page allows an IT engineer to quickly determine if Netreo is able to connect to an arbitrary device in your network and test the credentials for that device.

Additionally, to assist in troubleshooting device onboarding issues, the device being checked is not required to already be a managed device in Netreo for any of the tests to be performed. These tests may be used on any device that Netreo can reach on the network, whether managed by Netreo or not.

For convenience, any configuration values entered for one test that also apply to other tests, automatically populate to those tests once entered. This saves you having to re-enter the same values/selections when performing multiple tests on the same target device.

Credentials Tests

The SNMP, SSH and Windows PowerShell tabs are for credentials tests. In most cases, queries to devices are made using SNMP, SSH, or PowerShell, so a test for credentials of each type is included (see individual descriptions below).

These tests are for checking whether a specific set of credentials is working with a specific device. You may enter the credentials to test directly into the test, or select a device template containing the credentials. (Note: Devices that do not use device templates store the credentials for authenticating with them in the administrative view of the Device Dashboard. See the Authentication Section under the Main Tab heading of the Device Administration article for more information on device-specific authentication settings.)

These test are particularly useful during the initial implementation of a Netreo deployment for troubleshooting managed devices that are failing to collect data or showing device polling status failure.

Connectivity to the device is required for these tests to work. If a credentials test fails due to being unable to connect to the device, use the Connectivity Test to determine is basic connectivity is availble.

Connectivity Test

The Connectivity tab is for testing connectivity to a device. Specific ports on the device may also be tested (see description below).

This test is useful for troubleshooting why a device is not being added to Netreo.

SNMP Credentials Test

Test Description

The SNMP test is used to check if a given set of SNMP credentials works with a particular device. It queries the target device for its system description OID value using an SNMPwalk and displays the resulting output. SNMP is the protocol used for the majority of data collection by Netreo, especially for network infrastructure devices (router, switches, firewalls, etc.).

This test is very useful for troubleshooting why a device that communicates using SNMP is not being added to Netreo through the normal automated means where the error indicated is failing credentials.

Running the Test

The test must first be configured using the fields (outlined below) in the Target Device panel before it can be run.

Enter the location of the target device on the network, select whether the test should be sourced from Netreo itself or a connected service engine, enter the credentials you would like to test (or select a device template containing those credentials), then use the command buttons located at the bottom of the panel to execute the test or reset the test configuration.

Output from the test execution may be viewed in the Result panel below the Target Device panel. If a failure occurs, the output generally indicate the nature of the failure.

Test Configuration Fields

• IP ADDRESS/FQDN - (required) Enter the IP address or FQDN of the device to be tested. (This address must be reachable by Netreo or a deployed service engine.)
• SERVICE ENGINE - (required) Determines whether the test is sourced from a connected service engine appliance or from Netreo itself. If the target device has been onboarded for management by Netreo and has been assigned to a service engine select the appropriate service engine here, otherwise leave the selection as N/A.
• SNMP VERSION - (required) Select the version of SNMP the target device uses to communicate.
• CREDENTIALS - (required) Determines whether the credentials to be tested are entered manually or retrieved from a device template.
  • MANUALLY ENTER - If you would like to manually enter the credentials to be tested, select this option. The individual fields outlined below will become available or grayed-out depending on the version of SNMP selected above. (Select the eye icon next to a field to see entered values in plain text. Select again to hide.)
    • SNMP READ-ONLY STRING - Enter the SNMP community string required to access devices in your network, if applicable.
    • V3 USERNAME - Enter the username to be used for SNMPv3 access.
    • V3 AUTH PASSWORD - Enter the SNMPv3 authentication password for the above username, if required.
    • V3 AUTH ALGORITHM - Select the algorithm to use for SNMPv3 authentication.
    • V3 PRIVACY PASSWORD - If using privacy enter your SNMPv3 privacy password.
    • V3 PRIVACY ALGORITHM - If using privacy select the algorithm to use for SNMPv3 privacy encryption.
  • SELECT FROM TEMPLATE - If you would like to test credentials stored in a device template, select this option. (The credentials are not shown in the test configuration area. You will need to navigate to the appropriate device template to see and modify credentials tested using this option.)
    • TEMPLATE - Select the device template containing the credentials you would like to test.

Command Buttons

• Clear - This button clears any values entered or selections made in the test configuration fields.
• Test - This button executes the test according to the configuration of the fields.

SSH Credentials Test

Test Description

The SSH test is used to check if a given set of SSH credentials works with a particular device. It passes the command echo "Hello World" to the target device and displays the resulting output.

This test is very useful for troubleshooting why a device that communicates using SSH is not being added to Netreo through the normal automated means where the error indicated is failing credentials.

Running the Test

The test must first be configured using the fields (outlined below) in the Target Device panel before it can be run.

Enter the location of the target device on the network, select whether the test should be sourced from Netreo itself or a connected service engine, enter the credentials you would like to test (or select a device template containing those credentials), then use the command buttons located at the bottom of the panel to execute the test or reset the test configuration.

Output from the test execution may be viewed in the Result panel below the Target Device panel. If a failure occurs, the results generally indicate the nature of the failure.

Test Configuration Fields

• IP ADDRESS/FQDN - (required) Enter the IP address or FQDN of the device to be tested. (This address must be reachable by Netreo or a deployed service engine.)
• SERVICE ENGINE - (required) Determines whether the test is sourced from a connected service engine appliance or from Netreo itself. If the target device has been onboarded for management by Netreo and has been assigned to a service engine select the appropriate service engine here, otherwise leave the selection as N/A.
• CREDENTIALS - (required) Determines whether the credentials to be tested are entered manually or retrieved from a device template.
  • MANUALLY ENTER - If you would like to manually enter the credentials to be tested, select this option. (Select the eye icon next to a field to see entered values in plain text. Select again to hide.)
    • USERNAME - Enter the SSH username to access the device.
    • PASSWORD - Enter the password for the above username
  • SELECT FROM TEMPLATE - If you would like to test credentials stored in a device template, select this option. (The credentials are not shown in the test configuration area. You will need to navigate to the appropriate device template to see and modify credentials tested using this option.)
    • TEMPLATE - Select the device template containing the credentials you would like to test.

Command Buttons

• Clear - Clears any information or selections in the test configuration fields.
• Test - Executes the test according to the configuration of the fields.

Windows PowerShell Credentials Test

Test Description

The Windows PowerShell test is used to check if a given set of Windows credentials works with a particular device. It runs the query SELECT Name FROM Win32_ComputerSystem on the target device and displays the resulting output.

This test is very useful for troubleshooting why a device that communicates using WMI or WinRM is not being added to Netreo through the normal automated means where the error indicated is failing credentials.

Running the Test

The test must first be configured using the fields (outlined below) in the Target Device panel before it can be run.

Enter the location of the target device on the network, select whether the test should be sourced from Netreo itself or a connected service engine, select the authentication method, enter the credentials you would like to test (or select a device template containing those credentials), then use the command buttons located at the bottom of the panel to execute the test or reset the test configuration.

Output from the test execution may be viewed in the Result panel below the Target Device panel. If a failure occurs, the results generally indicate the nature of the failure.

Test Configuration Fields

• IP ADDRESS/FQDN - (required) Enter the IP address or FQDN of the device to be tested. (This address must be reachable by Netreo or a deployed service engine.)
• SERVICE ENGINE - (required) Determines whether the test is sourced from a connected service engine appliance or from Netreo itself. If the target device has been onboarded for management by Netreo and has been assigned to a service engine select the appropriate service engine here, otherwise leave the selection as N/A.
• AUTHENTICATION METHOD - (required)
  • WMI - Select to use Windows Management Instrumentation.
  • WINRM - Select to use Windows Remote Management.
• CREDENTIALS - (required) Determines whether the credentials to be tested are entered manually or retrieved from a device template.
  • MANUALLY ENTER - If you would like to manually enter the credentials to be tested, select this option. (Select the eye icon next to a field to see entered values in plain text. Select again to hide.)
    • DOMAIN - Enter the name of the Windows domain.
    • USERNAME - Enter the username to access the above domain.
    • PASSWORD - Enter the password for the above username.
  • SELECT FROM TEMPLATE - If you would like to test credentials stored in a device template, select this option. (The credentials are not shown in the test configuration area. You will need to navigate to the appropriate device template to see and modify credentials tested using this option.)
    • TEMPLATE - Select the device template containing the credentials you would like to test.

Command Buttons

• Clear - Clears any information or selections in the test configuration fields.
• Test - Executes the test according to the configuration of the fields.

Connectivity Test

Test Description

The Connectivity test allows you to confirm a working network connection to device (and even a specific port). If Netreo shows a managed device as down, but you believe it is not down, use this test to confirm that Netreo can actually communicate with the device.

This test is especially useful during the implementation phase of a Netreo deployment if the Interrogation list of the Device Management Dashboard shows IP addresses that have failed to be added as managed devices to Netreo. You can then test each IP address with this test to determine if connectivity is the reason for failure to be added. The test also allows you to determine which service engines are able to connect to specific IP addresses.

Running the Test

The test must first be configured using the fields (outlined below) in the Target Device panel before it can be run.

Select the protocol the test should use, enter the location of the target device on the network, enter the port number (if necessary), select whether the test should be sourced from Netreo itself or a connected service engine, then use the command buttons located at the bottom of the panel to execute the test or reset the test configuration.

Output from the test execution may be viewed in the Result panel below the Target Device panel. A successful test also returns the latency for the device to the test source. If a failure occurs, the results generally indicate the nature of the failure. (Note: Entering a bad address will produce a "Host down/unreachable" result, so be sure to check that the correct address has been entered.)

Test Configuration Fields

• PROTOCOL - Three options are available when performing the test. Uses Nmapto perform the test.
  • ICMP (Ping) - Select this option to perform a basic connectivity test on the target device.
  • TCP - Select this option to check if a specific TCP port is open on the target device.
  • UDP - Select this option to check if a specific UDP port is open on the target device.
• IP PROTOCOL - Select the IP protocol you wish to use for the test. Options are IPv4 (default) and IPv6. It is recommended to use the protocol that you expect the device to communicate with for monitoring.
• IP ADDRESS/FQDN - (required) Enter the IP address or FQDN of the device to be tested. (This address must be reachable by Netreo or a deployed service engine.)
• PORT NUMBER - (required for TCP and UDP tests) Enter the specific port number you would like to test.
• SERVICE ENGINE - (required) Determines whether the test is sourced from a connected service engine appliance or from Netreo itself. If the target device has been onboarded for management by Netreo and has been assigned to a service engine select the appropriate service engine here, otherwise leave the selection as N/A.

Command Buttons

• Clear - Clears any information or selections in the test configuration fields.
• Test - Executes the test according to the configuration of the fields.