PAM Extended Commands

PAM Extended Commands

The pam extended command group provides advanced management of PAM rotation schedules and discovery rules directly from Commander. These operations complement the web vault UI for automation, scripting, and CI/CD pipelines.

To get help on a particular subcommand, run:

pam extended schedule help
pam extended rule help

Command Reference

Schedule commands

Command
Description

pam extended schedule list

List all PAM rotation schedules visible to the authenticated user

pam extended schedule set

Create or update a rotation schedule for a PAM record

pam extended schedule delete

Remove a rotation schedule from a PAM record

Rule commands

Command
Description

pam extended rule list

List discovery rules associated with a PAM configuration

pam extended rule add

Add a new discovery rule to a PAM configuration

pam extended rule delete

Delete a discovery rule from a PAM configuration


pam extended schedule list

Lists all PAM rotation schedules the authenticated user can see. Optionally filter by PAM configuration UID.

Syntax

Options

Option
Description

--config-uid <uid>

Filter results to a specific PAM configuration UID

--format table|json

Output format. Default: table

Example — list all schedules

Example — JSON output


pam extended schedule set

Creates or updates a rotation schedule for a PAM record. The schedule is stored as a JSON cron expression inside PAMRotationSchedule.scheduleData and takes effect at the next rotation window.

Syntax

Parameters

Parameter
Required
Description

<uid_ref>

Yes

UID of the PAM record to schedule

--cron <expression>

Yes

5-field cron expression (minute hour day month weekday)

--config-uid <uid>

No

Associate schedule with a specific PAM configuration

--notify <email>

No

Email address to notify when the schedule fires. Repeatable.

Cron expression format

Keeper uses standard 5-field cron syntax:

Examples

Rotate every day at 03:00 UTC:

Rotate every 6 hours and notify two recipients:

Rotate at 02:30 on Mondays, scoped to a specific config:


pam extended schedule delete

Removes the rotation schedule from a PAM record by setting noSchedule=True. The record will no longer be rotated on a schedule; it can still be rotated manually.

Syntax

Parameters

Parameter
Required
Description

<uid_ref>

Yes

UID of the PAM record whose schedule should be removed

Example


pam extended rule list

Lists the discovery rules associated with a PAM configuration. Rules are stored in the PAM DAG under the DISCOVERY_RULES graph node.

Syntax

Parameters

Parameter
Required
Description

--config-uid <uid>

Yes

UID of the PAM configuration to query

--format table|json

No

Output format. Default: table

Example


pam extended rule add

Adds a new discovery rule to a PAM configuration. The rule is written to the PAM DAG via a PAMModifyRequest ADD operation on PAMElementData.

Syntax

Parameters

Parameter
Required
Description

<name>

Yes

Human-readable name for the rule

--cidr <range>

Yes

Target IP range in CIDR notation (e.g. 10.0.1.0/24)

--config-uid <uid>

Yes

UID of the PAM configuration to attach the rule to

--type

No

Target type: machine (default), user, or database

--protocol

No

Connection protocol: ssh (default), rdp, or database

--credential-uid <uid>

No

UID of a credential record to associate with the rule

Examples

Add a machine discovery rule for the web tier:

Add a database discovery rule with a linked credential:


pam extended rule delete

Deletes a discovery rule from a PAM configuration by its element UID (returned by pam extended rule list). The deletion is applied via a PAMModifyRequest DELETE operation.

Syntax

Parameters

Parameter
Required
Description

<uid>

Yes

Hex UID of the discovery rule element to delete

--config-uid <uid>

Yes

UID of the PAM configuration the rule belongs to

Example


Notes

  • All pam extended commands require an active enterprise admin session.

  • Record and configuration UIDs can be found using pam config list or pam project list.

  • Schedule changes take effect at the next rotation window evaluated by the PAM gateway; there is no forced immediate rotation.

  • Discovery rules added via pam extended rule add are evaluated by the PAM gateway during the next discovery cycle. Existing discovered records are not affected retroactively.

  • Use --format json with any list command to pipe output into scripts or other tools.

Last updated

Was this helpful?