Export-NAVEncryptionKey
Exports the encryption key to a file in a specified path on the computer or network.
Syntax
Default (Default)
Export-NAVEncryptionKey
[-KeyPath] <String>
[-Password <SecureString>]
[-ServerInstance] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
When using SQL Server authentication between the Business Central Server instance and database in SQL Server, Business Central encrypts passwords that are used by a Business Central Server instance to access to Business Central databases in SQL Server.This includes, for example, the Business Central Server service account credentials and the database credentials.
To encrypt and decrypt the passwords, an encryption key is used. Business Central uses a single encryption key per server instance. The same encryption must be included in the Business Central database to which the server instance connects.
In some cases, such as when you upgrade or migrate a system from one set of hardware to another, you might need to copy of the encryption key to use it on another Business Central Server instance.
By using the Export-NAVEncryptionKey cmdlet, you can export the encryption key from one Business Central Server instance to a file, and then use the Import-NAVEncryptionKey cmdlet to import the exported key into another Business Central Server instance. The Export-NAVEncryptionKey cmdlet enables you to specify a destination file for the key and specify a password to protect the file.
Examples
EXAMPLE 1
Export-NAVEncryptionKey -ServerInstance BC -KeyPath "C:\Keys\nav.key" -Password (Get-Credential).Password
The example exports an encryption key from a Business Central Server instance to a password protected file.
EXAMPLE 2
Export-NAVEncryptionKey -ServerInstance BC -KeyPath "C:\Keys\nav.key" | Import-NAVEncryptionKey -ServerInstance NewInstance
The example exports an encryption key from a Business Central Server instance, and then imports that key into another Business Central Server instance on the same computer.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
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 |
-KeyPath
Specifies the full path to where the key file will be exported. The full path includes the drive, folders, and file name. The folder path must already exist. The file will be created that has the given file name.
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: | False |
| Value from remaining arguments: | False |
-Password
Specifies a password that protects the encryption key file.
Parameter properties
| Type: | SecureString |
| 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 |
-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 |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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.
Outputs
System.String KeyPath
Returns the value of the KeyPath parameter.