Custom platforms
desktop client only
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 169: Custom platform: Properties
Name |
The name of the platform type which may be a product name. |
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 170: 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 or SSH key 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
desktop client only
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 or SSH key 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.
Adding a custom platform
desktop client only
It is the responsibility of the Asset Administrator to configure the rules so Safeguard for Privileged Passwords handles custom platforms. The custom platform script must be available for uploading. For more information, see Creating a custom platform script.
To add a custom platform
- Have the custom platform script file available to upload.
- Navigate to Administrative Tools | Settings | Asset Management | Custom Platforms.
- Click Add.
- These fields display:
- Name: Enter the unique name of the platform type, which may be a product name.
-
Platform Script: Click Browse. Navigate to and select the script file. Click Open. The selected custom platform script file displays.
- Select the Allow Sessions Requests check box to allow session access requests. This check box is typically selected for SSH. Clear the Allow Sessions check box to prohibit session access requests.
- Click OK. If the custom platform script has errors, an error message like the following displays: Definition was not a valid json object .
Registered Connectors
desktop client only
The Asset Administrator is responsible for adding and managing registered connectors.
Create and manage registered connectors in Administrative Tools | Settings | Asset Management | Registered Connectors.
The Registered Connectors pane displays the following.
Table 171: Registered Connectors: Properties
Display |
This column shows the display name entered for the registered connector. |
Platform Name |
This column shows the platform name. |
Visible To Partitions |
This column shows the partitions that the connector is visible for. When a connector is visible to all partitions then the column will show All Partitions. |
Use the following toolbar buttons to manage the registered connector settings.
Table 172: Registered Connectors: Toolbar
Add |
Add a registered connector. For more information, see Adding a registered connector. |
Delete Selected |
Remove the selected registered connector. |
Refresh |
Update the list of registered connectors. |
Edit |
Edit the selected registered connector. |
View |
View the valid operations for the registered connector. |