Managing Credentials

This section defines credentials and how they are used in SL1.

Use the following menu options to navigate the SL1 user interface:

To view a pop-out list of menu options, click the menu icon ().
To view a page containing all of the menu options, click the Advanced menu icon ().

What Are Credentials?

Credentials are access profiles (usually username, password, and any additional information required for access) that allow SL1 to retrieve information from devices and from software applications on devices.

Discovery uses SNMP credentials to retrieve SNMP information during initial discovery and nightly auto-discovery. If SL1 can connect to a device with an SNMP credential, SL1 deems that device "manageable" in SL1.
Dynamic Applications use credentials to retrieve SNMP information, database information, SOAP information, XML information, XSLT information, and WMI information.
SL1 includes a type of credential called "Basic/Snippet" that is not bound to a specific authentication protocol. You can use this type of credential for Dynamic Applications of type "WMI", of type "snippet", and when defining system backups. "Basic/Snippet" credentials can also be used for monitoring Windows devices using PowerShell.
SL1 includes a type of credential that allows SL1 to communicate with an LDAP or Active Directory system. For details on integrating SL1 with LDAP or Active Directory, see the section on Using Active Directory and LDAP.
SL1 includes a type of credential that allows Dynamic Applications of type "Snippet" to use SSH to communicate with a remote device. To use these Dynamic Applications, you must define an SSH credential.
SL1 includes a type of credential that allows Dynamic Applications to retrieve data from Windows devices. If you align a Dynamic Application for PowerShell with a PowerShell credential, SL1 assumes that you want to use its built-in agentless transport to communicate with Windows devices.

If necessary, a single device can use multiple credentials. If more than one agent or application is running on the device, each agent or application can be associated with its own credential. During discovery, SL1 will use the appropriate credential for each agent.

For example, suppose you want SL1 to discover a device that supports SNMP v2. To retrieve SNMP data from that device, SL1 must use a valid SNMP v2 read-only community string. So we would first go to the device and define the SNMP read-only community string. Then we would return to SL1 and create a credential in the SL1 system, using that community string. This new credential would allow discovery to retrieve SNMP data from the device.

Now suppose this same device also includes a MySQL database. Suppose you want SL1 to use a Dynamic Application to monitor that database. To retrieve data from the database, SL1 must use a valid username and password for that database. So we would first go to the device that hosts the MySQL database and create a database username and database password for SL1 to use. Then we would return to SL1 and create a credential in the SL1 system. The credential would include the database username and database password for the MySQL database. This credential would allow the Dynamic Application to retrieve data about the MySQL database.

Viewing Information about Credentials

The Credentials page (Manage > Credentials) allows you to view a list of all ScienceLogic credentials. From this page, you can also create new credentials and edit, duplicate, test, or delete existing credentials.

For each credential, the Credentials page displays the following information:

Name. Name of the credential.
ID. Unique numeric ID, automatically assigned by SL1 to each credential.
Type. Type of credential. Possible types are SNMP, Database, SOAP/XML, LDAP, Basic/Snippet, SSH/Key, and PowerShell.
Subtype. Subtype of credential, for vendor-specific credentials. Possible subtypes are Aliyun, AWS, Azure, Citrix Xen, IBM, and VMware.
Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the external device or application.
Last Edit. Date and time the credential was created or last edited.

If you do not see one of these columns on the Credentials page, click the Select Columns icon () to add or remove columns. You can also drag columns to different locations on the page or click on a column heading to sort the list of credentials by that column's values. SL1 retains any changes you make to the columns that appear on the Credentials page and will automatically recall those changes the next time you visit the page.

You can filter credentials by typing filter text or selecting filter options to narrow down the list to just the items you want to view. If you are looking for a very specific set of credentials, click the gear icon () to the right of the Search field and select Advanced. In this mode you can create an advanced search using "AND" or "OR" for multiple search criteria. For more information, see the section on Performing an Advanced Search.

Editing a credential and saving it overwrites the existing credential; it does not create a new credential. To create a new credential from an existing credential, see the section on Duplicating a Credential.

To automatically configure your SL1 Data Collector, Message Collector, or All-In-One Appliance to accept traps from monitored devices and communicate with those devices, click the SNMPv3 Trap Configuration Reset icon (). For more information, see the section on Configuring SNMPv3 Traps.

Defining Credentials

To define a credential in SL1:

Collect the information you need to create each credential (usually username and password).
Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select the type of credential you want to create. Your choices are:

SNMP Credential
Database Credential
SOAP/XML Host Credential
LDAP Credential
Basic/Snippet Credential
SSH/Key Credential
PowerShell Credential
Aliyun Credential
AWS Credential
AWS Assume Role Credential
AWS EC2 Credential
AWS IAM Credential
Azure Credential
Citrix XenServer Credential
IBM Cloud Credential
S3 Backup Credential
VMware Credential

The Create Credential modal page appears. In this page, you can define the new credential. The following sections explain how to create each type of credential.
Click the Save & Close button to save the new credential and close the window.

Defining an SNMP Credential

SNMP credentials allow SL1 to access SNMP data on a managed device. SL1 uses SNMP credentials to perform discovery, run auto-discovery, and gather information from SNMP Dynamic Applications.

To create an SNMP credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create SNMP Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This is a required field.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the device. The default value is 1500.
SNMP Version. SNMP version. Choices are SNMP V1, SNMP V2, and SNMP V3. The default value is SNMP V2.
Port. The port SL1 will use to communicate with the external device or application. The default value is 161. This field is required.
SNMP Retries. Number of times SL1 will try to authenticate and communicate with the external device. The default value is 1.

SNMP V1/V2 Settings

If you selected SNMP V1 or SNMP V2 in the SNMP Version field, complete these fields. These fields are inactive if you selected SNMP V3.

SNMP Community (Read-Only). The SNMP community string (password) required for read-only access of SNMP data on the remote device or application. For SNMP V1 and SNMP V2 credentials, you must supply a community string, either in this field or in the SNMP Community (Read/Write) field.
SNMP Community (Read/Write). The SNMP community string (password) required for read and write access of SNMP data on the remote device or application. For SNMP V1 and SNMP V2 credentials, you must supply a community string, either in this field or in the SNMP Community (Read Only) field.

SNMP V3 Settings

If you selected SNMP V3 in the SNMP Version field, complete these fields. These fields are inactive if you selected SNMP V1 or SNMP V2.

Security Name. Name for SNMP authentication. This field is required.
Security Passphrase. Password to authenticate the credential. This value must contain at least 8 characters. This value is required if you use a Security Level that includes authentication.

In addition to alphanumeric characters, you can also use the following special characters in an SNMP V3 security passphrase: ? - _ = , . : # + % $ [ ] { } & ! ( ) | /

You cannot use the following special characters in an SNMP V3 security passphrase: " ' \

Authentication Protocol. Select an authentication algorithm for the credential. This field is required. Choices are:

MD5. This is the default value.
SHA
SHA-224
SHA-256
SHA-384
SHA-512

The SHA option is SHA-128.

Security Level. Specifies the combination of security features for the credentials. This field is required. Choices are:

No Authentication / No Encryption.
Authentication Only. This is the default value.
Authentication and Encryption.

Engine ID. The unique engine ID for the SNMP agent you want to communicate with. (SNMPv3 authentication and encryption keys are generated based on the associated passwords and the engine ID.) This field is optional.
Context. A context is a mechanism within SNMPv3 (and AgentX) that allows you to use parallel versions of the same MIB objects. For example, one version of a MIB might be associated with SNMP Version 2 and another version of the same MIB might be associated with SNMP Version 3. For SNMP Version 3, specify the context name in this field. This field is optional.
Privacy Protocol. The privacy service encryption and decryption algorithm. This field is required. Choices are:

DES. This is the default value.
AES-128
AES-192
AES-256
AES-256-C. This option is for discovering Cisco devices only.

Privacy Protocol Passphrase. Privacy password for the credential. This field is optional.

Click Save & Close.

If you would like to test your credential using the Credential Tester panel, click Save & Test. For detailed instructions on using the Credential Tester panel, see the Using the Credential Tester Panel section.

Defining a Database Credential

Database credentials allow SL1 to access data on a database on a managed device. SL1 uses database credentials when collecting data for Database Dynamic Applications.

To create a database credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create Database Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the database.
Database Type. Type of database that will be accessed with the credential. Select from a list of databases supported by SL1. This field is required. Choices are:

MySQL
MS SQL Server
Oracle and *SQLNet
PostgreSQL
IBM DB2
Sybase ASE
Informix

For information about monitoring Informix databases, see the Monitoring Informix Databases section.

Database Name. Name of the database that will be accessed with the credential.
Database User. Username associated with a valid account on the database.
Password. Password associated with a valid account on the database.
Hostname/IP. Hostname or IP address where the database resides. This field is required.

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the current device (device that is currently using the credential).
You can include the variable %N in this field. SL1 will replace the variable with the hostname of the current device (device that is currently using the credential). If SL1 cannot determine the hostname, SL1 will replace the variable with the primary management IP address for the current device. This field is required.

NOTE: To use the localhost, in the Hostname/IP field, enter the IP address 127.0.0.1. The credential will not work if you enter the string localhost in the Hostname/IP field.

Port. Port number associated with the database you want to access with this credential. This field is required.

For DB Type of MySQL, the default value is 3306.
For DB Type of MS SQL Server, the default value is 1433.
For DB Type of Oracle and *SQLNet, the default value is 1521.
For DB Type of PostgreSQL, the default value is 5432.
For DB Type of IBM DB2, the default value is 523.
For DB Type of Sybase ASE, the default value is 4100.
For DB Type of Informix, see the 9088 section.

SL1's Database Servers include a MySQL database running on port 7706. Data Collectors and Message Collectors include a MySQL database running on port 7707.

Oracle Settings

These fields should be completed only if you selected Oracle & *SQLNet in the Database Type field.

Oracle Connect Type. Specifies the method SL1 should use to connect to the Oracle database. The choices are:

Oracle System Identifier (SID)
Oracle Real Application Clusters (SERVICE)
Oracle Server Direct Connection (SERVER)

In Oracle 11g, the "Oracle Server Direct Connection" option is deprecated. If you select this Oracle Connect Type for an Oracle 11g database, you must edit the file listener.ora and add the line "DEFAULT_SERVICE_LISTENER=<SID>", where <SID> is the SID value.

Oracle Database SID (if required). Enter the value for the Oracle Connect Type (either Oracle SID, Oracle RAC, or Oracle Server) selected in the Oracle Connect Type field.

Click Save & Close.

Monitoring Informix Databases

For SL1 to connect to an Informix database:

The Informix database server must have a DRDA listener configured on a separate port than the current listener(s).
The DRDA listener must be configured to share data with other listeners using a DBSERVERALIASES entry in the server's onconfig file.
For servers that host multiple databases, multiple DRDA listeners are required with different port assignments.

For example Informix configuration files, please contact ScienceLogic Support.

Defining a SOAP/XML Credential

SOAP/XML credentials allow SL1 to access a web server on a managed device. SOAP/XML credentials are used in several places in SL1, including:

With Dynamic Applications of type "SOAP".
With Dynamic Applications of type "XML".
With Dynamic Applications of type "XSLT".
With Dynamic Applications of type "snippet". The snippet code must define the authentication protocol. Dynamic Applications of type "snippet" can use any type of credential.

To create a SOAP/XML credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create SOAP/XML Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the web service.
Content Encoding. Tells the SOAP server or XML data-store how the content is encoded, so the SOAP server or XML data-store knows how to decode the message. Select the encoding that is appropriate for your request and response.
Method. HTTP method to use to exchange credential data from the managed device. Choices are GET or POST.

Typically, Dynamic Applications of type "XML" use GET methods. Dynamic Applications of type "SOAP" and of type "XSLT" use POST methods.

HTTP Version. Version of HTTP to use. Choices are 1.0 or 1.1.
URL. Address of the SOAP server, HTML document, or XML document. This field is required and should be of the following format:

https://IP address:port/full path to desired SOAP, HTML, or XML document

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the current device (device that is currently using the credential).

For component devices, SL1 will replace %D with the IP address of the root device.

You can include the variable %N in this field. SL1 will replace the variable with the hostname of the current device (device that is currently using the credential). If SL1 cannot determine the hostname, SL1 will replace the variable with the primary management IP address for the current device.

HTTP Auth User. Username with which to log in to the web server.
HTTP Auth Password. Password with which to access the web server.

Proxy Settings

If you use a proxy server in front of the SOAP server(s) or XML data-store(s) you want to communicate with, enter values in these fields. Otherwise, you can skip these fields.

Hostname/IP. The host name or IP address of the proxy server.
Port. Port on the proxy server to which you will connect.
User. Username to use to access the proxy server.
Password. Password to use to access the proxy server.

SOAP Options

These fields are optional. When a SOAP/XML credential is aligned with a SOAP or XSLT Dynamic Application, the requests defined in the Dynamic Application can use the values defined in these fields. To use a value defined in one of these fields, the request must include the substitution character associated with that value. For example, suppose a Dynamic Application request includes the XML tag <high_value=%1>. Suppose you specified "100" in the Embed Value [%1] field in the credential aligned with that Dynamic Application. The request will be sent with the XML tag <high_value=100>.

Embedded Password [%P]. Specifies a password value to include in a request. The value defined in this field is substituted in to the %P substitution character. The value will be encrypted in the request, will be masked in the Credential Editor, and will be stored in an encrypted form in the database.
Embed Value [%1]. The value defined in this field is substituted in to the %1 substitution character.
Embed Value [%2]. The value defined in this field is substituted in to the %2 substitution character.
Embed Value [%3]. The value defined in this field is substituted in to the %3 substitution character.
Embed Value [%4]. The value defined in this field is substituted in to the %4 substitution character.

HTTP Headers

If you require custom HTTP headers to communicate with the SOAP server, you can build the custom header here. To add a header, click the Add Header button

cURL Options

You can include the cURL command and various options in your credential. The list of cURL options lists all the options you can include in your credential. To include a cURL option in the credential, click the Add CURL Option drop-down and then select it from the list. You can then supply arguments in the blank text field to the right of the option.
For more information on cURL commands, see the cURL manpage at http://curl.haxx.se/docs/manpage.html.

Click Save & Close.

Defining an LDAP Credential

LDAP or Active Directory credentials allow SL1 to access data on an LDAP server or an Active Directory server.

Authentication is the method by which SL1 determines if a user can access the SL1 system. For user accounts that are to be authenticated with LDAP or Active Directory, SL1 uses the LDAP or Active Directory credential to establish communication with the LDAP or Active Directory server. SL1 will then query the Active Directory or the LDAP server to determine if the username and password are legitimate and accurate.

Additionally, SL1 can automatically create accounts for one or more LDAP or Active Directory users. SL1 uses the LDAP or Active Directory credential to communicate with Active Directory or the LDAP server and:

Determine if the username and password are legitimate and accurate.
Gather information to populate fields in the user's automatically-created account.

For details on using Active Directory or LDAP for authentication, see the Using Active Directory and LDAP section.

To create an LDAP credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create LDAP Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the directory server.
LDAP Type. Specifies the type of LDAP running on the directory server. Choices are LDAP or Active Directory.
Hostname/IP. Hostname or IP address of the LDAP or Active Directory server. This field is required.
Secure. Specifies whether you are using LDAP over SSL.
Port. Port number on the LDAP or Active Directory server to which SL1 will send requests. This field is required.
RDN (Bind DN / bind user). Bind DN. The bind DN is a user on the LDAP or Active Directory server who is permitted to search the directory within the specified search base.

In many LDAP or AD configurations, each user has read-access to his/her own account. Therefore, you might find it most useful to include the %u variable in this field. When an LDAP or AD user logs in to SL1, SL1 stores the username in the %u variable. SL1 then uses the %u variable to build the bind DN, uses the bind DN to communicate with the LDAP or AD server, and then authenticates the current user.
An example entry in the RDN field might be:

uid=%u, ou=People, dc=sciencelogic, dc=com

This creates a DN using the current login name as the uid.

You can also include the %d variable in this field. The %d variable represents the name of the LDAP domain, as specified in the LDAP Domain field.

If you have configured SL1 to automatically create accounts when a user logs in with an LDAP/AD username, you must include the %u variable in the RDN field.

LDAP Domain. If your LDAP or Active Directory configuration includes multiple domains, specify the domain components to bind to in this field. For example, you could specify:

dc=reston, dc=sciencelogic, dc=com.

This would bind to the sub-domain "reston", in the domain "sciencelogic", in the domain "com".

Bind Password. Password that allows access to the LDAP or Active Directory server. In most cases, when you specify a bind password in a credential, you are creating a "write" credential (that is, a credential that allows SL1 to make changes to the LDAP or AD server).
User Search Base. In this field, you specify the area in the directory where users to be authenticated reside, using RDN notation. For example, if you want to authenticate five users from the ou called "people", you could specify the RDN that includes that ou.

ou=People, dc=sciencelogic, dc=com.

This would allow SL1 to authenticate users in the ou called "people." In the User Search Scope field, you can specify whether SL1 should also authenticate all users in any ou underneath "people".

User Search Scope. In this field, you specify whether SL1 should search only the directory specified in User Search Base or whether SL1 should search the directory specified in User Search Base and all its child branches. Choice are:

Subtree. SL1 should search the directory specified in User Search Base and also search all its child branches.
One Level. SL1 should search only the directory specified in User Search Base.

Click Save & Close.

Defining a Basic/Snippet Credential

Dynamic Applications of type "snippet" are not required to use only the Basic/Snippet Credential. In Dynamic Applications of type "snippet", the snippet code must define the authentication protocol. Therefore, Dynamic Applications of type "snippet" can use any type of credential.

Basic/Snippet credentials define standard authentication parameters, but are not tied to a specific authentication protocol. Basic/Snippet credentials are used in several places in SL1, including:

With Dynamic Applications of type "snippet". The snippet code must define the authentication protocol.
With Dynamic Applications of type "WMI". The authentication protocol is specific to WMI and is specified by SL1 when the Dynamic Application is executed. To access WMI information on a Windows server, ensure that the Username you specify is allowed access to the server and to the WMI namespace.
With Dynamic Applications of type "PowerShell". For information about configuring your environment for PowerShell collection, see theMonitoring Windows Devices (PowerShell) section.
When defining external backups. The authentication protocol is defined in the Backup Management page (System > Settings > Backup).

To create a Basic/Snippet credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create Basic/Snippet Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
Username. Username for a user account on the device.
Password. Password for a user account on the device.
Hostname/IP. Hostname or IP address of the device from which you want to retrieve data. This field is required.

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the current device (device that is currently using the credential).
You can include the variable %N in this field. SL1 will replace the variable with the hostname of the current device (device that is currently using the credential). If SL1 cannot determine the hostname, SL1 will replace the variable with the primary management IP address for the current device.

Port. Port number associated with the data you want to retrieve. This field is required.

Click Save & Close.

Defining an SSH/Key Credential

Secure Shell (SSH) is a network protocol that enables users to securely access a command-line shell on a remote computer or server over an unsecured network. SSH provides strong encryption and authentication capabilities, making it an ideal method for securely administering commands or transferring data between a client and server.

To make SSH even more secure, you can use SSH keys instead of a simple password to log in to a server. SSH keys consist of two long strings of characters, called a public/private key pair, that are much less susceptible than passwords are to brute force attacks. The public key is placed on the server you want to access, while the private key resides on the client. When you use SSH to log in to the server from the client, the key pair is used to authenticate the session.

In SL1, some Dynamic Applications of type "Snippet" use SSH to communicate with a remote device. To use these Dynamic Applications, you must define an SSH credential. This credential specifies the hostname or IP address of the system you want to monitor, the port number used to access that system, and the private key used for authentication.

Consult the documentation associated with the PowerPack that contains the Dynamic Application of type "Snippet" to find detailed directions on configuring the remote device and generating a private key for SL1 to use.

To create an SSH/Key credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create SSH/Key Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
Hostname/IP. Hostname or IP address of the device from which you want to retrieve data. This field is required.

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the current device (device that is currently using the credential).
You can include the variable %N in this field. SL1 will replace the variable with hostname of the current device (device that is currently using the credential). If SL1 cannot determine the hostname, SL1 will replace the variable with the primary, management IP address for the current device.

Port. Port number associated with the data you want to retrieve. This field is required.

The default TCP port for SSH servers is 22.

Username. Username for an SSH or user account on the device to be monitored.
Password. Password for an SSH user account on the device to be monitored.
Private Key (PEM Format). Enter the SSH private key that you want SL1 to use, in PEM format.

The Private Key (PEM Format) field is only required in the current SL1 user interface. The Private Key (PEM Format) field is not required if you are using the classic SL1 user interface to define a credential.

The private key can have a maximum of 64 characters per line. Therefore, you cannot use keys in the OpenSSH format, because that format uses 70 characters per line. When you attempt to save the credential, SL1 will validate that the private key entered is in the correct format. You will be able to save the credential only if the private key is correctly formatted.

Click Save & Close.

Defining a PowerShell Credential

Dynamic Applications can include PowerShell commands that collect data from Windows devices. If you want to use SL1's built-in transport agent (that is, run "agentless" on the Windows device), you can align a PowerShell credential with those Dynamic Applications.

Consult the Monitoring Windows Devices (PowerShell) and Monitoring Windows Devices (WMI) sections for detailed directions on configuring the Windows devices for agentless communication and on configuring a proxy server.

To define a PowerShell credential in SL1, you will need the following information:

The username and password for a user on the Windows device.
If the user is an Active Directory account, the hostname or IP address of the Active Directory server and the domain.
Determine if an encrypted connection should be used.
If you are using a Windows Management Proxy, the hostname or IP address of the proxy server.

To create a PowerShell credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create Powershell Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the authenticating server. For collection to be successful, SL1 must connect to the authenticating server, execute the PowerShell command, and receive a response within the amount of time specified in this field.
Account Type. Type of authentication for the username and password in this credential. Choices are:

Active Directory. On the Windows device, Active Directory will authenticate the username and password in this credential.
Local. Local security on the Windows device will authenticate the username and password in this credential.

Hostname/IP. Hostname or IP address of the device from which you want to retrieve data. This field is required.

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the device that is currently using the credential.
You can include the variable %N in this field. SL1 will replace the variable with the hostname of the device that is currently using the credential. If SL1 cannot determine the hostname, SL1 will replace the variable with the primary, management IP address for the current device.
You can include the prefix HOST or WSMAN before the variable %D in this field if the device you want to monitor uses a service principal name (for example, "HOST://%D" or "WSMAN://%D"). SL1 will use the WinRM service HOST or WSMan instead of HTTP and replace the variable with the IP address of the device that is currently using the credential.

Username. Type the username for an account on the Windows device to be monitored or on the proxy server. This field is required.

NOTE: The user should not include the domain name prefix in the username for Active Directory accounts. For example, use "em7admin" instead of "MSDOMAIN\em7admin".

Password. Type the password for the account on the Windows device to be monitored or on the proxy server. This field is required.
Encrypted. Select whether SL1 will communicate with the device using an encrypted connection:

Toggle on (blue) if SL1 will communicate with the device using an encrypted connection. If the connection is encrypted, when communicating with the Windows server, SL1 will use a local user account with authentication of type "Basic Auth". You must then use HTTPS and can use a Microsoft Certificate or a self signed certificate.
Toggle off (gray) if the connection is not encrypted. If the connection is not encrypted, when communicating with the Windows server, SL1 will not encrypt the connection.

Port. Type the port number used by the WinRM service on the Windows device. This field is required and is automatically populated with the default port based on the value you selected in the Encrypted field.
PowerShell Proxy Hostname/IP. If you use a proxy server in front of the Windows devices you want to communicate with, type the fully-qualified domain name or the IP address of the proxy server in this field.
Active Directory Host/IP. If you selected Active Directory in the Account Type field, type the hostname or IP address of the Active Directory server that will authenticate the credential.
Active Directory Domain. If you selected Active Directory in the Account Type field, type the domain where the monitored Windows device resides.

Click Save & Close.

Defining an Aliyun Credential

To configure SL1 to monitor Aliyun's Alibaba Cloud service, you must first create an Aliyun credential. This credential allows the Dynamic Applications in the Alibaba Cloud: Aliyun PowerPack to connect with the Aliyun service.

SL1 includes an Aliyun credential type that you can use to connect with the Aliyun service during guided discovery. This credential type uses field names and terminology that are specific to the Aliyun service.

Alternatively, you could monitor Aliyun using a generic SOAP/XML credential that does not include Aliyun-specific fields. For more information, see the section on Creating a SOAP/XML Credential for Aliyun.

To create an Aliyun-specific credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create Aliyun Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
Account access key for Aliyun service (minimum 20 characters). The account access key ID for the Aliyun service. This field is required.
Account access key password for Aliyun service (minimum 20 characters). The account access key password for the Aliyun service. This field is required.

Proxy Settings

If you use a proxy server in front of the Aliyun services you want to communicate with, enter values in these fields. Otherwise, you can skip these fields.

Proxy Hostname/IP. The host name or IP address of the proxy server.
Proxy Port. Port on the proxy server to which you will connect.
Proxy User. Username to use to access the proxy server.
Proxy Password. Password to use to access the proxy server.

Click Save & Close.

Defining an AWS Credential

To use the Amazon Web Services (AWS) Dynamic Applications, you must configure a credential that allows SL1 to connect to the AWS REST API.

SL1 includes an AWS credential type that you can use to connect with the AWS service during guided discovery. This credential type uses field names and terminology that are specific to the AWS service.

Alternatively, you could monitor AWS using a generic SOAP/XML credential that does not include AWS-specific fields. For more information, see the section on Creating a SOAP/XML Credential for AWS.

To define an AWS-specific credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create AWS Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
AWS Access Key ID (minimum 20 characters). The Access Key ID for an account on the AWS device to be monitored. This field is required.
Cloud Type. Type of cloud that will be accessed with the credential. Select from a list of AWS clouds supported by SL1. Choices are:

Standard. Select this option if you want to connect to a standard AWS account.
GovCloud. Select this option if you want to connect to an AWS GovCloud account.
Beijing. Select this option if you want to connect to AWS regions in China.

AWS Secret Access Key (minimum 20 characters). The Secret Access Key for an account on the AWS device to be monitored. This field is required.

Proxy Settings

If you use a proxy server in front of the AWS devices you want to communicate with, enter values in these fields. Otherwise, you can skip these fields.

Proxy Hostname/IP. The host name or IP address of the proxy server.
Proxy Port. Port on the proxy server to which you will connect.
Proxy User. Username to use to access the proxy server.
Proxy Password. Password to use to access the proxy server.

Click Save & Close.

Defining an AWS Assume Role Credential

To use the Amazon Web Services (AWS) Dynamic Applications, you must configure a credential that allows SL1 to connect to the AWS REST API.

SL1 includes an AWS Assume Role credential type that you can use to connect with the AWS service during guided discovery using the Assume Role discovery method. The Assume Role discovery method provides an automated mechanism to discover all your AWS accounts within an organization using a single IAM key. This credential type uses field names and terminology that are specific to the AWS service.

For more information about monitoring AWS using Assume Role, see the section on Automated Discovery Using Assume Role with a Single IAM Key from the AWS Master Account.

To define an AWS Assume Role credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create AWS Assume Role Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Type a unique name for the credential. Can be any combination of alphanumeric characters, up to 64 characters.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the Select the organizations the credential belongs to drop-down field to align the credential with those specific organizations.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Type the time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
AWS Access Key ID. Type the Access Key ID for an account on the AWS device to be monitored.
AWS Secret Access Key. Type the Secret Access Key for an account on the AWS device to be monitored.
Cloud Type. Select the AWS cloud type that will be accessed with the credential. This field is required. Choices are:

Standard. Select this option if you want to connect to a standard AWS account.
GovCloud. Select this option if you want to connect to an AWS GovCloud account.
Beijing. Select this option if you want to connect to AWS regions in China.

Assume Role. Type the AWS Role you created in each account. The default name is "ScienceLogic-Monitor".
Assume Role Session. Optional. The default value is "SL1".
Organization Creation. Auto-creates an SL1 organization for accounts using AssumeRole. You can type one of the following options:

NAME. The name of the organization will contain the name of the user.
ID. The name of the organization will contain the ID of the user.
ID:NAME. The name of the organization will contain both the ID and name of the user, in that order.
NAME:ID. The name of the organization will contain both the name and ID of the user, in that order.

Configuration. Select the method used to control what AWS devices are discovered and monitored. Choices are:

Default. The default AWS discovery method.
AwsConfig. Select this option if your accounts have the AWS Config service enabled.
AwsCloudwatch. Select this option to discover only the AWS regions that are reporting CloudWatch metrics.

Regions. Type the AWS regions that you want to discover. For example, entering "ap-southeast-2, us-east-2" will discover two regions. If left blank, all regions will be discovered. The default value is "ALL".
Filter by Tags. To discover AWS devices and filter them by tags, type the tag operation, tag key, and tag value, in the following format: <operation>#<tag name>#<tag value>. For example, if you want to filter by Tag Name, you would type the following:

Tags:equals#Name#Example

Valid operations include:

equals
notEquals
contains
notContains

You can chain together multiple filters separating them by a comma. For example:

Tags:equals#Name#Example,contains#Owner#Someone

Proxy Hostname/IP. Type the host name or IP address of the proxy server.
Proxy Port. Type the port number on the proxy server to which you will connect.
Proxy User. Type the username to use to access the proxy server.
Proxy Password. Type the password to use to access the proxy server.

If you use a proxy server in front of the AWS devices you want to communicate with, enter values in the proxy fields. Otherwise, you can skip these fields.

Click Save & Close.

Defining an AWS EC2 Credential

To use the Amazon Web Services (AWS) Dynamic Applications, you must configure a credential that allows SL1 to connect to the AWS REST API.

SL1 includes an AWS EC2 credential type that you can use to connect with the AWS service during guided discovery when your Data Collectors are EC2 instances. This credential type uses field names and terminology that are specific to the AWS service.

For more information about monitoring AWS accounts within an organization when your Data Collectors are EC2 instances, see the section on Automated Discovery when the Data Collector Runs as an EC2 Instance.

To define an EC2 credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create AWS EC2 Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Type a unique name for the credential. Can be any combination of alphanumeric characters, up to 64 characters.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the Select the organizations the credential belongs to drop-down field to align the credential with those specific organizations.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Type the time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
Cloud Type. Select the AWS cloud type that will be accessed with the credential. This field is required. Choices are:

Standard. Select this option if you want to connect to a standard AWS account.
GovCloud. Select this option if you want to connect to an AWS GovCloud account.
Beijing. Select this option if you want to connect to AWS regions in China.

Organization Arn. Type the Amazon Resource Name (ARN) for the Assume Role. This is the ARN of the role created in the master billing account.
Assume Role. Type the AWS Role you created in each account. The default name is "ScienceLogic-Monitor".
Assume Role Session. Optional. The default value is "SL1".
Organization Creation. Auto-creates an SL1 organization for accounts using AssumeRole. You can type one of the following options:

NAME. The name of the organization will contain the name of the user.
ID. The name of the organization will contain the ID of the user.
ID:NAME. The name of the organization will contain both the ID and name of the user, in that order.
NAME:ID. The name of the organization will contain both the name and ID of the user, in that order.

Configuration. Select the type of method used to control what AWS devices are discovered and monitored. Choices are:

Default. The default AWS discovery method.
AwsConfig. Select this option if your accounts have the AWS Config service enabled.
AwsCloudwatch. Select this option to discover only the AWS regions that are reporting CloudWatch metrics.

Regions. Type the AWS regions that you want to discover. For example, entering "ap-southeast-2, us-east-2" will discover two regions. If left blank, all regions will be discovered. The default value is "ALL".
Filter by Tags. To discover AWS devices and filter them by tags, type the tag operation, tag key, and tag value, in the following format: <operation>#<tag name>#<tag value>. For example, if you want to filter by Tag Name, you would type the following:

Tags:equals#Name#Example

Valid operations include:

equals
notEquals
contains
notContains

You can chain together multiple filters separating them by a comma. For example:

Tags:equals#Name#Example,contains#Owner#Someone

Proxy Hostname/IP. Type the host name or IP address of the proxy server.
Proxy Port. Type the port number on the proxy server to which you will connect.
Proxy User. Type the username to use to access the proxy server.
Proxy Password. Type the password to use to access the proxy server.

If you use a proxy server in front of the AWS devices you want to communicate with, enter values in the proxy fields. Otherwise, you can skip these fields.

Click Save & Close.

Defining an AWS IAM Credential

To use the Amazon Web Services (AWS) Dynamic Applications, you must configure a credential that allows SL1 to connect to the AWS REST API.

You can use IAM policies in AWS to restrict which regions and services SL1 will monitor. To do this, you can create another IAM policy and apply that along with the SL1 monitoring policy to the applicable user or role(s).

SL1 includes an AWS IAM credential type that you can use to connect with the AWS service during guided discovery using the IAM discovery method. This credential type uses field names and terminology that are specific to the AWS service.

For more information about monitoring AWS using IAM permissions, see the section on Using IAM Permissions to Restrict SL1 Access to Specific Regions and Services.

To define an AWS IAM credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create AWS IAM Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Type a unique name for the credential. Can be any combination of alphanumeric characters, up to 64 characters.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the Select the organizations the credential belongs to drop-down field to align the credential with those specific organizations.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Type the time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
AWS Access Key ID. Type the Access Key ID for an account on the AWS device to be monitored.
AWS Secret Access Key. Type the Secret Access Key for an account on the AWS device to be monitored.
Cloud Type. Select the AWS cloud type that will be accessed with the credential. This field is required. Choices are:

Standard. Select this option if you want to connect to a standard AWS account.
GovCloud. Select this option if you want to connect to an AWS GovCloud account.
Beijing. Select this option if you want to connect to AWS regions in China.

Configuration. Select the method used to control what AWS devices are discovered and monitored. Choices are:

Default. The default AWS discovery method.
AwsConfig. Select this option if your accounts have the AWS Config service enabled.
AwsCloudwatch. Select this option to discover only the AWS regions that are reporting CloudWatch metrics.

Regions. Type the AWS regions that you want to discover. For example, entering "ap-southeast-2, us-east-2" will discover two regions. If left blank, all regions will be discovered. The default value is "ALL".
Filter by Tags. To discover AWS devices and filter them by tags, type the tag operation, tag key, and tag value, in the following format: <operation>#<tag name>#<tag value>. For example, if you want to filter by Tag Name, you would type the following:

Tags:equals#Name#Example

Valid operations include:

equals
notEquals
contains
notContains

You can chain together multiple filters separating them by a comma. For example:

Tags:equals#Name#Example,contains#Owner#Someone

Proxy Hostname/IP. Type the host name or IP address of the proxy server.
Proxy Port. Type the port number on the proxy server to which you will connect.
Proxy User. Type the username to use to access the proxy server.
Proxy Password. Type the password to use to access the proxy server.

If you use a proxy server in front of the AWS devices you want to communicate with, enter values in the proxy fields. Otherwise, you can skip these fields.

Click Save & Close.

Defining an Azure Credential

To configure SL1 to monitor Microsoft Azure, you must first create an Azure credential. This credential allows the Dynamic Applications in the Microsoft: AzurePowerPack to connect with the Azure Active Directory Application.

SL1 includes an Azure credential type that you can use to connect with the Azure service during guided discovery. This credential type uses field names and terminology that are specific to the Azure service.

Alternatively, you could monitor Azure using a generic SOAP/XML credential that does not include Azure-specific fields. For more information, see the section on Creating a SOAP/XML Credential for Azure.

To define an Azure-specific credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create Azure Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
Azure AD application endpoint token URL (OAuth2.0). The AD application endpoint token URL for the Azure Active Directory application. This field is required.
Application ID for Azure AD application. The Application ID for the Azure Active Directory application. This field is required.
Tenant ID for Azure AD application. The Tenant ID for the Azure Active Directory application. This field is required.
Azure subscription ID (if single subscription). The subscription ID for the Azure Active Directory application. This field is required only if you are monitoring a single Azure subscription.
Secret key for Azure AD application. The secret key for the Azure Active Directory application. This field is required.

Proxy Settings

If you use a proxy server in front of the Azure Active Directory applications you want to communicate with, enter values in these fields. Otherwise, you can skip these fields.

Proxy Hostname/IP. The host name or IP address of the proxy server.
Proxy Port. Port on the proxy server to which you will connect.
Proxy User. Username to use to access the proxy server.
Proxy Password. Password to use to access the proxy server.

Click Save & Close.

Defining a Citrix XenServer Credential

To use the Dynamic Applications in the Citrix: Xen PowerPack, you must first define a credential in SL1 that enables SL1 to communicate with your XenCenter system and XenServer devices.

SL1 includes a Citrix Xen credential type that you can use to connect with your XenServer devices during guided discovery. This credential type uses field names and terminology that are specific to XenServer.

Alternatively, you could monitor Citrix XenServer using a generic Basic/Snippet credential that does not include XenServer-specific fields. For more information, see the section on Configuring a Basic/Snippet Credential for XenServer.

To define a XenServer-specific credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create Citrix Xen Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
XenServer username. The username for an account on the XenServer device to be monitored.
XenServer password. The username for an account on the XenServer device to be monitored.
Hostname/IP of the Xen server. The Hostname or IP address of the XenServer device from which you want to retrieve data. This field is required.
Port. The port number associated with the data you want to receive. This field is required.

Click Save & Close.

Defining an IBM Cloud Credential

To configure SL1 to monitor an IBM Cloud/SoftLayer account, you must create an IBM credential. This credential allows the Dynamic Applications in the SoftLayer: Cloud PowerPack to communicate with your IBM Cloud/SoftLayer account.

SL1 includes an IBM credential type that you can use to connect with your IBM Cloud/SoftLayer service during guided discovery. This credential type uses field names and terminology that are specific to IBM Cloud/SoftLayer.

Alternatively, you could monitor IBM Cloud/SoftLayer using a generic Basic/Snippet credential that does not include IBM-specific fields. For more information, see the section on Configuring a Basic/Snippet Credential for SoftLayer.

To define an IBM-specific credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create IBM Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
IBM/SoftLayer account username. The IBM/SoftLayer username for an account on the IBM device to be monitored.
IBM/SoftLayer account API key. The IBM/SoftLayer API key for an account on the IBM device to be monitored.
Hostname/IP. The Hostname or IP address of the IBM device from which you want to retrieve data. The default value is %D. SL1 will replace the variable with the IP address of the device that is currently using the credential. This field is required.
Port. The port number associated with the data you want to receive. This field is required.

The default TCP port for IBM devices is 80.

Click Save & Close.

Defining an S3 Backup Credential

You can use an S3 storage service to store configuration backups for SL1. To do so, you will need to create a credential that enables SL1 to connect to the S3 service. SL1 includes an S3 Backup credential type, which uses field names and terminology specific to S3 services, that you can use to connect with your S3 service.

SL1 supports the use of Amazon Web Services (AWS) or MinIO for S3 backup storage.

For more information about configuration backups, see the section on Backup Management.

To define an S3 backup credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create S3 Backup Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Type a unique name for the credential. Can be any combination of alphanumeric characters, up to 64 characters.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations.

To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

Timeout (ms). Type the time, in milliseconds, after which SL1 will stop trying to communicate with the S3 storage service.
Provider. Select the S3 storage provider you want to use to store the backup. Choices are Amazon Web Services (AWS) S3 and Minio Object Storage.
Access Key ID. Type the Access Key ID for the S3 account on which you want to store the backup.
Secret Access Key. Type the Secret Access Key for the S3 account on which you want to store the backup.
Endpoint. Type the URL of the S3 endpoint. The endpoint URL should not include the bucket name.
Region. Select the region of the S3 endpoint.
Bucket. Type the name of the S3 bucket on which you want to store the backup.
Encryption Password. Type the encryption password for the backup file.
Encryption Salt. Type the encryption salt used to safeguard the backup file encryption password.

Click Save & Close.

Defining a VMware Credential

To use the Dynamic Applications in the VMware: vSphere Base PackPowerPack, you must configure a SOAP/XML credential for the VMware web service.

SL1 includes a VMware credential type that you can use to connect with the VMware web service during guided discovery. This credential type uses field names and terminology that are specific to VMware vSphere.

Alternatively, you could monitor VMware using a generic SOAP/XML credential that does not include VMware-specific fields. For more information, see the section on Configuring a SOAP/XML Credential for VMware.

To define a VMware-specific credential:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and then select Create VMware Credential. The Create Credential modal page appears:

Supply values in the following fields:

Name. Name of the credential. Can be any combination of alphanumeric characters, up to 64 characters. This field is required.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.

To learn more about aligning credentials and organizations, see Aligning Organizations With a Credential.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the device from which you want to retrieve data.
VMware web service username. The VMware username for the VMware web service account. This field is required.
VMware web service password. The VMware password for the VMware web service account. This field is required.
URL. The URL of the VMware web service that you want to monitor. If you are a user that uses a domain account to log in to your vCenter, add <user/domain_name> to the URL. This field is required.

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the device that is currently using the credential. For component devices, SL1 will replace %D with the IP address of the root device.
You can include the variable %N in this field. SL1 will replace the variable with the hostname of the device that is currently using the credential. If SL1 cannot determine the hostname, SL1 will replace the variable with the primary management IP address for the current device.

Click the URL field for a set of options for formatting the URL: http(s)://Host:Port/Path | %D = Aligned Device IP | %N = Aligned Device Name. For example: https://%D:433/<sample path>.

Click Save & Close.

Testing a Credential

You can test a credential using a predefined credential test. For more information about creating and managing credential tests, see the section on Managing Credential Tests.

Using the Credential Tester Panel

When defining or editing a credential in SL1, you can test the credential using the Credential Tester panel.

To test a credential using the Credential Tester panel:

From the Credentials page (Manage > Credentials) or from the Credential Selection page during guided or unguided discovery, click Create New to create a new credential or click the Actions icon () of a credential that you want to test and then select Edit/Test.
While defining or editing the credential, supply values in the required fields. Required fields may vary depending on the type of credential you create.
Click the Save & Test button. This activates the Credential Tester fields.
In the Credential Tester panel, supply values in the following fields:

Select Credential Test. Select a credential test to run. This drop-down list includes the ScienceLogic Default Credential Tests, credential tests included in any PowerPacks that have been optionally installed on your system, and credential tests that users have created on your system.
Select Collector. Select the All-In-One Appliance or Data Collector that will run the test.
IP or Hostname to test. Type a hostname or IP address that will be used during the test. For example, if you are testing an SNMP credential, the hostname/IP address you supply will be used to perform a test SNMP request.

Click the Test Credential button to run the credential test. The Testing Credential window appears.

The Testing Credential window displays a log entry for each step in the credential test. The steps performed are different for each credential test. The log entry for each step includes the following information:

Step. The name of the step.
Description. A description of the action performed during the step.
Log Message. The result of the step for this execution of the credential test.
Status. Whether the result of this step indicates the credential and/or the network environment is configured correctly (Passed) or incorrectly (Failed).
Step Tip. Mouse over the question mark icon () to display the tip text. The tip text recommends what to do to change the credential and/or the network environment if the step has a status of "Failed".

Specifying Credentials For Discovery and Devices

Discovery is the process by which SL1 discovers what types of hardware and applications exist on the network and then retrieves data from the discovered hardware and applications.

Before running discovery, you must:

Determine the SNMP credentials for the devices and applications in your network. Define correlating credentials in SL1, to allow discovery to retrieve as much information as possible.
If you want SL1 to immediately start collecting data from devices using Dynamic Applications, you should also define any additional credentials required for those Dynamic Applications. For example, if you want SL1 to immediately start monitoring all MySQL databases in your network, you should define credentials that allow SL1 to communicate with each MySQL database in your network. During discovery, SL1 will determine which devices can be monitored with a Dynamic Application for MySQL. After discovery, SL1 will use the database credential to collect data about each MySQL database in your network.

Use the previous sections to define credentials for your network.

When you run discovery, you must specify one or more of these credentials to use. The more credentials you align with a discovery session, the more access SL1 will have to devices and their data during discovery.

For information about specifying credentials during guided discovery, see the section on Adding Devices Using Universal or Guided Discovery.
For information about specifying credentials during unguided discovery, see the section on Adding Devices Using Unguided Discovery.
For information about specifying credentials during initial classic discovery, see the section on Specifying Credentials During Initial Classic Discovery.

Specifying Credentials for a Device/Dynamic Application Pair

After a device has been discovered by SL1 and one or more Dynamic Applications have been aligned with the device, you can manually assign the credential to use for each Dynamic Application.

The manually assigned credential will be used by SL1 only for this specific Dynamic Application associated with this specific device. For all other devices, SL1 will use the default credential associated with each device, or will use the credential defined on the Collections tab for each device.

To manually associate a credential with a Dynamic Application aligned to a device:

Go to the Devices page by clicking the Devices icon ().
Find the device for which you want to define a credential. Click its hyperlink in the Device Name column.
On the Device Investigator, click the Collections tab.
Find the Dynamic Application for which you want to define a credential. Click its radio button and then click Edit.

In the information pane for the Dynamic Application, click the Edit icon () next to the Credential field.

From the Choose Credential modal page, select the credential that you want to align to the Dynamic Application, and then click the [Select] button.

Your organization membership(s) might affect the list of credentials you can see on the Choose Credential modal page. To learn more about credentials and organizations, see the section Aligning Organizations With a Credential.

If this Dynamic Application has already been aligned with a credential to which you do not have access, the Credential field will display the value Restricted Credential. If you align the Dynamic Application with a different credential, you will not be able to re-align the device with the Restricted Credential.

The selected Dynamic Application will now use the manually selected credential when collecting data from this device. You should see your change reflected in the Credential field in the information pane for the Dynamic Application on the Collections tab.

For more information about the Collections tab, see the section on The Collections Tab.

Aligning One or More Organizations With a Credential

To support multi-tenancy, SL1 allows you to align each credential with one, multiple or all organizations in SL1. You can also align a credential with no organizations.

When you align an organization with a credential, you control who can view details about the credential, who can view the name of the credential, and who can apply the credential in SL1.

NOTE: When you align an organization with a credential, you are restricting only the users who can view and assign the credential. You are not restricting the devices and actions that can be associated with the credential. For example, you can align a credential only with the organization "Operations" but assign the credential to a device in the "Finance" organization.

By default, newly created credentials are aligned to all organizations. However, when defining a new credential, you can opt to align the credential with one or more specific organizations rather than all credentials. To do so, toggle off the All Organizations field on the Create Credential modal and then select one or more specific organizations from the What organization manages this service? drop-down field.

Credentials that are aligned with an organization have the following behavior:

For each credential that is aligned with an organization, only administrators and users who are members of the aligned organization can view the credential on the Credentials page.
When aligning credentials to devices or Dynamic Applications, non-administrator users can view and align only those credentials that are assigned to organizations common to both the user and the device’s collector group, plus those credentials that are assigned to all organizations or otherwise required for that collector group.
Users can change the organization setting of only those credentials that are not currently aligned to any devices.
In any field or column that displays the name of the credential, users who are not members of the aligned organization will not see the credential name. Instead, these users will see either a dash character (-) or the text "Restricted Credential".
In any list from which users can select a credential, users who are not members of the aligned organization will not see the credential as an entry in the list.
In any page where the credential has already been assigned, users who are not members of the aligned organization will see only the name "Restricted Credential".
In any page where the credential has already been assigned, users who are not members of the aligned organization can save the page and maintain the credential. The credential will still appear to that user as "Restricted Credential".
In any page where the credential has already been assigned, users who are not members of the aligned organization can change the credential to a credential aligned with their organization(s). However, those users cannot change the credential again and re-assign the "Restricted Credential". The entry for "Restricted Credential" is removed from the list of possible credentials.
If you attempt to run a discovery session where the devices, collector group, and credentials do not all belong to the same organization, you will receive an error and will not be able to save or execute the discovery session.

To understand the behavior of a credential aligned with an organization, consider the following example:

Suppose you have a user account of type "Administrator". Suppose you create an SNMP credential called "ops_cred". Suppose you align that credential with the organization "Operations".
In the Credentials page, only administrators and users who are members of the organization "Operations" will be able to see the credential "ops_cred" in SL1.
In SL1, in any field or column that displays the name of the credential, users who are not members of the organization "Operations" will not see the "ops_cred" name displayed. Instead, these users will see either a dash character (-) or the text "Restricted Credential".
In SL1, in any list from which users can select a credential, users who are not members of the organization "Operations" will not see the "ops_cred" credential as an entry in the field.
In SL1, in any page where the credential "ops_cred" has already been assigned, users who are not members of the organization "Operations" will see only the name "Restricted Credential".
In SL1, in any page where the credential "ops_cred" has already been assigned, users who are not members of the organization "Operations" can save the page and maintain the "ops_cred" credential. The credential will still appear to that user as "Restricted Credential".
In SL1, in any page where the credential "ops_cred" has already been assigned, users who are not members of the organization "Operations" can change the credential to a credential aligned with their organization. However, that user cannot change the credential again and re-assign the "Restricted Credential". The entry for "Restricted Credential" is removed from the list of possible credentials.

Editing a Credential

The Credentials page allows you to edit credentials from SL1.

To edit a credential:

Go to the Credentials page (Manage > Credentials).
Click the Actions icon () of the credential you want to edit and then select Edit/Test. The Edit Credential page appears.
After editing the fields in the Edit Credential modal page, click the Save & Close button.

When editing a credential, the current password displays as a masked string of characters. If you make any changes to this field, SL1 completely removes the previous credential password and replaces it with what you type; therefore, you must either completely replace the password or leave it unchanged. If you accidentally type anything in the password field but do not actually want to change the password, you should close the Edit Credential modal page without saving your changes to avoid overwriting the current password.

Duplicating a Credential

The Credentials page allows you to create a duplicate of an existing credential. When you do so, SL1 copies all of the original credential's values into the new credential. You can then edit the new credential to make changes as needed while still retaining the values that you want to keep from the original credential.

To duplicate a credential:

Go to the Credentials page (Manage > Credentials).
Click the Actions icon () of the credential you want to duplicate and then select Duplicate.
A copy of the credential appears on the Credentials page.
To edit the copied credential, click its Actions icon () and then select Edit/Test. The Edit Credential modal appears.
After editing the fields in the Edit Credential modal, click the Save & Close button.

Deleting a Credential

The Credentials page allows you to delete one or more credentials from SL1.

SL1 displays an error message if you attempt to delete a credential that is currently assigned to one or more devices.

To delete a credential:

Go to the Credentials page (Manage > Credentials).
Click the Actions icon () of the credential you want to delete and then select Delete.
The credential is deleted.

Using Credentials in the Classic SL1 User Interface

This section describes how to view, define, and manage credentials using the Credential Management page in the classic SL1 user interface.

Viewing Information about Credentials in the Classic SL1 User Interface

The Credential Management page allows you to view a list of all ScienceLogic credentials. From this page, you can also create new credentials and editing existing credentials.

To sort the list of credentials, click on a column heading. The list will be sorted by the column value, in ascending order. To sort by descending order, click the column heading again. The Last Edited column sorts by descending order on the first click; to sort by ascending order, click the column heading again.

For each credential, the page displays:

Profile Name. Name of the credential.
Organization. If you have an account of type "User" and are a member of only one ScienceLogic organization, this field will not appear in the Credential Management page. The Credential Management page will display only credentials that are aligned with your organization. For all other users, this column specifies the organization(s) aligned with the credential. Possible values are all orgs, multiple orgs, a single organization name, or none. For details, see the section Aligning One or More Organizations with a Credential.
RO Use. Specifies the number of devices that SL1 can retrieve read-only information from, using the credential.
RW Use. Specifies the number of devices that SL1 can both read from and write to, using the credential.
DA Use. Specifies the number of Dynamic Applications aligned with this credential.
Type. Type of credential. Possible types are SNMP, Database, SOAP/XML, LDAP/AD, Basic/Snippet, SSH/Key, and PowerShell.
Credential User. Username associated with the credential.
Host. Hostname or IP address that SL1 will use the credential to communicate with.
Port. Port used by the credential to communicate with the external device or application.
Timeout. Time, in milliseconds, after which SL1 will stop trying to communicate with the external device or application.
ID. Unique numeric ID, automatically assigned by SL1 to each credential.
Last Edited. Date and time the credential was created or last edited.
Edited By. ScienceLogic user who created or last edited the credential.

Filtering the List of Credentials in the Classic SL1 User Interface

To filter the list of credentials in the Credential Management page, use the search fields at the top of each column. The search fields are find-as-you-type filters; as you type, the page is filtered to match the text in the search field, including partial matches. Text matches are not case-sensitive. Additionally, you can use the following special characters in each filter:

, (comma). Specifies an "or" operation. For example:

"dell, micro" would match all values that contain the string "dell" OR the string "micro".

& (ampersand). Specifies an "and" operation. For example:

"dell & micro" would match all values that contain the string "dell" AND the string "micro".

! (exclamation mark). Specifies a "not" operation. For example:

"!dell" would match all values that do not contain the string "dell".

^ (caret mark). Specifies "starts with." For example:

"^micro" would match all strings that start with "micro", like "microsoft".

"^" will include all rows that have a value in the column.

"!^" will include all rows that have no value in the column.

$ (dollar sign). Specifies "ends with." For example:

"$ware" would match all strings that end with "ware", like "VMware".

"$" will include all rows that have a value in the column.

"!$" will include all rows that have no value in the column.

min-max. Matches numeric values only. Specifies any value between the minimum value and the maximum value, including the minimum and the maximum. For example:

"1-5" would match 1, 2, 3, 4, and 5.

- (dash). Matches numeric values only. A "half open" range. Specifies values including the minimum and greater or including the maximum and lesser. For example:

"1-" matches 1 and greater, so it would match 1, 2, 6, 345, etc.

"-5" matches 5 and less, so it would match 5, 3, 1, 0, etc.

> (greater than). Matches numeric values only. Specifies any value "greater than." For example:

">7" would match all values greater than 7.

< (less than). Matches numeric values only. Specifies any value "less than." For example:

"<12" would match all values less than 12.

>= (greater than or equal to). Matches numeric values only. Specifies any value "greater than or equal to." For example:

"=>7" would match all values 7 and greater.

<= (less than or equal to). Matches numeric values only. Specifies any value "less than or equal to." For example:

"=<12" would match all values 12 and less.

= (equal). Matches numeric values only. For numeric values, allows you to match a negative value. For example:

"=-5 " would match "-5" instead of being evaluated as the "half open range" as described above.

Defining One or More SNMP Credentials for Initial Discovery in the Classic SL1 User Interface

Before running discovery, you must first define credentials for the devices and applications in the network to be managed. You must either define or note the credentials on the device to be managed, and then you must define matching credentials in SL1.

To create credentials for initial discovery, you must first:

Determine which devices or IP ranges you want to discover.
Determine which of these devices support SNMP.
Determine the SNMP community string or SNMP credentials for each device that supports SNMP.

If you do not know which devices in your network support SNMP, consult your system administrator. In some cases, you might also need to consult your system administrator about enabling SNMP, and defining SNMP community strings or SNMP credentials on these devices.

In SL1, define one or more SNMP credentials to use during discovery. These credentials should match those SNMP community strings and SNMP credentials that already exist in your network.
Initially, discovery uses only SNMP credentials. However, when SL1 collects data specified in Dynamic Applications, SL1 can use other types of credentials.

Defining Credentials in the Classic SL1 User Interface

To define a credential in the classic SL1 user interface:

Collect the information you need to create each credential (usually username and password).
Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, click the Create menu. Select the type of credential you want to create. Your choices are:

SNMP Credential
Database Credential
SOAP/XML Host Credential
LDAP/AD Credential
Basic/Snippet Credential
SSH/Key Credential
PowerShell Credential

The Credential Editor modal page appears. In this page, you can define the new credential. The following sections explain how to create each type of credential.
Click the Save button to save the new credential.

Defining an SNMP Credential in the Classic SL1 User Interface

SNMP Credentials allow SL1 to access SNMP data on a managed device. SL1 uses SNMP credentials to perform discovery, run auto-discovery, and gather information from SNMP Dynamic Applications.

To create an SNMP credential:

Go to the Credential Management page (System > Manage > Credentials).
Click the Actions button and select Create SNMP Credential. The Credential Editor page appears.

Supply values in the following fields:

Profile Name. Name of the credential. Can be any combination of alphanumeric characters. This field is required.
SNMP Version. SNMP version. Choices are SNMP V1, SNMP V2, and SNMP V3. The default value is SNMP V2.
Port. The port SL1 will use to communicate with the external device or application. The default value is 161. This field is required.
Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the SNMP device. The default value is 1500.
Retries. Number of times SL1 will try to authenticate and communicate with the external device. The default value is 1.

SNMP V1/V2 Settings

These fields appear if you selected SNMP V1 or SNMP V2 in the SNMP Version field. The fields are inactive if you selected SNMP V3.

SNMP Community (Read-Only). The SNMP community string (password) required for read-only access of SNMP data on the remote device or application. For SNMP V1 and SNMP V2 credentials, you must supply a community string, either in this field or in the SNMP Community (Read/Write) field.
SNMP Community (Read/Write). The SNMP community string (password) required for read and write access of SNMP data on the remote device or application. For SNMP V1 and SNMP V2 credentials, you must supply a community string, either in this field or in the SNMP Community (Read Only) field.

SNMP V3 Settings

These fields appear if you selected SNMP V3 in the SNMP Version field. These fields are inactive if you selected SNMP V1 or SNMP V2.

Security Name. Name for SNMP authentication. This field is required.
Security Passphrase. Password to authenticate the credential. This value must contain at least 8 characters. This value is required if you use a Security Level that includes authentication.
Authentication Protocol. Select an authentication algorithm for the credential. This field is required. Choices are:

MD5. This is the default value.
SHA
SHA-224
SHA-256
SHA-384
SHA-512

The SHA option is SHA-128.

Security Level. Specifies the combination of security features for the credentials. This field is required. Choices are:

No Authentication / No Encryption.
Authentication Only. This is the default value.
Authentication and Encryption.

SNMP v3 Engine ID. The unique engine ID for the SNMP agent you want to communicate with. (SNMPv3 authentication and encryption keys are generated based on the associated passwords and the engine ID.) This field is optional.
Context Name. A context is a mechanism within SNMPv3 (and AgentX) that allows you to use parallel versions of the same MIB objects. For example, one version of a MIB might be associated with SNMP Version 2 and another version of the same MIB might be associated with SNMP Version 3. For SNMP Version 3, specify the context name in this field. This field is optional.
Privacy Protocol. The privacy service encryption and decryption algorithm. This field is required. Choices are:

DES. This is the default value.
AES-128
AES-192
AES-256
AES-256-C. This option is for discovering Cisco devices only.

Privacy Protocol Passphrase. Privacy password for the credential. This field is optional.

Click the Save button to save the new SNMP credential.
Repeat steps 1-4 for each SNMP-enabled device in your network that you want to monitor with SL1.

NOTE: When you define an SNMP Credential, SL1 automatically aligns the credential with all organizations of which you are a member.

Defining a Database Credential in the Classic SL1 User Interface

Database Credentials allow SL1 to access data on a database on a managed device. SL1 uses database credentials when collecting data for Database Dynamic Applications.

To define a database credential:

Collect the information you need to create each credential (usually username and password).
Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, click the Actions menu. Select Create Database Credential.

The Credential Editor modal page appears. In this page, you can define the new database credential. To define the new credential, supply values in the following fields:

Basic Settings

Profile Name. Name of the credential. Can be any combination of alphanumeric characters. This field is required.
DB Type. Type of database that will be accessed with the credential. Select from a list of databases supported by SL1. This field is required.

For information about monitoring Informix databases, see the Monitoring Informix Databases section.

DB Name. Name of the database that will be accessed with the credential.
DB User. Username associated with a valid account on the database.
Password. Password associated with a valid account on the database.
Hostname/IP. Hostname or IP address where the database resides. This field is required.

You can an include the variable %D in this field. SL1 will replace the variable with the IP address of the current device (device that is currently using the credential).
You can include the variable %N in this field. SL1 will replace the variable with the hostname of the current device (device that is currently using the credential). If SL1 cannot determine the hostname, SL1 will replace the variable with the primary management IP address for the current device.

NOTE: To use the localhost, in the Hostname/IP field, enter the IP address 127.0.0.1. The credential will not work if you enter the string localhost in the Hostname/IP field.

Port. Port number associated with the database you want to access with this credential. This field is required.

For DB Type of MySQL, the default value is 3306.
For DB Type of MS SQL Server, the default value is 1433.
For DB Type of Oracle and SQLNet, the default value is 1521.
For DB Type of PostgreSQL, the default value is 5432.
For DB Type of IBM DB2, the default value is 523.
For DB Type of Sybase ASE, the default value is 4100.
For DB Type of Informix, see the 9088 section.
For DB Type of Ingress, the default value is 1572.

SL1's Database Servers include a MySQL database running on port 7706. Data Collectors and Message Collectors include a MySQL database running on port 7707.

Oracle Settings

These fields appear if you selected Oracle & *SQLNet in the DB Type field. Otherwise, these fields are grayed out.

Oracle Connect Type. Specifies the method SL1 should use to connect to the Oracle database. The choices are:

Oracle System Identifier (SID)
Oracle Real Application Clusters (SERVICE)
Oracle Server Direct Connection (SERVER)

SID (if required). Enter the value for the Oracle Connect Type (either Oracle SID, Oracle RAC, or Oracle Server) selected in the Oracle Connect Type field.

Click the Save button to save the new database credential.
Repeat steps 1-5 for each database credential in your network.

When you define a Database Credential, the credential will automatically be aligned with the organization(s) you are a member of. To learn more about credentials and organizations, see Aligning One or More Organizations with a Credential.

Defining a SOAP/XML Host Credential in the Classic SL1 User Interface

SOAP/XML credentials allow SL1 to access a web server on a managed device. SOAP/XML credentials are used in several places in SL1, including:

With Dynamic Applications of type "SOAP".
With Dynamic Applications of type "XML".
With Dynamic Applications of type "XSLT".
With Dynamic Applications of type "snippet". The snippet code must define the authentication protocol. Dynamic Applications of type "snippet" can use any type of credential.

To define a SOAP/XML credential:

Collect the information you need to create each credential (usually username and password).
Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, click the Actions menu. Select Create SOAP/XML Host Credential.

The Credential Editor modal page appears. In this page, you can define the new SOAP/XML credential. To define the new credential, supply values in the following fields:

Basic Settings

Profile Name. Name of the credential. Can be any combination of alphanumeric characters. This field is required.
Content Encoding. Tells the SOAP server or XML data-store how the content is encoded, so the SOAP server or XML data-store knows how to decode the message. Select the encoding that is appropriate for your request and response.
Method. HTTP method to use to exchange credential data from the managed device. Choices are GET or POST.
Typically, Dynamic Applications of type "XML" use GET methods. Dynamic Applications of type "SOAP" and of type "XSLT" use POST methods.

HTTP Version. Version of HTTP to use. Choices are 1.0 or 1.1.
URL. Address of the SOAP server, HTML document, or XML document. This field is required and should be of the format:

https://IP address:port/full path to desired SOAP, HTML, or XML document

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the current device (device that is currently using the credential).
For component devices, SL1 will replace %D with the IP address of the root device.

You can include the variable %N in this field. SL1 will replace the variable with the hostname of the current device (device that is currently using the credential). If SL1 cannot determine the hostname, SL1 will replace the variable with the primary management IP address for the current device.

HTTP Auth User. Username with which to log in to the web server.
HTTP Auth Password. Password with which to access the web server.
Timeout (seconds). Time, in seconds, after which SL1 will stop trying to communicate with the web server.

Proxy Settings

This pane displays optional fields. If you use a proxy server in front of the SOAP server(s) or XML data-store(s) you want to communicate with, enter values in these fields.

Hostname/IP. The host name or IP address of the proxy server.
Port. Port on the proxy server to which you will connect.
User. Username to use to access the proxy server.
Password. Password to use to access the proxy server.

cURL Options

You can include the cURL command and various options in your credential. The list of cURL options lists all the options you can include in your credential. To include a cURL option in the credential, select it and then select the right-arrow icon. You can then supply arguments in the field to the left of the option.
For more information on cURL commands, see the cURL manpage at http://curl.haxx.se/docs/manpage.html.

SOAP Options

Embedded Password [%P]. Specifies a password value to include in a request. The value defined in this field is substituted in to the %P substitution character. The value will be encrypted in the request, will be masked in the Credential Editor, and will be stored in an encrypted form in the database.
Embed Value %1. The value defined in this field is substituted in to the %1 substitution character.
Embed Value %2. The value defined in this field is substituted in to the %2 substitution character.
Embed Value %3. The value defined in this field is substituted in to the %3 substitution character.
Embed Value %4. The value defined in this field is substituted in to the %4 substitution character.

HTTP Headers

If you require custom HTTP headers to communicate with the SOAP server, you can build the custom header here.

Click the Save button to save the new SOAP/XML credential.
Repeat steps 1-5 for each SOAP/XML credential in your network.

When you define a SOAP/XML Credential, the credential will automatically be aligned with the organization(s) you are a member of. To learn more about credentials and organizations, see Aligning One or More Organizations with a Credential.

Defining an LDAP/AD Credential in the Classic SL1 User Interface

LDAP or Active Directory credentials allow SL1 to access data on an LDAP server or an Active Directory server.

Determine if the username and password are legitimate and accurate.
Gather information to populate fields in the user's automatically-created account.

For details on using Active Directory or LDAP for authentication, see the Using Active Directory and LDAP section.

To define an LDAP/AD credential:

Collect the information you need to create each credential (usually username and password).
Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, click the Actions menu. Select Create LDAP/AD Credential.

The Credential Editor modal page appears. In this page, you can define the new LDAP/AD Credential. To define the new credential, supply values in the following fields:

Basic Settings

Profile Name. Name of the credential. Can be any combination of alphanumeric characters. This field is required.
LDAP Type. Specifies the "flavor" or LDAP running on the directory server. Choices are LDAP or Active Directory.
Hostname/IP. Hostname or IP address of the LDAP or Active Directory server. This field is required.
Port. Port number on the LDAP or Active Directory server to which SL1 will send requests. This field is required.
Secure. Specifies whether you are using LDAP over SSL.
RDN (Bind DN / bind user). Bind DN. The bind DN is a user on the LDAP or Active Directory server who is permitted to search the directory within the specified search base.

In many LDAP or AD configurations, each user has read-access to his/her own account. Therefore, you might find it most useful to include the %u variable in this field. When an LDAP or AD user logs in to SL1, SL1 stores the username in the %u variable. SL1 then uses the %u variable to build the bind DN, uses the bind DN to communicate with the LDAP or AD server, and then authenticates the current user.
An example entry in the RDN field might be:

uid=%u, ou=People, dc=sciencelogic, dc=com

This creates a DN using the current login name as the uid.

You can also include the %d variable in this field. The %d variable represents the name of the LDAP domain, as specified in the LDAP Domain field.

If you have configured SL1 to automatically create accounts when a user logs in with an LDAP/AD username, you must include the %u variable in the RDN field.

LDAP Domain. If your LDAP or Active Directory configuration includes multiple domains, specify the domain components to bind to in this field. For example, you could specify:

dc=reston, dc=sciencelogic, dc=com.

This would bind to the sub-domain "reston", in the domain "sciencelogic", in the domain "com".

Bind Password. Password that allows access to the LDAP or Active Directory server. In most cases, when you specify a bind password in a credential, you are creating a "write" credential (that is, a credential that allows SL1 to make changes to the LDAP or AD server).
User Search Base. In this field, you specify the area in the directory where users to be authenticated reside, using RDN notation. For example, if you want to authenticate five users from the ou called "people", you could specify the RDN that includes that ou.

ou=People, dc=sciencelogic, dc=com.

This would allow SL1 to authenticate users in the ou called "people." In the User Search Scope field, you can specify whether SL1 should also authenticate all users in any ou underneath "people".

User Search Scope. In this field, you specify whether SL1 should search only the directory specified in User Search Base or whether SL1 should search the directory specified in User Search Base and all its child branches. Choice are:

Subtree. SL1 should search the directory specified in User Search Base and also search all its child branches.
One Level. SL1 should search only the directory specified in User Search Base.

Click the Save button to save the new LDAP/AD credential.
Repeat steps 1-5 for each LDAP/AD credential in your network.

When you define an LDAP/AD Credential, the credential will automatically be aligned with the organization(s) you are a member of. To learn more about credentials and organizations, see the section Aligning One or More Organizations with a Credential.

Defining a Basic/Snippet Credential in the Classic SL1 User Interface

Basic/Snippet credentials define standard authentication parameters, but are not tied to a specific authentication protocol. Basic/Snippet credentials are used in several places in SL1, including:

With Dynamic Applications of type "snippet". The snippet code must define the authentication protocol.
With Dynamic Applications of type "WMI" . The authentication protocol is specific to WMI and is specified by SL1 when the Dynamic Application is executed. To access WMI information on a Windows server, ensure that the Username you specify is allowed access to the server and to the WMI namespace.
With Dynamic Applications of type "PowerShell". For information about configuring your environment for PowerShell collection, see theMonitoring Windows Devices (PowerShell) section.
When defining external backups. The authentication protocol is defined in the Backup Management page (System > Settings > Backup).

To define a Basic/Snippet credential:

Collect the information you need to create each credential (usually username and password).
Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, click the Actions menu. Select Create Basic/Snippet Credential.

The Credential Editor modal page appears. In this page, you can define the new Basic/Snippet credential. To define the new credential, supply values in the following fields:

Credential Name. Name of the credential. Can be any combination of alphanumeric characters. This field is required.
Hostname/IP. Hostname or IP address of the device from which you want to retrieve data. This field is required.

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the current device (device that is currently using the credential).
You can include the variable %N in this field. SL1 will replace the variable with the hostname of the current device (device that is currently using the credential). If SL1 cannot determine the hostname, SL1 will replace the variable with the primary management IP address for the current device.

Port. Port number associated with the data you want to retrieve. This field is required.
Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the authenticating server.
Username. Username for a user account on the device.
Password. Password for a user account on the device.

Click the Save button to save the new Basic/Snippet credential.
Repeat steps 1-5 for each Basic/Snippet credential in your network.

When you define a Basic/Snippet credential, the credential will automatically be aligned with the organization(s) you are a member of. To learn more about credentials and organizations, see the section Aligning One or More Organizations with a Credential.

Defining an SSH/Key Credential in the Classic SL1 User Interface

To make SSH even more secure, you can use SSH keys instead of a simple password to log into a server. SSH keys consist of two long strings of characters, called a public/private key pair, that are much less susceptible than passwords are to brute force attacks. The public key is placed on the server you want to access, while the private key resides on the client. When you use SSH to log into the server from the client, the key pair is used to authenticate the session.

To define an SSH/Key credential:

Collect the information you need to create each credential (usually username and password).
Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, click the Actions menu. Select Create SSH/Key Credential.

The Credential Editor modal page appears. In this page, you can define the new SSH/Key credential. To define the new credential, supply values in the following fields:

Credential Name. Name of the credential. Can be any combination of alphanumeric characters. This field is required.
Hostname/IP. Hostname or IP address of the device from which you want to retrieve data. This field is required.

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the current device (device that is currently using the credential).
You can include the variable %N in this field. SL1 will replace the variable with hostname of the current device (device that is currently using the credential). If SL1 cannot determine the hostname, SL1 will replace the variable with the primary, management IP address for the current device.

Port. Port number associated with the data you want to retrieve. This field is required.

The default TCP port for SSH servers is 22.

Timeout (ms). Time, in milliseconds, after which SL1 will stop trying to communicate with the authenticating server.
Username. Username for an SSH or user account on the device to be monitored.
Password. Password for an SSH user account on the device to be monitored.
Private Key (PEM Format). Enter the SSH private key that you want SL1 to use, in PEM format.

Click the Save button to save the new SSH/Key credential.
Repeat steps 1-5 for each SSH/Key credential in your network.

When you define a SSH/Key credential, the credential will automatically be aligned with the organization(s) you are a member of. To learn more about credentials and organizations, see the section Aligning One or More Organizations with a Credential.

Defining a PowerShell Credential in the Classic SL1 User Interface

To define a PowerShell credential in SL1:

Collect the information you need to create the credential:

The username and password for a user on the Windows device.
If the user is an Active Directory account, the hostname or IP address of the Active Directory server and the domain.
Determine if an encrypted connection should be used.
If you are using a Windows Management Proxy, the hostname or IP address of the proxy server.

Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, click the Actions menu. Select Create PowerShell Credential.
The Credential Editor page appears, where you can define the following fields:

Profile Name. Name of the credential. Can be any combination of alphanumeric characters. This field is required.
Hostname/IP. Hostname or IP address of the device from which you want to retrieve data. This field is required.

You can include the variable %D in this field. SL1 will replace the variable with the IP address of the device that is currently using the credential.
You can include the variable %N in this field. SL1 will replace the variable with the hostname of the device that is currently using the credential. If SL1 cannot determine the hostname, SL1 will replace the variable with the primary, management IP address for the current device.
You can include the prefix HOST or WSMAN before the variable %D in this field if the device you want to monitor uses a service principal name (for example, "HOST://%D" or "WSMAN://%D"). SL1 will use the WinRM service HOST or WSMan instead of HTTP and replace the variable with the IP address of the device that is currently using the credential.

Username. Type the username for an account on the Windows device to be monitored or on the proxy server. This field is required.

NOTE: The user should not include the domain name prefix in the username for Active Directory accounts. For example, use "em7admin" instead of "MSDOMAIN\em7admin".

Encrypted. Select whether SL1 will communicate with the device using an encrypted connection. Choices are:

yes. When communicating with the Windows server, SL1 will use a local user account with authentication of type "Basic Auth". You must then use HTTPS and can use a Microsoft Certificate or a self-signed certificate.
no. When communicating with the Windows server, SL1 will not encrypt the connection.

Port. Type the port number used by the WinRM service on the Windows device. This field is automatically populated with the default port based on the value you selected in the Encrypted field. This field is required.

Account Type. Type of authentication for the username and password in this credential. Choices are:

Active Directory. On the Windows device, Active Directory will authenticate the username and password in this credential.
Local. Local security on the Windows device will authenticate the username and password in this credential.

Timeout (ms). Type the time, in milliseconds, after which SL1 will stop trying to collect data from the authenticating server. For collection to be successful, SL1 must connect to the authenticating server, execute the PowerShell command, and receive a response within the amount of time specified in this field.
Password. Type the password for the account on the Windows device to be monitored or on the proxy server. This field is required.
PowerShell Proxy Hostname/IP. If you use a proxy server in front of the Windows devices you want to communicate with, type the fully-qualified domain name or the IP address of the proxy server in this field.
Active Directory Hostname/IP. If you selected Active Directory in the Account Type field, type the hostname or IP address of the Active Directory server that will authenticate the credential.
Domain. If you selected Active Directory in the Account Type field, type the domain where the monitored Windows device resides.

To save the credential, click the Save button. To clear the values you set, click the Reset button.

Specifying Credentials During Initial Classic Discovery

Discovery is the process by which SL1 discovers what types of hardware and applications exist on the network and then retrieves data from the discovered hardware and applications.

Before running discovery, you must:

Determine the SNMP credentials for the devices and applications in your network. Define correlating credentials in SL1, to allow discovery to retrieve as much information as possible.
If you want SL1 to immediately start collecting data from devices using Dynamic Applications, you should also define any additional credentials required for those Dynamic Applications. For example, if you want SL1 to immediately start monitoring all MySQL databases in your network, you should define credentials that allow SL1 to communicate with each MySQL database in your network. During discovery, SL1 will determine which devices can be monitored with a Dynamic Application for MySQL. After discovery, SL1 will use the database credential to collect data about each MySQL database in your network.

Use the previous sections to define credentials for your network.

To specify credentials during initial discovery:

Go to the Discovery Control Panel page (System > Manage > Classic Discovery).
In the Discovery Control Panel page, click the Create button.
In the Discovery Session Editor page, supply values in each field.

In the SNMP Credentials field and in the Other Credentials field, you can select one or more credentials to use during discovery. In these fields, you should see a list of all credentials in SL1.
When trying to communicate with discovered hardware and applications, SL1 will look at the list of selected credentials and use the appropriate credential to get permission to access data on the external system.

During discovery, SL1 tries each SNMP credential specified in the discovery session on each discovered device, to determine if SL1 can collect SNMP details from the device. Later in the discovery session, during alignment of Dynamic Applications, discovery again tries each SNMP credential specified in the discovery session. If one of the SNMP credentials times out three times without any response, discovery will stop trying to use that SNMP credential to align SNMP Dynamic Applications. Note that "no response" means that a device did not respond at all. Note that if a device reports that "no OID was found" or "the end of the OID tree was reached", these are considered a legitimate response and would not cause SL1 to abandon the credential.

Defining the Primary and Secondary Credentials for a Single Device in the Classic SL1 User Interface

You can define multiple credentials for a single device. This allows SL1 to align multiple agents and applications for a single device. For example, SL1 might use an SNMP credential to discover hardware information about a device and a database credential to retrieve information about the database on the same device.

To define primary and secondary credentials for a single device:

When defining primary and secondary credentials for a device, you will see only the credentials aligned to organizations you are a member of. If a primary or secondary credential has already been defined on the device, and is aligned to an organization you are not a member of, the credential will be restricted.

Go to the Device Manager page (Devices > Device Manager).
In the Device Manager page, find the device you want to edit. Click its wrench icon (). The Device Properties page is displayed.
In the Device Properties page, you can select two SNMP credentials in the fields SNMP Read and SNMP Write.
To select a second credential (either of type SNMP or of another type), click the [Actions] menu. Select Secondary Credentials.
The Secondary Credentials modal page appears. In the Secondary Credentials modal page, you can select one or more credentials to associate with the device. To add a secondary credential to a device, highlight an entry in the list of credentials. To select multiple credentials, hold down the <CTRL> key and select the entries by left-clicking with your mouse.
During discovery (either nightly, manual, or associated with device policies), SL1 will first try the primary credentials for the device and then will try the secondary credentials.
Click the Save button to save the change to the device.

Defining the Credentials for a Specific Device/Dynamic Application Pair in the Classic SL1 User Interface

After a device has been discovered by SL1 and one or more Dynamic Applications have been aligned with the device, you can manually assign the credential to use for each Dynamic Application.

To manually associate a credential with a Dynamic Application aligned to a device:

Go to the Device Manager page (Devices > Device Manager).
In the Device Manager page, find the device for which you want to define a credential. Click its wrench icon ().
In the Device Administration panel, click the Collections tab.
In the Dynamic Application Collections page, find the Dynamic Application you want to define a credential for. Select its checkbox (). To apply a credential to multiple Dynamic Applications, select the checkbox for each Dynamic Application.

From the Select Action drop-down list, select the credential from the list of all credentials that you are allowed to use, and then click the [Go] button.

Your organization membership(s) might affect the list of credentials you can see in the Select Action drop-down list.

If this Dynamic Application has already been aligned with a credential to which you do not have access, the Credential column will display the value Restricted Credential. If you align the Dynamic Application with a different credential, you will not be able to re-align the device with the Restricted Credential.

The selected Dynamic Applications will now use the manually selected credential when collecting data from this device. You should see your change reflected in the Credential column in the Dynamic Application Collections page.

Specifying Credentials in a Device Template in the Classic SL1 User Interface

You can specify the primary SNMP credentials in a device template. Then, when you use the device template to create a new device or when you apply the device template to a device group, the primary credentials are automatically applied to each device and appear in the Device Properties page, in the SNMP Read field.

If you include a device template during discovery or re-discovery, SL1 will discover devices first and then apply the device template to each discovered device. During discovery, SL1 automatically assigns a default SNMP credential to each discovered device (that is not a pingable device) and then applies the device template.

If you include a primary SNMP credential in a device template and then apply that device template during discovery, you might overwrite the default SNMP credential assigned by SL1. In some cases, this could prevent SL1 from communicating further with the device.

For more details on device templates and device groups, see the Device Groups and Device Templates section.

How SL1 Uses Credentials During Classic Discovery

During initial discovery, nightly discovery, discovery associated with device policies, and any manually triggered discovery, SL1 uses credentials in the following order:

For devices that have not yet been discovered, SL1 uses the credentials supplied in the Discovery Session Editor page to collect both SNMP data and Dynamic Application data.
For devices that have already been discovered at least once, SL1 uses the SNMP credentials specified in the Device Properties page.
For devices that have already been discovered at least once, SL1 uses the secondary credentials defined in the Device Properties page if the primary credentials don't work.
For devices that have already been discovered at least once, SL1 will use the credentials defined in the Dynamic Application Collections page for specific Dynamic Applications.

Aligning One or More Organizations With a Credential in the Classic SL1 User Interface

To support multi-tenancy, SL1 allows you to align each credential with one, multiple or all organizations in SL1. You can also align a credential with no organizations.

When you align an organization with a credential, you control who can view details about the credential, who can view the name of the credential, and who can apply the credential in SL1.

If you have an account of type "User" and are a member of only one organization, the Organization column will not appear in the Credential Management page. The Credential Management page will display only credentials that are aligned with your organization.

Credentials that are aligned with an organization have the following behavior:

For each credential that is aligned with an organization, only administrators and users who are members of the aligned organization will be able to see the credential in the Credential Management page.
When aligning credentials to devices or Dynamic Applications, non-administrator users can view and align only those credentials that are assigned to organizations common to both the user and the device’s collector group, plus those credentials that are assigned to all organizations or otherwise required for that collector group.
Users can change the organization setting of only those credentials that are not currently aligned to any devices.
In SL1, in any field or column that displays the name of the credential, users who are not members of the aligned organization will not see the credential name. Instead, these users will see either a dash character (-) or the text "Restricted Credential".
In SL1, in any list from which users can select a credential, users who are not members of the aligned organization will not see the credential as an entry in the list.
In SL1, in any page where the credential has already been assigned, users who are not members of the aligned organization will see only the name "Restricted Credential".
In SL1, in any page where the credential has already been assigned, users who are not members of the aligned organization can save the page and maintain the credential. The credential will still appear to that user as "Restricted Credential".
In SL1, in any page where the credential has already been assigned, users who are not members of the aligned organization can change the credential to a credential aligned with their organization(s). However, those users cannot change the credential again and re-assign the "Restricted Credential". The entry for "Restricted Credential" is removed from the list of possible credentials.

To understand the behavior of a credential aligned with an organization, consider the following example:

Suppose you have a user account of type "Administrator". Suppose you create an SNMP credential called "ops_cred". Suppose you align that credential with the organization "Operations".
In the Credential Management page, only administrators and users who are members of the organization "Operations" will be able to see the credential "ops_cred" in SL1.
In SL1, in any field or column that displays the name of the credential (for example, in the SNMP Credential column in the Device Manager page), users who are not members of the organization "Operations" will not see the "ops_cred" name displayed. Instead, these users will see either a dash character (-) or the text "Restricted Credential".
In SL1, in any list from which users can select a credential (for example, in the SNMP Read field, in the Device Properties page), users who are not members of the organization "Operations" will not see the "ops_cred" credential as an entry in the field.
In SL1, in any page where the credential "ops_cred" has already been assigned, users who are not members of the organization "Operations" will see only the name "Restricted Credential".
In SL1, in any page where the credential "ops_cred" has already been assigned (for example, in the SNMP Read field, in the Device Properties page), users who are not members of the organization "Operations" can save the page and maintain the "ops_cred" credential. The credential will still appear to that user as "Restricted Credential".
In SL1, in any page where the credential "ops_cred" has already been assigned, (for example, in the SNMP Read field, in the Device Properties page), users who are not members of the organization "Operations" can change the credential to a credential aligned with their organization. However, that user cannot change the credential again and re-assign the "Restricted Credential". The entry for "Restricted Credential" is removed from the list of possible credentials.

Default Organizations Aligned with a Credential

When you create a new credential, SL1 automatically aligns the credential with all your organizations. For example:

Account Type	Organization(s) Aligned with the ScienceLogic Account	Default Organizations Aligned with Credential
Administrator	All	All
User	Primary Organization = NOC Additional Organization Memberships = All organizations	All
User	Primary Organization = NOC Additional Organization Memberships = Sales	NOC, Sales
User	Primary Organization = NOC Additional Organization Memberships = None	NOC

After you save the credential, you can edit the organization(s) aligned with the credential.

Editing the Organizations Aligned with a Credential

After a credential has been created, you change the default organizations aligned with a credential.

To edit the organization alignment on a credential:

Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, find the credential for which you want to edit the organization. In the Organization column, click its org icon ().
The Align Organizations modal page appears. In this page, provide values in the following fields:

Credential Availability. Specifies whether you want to align all organizations with the credentials or manually select one, multiple, or no organizations to align with the credential. Choices are:

Aligned Organizations Only. Selecting this option will make the Aligned Organizations pane available. You can select one or multiple organizations to be aligned with the credential.
System (All Organizations). This option is only available if you are a system administrator or a member of all organizations in SL1. All organizations will be aligned with the credential. If another organization is created, it will be aligned to the credential, by default.

NOTE: The Credential Availability field appears only for users who are Administrators and users who are members of all organizations.

Aligned Organizations. Displays a list of all organizations to which you belong. Select one, multiple, or no organizations to align with the credential.

To select a single organization, highlight it and left-click.
To unselect a single organization, highlight it and left-click.
To select multiple organizations, hold down the CTRL key and select the entries by left-clicking.
To unselect multiple organizations, hold down the CTRL key and select the entries by left-clicking.

NOTE: Only users who are Administrators and users who are members of all organizations can unselect all organizations in the Aligned Organizations list.

To save the new organization alignment, click the Save button.

Restricted Credentials in the Discovery Session Editor Page

The Discovery Session Editor page allows you to select multiple credentials to align with a discovery session.

In the SNMP Credentials field and the Other Credentials field, the Discovery Session Editor page might include credentials that have been aligned with one or more organizations. If one of these credentials has been previously selected, users who are not members of the aligned organization(s) will see "Restricted Credential" appear in the SNMP Credentials field or the Other Credentials field.

If multiple aligned credentials have been previously selected for a discovery session, users who are not members of the aligned organization(s) will see only a single "Restricted Credential entry appear in the SNMP Credentials field or the Other Credentials field. This single entry of Restricted Credential represents all restricted credentials. If a user who is not a member of the aligned organization(s) removes the entry Restricted Credential from the discovery session, all restricted credentials are removed. That user cannot change the credential again and re-assign Restricted Credential. The entry for Restricted Credential is removed from the list of possible credentials.

Editing a Credential in the Classic SL1 User Interface

The Credential Management page allows you to edit credentials from SL1. To do so:

Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, click the wrench icon () for the credential you want to edit.
The Credential Editor modal appears.
After editing the fields in the Credential Editor, click the Save button. If you want to save your changes as a new credential, click the Save As button.

Deleting a Credential in the Classic SL1 User Interface

The Credential Management page allows you to delete one or more credentials from SL1. To do so:

You cannot delete a credential until all aligned devices, Dynamic Applications, backup settings, LDAP/AD settings, and discovery sessions that use the credential are aligned with another credential.

Go to the Credential Management page (System > Manage > Credentials).
In the Credential Management page, select the checkbox for each credential you want to delete.
Go to the Select Actions menu (in the lower right). Select DELETE Credential Policy. Click the Go button.
The selected credentials will be deleted.