Privilege Management Powershell API Reference Guide

The Privilege Management for Windows PowerShell API enables you to configure Privilege Management for Windows using PowerShell. This enables integrations with external systems and provides an alternative to using the Privilege Management Policy Editor.

All operations available using the Privilege Management Policy Editor are also available using the PowerShell API. Syntax help is available via the module by using Get-Help <cmdlet name>.

The types properties and values you will be working with are documented in the automatically generated file PowerShell API.chm, which resides in the PowerShell directory. This is usually located at C:/Program Files/Avecto/Privilege Guard Client/PowerShell.

 

In order to maintain backwards compatibility, the PowerShell cmdlets have not been renamed along with the product. Therefore, many of the objects and cmdlets reference the former product name Defendpoint.

The examples in this guide will show you how to retrieve, update, and save an existing configuration file.

The typical workflow for using the PowerShellAPI is:

  • Get-DefendpointSettings.
  • Find the relevant section of the config you want to work with.
  • Update, add, or delete the information.
  • Set-DefendpointSettings.

Prerequisites

Before running any other cmdlets, run the following two commands to initialize the cmdlets:

Import-Module 'C:/Program Files/Avecto/Privilege Guard Client/PowerShell/Avecto.Defendpoint.Cmdlets/Avecto.Defendpoint.Cmdlets.dll'
Import-Module 'C:/Program Files/Avecto/Privilege Guard Client/PowerShell/Avecto.Defendpoint.Cmdlets/Avecto.Defendpoint.Settings.dll'