Store shared host credentials
This topic describes how to manage credentials for multiple remote hosts that share the same authentication details. To simplify credential management, you can configure a single CI to define shared credentials for any remote host requiring authentication. When defining an overthere host connection, you can then select the shared credentials CI.
This approach applies to the following host types:
- SmbHostCredentials: Use this CI type for SmbHost and CifsHost connections.
- SshHostCredentials: Use this CI type for for SshHost and SshJumpstation connections.
To define credentials, you must have admin global permissions.
Create shared credentials for an SSH host connection
To create a shared host credentials CI for an SSH host connection:
-
In the top bar, click Explorer.
-
Hover over Configuration, click , and select New > credentials > SshHostCredentials.
Alternatively you can right-click the Configuration node and select New > credentials > SshHostCredentials.
- In the Name field, enter a name for the credentials to use throughout the system.
- In the Common section, do one of the following:
- Enter the Username and Password.
- If you use an SSH key to connect to a remote host, enter the Username, Private Key File, and Passphrase.
- Click Save.
If you are storing passwords in the HashiCorp Vault external secrets management tool, you toggle the field to select the related CI for the Password and Passphrase fields. For details, see Manage secrets using HashiCorp Vault.
Create shared credentials for an SMB or CIFs host connection
To create a shared host credentials CI for an SMB or CIFs host connection:
-
In the top bar, click Explorer.
-
Hover over Configuration, click , and select New > credentials > SmbHostCredentials.
Alternatively you can right-click the Configuration node and select New > credentials > SmbHostCredentials.
- In the Name field, enter a name for the credentials to use it throughout the system.
- In the Common section, in the Username and Password fields, enter the credentials you want to store.
- Click Save.
If you are storing passwords in the HashiCorp Vault external secrets management tool, you toggle the field to select the related CI for the Password field. For details, see Manage secrets using HashiCorp Vault.
Use the credentials CI
The credentials CI is now available from the Credentials dropdown when creating a SSH or SMB host connection. See Choose a host type and connection type for details on creating a host connection.