Share via

Import-NAVConfigurationPackageFile

  • Reference
Module:
Microsoft.BusinessCentral.Management

Imports a configuration package file into the Business Central application database.

Syntax

Import-NAVConfigurationPackageFile
      [-Path] <String>
      [[-SetupType] <String>]
      [[-ProcessingOrder] <Int32>]
      [-ServerInstance] <String>
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Import-NAVConfigurationPackageFile cmdlet enables you to take a configuration package file and import it into the application database of Business Central. After the package is imported it available to all tenants. From the Business Central client, you can then apply the package to specific new customers.

Set the -Force parameter to overwrite an existing package.

Examples

EXAMPLE 1

Import-NAVConfigurationPackageFile -Path C:\Documents\NAV9.00.W1.ENU.TRIAL.rapidstart -ServerInstance 'MyCompNAV'

None

This example imports the configuration package file that is called NAV9.00.W1.ENU.TRIAL.rapidstart. The file is located in the C:\Documents folder. It imports the contents as a Company setup type configuration package into the application database of the Business Central Server instance MyCompNAV.

EXAMPLE 2

Get-NAVServerInstance | Import-NAVConfigurationPackageFile -Path MyPack.rapidstart -Type Other

Gets a list of all Business Central Server instances on the computer, then takes the MyPack.rapidstart file from the current directory and imports it into the application databases on the server instance. The configuration package is imported as a type Other.

Parameters

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
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

-Path

Specifies the folder path and file name to the configuration package file. These files typically have a .rapidstart extension.

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

-ProcessingOrder

Specifies the order in which the configuration packages will be processed.

Type:Int32
Position:3
Default value:0
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProgressAction

A common PowerShell parameter that determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider. Learn more.

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Specifies the name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name such as myinstance.

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

-SetupType

Specifies the setup type or purpose of the configuration package file. You can set this parameter to one of the following values:

Company - Application - Other -

Type:String
Position:2
Default value:Company
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

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