---
title: "Host Template: Application - Microsoft Exchange - Mailflow"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/application-microsoft-exchange-agentless-opspack/application-microsoft-exchange-mailflow-host-template/index.html"
---## Overview

Monitor the mailflow status of your Microsoft Exchange server with a variery of checks including message latency, SMTP connectivity status, message counts, failure rates and back pressure status.

This Host Template includes the following Service Checks:

| Service&nbsp;Check&nbsp;Name | Description | Default&nbsp;Thresholds (Metric:&nbsp;Warning,&nbsp;Critical) | UOM |
|:-----------------------------|:------------|:------------------------------------------------:|:---:|
| Exchange - Mailflow - Status | Check that mail can be successfully sent from and delivered to the system mailbox. | N/A | N/A |
| Exchange - Mailflow - Message Latency | Check the mail message latency for a successfully sent and delivered message to the system mailbox. | N/A | s |
| Exchange - Mailflow - SMTP Connectivity Status | Check whether an SMTP connection can successfully be established to the Receive connectors on a specific server. | N/A | N/A |
| Exchange - Mailflow - SMTP Message Count | Shows the number of messages sent/received by the SMTP server each second. Determines current load. Compare values to historical baselines. | N/A | N/A |
| Exchange - Mailflow - Mailbox Server Failure Rate | Shows the percentage of connectivity related failures between this Client Access Server and MBX servers over the last 200 samples. If not run with verbose mode, results will be truncated and summarised. | failure_rate: &#8203;`0`,`10` | % |
| Exchange - Mailflow - Mailbox Queue | Shows the number of messages in the given mailbox queue. Supports mutliple Queue variables. | N/A | N/A |
| Exchange - Mailflow - Back Pressure Status | Monitors the following resources:
- DatabaseUsedSpace: Hard drive utilization for the drive that holds the message queue database.
- PrivateBytes: The memory that's used by the EdgeTransport.exe process.
- QueueLength: The number of messages in the Submission queue.
- SystemMemory: The memory that's used by all other processes.
- UsedDiskSpace: Hard drive utilization for the drive that holds the message queue database transaction logs.
- UsedDiskSpace: Hard drive utilization for the drive that's used for content conversion.
- UsedVersionBuckets: The number of uncommitted message queue database transactions that exist in memory. | N/A | N/A |


**Note**


See details about [Monitoring Plugin thresholds here](https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT).



## Usage Instructions

Please review the overall [Application - Microsoft Exchange Agentless Opspack](https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/application-microsoft-exchange-agentless-opspack/application-microsoft-exchange-agentless-opspack/index.html) documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

### Add this Host Template

Add the **Application - Microsoft Exchange - Mailflow** Host Template to your Opsview Monitor host.
If the resource you're monitoring has no hostname or public IP, then open the **Advanced** settings pane and change **Host Check Command** to **Always assumed to be UP**.


**Note**


For more information, refer to the documentation on [Adding Host Templates to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/host/index.html#host-templates).



### Add and configure Variables

The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:

- [**WINRM_TRANSPORT**](#winrm_transport)
- [**MS_EXCHANGE_QUEUE_NAME**](#ms_exchange_queue_name)


**Note**


For more information, refer to the documentation on [Adding Variables to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/adding-a-new-variable/index.html#adding-a-variable-to-a-host).



### Apply Changes

Apply Changes and the system will now be monitored:

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-application-microsoft-exchange-agentless-output-application-microsoft-exchange-mailflow.png)

## Additional Information

Ensure you have set the Primary Hostname/IP field of your Opsview Host to the hostname or IP address of your exchange server.

## Available Variables

### WINRM_TRANSPORT

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `-Transport` | Value | Authentication Type | Authentication type to use |
| `-Username` | Arg1 | Username | Username for remote windows host |
| `-Password` | Arg2 | Password | Password for remote windows host |
| `-Scheme` | Arg3 | Scheme | Scheme for connecting to remote windows host |
| N/A | Arg4 | Extra Args | Extra args for check_by_winrm. The value is appended to the check_by_winrm call. |

### MS_EXCHANGE_QUEUE_NAME

For Service Checks using the Queue parameter, giving this argument a value of '`.`' (period character, no quotes) will run the check across all available queues.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `-Queue` | Value | MS Exchange Queue Name | Mailbox queue to monitor |

## Plugin help

Plugin: `check_microsoft_exchange`


**Secure Args**


This plugin uses the [Secure Args](https://docs.itrsgroup.com/docs/opsview/6.11.7/configuration/secure-arguments/index.html) feature for argument passing.



For mode-specific help, run the plugin with the `-h -m <mode>` flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:

| Service&nbsp;Check&nbsp;Name | Mode |
|:-----------------------------|:-----|
| Exchange - Mailflow - Status | `MSExMailflow.Status` |
| Exchange - Mailflow - Message Latency | `MSExMailflow.Message.Latency` |
| Exchange - Mailflow - SMTP Connectivity Status | `MSExMailflow.SMTP.Connectivity` |
| Exchange - Mailflow - SMTP Message Count | `MSExMailflow.SMTP.Message.Count` |
| Exchange - Mailflow - Mailbox Server Failure Rate | `MSExMailflow.Mailbox.Failure.Rate` |
| Exchange - Mailflow - Mailbox Queue | `MSExMailflow.Mailbox.Queue` |
| Exchange - Mailflow - Back Pressure Status | `MSExMailflow.Back.Pressure.Status` |


