Microsoft Dynamics NAV Windows PowerShell Cmdlets
Microsoft Dynamics NAV 2016 includes Windows PowerShell cmdlets for administration and for development and file management of application object files and extension packages. The cmdlets are available in two Windows PowerShell modules: Microsoft Dynamics NAV 2016 Administration Shell and Microsoft Dynamics NAV 2016 Development Shell.
The Microsoft Dynamics NAV 2016 Administration Shell includes cmdlets for administering the Microsoft Dynamics NAV deployment, such as adding and configuring Microsoft Dynamics NAV server instances, databases, and users. Also included are cmdlets for administering extension packages. The Microsoft Dynamics NAV 2016 Administration Shell is installed with the Microsoft Dynamics NAV Server.
The Microsoft Dynamics NAV 2016 Development Shell includes cmdlets for merging and modifying application object files. Also included are cmdlets for creating extension packages. The Microsoft Dynamics NAV 2016 Development Shell is installed with the Microsoft Dynamics NAV Development Environment.
The cmdlets are implemented in Windows PowerShell 3.0, which is included with Windows Server 2012 and Windows 8 and later. For other versions of Windows supported for Microsoft Dynamics NAV 2016, you can install it as part of the Windows Management Framework 3.0 on the Microsoft Download Center.
Note
Alternatively to running Microsoft Dynamics NAV 2016 Administration Shell and Microsoft Dynamics NAV 2016 Development Shell from where they are installed, you can import the relevant module into the Windows PowerShell Integrated Scripting Environment (ISE).
Starting a Microsoft Dynamics NAV 2016 Administration Shell Session
You must run the Microsoft Dynamics NAV 2016 Administration Shell as an Administrator. On the computer that is running Microsoft Dynamics NAV Server, choose Start, in the Search box, type Microsoft Dynamics NAV 2016 Administration Shell, right-click the related link, and then choose Run as Administrator.
Important
To run the cmdlets in the Microsoft Dynamics NAV 2016 Administration Shell, you must be a member of the local Administrator group on the computer where the Microsoft Dynamics NAV 2016 Administration Shell is installed.
Starting a Microsoft Dynamics NAV 2016 Development Shell Session
On the computer that is running Microsoft Dynamics NAV Development Environment, choose Start, in the Search box, type Microsoft Dynamics NAV 2016 Development Shell, and then choose the related link.
Getting Help on Microsoft Dynamics NAV Cmdlets
To see the cmdlets that are available for Microsoft Dynamics NAV, type the following at the Windows PowerShell prompt.
Get-Command *NAV*
To get Help about syntax and options for a specific cmdlet, type the following cmdlet.
Get-Help <cmd name>
For example, to get Help about the Get-NAVServerInstance cmdlet, type the following.
Get-Help Get-NAVServerInstance
To get online Help in the MSDN Library for a specific cmdlet, type the following cmdlet.
Get-Help <cmd name> -online
For more information about Microsoft Dynamics NAV 2016 Administration Shell cmdlets, see Administration Cmdlets for Microsoft Dynamics NAV and Administration Cmdlets for Microsoft Dynamics NAV Extensions.
For more information about Microsoft Dynamics NAV 2016 Development Shell cmdlets, see Development Cmdlets for Microsoft Dynamics NAV and Development Cmdlets for Microsoft Dynamics NAV Extensions.
For more information about Windows PowerShell, see Windows PowerShell Getting Started Guide.
See Also
Concepts
Sample Windows PowerShell Scripts for Microsoft Dynamics NAV
Administration
Comparing and Merging Application Object Source Files
Other Resources
Administration Cmdlets for Microsoft Dynamics NAV
Development Cmdlets for Microsoft Dynamics NAV
Development Cmdlets for Microsoft Dynamics NAV Extensions
Administration Cmdlets for Microsoft Dynamics NAV Extensions