Edit

Business Central Administration Shell

  • Article

The Business Central Administration Shell includes PowerShell cmdlets for administering Business Central on-premises deployments. You use it for configuring Business Central Server and Web server instances, databases, users, and more. You also use it to manage extensions, like publishing, syncing, installing and upgrading.

Install the Business Central Administration Shell

The Business Central Administration Shell is installed together with Business Central Server components by using the Business Central Setup wizard. To install it, run the setup.exe that's available on the installation media (DVD). Follow the wizard, and choose either the Install Demo option or the Server option in the customized setup. For more information, see Install Using Setup.

Run the Business Central Administration Shell

To run the shell, you have to be a member of the local administrator group on the computer. There are a couple ways to run the shell.

  • One way is from the Start menu or Search on your desktop. Select Start or Search, type Business Central Administration Shell, right-click it, then select Run as administrator.

  • Another way is from Windows PowerShell. Start Windows PowerShell as an administrator. At the prompt, run the following command:

    Import-Module -Name C:\Program Files\Microsoft Dynamics 365 Business Central\nnn\Service\navadmintool.ps1

    Replace C:\Program Files\Microsoft Dynamics 365 Business Central\nnn with the path to your server installation.

Get help on the cmdlets

To see the cmdlets that are available, type the following command at the prompt:

Get-Command *NAV*

To get help about syntax and options for a specific cmdlet, type the following command:

Get-Help <cmd name> -full

For example, to get Help about the Get-NAVServerInstance cmdlet, type the following command.

Get-Help Get-NAVServerInstance -full

To go the online version of the help on Microsoft Docs, type the following command:

Get-Help <cmd name> -online

Learn more

For more information about Business Central Administration Shell cmdlets, see Administration Cmdlets .

For more information about Windows PowerShell, see Windows PowerShell Getting Started Guide.

See Also

Configuring Business Central Server Instances
Configuring Business Central Web Server Instances
Publish and Install Extenstions