Updates
It is the responsibility of the Appliance Administrator to update or upgrade One Identity Safeguard for Privileged Passwords by installing an update file to modify the software or configuration of the running appliance. See the Download Software page for available SPP releases and version patches.
Clustered environment
Apply the patch so all appliances in the cluster are on the same version. The procedure for patching cluster members depends on the Safeguard for Privileged Passwords version you are currently running.
- If you are running Safeguard for Privileged Passwords 2.0.1.x or earlier, you must unjoin replica appliances, install the patch on each appliance, and then enroll the replica appliances to rebuild your cluster. For more information, see Patching cluster members in the One Identity Safeguard for Privileged Passwords 2.0 Administration Guide.
- If you are running Safeguard for Privileged Passwords 2.1.x or 2.2.x, you can use the enhanced cluster patching feature where unjoining replica appliances is no longer required. For more information, see Patching cluster members.
To install an update file
-
Back up your system before you install an update file. For more information, see Backup and restore.
- Navigate to Administrative Tools | Settings | Appliance | Updates. The current Appliance Version, Client Version, and OS Version display.
- Click Upload a File and browse to select an update file.
Note: When you select a file, Safeguard for Privileged Passwords uploads it to the server, but does not install it.
- Once the file has successfully uploaded, click one of the following:
- Install Now to install the update file.
Note: Once you install an update file, you cannot uninstall it.
- Remove to delete the file from the server without installing it.
The Updates pane shows the upgrade progress and when the appliance has been successfully upgraded.
Asset Management settings
Use the Asset Management settings to define and manage dynamic tags for assets and asset accounts which include directory accounts. Asset Management settings allow you to add a custom platform.
Navigate to Administrative Tools | Settings| Asset Management.
Table 121: Asset Management settings
|
Custom platforms |
Where you add a custom platform |
|
Tags |
Where you view and manage dynamic tags for assets and asset accounts |
Custom platforms
The Asset Administrator adds a custom platform that includes uploading the custom platform script with the platform's commands and details. Auditors and Partition Administrators have read only rights. Custom platforms are global across all partitions. The custom platform can be selected when adding or updating an asset.
Create and manage custom platforms in Administrative Tools | Settings | Asset Management | Custom Platforms.
The Custom Platform pane displays the following.
Table 122: Custom platform: Properties
| Name |
The name of the platform type which may be a product name. |
|
Version |
The version of the target platform to use as an identifier. |
|
Architecture |
The CPU architecture to use as an identifier. If not applicable, use Any. |
|
Platform Script |
The name of the custom platform script file displays once selected. |
|
Allow Sessions Requests |
If selected, session access requests are allowed. |
Use the following toolbar buttons to manage the custom platform settings.
Table 123: Custom Platform: Toolbar
 Add |
Add a custom platform. For more information, see Adding a custom platform. |
 Delete Selected |
Remove the selected custom platform.
|
|
CAUTION: If the custom platform is associated with an asset, deleting the custom platform may halt password validation and reset. A warning displays, indicating that the asset will be assigned to the Product platform type Other. Enter Force Delete to confirm the deletion. | |
 Refresh |
Update the list of custom platforms. |
|
 View
|
View the custom platform script parameters including:
- Supported operations, for example Suspend and Restore Accounts, Check System, Check Password, Change Password
- Details including Name, Task, Type, Default, and Description
|
 Download Selected Script |
Download the selected custom platform JSON script. |
Creating a custom platform script
A custom platform script identifies the platform's commands and associated details. Scripts are written in JSON. Scripts include metadata, parameters, function blocks, operations, and if/then constructs to authenticate to the platform and perform password validation and reset. The custom platform script is uploaded when adding the custom platform.
An Asset Administrator can create an asset and accept default values in the associated custom script. If you later upload a new version of the custom platform script with different defaults, the asset defaults are not changed.
A delegated administrator cannot create a custom platform script.
Sample scripts
Sample custom platform scripts and command details are available at the following links available from the on GitHub:
|
|
CAUTION: Example scripts are provided for information only. Updates, error checking, and testing are required before using them in production. Safeguard for Privileged Passwords checks to ensure the values match the type of the property that include a string, boolean, integer, or password (which is called secret in the API scripts). Safeguard for Privileged Passwords cannot check the validity or system impact of values entered for custom platforms. |
During development, check your JSON using a validator.
