PAM Connection Commands

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. To launch

Connection Edit command

Edits connection settings on PAM resource records (pamMachine, pamDatabase, pamDirectory, etc.) or on a PAM Configuration record. Updates vault fields (protocol, port override, scrollback, admin/launch credentials).

DotNet CLI

Command: pam-connection edit

Alias: pam-conn edit / pam-conn e

Parameters:

Parameter	Description
<record> (positional)	PAM resource or PAM Configuration UID / title
--configuration, -c	PAM Configuration UID or title (required when the resource is not already linked)
--admin-user, -a	PAM User UID/title for the admin credential on the resource
--launch-user	PAM User UID/title for the launch credential
--clear-launch-user	Remove the launch credential from the resource (pamMachine / pamDatabase / pamDirectory only)
--protocol, -p	Connection protocol (e.g. ssh, rdp, mysql, postgresql, sql-server, telnet, vnc, http, kubernetes). Empty string clears
--connections	Connections permission: on, off, or default
--connections-recording	Session recording: on, off, or default
--typescript-recording	TypeScript recording: on, off, or default
--connections-override-port	Port override for connections. Empty string clears
--key-events, -k	Key events (recordingIncludeKeys): on, off, or default
--scrollback	Terminal scrollback size. Empty string clears
--rotate-on-termination	Rotate launch credentials when the session ends: on or off (pamMachine / pamDatabase / pamDirectory only)
--silent, -s	Suppress summary output

Examples:

My Vault> pam-connection edit <RESOURCE_UID> --configuration <CONFIG_UID> --connections=on --protocol ssh
My Vault> pam-connection edit <RESOURCE_UID> --admin-user <PAM_USER_UID> --launch-user <PAM_USER_UID>
My Vault> pam-connection edit <RESOURCE_UID> --connections-recording=on --key-events=on
My Vault> pam-connection edit <RESOURCE_UID> --connections-override-port 2222 --scrollback 1000
My Vault> pam-connection edit <RESOURCE_UID> --rotate-on-termination=on
My Vault> pam-connection edit <RESOURCE_UID> --clear-launch-user
My Vault> pam-connection edit <CONFIG_UID> --connections=on
My Vault> pam-conn e <RESOURCE_UID> -c <CONFIG_UID> --connections=on -p ssh

DotNet SDK

Function:

using KeeperSecurity.Plugins.PAM;

var result = await ConnectionUtils.EditConnectionAsync(vault, new PamConnectionEditOptions
{
    Record = "<RESOURCE_UID>",
    Configuration = "<CONFIG_UID>",
    Connections = "on",
    Protocol = "ssh",
    AdminUser = "<PAM_USER_UID>",
    LaunchUser = "<PAM_USER_UID>",
    ConnectionsRecording = "on",
    TypescriptRecording = "default",
    ConnectionsOverridePort = "2222",
    KeyEvents = "on",
    Scrollback = "1000",
    RotateOnTermination = "on",
    Silent = false
});

foreach (var message in result.Messages)
{
    Console.WriteLine(message);
}

if (result.RecordUpdated || result.GraphUpdated)
{
    Console.WriteLine($"Connection settings updated for {result.RecordUid}");
}

Power Commander

Command: Set-KeeperPamConnection

Alias: pam-connection-edit

Parameters:

Parameter	Description
-Record	PAM resource or PAM Configuration UID / title
-Configuration, -c	PAM Configuration UID/title
-AdminUser, -a	PAM User for admin credential
-LaunchUser, -lu	PAM User UID/title for the launch credential
-ClearLaunchUser	Remove launch credential
-Protocol, -p	Connection protocol (e.g. ssh, rdp, mysql, postgresql, sql-server, telnet, vnc, http, kubernetes). Empty string clears
-Connections, -cn	Connections permission: on, off, or default
-ConnectionsRecording, -cr	Session recording: on, off, or default
-TypescriptRecording, -tr	TypeScript recording: on, off, or default
-ConnectionsOverridePort, -cop	Port override for connections. Empty string clears
-KeyEvents, -k	Key events: on, off, or default
-Scrollback, -sb	Terminal scrollback size. Empty string clears
-RotateOnTermination	Rotate launch credentials when the session ends: on or off (pamMachine / pamDatabase / pamDirectory only)
-Silent, -s	Suppress final update line

Examples:

PS > Set-KeeperPamConnection -Record "DkPBB1AuaHpt8JQ-jTLEEw" -Configuration "fTKLyvpZsuabGJiRuut40g" `
  -AdminUser "dy3D5Uky_soUveE3TpMLaQ" -Protocol ssh -Connections on -ConnectionsRecording on -ConnectionsOverridePort 22
Connection settings updated for DkPBB1AuaHpt8JQ-jTLEEw

PS > pam-connection-edit -r "DxtvucKwfKCM9YCH1iuTCg" -c "fTKLyvpZsuabGJiRuut40g" `
  -a "q6bWilZxKHjW5F3LySI2wQ" -lu "iqqtWcC146Te5eCXC-Uztw" -p rdp -cn on -cr on -cop 3389

PS > Set-KeeperPamConnection -Record "DkPBB1AuaHpt8JQ-jTLEEw" -ClearLaunchUser -Silent

Python CLI

Command: Coming Soon

Python SDK

Command: Coming Soon