Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ To set up an environment to run Mendix applications, you will need to install th

Before starting this how-to, make sure you have the following prerequisites:

* MS Windows Server 2012 or higher
* MS Windows Server 2016 or above
* The Mendix Service Console will run and deploy a Mendix app on the [minimum hardware requirements for MS Windows Server 2012](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/jj134246(v=ws.11)#system-requirements). However, you may need to increase the specifications depending on the functionality of your app. Although not directly comparable, see the [Cloud Resource Packs](/developerportal/deploy/mendix-cloud-deploy/#resource-pack) used when deploying to Mendix Cloud for comparative information.
* .NET Framework 4.7.2 or higher
* .NET Framework 10 LTS or above
* IIS 8 or higher with the following service roles enabled:

* IIS Management console
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Before starting this how-to, make sure you complete the following prerequisites:

* Manually deploy your Mendix app and ensure that there are no errors during the deployment. For more information, see [Microsoft Windows](/developerportal/deploy/deploy-mendix-on-microsoft-windows/).
* Ensure that your Windows PowerShell version is 5.1. Other versions are currently not supported.
* Ensure that your Mendix Service Console version is 4.7.4 or above.
* To run powershell cmdlets on Mendix Service Console 4.9.0 and above, ensure that your Windows PowerShell version is [7.6.5](https://github.com/PowerShell/PowerShell/releases/download/v7.6.5/PowerShell-7.6.5-win-x64.msi).
* Familiarize yourself with the update process for Mendix apps running on Windows. For more information, see [MS Windows: Update a Mendix App](/developerportal/deploy/updating-a-mendix-application/).

## Importing Mendix-Specific Cmdlets into Windows PowerShell {#powershell}
Expand Down Expand Up @@ -113,6 +113,14 @@ The `AdminPassword` parameter to the Start-MxApp cmdlet sets the administrator p
Start-MxApp $appName -AdminPassword "Abcd@1234"
```

#### `CreateDatabase`

The `CreateDatabase` parameter to the Start-MxApp cmdlet creates database for a Mendix app if does not exists.

```text
Start-MxApp $appName -CreateDatabase -SynchronizeDatabase
```

### Sample Script - Determine the Mendix Runtime Version

The following script demonstrates how you can check which version of the Mendix Runtime is required for your app. It inspects a deployment package, finds the Mendix Runtime version it needs, and downloads the correct version.
Expand Down Expand Up @@ -222,6 +230,19 @@ $app = Start-MxApp "MyAppName" -NoService -SynchronizeDatabase
Write-Host "Server ID: $($app.ServerId)"
```

### Sample Script - Get Runtime Status and App Health Status

The `Start-MxApp` cmdlet retrieves the runtime status and app health status when starting a Mendix app. The following script example demonstrates the process required to retrieve `RuntimeStatus` and `AppHealth`.

```text
# Start the Mendix app and get runtime status and app health status
$app = Start-MxApp "MyAppName" -NoService -SynchronizeDatabase

# Display the runtime status and app health status
Write-Host "Runtime Status: $($app.RuntimeStatus)"
Write-Host "App Health Status: $($app.AppHealth)"
```

## Troubleshooting

If you encounter any issues while automating Mendix deployment on Windows using cmdlets, use the following troubleshooting tips to help you solve them.
Expand Down
Loading