Credentials
Overview
Credentials are the user ID and password under which an Agent runs tasks on the machine where the Agent resides.
By default, an Agent will run tasks under the same Credentials used to install the Agent. However, via the Controller user interface, you also can define Credentials and assign them to any task or Agent.
When prompted for Credentials, the Agent looks in the following locations, in this order, for a user ID and password:
If the task specifies Credentials, the Agent uses those Credentials.
If the task does not specify Credentials, the Agent uses the Credentials specified in its Agent Details record.
If the Agent Details does not specify Credentials, the Agent uses the Credentials used to install the Agent.
Types of Credentials
There are four types of Credentials:
Standard | Runtime user name and runtime password of a user. |
|---|---|
Resolvable | Runtime user name and runtime password of a user that you can embed into a task or script without exposing the password in clear text. |
Web Service | Runtime user name and runtime password of a user running a Web Service task. |
Runtime user name and runtime password of a user connecting to an incoming mail server (IMAP). |
Converting Credential Types
You can convert a Credential from any type to any type.
To convert a Credential type from Standard to Resolvable, Web Service, or Email, the Resolvable Credentials Permitted, Web Service Credentials Permitted, or Email Credentials Permitted Universal Controller system property, respectively, must be set to true.
To convert a Credential, either:
Click the Convert... button in the Credential Details.
Select Convert... in the Credentials Details action menu.
Select Convert... for a specific Credential in the Credentials List action menu.
When you convert a Credential, you must provide a new password. The Controller will not convert an encrypted password of one Credential type to an encrypted password of a different Credential type.
Note
Converting a Credential type does not create a new version of the Credential. Also, you cannot restore a Credential to an older version if the Credential type of the current version is not the same Credential type as the older version.
Credentials Compatibility
As of Universal Controller 6.4.x, the Credential Runtime Passwords, along with the LDAP Settings Bind Password, Email Connection Passwords, Promotion Target Passwords, and Promotion Schedule Promotion Passwords, now are encrypted using AES with 128-bit keys.
Additionally, Standard and Resolvable Credentials are encrypted using separate keys; therefore, an encrypted password for a Standard Credential cannot be decrypted by the Resolvable Credential framework.
Under the following circumstances, conversion from the old encryption to the new encryption will be automatic. Furthermore, all pre-6.4.x credentials will be recognized as Standard credentials.
Apply maintenance to a pre-6.4.x release of Universal Controller to increase it to a 7.2.x release.
Perform a bulk import or list import from a pre-6.4.x release of Universal Controller to a 7.2.x release.
Promote from a pre-6.4.x release of Universal Controller to a 7.2.x release.
Under the following circumstance, conversion from the new encryption to the old encryption will be automatic.
Promote from a 7.2.x release of Universal Controller to a compatible pre-6.4.x release. However, any attempt to promote a Resolvable Credential from a 7.2.x release of Universal Controller to a compatible pre-6.4.x release will fail.
Pre-6.4.0.0 releases cannot decrypt anything encrypted by a 7.2.x release, with the exception of promotion (noted above), which is fully backwards compatible.
Please note the following backwards compatibility constraints with respect to List Import, Bulk Import, and the Universal Controller Start-up Properties (opswise.properties).
Any attempt to List Import or Bulk Import XML (containing a password encrypted by a 7.2.x release) into a pre-6.4.0.0 release will result in an encrypted value that cannot be decrypted by the pre-6.4.0.0 release.
Any encrypted passwords within the Universal Controller Start-up Properties will be re-encrypted using the new algorithm when the 7.2.x Controller initializes at start-up. Once converted, that Universal Controller Start-up Properties will no longer be compatible with a pre-6.4.0.0 release.
Resolvable Credentials
Resolvable Credentials are meant to be used with scripts and commands specified in tasks, and resolved when the script or command is executed. They provide the script or command with access to Credentials (user name and password) without having to hard-code the Credentials in the script, command, or parameters itself.
In order to enable the use of Resolvable Credentials, the Resolvable Credentials Permitted Universal Controller system property must be set to true (default is false).
If the Resolvable Credentials Permitted property is set to false, the following restrictions on Resolvable Credentials apply:
You cannot create a Resolvable Credential.
You cannot convert a Standard Credential to a Resolvable Credential.
Any attempt to launch a task with an embedded Resolvable Credential will result in a Start Failure status.
Using Resolvable Credentials in a Script
To use Resolvable Credentials with a script, embed the Resolvable Credentials in any of the following:
Content of a Script specified in the Script field in a Linux/Unix or Windows task.
Content of a Data Script.
Universal Template Script (Script, Linux/Unix Script, or Windows Script field).
Content of a Script specified in the Payload Script field in a Web Service task.
Using Resolvable Credentials in a Task
To use Resolvable Credentials with a task, embed the Resolvable Credentials in any of the following:
Task | Fields |
|---|---|
| |
| |
|