SSH private key credentials form

These fields are available in the Credentials form for SSH private keys.

SSH private key credentials are recommended over SSH password credentials for security reasons.

Table 1. SSH private key credentials form
Field Input value
Name Unique and descriptive name for this credential. For example, you might call it SSH Atlanta.
Active Enable or disable these credentials for use.
User name Enter a UNIX or Linux user name. Avoid leading or trailing spaces in user names. A warning appears if the platform detects leading or trailing spaces in the user name.
Password Enter the UNIX or Linux password. For SSH Private Key type credentials, enter the sudo password if one is required for the user name.
SSH passphase Type a secure SSH passphrase. This field is available only for SSH Private Key credentials.
SSH private key Enter a secure, private keythat can be used instead of a password for SSH logins. This field is available only for SSH Private Keycredentials.

The private key must be entered in the proper format to ensure it is correctly encrypted. The private key must start with the string -----BEGIN.

Here is an example of a correctly formatted private key

-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAsEK65scPssPSobpDFMpR+Btv3MS4Q7NP8ERaStRZsh3IWz+x...
...7hrxV2dbSug60FahyupGWBGtPnXm5PaE2X5WPLuUj94ue48i1Fs
-----END RSA PRIVATE KEY-----

The ServiceNow platform supports private keys in the PEM format generated by the OpenSSH ssh-keygen utility. To convert PPK keys that were generated by PuTTY:

  • Open your private key in PuTTYGen.
  • Export it in OpenSSH format from the menu Conversions > Export OpenSSH key.
  • Save the new OpenSSH key.
Tag Allow workflow creators to assign individual credentials to any activity in an Orchestration workflow or assign different credentials to each occurrence of the same activity type in an Orchestration workflow.
MID servers Select one or more MID Servers from the list of available MID Servers. The credentials configured in this record are available to the MID Servers in this list. This field is available only when you select Specific MID servers from the Applies to field.
Applies to Select whether to apply these credentials to All MID servers in your network, or to one or more Specific MID servers. Specify the MID Servers that should use these credentials in the MID servers field.
Order The order (sequence) in which the platform tries this credential as it attempts to log onto devices. The smaller the number, the higher in the list this credential appears. Establish credential order when using large numbers of credentials or when security locks out users after three failed login attempts. If all the credentials have the same order number (or none), Discovery or Orchestration tries the credentials in a random order.