Microsoft.Dynamics.Nav.Management
The Business Central Administration Shell includes cmdlets for administering the Business Central deployment, such as adding and configuring Business Central Server instances, databases, and users. These cmdlets are included in the Microsoft.Dynamics.Nav.Management module that is installed as part of the Business Central Administration Shell when you install the Business Central Server.
Note
Also included in the Business Central Administration Shell are cmdlets for administering extension packages and Business Central Web Server instances. For more information about these cmdlets, see Microsoft.Dynamics.Nav.Apps.Management and NAVWebClientManagement.
Microsoft.Dynamics.Nav.Management
| Convert-NAVCustomization |
Converts user personalizations in the Business Central database to the latest version. |
| Convert-NAVTenant |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| Copy-NAVCompany |
Creates a new company and copies all data from an existing company in the same tenant database. |
| Copy-NAVTenantData |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| Dismount-NAVTenant |
Dismounts a tenant on the specified Business Central Server instance. All active user sessions that access the tenant will end. |
| Dismount-NAVTenantDatabase |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| Export-NAVApplication |
Extracts the application tables in a Business Central database to a separate database. The new application database is created on the same SQL Server instance as the original database. |
| Export-NAVData |
Exports data from a Business Central database. |
| Export-NAVEncryptionKey |
Exports the encryption key to a file in a specified path on the computer or network. |
| Export-NAVServerLicenseInformation |
Exports license information from the Business Central database. |
| Get-NAVAddIn |
Returns information about add-ins that are registered in the table 2000000069 Add-ins of the Business Central database. |
| Get-NAVApplication |
Gets information about the application database that is mounted against the specified Business Central Server instance. |
| Get-NAVCompany |
Gets a list of the Business Central companies in the specified tenant database. |
| Get-NAVDataFile |
Gets information from a Business Central data file. |
| Get-NAVDataUpgrade |
Gets information about a data upgrade process that is currently running, or the last completed data upgrade process. |
| Get-NAVServerAppConfiguration |
Returns the settings in an application-specific configuration file of a Business Central Server instance. |
| Get-NAVServerConfiguration |
Returns configuration settings for the specified Business Central Server instance. |
| Get-NAVServerInstance |
Gets service details for the specified Business Central Server instance. |
| Get-NAVServerPermission |
Returns information about the permissions that are applied to Business Central objects for the specified Business Central Server instance. |
| Get-NAVServerPermissionSet |
Returns a list of permission sets for the specified Business Central Server instance. |
| Get-NAVServerSession |
Returns information about active sessions for a Business Central Server instance. |
| Get-NAVServerUser |
Returns information about all users created in the current Business Central database. |
| Get-NAVServerUserPermissionSet |
Returns permission set information for Business Central users. |
| Get-NAVTableConnection |
Gets a list of connections to external database tables from a Business Central application. |
| Get-NAVTenant |
Gets the tenants that are mounted against the specified Business Central Server instance. |
| Get-NAVTenantDatabase |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| Get-NAVWebService |
Gets a list of all web services that are created in the application on the specified Business Central Server instance. |
| Import-NAVConfigurationPackageFile |
Imports a configuration package file into the Business Central application database. |
| Import-NAVData |
Imports data from a file that has been exported from a Business Central database. |
| Import-NAVEncryptionKey |
Imports an encryption key from a file to a Business Central Server instance and database in SQL Server. |
| Import-NAVMembershipEntitlement |
Imports the license entitlement data for a membership association. |
| Import-NAVServerLicense |
Imports a license file into a Business Central database. |
| Invoke-NAVApplicationDatabaseConversion |
Performs a technical upgrade of a database from a previous version of Business Central. |
| Invoke-NAVCodeunit |
Invokes the specified codeunit with the specified parameters. |
| Invoke-NAVMemoryManager |
Invokes the CLR memory manager (garbage collector) on the specified Business Central server instance. |
| Invoke-NAVSanitizeField |
Invokes the sanitize field operation on the specified tenant. |
| Mount-NAVApplication |
Mounts the Business Central application against the specified server instance. |
| Mount-NAVTenant |
Mounts a tenant database against the specified Business Central Server instance. |
| Mount-NAVTenantDatabase |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| Move-NAVTenant |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| New-NAVAddIn |
Registers an add-in the system table 2000000069 Add-ins of the Business Central database. |
| New-NAVApplicationDatabase |
Creates a new Business Central application database. |
| New-NAVCompany |
Creates a new Business Central company in the specified database. |
| New-NAVDatabase |
Creates a new Business Central database from a backup file. |
| New-NAVEncryptionKey |
Create an encryption key and stores it in a file in a specified path on the computer or network. |
| New-NAVServerAppConfiguration |
Creates a new application-specific configuration file for the Business Central Server instance. |
| New-NAVServerConfiguration |
Creates a new configuration with default values, or to replace the existing configuration for a Business Central Server instance. |
| New-NAVServerInstance |
Creates a new Business Central Server instance. |
| New-NAVServerPermission |
Adds a permission to a permission set. |
| New-NAVServerPermissionSet |
Creates a new permission set. |
| New-NAVServerUser |
Creates a new Business Central user. |
| New-NAVServerUserPermissionSet |
Assigns a permission set to a Business Central user. |
| New-NAVTableConnection |
Registers a connection to an external database table so the table can be used by the Business Central application. |
| New-NAVTenant |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| New-NAVWebService |
Creates a new Business Central web service. |
| Register-NAVTenant |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| Remove-NAVAddIn |
Removes an add-in that is registered in the system table 2000000069 Add-ins of the Business Central database. |
| Remove-NAVApplication |
Removes the tables that define the application from a Business Central database. When you have removed the application tables from the database, you cannot import them again. Make sure that you have a full backup available. |
| Remove-NAVCompany |
Removes a company from a Business Central database. |
| Remove-NAVConfigurationPackageFile |
Removes a configuration package file from the Business Central app database. |
| Remove-NAVServerInstance |
Removes a Business Central Server instance. |
| Remove-NAVServerPermission |
Removes a permission from a permission set. |
| Remove-NAVServerPermissionSet |
Removes a Business Central permission set. |
| Remove-NAVServerSession |
Closes the specified client connection to a Business Central Server instance. |
| Remove-NAVServerUser |
Deletes a Business Central user. |
| Remove-NAVServerUserPermissionSet |
Removes a permission set from the list of permission sets that are assigned to a Business Central user. |
| Remove-NAVTableConnection |
Removes a connection to an external database table from the Business Central application. |
| Remove-NAVTenant |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| Remove-NAVWebService |
Removes the specified web services from the application that is mounted against the specified Business Central Server instance. |
| Rename-NAVCompany |
Renames a company in a Business Central database. |
| Repair-NAVCustomization |
Repairs UI customizations that are saved in a tenant so that they work with the currently installed base application and extensions. UI customizations include profile customizations and user personalizations. |
| Restart-NAVServerInstance |
Restarts a Business Central Server instance. |
| Resume-NAVDataUpgrade |
Resumes a suspended data upgrade process. |
| Set-NAVAddIn |
Specifies the description, category, resource or resourcefile of an add-in that is registered in the system table 2000000069 Add-ins of the Business Central database. |
| Set-NAVApplication |
Sets the application version or application family fields in the application database connected to the specified Business Central Server instance. |
| Set-NAVCompany |
Changes properties of a Business Central company. |
| Set-NAVServerAppConfiguration |
Specifies a setting in an application-specific configuration file for a Business Central Server instance. |
| Set-NAVServerConfiguration |
Configures settings for a Business Central Server instance. |
| Set-NAVServerInstance |
Changes the service state of a Business Central Server instance. |
| Set-NAVServerPermission |
Changes the values for an existing permission set. |
| Set-NAVServerPermissionSet |
Changes the Name field of a Business Central permission set. |
| Set-NAVServerUser |
Changes the configuration settings of an existing Business Central user. |
| Set-NAVTenant |
Sets the tenant to acquire or release exclusive access. NOTE: This cmdlet also supports shared-schema operations that are for internal use only. These operations can't be used on Business Central on-premises tenants. |
| Start-NAVDatabaseCompression |
Starts the compression of a tenant database. This will compress any tables that do not have an explicit compression level specified to the database default level. |
| Start-NAVDataUpgrade |
Starts the process for upgrading the data in the tenant database. |
| Start-NAVServerInstance |
Starts a Business Central Server instance. |
| Stop-NAVDataUpgrade |
Stops the data upgrade process that is currently running or suspended. |
| Stop-NAVServerInstance |
Stops a Business Central Server instance. |
| Sync-NAVTenant |
Synchronizes a tenant database schema with an application database. |
| Sync-NAVTenantDatabase |
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727. |
| Test-NAVTenantDatabaseSchema |
Checks for any errors in the tenant database schema. |
| Update-NAVScheduledTaskList |
Updates the application-wide list of scheduled tasks with the information from the tenant database. |