Configuring Credentials

Credentials Configuration

vuSmartMaps™ relies on various types of credentials for different activities, including data collection. These credentials are managed within vuSmartMaps under Platform Settings > Definitions > Credentials. The following landing page is shown when navigating to Credentials.

When you navigate to the Credentials page, you’ll find information related to the following types of credentials:

• SSH
• Telnet
• SNMP
• User Credentials
• Cloud Provider Credentials (AWS, Azure, GCP)

SSH

Secure Shell (SSH) is a cryptographic network protocol used for secure remote login and command-line execution. It ensures secure communication over unsecured networks and is commonly used for accessing and managing remote systems. SSH credentials are used by the Command Line Interface (CLI) and Configuration Collector data source to allow vuSmartMaps to communicate securely with client environments.

💡 Note: vuSmartMaps supports only SSH version 2.

The following information is displayed on the SSH table under the Credentials page.

• Name
• User ID
• Port

Here are the steps to configure SSH credentials:

1. Click on the plus button + to add a new SSH credential.
2. You will see Add an SSH Credential popup as shown below:
   
   
   
   
   
   • Name: Enter the name of the SSH credential. The name should be unique.
   • Port: Enter the port number.
   • User ID: Enter the user ID.
   • Password: Enter the password.
   • Privilege Password: Enter the privilege password. The password specified here is used when systems require an additional password for privileged operations. (Example: Privileged operations in Cisco Router)
   • Key File: Enter the key file if authentication is key-based.
3. Submit the form with the Save button.

Telnet

Telnet allows remote access and control of devices or systems over a network. It can also be used by other protocols, such as FTP, for establishing protocol control channels.

The following information is displayed on the Telnet table under the Credentials page.

• Name
• User ID
• Port

Here are the steps to configure Telnet credentials:

1. Click on the plus button + to add a new telnet credential.
   
   
   
   
2. You will see Add a Telnet Credential popup as shown below:
   
   • Name: Enter the credential name.
   • Port: Enter the port number.
   • User ID: Enter the user ID.
   • Password: Enter the password.
   • Privilege Password: Enter the privilege password. The password specified here is used when systems require an additional password for privileged operations. (Example: Privileged operations in Cisco Router)
3. Submit the form by clicking on the Save button.

SNMP

Simple Network Management Protocol (SNMP) is used to manage network elements. vuSmartMaps utilizes SNMP credentials to collect health and performance information from network devices like routers, firewalls, and switches. The specific SNMP credential configuration depends on the SNMP version being used (v1, v2c, or v3) and may require community strings or usernames, along with authentication and privacy protocols.

1. SNMPv1: Initial version of the SNMP Protocol.
2. SNMPv2c: The revised version with enhancements along with the existing SNMPv1 administration structure “community-based” and hence SNMPv2c.
3. SNMPv3: It is the most secure version of SNMP. It facilitates remote configuration of SNMP entities and adds both encryption and authentication (Auth Key and Privacy Key), which can be used together or separately.

SNMP Credential configuration depends upon the SNMP version being used. If the SNMP version is v1 or v2c, you would need the Community string. If the SNMP version is v3, you would need a username. Also, for SNMP version 3, depending upon the security level, you would also need to know the authentication protocol, privacy protocol, and their keys.

The following information is displayed on the SNMP table under the Credentials page.

• Name
• Version
• Port
• Auth Protocol
• Priv Protocol

Here are the steps to configure an SNMP credential:

1. Click on the plus button + to add a new SNMP credential.
   
   
   
   
2. You will see Add SNMP Credential popup as shown below:
   
   • Name: Enter the name of the SNMP Credential. This should be unique.
   • Version: Select the version. Supported values are v1, v2c, and v3.
     
     • If the SNMP version is v1 or v2c, fill in the Port & Community string and submit the form.
       
       
       
       
       
       
     • If the SNMP version is v3, fill in the username. Select security level.

💡 Note: Please make a note of the following with respect to the v3 version of SNMP on the security level.

1. No-auth-no-priv: This security level does not require any further information. Submit the form with the Save button.
2. auth-no-priv: Add authentication protocol and key. Submit the form with the Save button.
3. auth-priv: Add authentication protocol, authentication key, privacy protocol, and privacy key. Submit the form with the Save button.

User Credentials

User credentials are used to add usernames and passwords for communication with apps or services that require username and password authentication. For example, JDBC and Java API data sources use User credentials.

The following information is displayed on the USER table under the Credentials page:

• Name
• Username

Here are the steps to configure user credentials:

1. Click on the plus button + to add a new user credential.
   
   
   
   
2. You will see Add User Credential popup as shown below:
   
   • Name: Enter the credential name.
   • Username: Enter the username.
   • Password: Enter the password.
3. Once the above is done, click on the Save button.

Cloud Provider Credentials (AWS, Azure, GCP)

When creating cloud-based O11ySources (like AWS, Azure, GCP, etc.), it is essential to provide the subscription information and associated credentials. Managing this information centrally via definitions is efficient and prevents the need to request credentials for each O11ySource individually.

To manage Cloud Provider Credentials, follow these steps:

1. Click on the + button across the respective section on the credentials page.
2. Fill in the required fields. (AWS, Azure, or GCP)
3. Click on Save to save the credentials.

AWS Credentials

• Key-based Authentication:

• • Access Key: A long-term credential associated with an AWS IAM user or the root account of the AWS account. (e.g., AKIAIOSFODNN7EXAMPLE)
  • Secret Access Key: A secret key associated with the access key ID. It’s used to sign requests to AWS services and must be kept confidential. (e.g., wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)

• Role-based Authentication:

• • Account ID: The ID of the Amazon account. (Required)
  • External ID: The external ID token for setting up an IAM role. You can obtain it with the GET /aws/iamExternalId request. (Optional)
  • IAM Role: The IAM role to be used to get monitoring data. (Required)

Azure Credentials

• Azure Active Directory Credentials:

• • Client ID: The unique identifier for your application registered in Azure AD.
  • Client Secret or Certificate: A secret key or certificate associated with the registered application. This is used for authenticating requests made by your application to Azure AD.
  • Tenant ID: The identifier for the Azure AD tenant where your application is registered.
  • Subscription ID: This is a unique identifier for your Azure subscription, represented as a Globally Unique Identifier (GUID) in the format of 32 hexadecimal characters typically arranged in the structure 8-4-4-4-12. For example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. This ID is required to associate your application with a specific subscription for billing and access purposes.

GCP Credentials

• Project ID: A single string with your GCP Project ID.
• Credentials JSON: Credentials JSON downloaded from GCP.

Deleting Credentials

To remove any of the existing credentials:

1. Select the check box on the left side of the credential to be deleted.
2. Once selected, click on the delete button shown in the top right corner of the listing table. You are then prompted to delete confirmation as shown:
   
   
   
   
3. Click on the Delete button if you wish to proceed with the deletion, else click on the Cancel button.