/VaultControl

Invoke CyberArk PARClient.exe Utility with PowerShell

Primary LanguagePowerShellMIT LicenseMIT

VaultControl

Master Branch Latest Build CodeFactor Coverage PowerShell Gallery License
appveyor tests codefactor codecov psgallery license
coveralls downloads

Invoke CyberArk PARClient.exe Utility Commands with PowerShell

Getting Started

  • import-module VaultControl
  • Run Set-PARConfiguration to set the path to the PARClient.exe utility on your computer, and any non-default port used for PARClient operations.

List of Commands

  • Get-PARServer - Gets resource and component information from a vault
  • Get-PARComponent - Gets vault component status
  • Get-PARComponentLog - Gets component log content
  • Get-PARComponentConfig - Gets DBParm/PADR parameter values
  • Get-PARServerLog - Gets OS event logs from vault server
  • Get-PARService - Gets status of monitored Operating System services
  • Restart-PARComponent - Restarts CyberArk Vault/PADR/ENE/CVM component
  • Restart-PARServer - Initiates reboot of Vault server
  • Set-PARComponentConfig - Updates DBParm/PADR parameter values
  • Start-PARComponent - Starts CyberArk Vault/PADR/ENE/CVM component
  • Stop-PARComponent - Stops CyberArk Vault/PADR/ENE/CVM component
  • Set-PARConfiguration - Sets default values for path to PARClient.exe & PARClient Port

Installation

Prerequisites

  • Requires Powershell v3 (minimum)
  • CyberArk PARClient.exe utility
  • CyberArk Vault/PADR/ENE with which to interact

Install Options

This repository contains a folder named VaultControl.

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

Use one of the following methods:

Option 1: Install from PowerShell Gallery

Download the module from the PowerShell Gallery.

  • PowerShell 5.0 or above required.

From a PowerShell prompt, run:

Install-Module -Name VaultControl -Scope CurrentUser

Option 2: Manual Install

Find your PowerShell Module Paths with the following command:

$env:PSModulePath.split(';')

Download a Release or the master branch

Extract the archive

Copy the VaultControl folder to your "Powershell Modules" directory of choice.

Changelog

All notable changes to this project will be documented in the Changelog

Author

License

This project is licensed under the MIT License.

Contributing

Feedback, Issues and Pull Requests are encouraged.