Install-NAVApp
Install-NAVApp
Installs a Microsoft Dynamics NAV extension for a tenant in the specified Microsoft Dynamics NAV deployment.
Syntax
Parameter Set: Path
Install-NAVApp [-ServerInstance] <String> -Path <String> [-DoNotLoadData] [-Force] [-PassThru] [-Tenant <TenantId> ] [ <CommonParameters>]
Parameter Set: Properties
Install-NAVApp [-ServerInstance] <String> -Name <String> [-DoNotLoadData] [-Force] [-PassThru] [-Publisher <String> ] [-Tenant <TenantId> ] [-Version <Version> ] [ <CommonParameters>]
Detailed Description
Use the Install-NAVApp cmdlet to install an already published extension for a tenant in a Microsoft Dynamics NAV deployment.
Parameters
-DoNotLoadData
Specifies that the installation must run without loading any data that was saved from an earlier installation of the extension.
When an extension is uninstalled, data can be saved and then imported when the extension is installed again. Set this parameter if you do not want to import data from an earlier installation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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 |
-Name<String>
Specifies the name of the extension that you want to install. The results must return only one extension; otherwise nothing installs.
Aliases |
AppName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. The object contains the properties of the extension, such as name, publisher, and version.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies the path to an extension package file that you want to install for the tenant. The extension must already have been published to the server instance before you can install it for the tenant.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Publisher<String>
Specifies the publisher of the extension that you want to install. The results must return only one extension; otherwise nothing installs.
Aliases |
AppPublisher |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServerInstance<String>
Specifies the Microsoft Dynamics NAV Server instance that the extension is published to, such as DynamicsNAV90.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Tenant<TenantId>
Specifies the ID of the tenant that you want to install the extension for, such as Tenant1.
If the specified Microsoft Dynamics NAV Server instance is not multitenant, you can specify the value default; otherwise, do not set the parameter.
Aliases |
Id |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Version<Version>
Specifies the version of the extension that you want to install. The results must return only one extension; otherwise nothing installs.
Aliases |
AppVersion |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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 --------------------------
Description
-----------
This example installs the Microsoft Dynamics NAV extension with the specified name and version for the tenant with the ID Tenant1. If the extension includes a database schema change, the tenant database is automatically synchronized.
PS C:\>
Install-NAVApp -ServerInstance DynamicsNAV90 -Name 'Proseware SmartStuff' -Version 2.3.4.500 -Tenant 'Tenant1'
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This example installs an extension that is returned from the Get-NAVAppInfo cmdlet for the tenant with the ID Tenant1. If the extension contains a database schema change, the tenant database is automatically synchronized.
PS C:\>
Get-NAVAppInfo -ServerInstance DynamicsNAV90 -Name 'Proseware SmartStuff' -Version 2.3.4.500 | Install-NAVApp -Tenant 'Tenant1'
-------------------------- EXAMPLE 3 --------------------------
Description
-----------
This example installs an extension at the specified path for the tenant with the ID Tenant1. The extension must already have been published to the server instance before you can install it for the tenant. If the extension contains a database schema change, the tenant database is automatically synchronized.
PS C:\>
Install-NAVApp -ServerInstance DynamicsNAV90 -Path '.\Proseware SmartStuff.navx' -Tenant 'Tenant1'
-------------------------- EXAMPLE 4 --------------------------
Description
-----------
This example installs the extension with the provided name and version for the tenant with the ID Tenant1. If the extension contains a schema change, the tenant database will be synchronized. However, because the -DoNotLoadData switch is set, any data that was backed up from a previous uninstall of this extension will not be loaded.
PS C:\> Install-NAVApp -ServerInstance DynamicsNAV90 -Name 'Proseware SmartStuff' -Version 2.3.4.500 -Tenant 'Tenant1' -DoNotLoadData
-------------------------- EXAMPLE 5 --------------------------
Description
-----------
This example installs the extension with the specified name and version on a Microsoft Dynamics NAV Server instance that is not used in a multitenant deployment. If the extension contains a schema change, the database is synchronized.
PS C:\> Install-NAVApp -ServerInstance DynamicsNAV90 -Name 'Proseware SmartApp' -Version 2.3.4.500
-------------------------- EXAMPLE 6 --------------------------
Description
-----------
This example installs the extension with the specified name and version to all tenants of the DynamicsNAV90 server instance.
PS C:\> Get-NAVTenant -ServerInstance DynamicsNAV90 | Install-NAVApp -ServerInstance DynamicsNAV90 -Name 'Proseware SmartStuff' -Version 2.3.4.500