How to load the Windows PowerShell cmdlets and get cmdlet help

This article provides more information about how to use the Windows PowerShell cmdlets for App-V.

Requirements for using PowerShell cmdlets

Review the following requirements for using the App-V PowerShell cmdlets:

Users can run App-V Server cmdlets only if you grant them access by using one of the following methods

Cmdlets that require an elevated command prompt

  • Add-AppvClientPackage
  • Remove-AppvClientPackage
  • Set-AppvClientConfiguration
  • Add-AppvClientConnectionGroup
  • Remove-AppvClientConnectionGroup
  • Add-AppvPublishingServer
  • Remove-AppvPublishingServer
  • Send-AppvClientReport
  • Set-AppvClientMode
  • Set-AppvClientPackage
  • Set-AppvPublishingServer

Cmdlets that end users can run, unless you configure them to require an elevated command prompt

  • Publish-AppvClientPackage
  • Unpublish-AppvClientPackage

To configure these cmdlets to require an elevated command prompt, use one of the following methods:

Loading the PowerShell cmdlets

To load the PowerShell cmdlet modules:

  1. Open Windows PowerShell or Windows PowerShell Integrated Scripting Environment (ISE).

  2. Type one of the following commands to load the cmdlets for the module you want:

App-V component Command to type
App-V Server Import-Module AppvServer
App-V Sequencer Import-Module AppvSequencer
App-V Client Import-Module AppvClient

Getting help for the PowerShell cmdlets

Starting in App-V 5.0 SP3, cmdlet help is available in two formats:

As a downloadable module

To download the latest help after downloading the cmdlet module:

  1. Open Windows PowerShell or Windows PowerShell Integrated Scripting Environment (ISE).

  2. Type one of the following commands to load the cmdlets for the module you want:

    App-V component Command to type
    App-V Server Update-Help -Module AppvServer
    App-V Sequencer Update-Help -Module AppvSequencer
    App-V Client Update-Help -Module AppvClient

On the web

App-V component Module documentation
App-V Server AppvServer
App-V Sequencer AppvSequencer
App-V Client AppvClient

Displaying the help for a PowerShell cmdlet

To display help for a specific PowerShell cmdlet:

  1. Open Windows PowerShell or Windows PowerShell Integrated Scripting Environment (ISE).

  2. Type Get-Help <cmdlet>, for example, Get-Help Publish-AppvClientPackage.