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

KeeperPAM Commands

Management of KeeperPAM functionality including Discovery, Rotation, Connections and Tunnels

Overview

KeeperPAM functionality including discovery, password rotation, PAM Configuration, Keeper Gateway configuration can be controlled and operated through Python SDK using the pam command and sub-commands.

pam Command

command: pam

Detail: Perform KeeperPAM controls.

Sub Commands


Sub-Command: gateway

View, create and remove Keeper Gateway services. To learn more about the Keeper Gateway

list

Command: pam gateway list

Lists all gateways accessible by the user. This includes:

  • Gateways directly accessible by the user in their vault.

  • Gateways registered under any managed node from the user's role.

Parameters:

new

Command: pam gateway new

Command: pam gateway new

Parameters:

edit

Allows updating the gateway's name or registered node. Equivalent actions can be performed in the Admin Console, under Secrets Manager → Gateways.

Command: pam gateway edit

Parameters:

remove

Removes a gateway. The user executing this command must have admin rights on the gateway's parent application to perform this action.

Command: pam gateway remove

Parameters:

--gateway, -g GATEWAY UID of the Gateway

set-max-instances

Defines maximum gateway pool instances.

Command: pam gateway set-max-instances

Parameters:

--gateway, -g GATEWAY Gateway UID or Name

--max-instances, -m MAX_INSTANCES Maximum number of gateway instances (must be >= 1)


Sub-Command: config

View, create, edit and remove Keeper PAM Configurations

list

Command: pam config list

Parameters

--config, -c PAM_CONFIGURATION Specific PAM Configuration UID

--verbose, -v Verbose

--format {table,json} Output format (table, json)

new

Command: pam config new

Parameters:

edit

Command: pam config edit

Parameters:

remove

Command: pam config remove

Parameters:

--gateway, -g GATEWAY UID of the Gateway


Sub-Command: action

Discovery, rotation and service account management of PAM Resources

gateway-info

Command: pam action gateway-info

Parameters:

--gateway, -g GATEWAY_UID Gateway UID

--verbose, -v Verbose Output

rotate

Issue a credential rotation on the specific resource, folder of resources, or pattern in the resource title.

Command: pam action rotate

Parameters:

job-info

Display information about the running job

Command: pam action job-info

Parameters:

--gateway, -g GATEWAY_UID Gateway UID. Needed only if there are more than one gateway running

job-cancel

Cancel a running job

Command: pam action job-cancel

Parameters:

--gateway, -g GATEWAY_UID Gateway UID. Needed only if there are more than one gateway running

discover start

Start a discovery job

Command: pam action discover start

Parameters:

discover status

Display the status of a discovery job

Command: pam action discover status

Parameters:

discover remove

Stop a running discovery job

Command: pam action discover remove

Parameters:

--job-id, -j JOB_ID Discovery job id.

discover process

Process the findings of a discovery job

Command: pam action discover process

Parameters:

discover rule add

Add a discovery rule

Command: pam action discover rule add

Parameters:

discover rule list

Command: pam action discover rule list

Parameters:

discover rule remove

Command: pam action discover rule remove

Parameters:

discover rule update

Command: pam action discover rule update

Parameters:

service list

Display the services and scheduled tasks associated to a specific Keeper Gateway

Command: pam action service list

Parameters:

service add

Add an association for a service to a specific Keeper Gateway and PAM Machine. Once associated, Keeper will update the credentials for that service, on the specific PAM Machine, and restart the service (if running).

Command: pam action service add

Parameters:

service remove

Remove an association for a service on a specific PAM Machine.

Command: pam action service remove

Parameters:

saas config

Command: pam action saas config

Parameters:

saas set

Command: pam action saas set

Parameters:

saas remove

Command: pam action saas remove

Parameters:

saas user

Command: pam action saas user

Parameters:

saas update

Command: pam action saas update

Parameters:

debug info

Command: pam action debug info

Parameters:

--record-uid, -i RECORD_UID. Keeper PAM record UID.

debug gateway

Command: pam action debug gateway

Parameters:

debug graph

Command: pam action debug graph

Parameters:

debug acl

Command: pam action debug acl

Parameters:

Command: pam action debug link

Parameters:

debug rs-reset

Command: pam action debug rs-reset

Parameters:

debug vertex

Command: pam action debug vertex

Parameters:

Sub-Command: rotation

View and create Keeper Rotation configuration for records.

list

Display a list of all resources configured for rotation

Command: pam rotation list

Parameters

--verbose, -v Verbose output

info

Display information about the rotation settings for a particular resource.

Command: pam rotation info

Parameters:

--record-uid, -r RECORD_UID. Record UID to rotate

edit

Command: pam rotation edit

Parameters:

script list

Command: pam rotation script list

Parameters:

script add

Command: pam rotation script add

Parameters:

script edit

Command: pam rotation script edit

Parameters:

script delete

Command: pam rotation script delete

Parameters:

--script SCRIPT Script UID or name


Sub-Command: connection

This command will edit the connection parameters and user accounts that are attached to PAM Machine and PAM Database records. The process can also be done in bulk with the run-batch command.

connection edit

Command: pam connection edit

Parameters:


Sub-Command: rbi

This command provides the ability to edit remote browser isolation settings for a record.

rbi edit

Command: pam rbi edit

Parameters:

Last updated

Was this helpful?