AXUpdate command line parameters reference

  • Article

Important

This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

When you run the AXUpdate.exe, by default it runs the Update Setup Wizard. This wizard has a graphical user interface (GUI) that prompts you for required information. You can also run AXUpdate.exe at a command prompt, in silent mode. When AXUpdate.exe runs in silent mode, there is no GUI. Instead, you must supply all the required information at the command prompt when you start AXUpdate.exe.

The following command-line parameters can be used to install updates.

Parameter

Description

AcceptLicenseTerms

Specify whether you accept the terms of the license agreement.

  • 1 – Accept the license terms.

  • 0 – Do not accept the license terms.

If the HideUI parameter is set to 0, the License terms page is displayed, regardless of the setting of AcceptLicenseTerms.

If HideUI is set to 1, AcceptLicenseTerms must be set to 1. If AcceptLicenseTerms is set to 0, you receive an error message, and the installation stops.

AosInstanceName

Specify the name of the instance of Application Object Server (AOS) to update. To update multiple AOS instances, enter a semicolon-delimited list. If this parameter is not included, all AOS instances are updated.

AosStart

Specify whether the AOS instances are restarted after the update is applied.

  • 0 – Do not restart the AOS instances.

  • 1 – Restart the AOS instances. This is the default setting.

HideUI

Specify whether the UI for the installer is displayed.

  • 0 – Show the wizard. This is the default setting.

  • 1 – Hide the wizard, and run in silent mode.

If HideUI is set to 1, the AcceptLicenseTerms parameter must be set to 1. Otherwise, you receive an error message, and the installation stops.

InstallAos

Specify whether updates for the AOS instances are installed.

  • 0 – Do not install updates for AOS. This is the default setting.

  • 1 – Install updates for AOS.

If the AosInstanceName parameter is not included, all AOS instances are updated.

InstallClientOBA

Specify whether updates for the Microsoft Dynamics AX client and the Microsoft Office Add-ins are installed.

  • 0 – Do not install updates for the client and the Office Add-ins. This is the default setting.

  • 1 – Install updates for the client and the Office Add-ins.

InstallComponents

Specify whether updates for all other components are installed.

  • 0 – Do not install updates for other components. This is the default setting.

  • 1 – Install updates for other components.

InstallHelpServer

Specify whether updates for Help Server are installed.

  • 0 – Do not install updates for Help Server. This is the default setting.

  • 1 – Install updates for Help Server.

InstallModelDatabase

Specify whether updates for the model store database are installed.

  • 0 – Do not install updates for the model store database. This is the default setting.

  • 1 – Install updates for the model store database.

InstallSetupSupport

Specify whether updates for Setup Support are installed.

  • 0 – Do not install updates for Setup Support. This is the default setting.

  • 1 – Install updates for Setup Support.

InstallTraceParser

Specify whether updates for Trace Parser are installed.

  • 0 – Do not install updates for Trace Parser. This is the default setting.

  • 1 – Install updates for Trace Parser.

LogDir

Specify where the log files for AXUpdate.exe are saved.

By default, the following path is used:

%ALLUSERSPROFILE%\Microsoft\Dynamics AX\Dynamics AX Setup Logs\

Note

When log files are saved to the default location, they are arranged in dated folders to protect existing log files from being overwritten. If you override the default value for LogDir, the logs are saved to the exact folder that you specify. Any log files that are already located in that folder are overwritten.

The path can be fully qualified, or it can be relative to the location of the AXUpdate.exe file. Relative paths can include upward qualifiers, such as "..\..\".

ModelDatabaseInstanceName

Specify the name of the model store database to update. To update multiple model store databases, enter a semicolon-delimited list.

If this parameter is not included, all model store databases from the server configurations for the local AOS instances are updated.

See also

Run AXUpdate in silent mode