windows-itpro-docs/windows/application-management/app-v/appv-load-the-powershell-cmdlets-and-get-cmdlet-help.md
2018-08-08 16:02:55 -07:00

8.0 KiB
Raw Blame History

title, description, author, ms.pagetype, ms.mktglfcycl, ms.sitesec, ms.prod, ms.date
title description author ms.pagetype ms.mktglfcycl ms.sitesec ms.prod ms.date
How to Load the Windows PowerShell Cmdlets for App-V and Get Cmdlet Help (Windows 10) How to Load the Windows PowerShell Cmdlets for App-V and Get Cmdlet Help MaggiePucciEvans mdop, appcompat, virtualization deploy library w10 04/19/2017

How to load the Windows PowerShell cmdlets for App-V and get cmdlet help

Applies to: Windows 10, version 1607

Requirements for using Windows PowerShell cmdlets

Review the following requirements for using the Windows PowerShell cmdlets:

Requirement Details
Requirement Details

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

  • When you are deploying and configuring the App-V Server:

    Specify an Active Directory group or individual user that has permissions to manage the App-V environment. See [How to Deploy the App-V Server](appv-deploy-the-appv-server.md).

  • After youve deployed the App-V Server:

    Use the App-V Management console to add an additional Active Directory group or user. See [How to Add or Remove an Administrator by Using the Management Console](appv-add-or-remove-an-administrator-with-the-management-console.md).

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:

  • Run the Set-AppvClientConfiguration cmdlet with the -RequirePublishAsAdmin parameter.

    For more information, see:
    [How to Manage Connection Groups on a Stand-alone Computer by Using Windows PowerShell](appv-manage-connection-groups-on-a-stand-alone-computer-with-powershell.md)
    [How to Manage App-V Packages Running on a Stand-Alone Computer by Using Windows PowerShell](appv-manage-appv-packages-running-on-a-stand-alone-computer-with-powershell.md#bkmk-admins-pub-pkgs).

  • Enable the “Require publish as administrator” Group Policy setting for App-V Clients.

    For more information, see [How to Publish a Package by Using the Management Console](appv-publish-a-packages-with-the-management-console.md)

Alt:

This section will tell you what you'll need to use the PowerShell cmdlets.

How to let users use cmdlets

You can grant your users access to PowerShell cmdlets through one of the following methods:

Elevated command prompt

You'll need an elevated command prompt to run the following cmdlets:

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

Other cmdlets

The following cmdlets are ones 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 Windows PowerShell cmdlets

To load the Windows 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 Windows 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, open Windows PowerShell or Windows PowerShell Integrated Scripting Environment (ISE), and type one of the following commands:
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


Displaying the help for a Windows PowerShell cmdlet

To display help for a specific Windows PowerShell cmdlet:

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

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

Have a suggestion for App-V?

Add or vote on suggestions on the Application Virtualization feedback site.
For App-V issues, use the App-V TechNet Forum.