Repository files navigation

Master Branch	Latest Build	CodeFactor	Coverage	PowerShell Gallery	License

Use the native functions of the CyberArk PACLI command line utility translated into PowerShell.

If you are landing here and interested in using PowerShell to automate an aspect of CyberArk,

I recommend investigating mypsPAS module first, to see if you can achieve what you need with the REST API.

• PoShPACLI
  • Usage & Examples
  • PACLI to PoShPACLI Function Relationship
  • Getting Started
    • Prerequisites
    • Installation Options
  • Changelog
  • License
  • Contributing

An identical process to using the PACLI tool on its own should be followed.

• Check therelationship table to determine what PoShPACLI function exposes which PACLI command.

Set-PVConfiguration must be run before using the module for the first time.This function identifies the location of thePACLI.exe utility to the module.

When starting PACLI, defining a vault, & Authenticating, any values provided forSessionID,Vault name &User name are automatically provided to future PoShPACLI commands.

TheGet-PVConfiguration function is used to view the current values in use by the module.

Execute the sequence of commands to complete a required process.

The module provides the the required parameter values to the PACLI executable.

Output can be piped between PoShPACLI functions:

The table shows how the the PoShPACLI module functions relate to their native PACLI counterparts:

• Requires Powershell v5 (minimum)
• The CyberArk PACLI executable must be present on the same computer as the module.
  • PACLI 7.2 was used for development, anything less is considered unsupported for use with this module.
• A CyberArk user with which to authenticate, which has appropriate Vault/Safe permissions.

This repository contains a folder namedPoShPACLI.

The folder and it's contents needs to be present in one of your PowerShell Module Directories.

Use one of the following methods:

Download the module from thePowerShell Gallery.

• PowerShell 5.0 or above required.

From a PowerShell prompt, run:

Install-Module-Name PoShPACLI-Scope CurrentUser

Find your PowerShell Module Paths with the following command:

$env:PSModulePath.split(';')

Download a Release

OR

Download themaster branch

Extract the archive

Copy thePoShPACLI folder to your "Powershell Modules" directory of choice.

Validate Module Exists on your local machine:

Get-Module-ListAvailable PoShPACLI

Import the module:

Import-Module PoShPACLI

List Module Commands:

Get-Command-Module PoShPACLI

Get detailed information on specific commands:

Get-HelpOpen-PVSafe-Full

All notable changes to this project will be documented in theChangelog

• Pete Maan -pspete

This project is licensed under the MIT License - see theLICENSE.md file for details

Any and all contributions to this project are appreciated.See theCONTRIBUTING.md for a few more details.