Edit

Share via

Install-WssAddIn

  • Reference
Module:
WSSCmdlets

Installs or redeploys an add-in package.

Syntax

Install-WssAddIn
       [-Force]
       [-InstallOnClients]
       [-PackagePath] <String>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Install-WssAddIn
       [-Force]
       [-Id] <Guid>
       [-Redeploy]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Install-WssAddIn cmdlet installs a new add-in or redeploys an installed add-in. To install an add-in, specify the path of a package file. To redeploy an add-in, specify the Id of the alert.

Examples

Example 1: Install an add-in package

PS C:\> Install-WssAddIn -PackagePath "c:\TSQAaddin.wssx"

This command installs the add-in from the add-in package named TSQAaddin.wssx.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies the GUID for an installed package. The cmdlet redeploys the add-ins for this package.

Type:Guid
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InstallOnClients

Indicates that cmdlet deploys the add-in to clients.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PackagePath

Specifies the absolute path of the add-in package file (.wssx).

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Redeploy

Indicates that the cmdlet redeploys an add-in. If you specify this parameter, specify the PackagePath parameter.

Type:SwitchParameter
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.WindowsServerSolutions.AddinInfrastructure.PackageInfo

This cmdlet generates package information about the installed add-in.