For the complete documentation index, see llms.txt. This page is also available as Markdown.

Commander CLI

Setup and management of Universal Secrets Sync using Keeper Commander CLI

Overview

In this guide, you will learn how to sync resources within your target cloud secret infrastructure using Universal Secrets Sync ("USS") with Keeper Commander.

Prerequisites

Prior to using USS on Commander, make sure to review the Setup documentation.

Note that using Commander to initiate a sync should only be necessary if Dry run is selected in the USS settings of the corresponding PAM cloud configuration. Otherwise, USS will run automatically.

Starting Commander

Log in to Keeper Commander CLI using the keeper shell command.

$ keeper shell

List Configurations

Run the command pam config list or pam c l command to list all configurations

My Vault> pam config list
UID                     Config Name                   Config Type              Shared Folder                                              Gateway UID             Resource Record UIDs
----------------------  ----------------------------  -----------------------  ---------------------------------------------------------  ----------------------  ----------------------
qZkz5qoShpQL2J_TKurbRw  AWS USS Configuration         pamAwsConfiguration      AWS USS Folder - Users (yEW84228pFIEsbHPokxGjg)            Wu6-vzjOSJKOs3xGvmO74w
BtRLYDwx0AtvN2kaMbS-gQ  AWS USS Configuration IE      pamAwsConfiguration      AWS USS Folder - Users (yEW84228pFIEsbHPokxGjg)            Wu6-vzjOSJKOs3xGvmO74w
Fp_Nt9sI-fjd4n4jhOdMrw  Azure USS Configuration       pamAzureConfiguration    AWS USS Folder - Users (yEW84228pFIEsbHPokxGjg)            Wu6-vzjOSJKOs3xGvmO74w
e-oiP-gCEeatNVpLrVZ6Tg  GCP PAM Config                pamGcpConfiguration      Local Gateway Folder - Resources (KBfF0jOvPg6FxOZyz2xNzA)  1MX6ZTJPQWmHF1S_CRQ3Gw
VjFRx3_0kMyedeAKuQSpcQ  GCP USS Configuration         pamGcpConfiguration      AWS USS Folder - Users (yEW84228pFIEsbHPokxGjg)            Wu6-vzjOSJKOs3xGvmO74w
mzkHNi21uEB8bpxa228bjw  Local Gateway Configuration   pamNetworkConfiguration  Local Gateway Folder - Users (jkj1rVit39QcJJM70lMCDQ)      1MX6ZTJPQWmHF1S_CRQ3Gw
My Vault>

The Configuration UID is required to start the sync process.

Start Sync Job

Run the pam universal-sync-run command to start a sync job. The configuration UID must be provided with the -n option.

The sync job is scheduled and a confirmation is returned with the action ID:

Check job status

Use the pam action job-info command with the action ID and gateway UID returned above to check whether the job has completed:

View sync results

Once the job has finished, run pam usc list with the configuration UID to view the sync results:

The following is a sample output showing the configuration details and the sync status for each folder. Verify that all folders show a Status of Success and that the Last Synced timestamp reflects the time the job completed. A Failed status on any folder indicates an error — check the Gateway logs and verify that the Sync Identity has the correct permissions on the target cloud secrets manager.

Commander Reference

Keeper Commander provides many advanced capabilities for managing gateways, configurations, rotations and discovery. See the KeeperPAM Commands for a list of all available options.

Last updated

Was this helpful?