Import-NAVConfigurationPackageFile
Imports a configuration package file into the Business Central application database.
Syntax
Default (Default)
Import-NAVConfigurationPackageFile
[-Path] <String>
[[-SetupType] <String>]
[[-ProcessingOrder] <Int32>]
[-ServerInstance] <String>
[-Force]
[-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Path
Specifies the folder path and file name to the configuration package file. These files typically have a .rapidstart extension.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ProcessingOrder
Specifies the order in which the configuration packages will be processed.
Parameter properties
| Type: | Int32 |
| Default value: | 0 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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 -
Parameter properties
| Type: | String |
| Default value: | Company |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.