PSMPSession

Format an ssh connection command and connect to a target server, using a target account via CyberArk PSMP.

Main Branch	Latest Build	CodeFactor	Coverage	PowerShell Gallery	License

Usage

New-PSMPSession

Local Account Targets

Domain Account Targets

Vault Usernames in UPN Format

Target Usernames in UPN Format

Vault Username and Target Username in UPN Format

Installation

Prerequisites

• PowerShell Core or Powershell v5.1 (minimum).
• SSH Client installed and configured on your PATH
• Target account to connect to a target server through CyberArk PSMP.

Install Options

Use one of the following methods:

Option 1: Install from PowerShell Gallery

PowerShell 5.0 or above must be used

This is the simplest & preferred method for installation of the module.

To install the module from the PowerShell Gallery,
from a PowerShell prompt, run:

Install-Module -Name PSMPSession -Scope CurrentUser

Option 2: Manual Install

You can manually copy the module files to one of your powershell module folders.

Find your PowerShell Module Paths with the following command:

$env:PSModulePath.split(';')

The module files should be placed in a folder named PSMPSession in one of the listed locations.

More: about_PSModulePath

There are multiple options for downloading the module files:

PowerShell Gallery

• Download from the module PowerShell Gallery:
  • Run the PowerShell command Save-Module -Name PSMPSession -Path C:\temp
  • Copy the C:\temp\PSMPSession folder to your "Powershell Modules" directory of choice.

PSMPSession Release

• Download the latest release
  • Unblock & Extract the archive
  • Rename the extracted PSMPSession-v#.#.# folder to PSMPSession
  • Copy the PSMPSession folder to your "Powershell Modules" directory of choice.

PSMPSession Branch

• Download the main branch
  • Unblock & Extract the archive
  • Copy the PSMPSession (\<Archive Root>\PSMPSession-main\PSMPSession) folder to your "Powershell Modules" directory of choice.