Install-WssAddIn
Install-WssAddIn
Installs or redeploys an add-in package.
Syntax
Parameter Set: InstallParamSet
Install-WssAddIn [-PackagePath] <String> [-Force] [-InstallOnClients] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RedeployParamSet
Install-WssAddIn [-Redeploy] [-Id] <Guid> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Id<Guid>
Specifies the GUID for an installed package. The cmdlet redeploys the add-ins for this package.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InstallOnClients
Indicates that cmdlet deploys the add-in to clients.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PackagePath<String>
Specifies the absolute path of the add-in package file (.wssx).
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-Redeploy
Indicates that the cmdlet redeploys an add-in. If you specify this parameter, specify the PackagePath parameter.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Install an add-in package
This command installs the add-in from the add-in package named TSQAaddin.wssx.
PS C:\> Install-WssAddIn -PackagePath "c:\TSQAaddin.wssx"