Sets the environment into maintenance mode

Enable-D365MaintenanceMode [[-MetaDataDir] <String>] [[-BinDir] <String>] [[-DatabaseServer] <String>]
 [[-DatabaseName] <String>] [[-SqlUser] <String>] [[-SqlPwd] <String>] [[-LogPath] <String>]
 [-ShowOriginalProgress] [-OutputCommandOnly] [<CommonParameters>]

Sets the Dynamics 365 environment into maintenance mode to enable the user to update the license configuration

Enable-D365MaintenanceMode

On VHD based environments, this will execute the Microsoft.Dynamics.AX.Deployment.Setup.exe with the default values that was pulled from the environment and put the environment into the maintenance mode. On cloud hosted environments, a SQL script is used instead.

Enable-D365MaintenanceMode -ShowOriginalProgress

On VHD based environments, this will execute the Microsoft.Dynamics.AX.Deployment.Setup.exe with the default values that was pulled from the environment and put the environment into the maintenance mode. On cloud hosted environments, a SQL script is used instead. The output from stopping the services will be written to the console / host. The output from the "deployment" process will be written to the console / host. The output from starting the services will be written to the console / host.

The path to the meta data directory for the environment

Default path is the same as the aos service PackagesLocalDirectory

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: "$Script:MetaDataDir"
Accept pipeline input: False
Accept wildcard characters: False

The path to the bin directory for the environment

Default path is the same as the aos service PackagesLocalDirectory\bin

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: "$Script:BinDir"
Accept pipeline input: False
Accept wildcard characters: False

The name of the database server

If on-premises or classic SQL Server, use either short name og Fully Qualified Domain Name (FQDN).

If Azure use the full address to the database server, e.g. server.database.windows.net

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: $Script:DatabaseServer
Accept pipeline input: False
Accept wildcard characters: False

The name of the database

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: $Script:DatabaseName
Accept pipeline input: False
Accept wildcard characters: False

The login name for the SQL Server instance

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: $Script:DatabaseUserName
Accept pipeline input: False
Accept wildcard characters: False

The password for the SQL Server user

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: $Script:DatabaseUserPassword
Accept pipeline input: False
Accept wildcard characters: False

The path where the log file(s) will be saved

When running without the ShowOriginalProgress parameter, the log files will be the standard output and the error output from the underlying tool executed

Type: String
Parameter Sets: (All)
Aliases: LogDir

Required: False
Position: 7
Default value: $(Join-Path -Path $Script:DefaultTempPath -ChildPath "Logs\MaintenanceMode")
Accept pipeline input: False
Accept wildcard characters: False

Instruct the cmdlet to show the standard output in the console

Default is $false which will silence the standard output

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Instruct the cmdlet to only output the command that you would have to execute by hand

Will include full path to the executable or SQL script and the needed parameters based on your selection

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Tags: MaintenanceMode, Maintenance, License, Configuration, Servicing

Author: Mötz Jensen (@splaxi) Author: Tommy Skaue (@skaue)

On VHD based environments with administrator privileges: The cmdlet wraps the execution of Microsoft.Dynamics.AX.Deployment.Setup.exe and parses the parameters needed.

Without administrator privileges or on cloud hosted environments: Will stop all services, execute a SQL script and starts the AOS service (other services are not needed during maintenance mode).

Get-D365MaintenanceMode

Disable-D365MaintenanceMode