Vunetrix Manual: SMTP&IMAP Round Trip Sensor

Sensor Name

Enter a meaningful name to identify the sensor. The name will be shown by default in the device tree and in all alarms.

Tags

Enter one or more tags, separated by space or comma. You can use tags to group sensors and use tag-filtered views later on. Tags are not case sensitive. We recommend using the default value. You can add additional tags to it, if you like. Other tags are automatically inherited from objects further up in the device tree. Those are not visible here.

Priority

Select a priority for the sensor. This setting determines where the sensor will be placed in sensor lists. Top priority will be at the top of a list. You can choose from one star (low priority) to five stars (top priority).

Sensor Result

Define what will be done with the result of the sensor. Choose between:

• Discard sensor result: Do not store the sensor result.
• Write sensor result to disk (Filename: "Result of Sensor [ID].txt"): Store the last result received from the sensor to the "Logs (Sensor)" directory (on the Master node, if in a cluster). File name: Result of Sensor [ID].txt. This is for debugging purposes. The file will be overridden with each scanning interval. For information on how to find the folder used for storage, please see Data Storage section.

Email Settings

From

Specify which address the sent emails will contain in the from field. Please enter a valid email address.

To

Specify to which address the emails will be sent to. Please enter a valid email address.

Helo Ident

Enter a server name for the helo part of the mail protocol. For some mail servers the helo ident must be the valid principal host domain name for the client host.

Step 1: Send Email to Parent Device Using SMTP

In this step, you configure how emails will be sent. As SMTP server, the sensor uses the IP-Address/DNS Name property's value of the device it is added on.

Port

Enter the number of the port that will be used to send an email via SMTP. Please enter an integer value. For non-secure connections usually port 25 is used; usually port 465 or 587 for SSL connections. The actual setting depends on the server you are connecting to. Please enter an integer value. We recommend using the default value. If you do not get a connection, please try another port number.

Timeout for SMTP Connection (Sec.)

Enter a timeout in seconds for the SMTP connect. If the reply takes longer than this value the request is aborted and an error message is triggered.

TLS (Transport-Level Security)

Select if the SMTP connection will be secured via SSL. Choose between:

• Don't use: Do not use encryption for the SMTP connection.
• Use: Connect to the SMTP server using the SSL method selected below.

SSL-Method

This field is only visible if security is enabled above. Select the SSL method that will be used when connecting to the server. We recommend using the default value. Only if you experience connection problems, try another setting. Choose between:

• SSL V2
• SSL V2 or V3
• SSL V3
• TLS V1

SMTP Authentication Type

Define if you want to use an authentication for the SMTP connection. Choose between:

• None: Do not use any authentication method.
• Username/Password: Authenticate at the SMTP server via username and password.

Username

This field is only visible if SMTP authentication is enabled above. Enter a username for SMTP authentication. Please enter a string.

Password

This field is only visible if SMTP authentication is enabled above. Enter a password for SMTP authentication. Please enter a string.

Additional Text for Email Subject

The subject part of the round trip email is created automatically by Vunetrix. It consists of the string "Vunetrix Roundtrip Mail:" followed by a unique GUID to correctly identify the email in the IMAP mailbox (e.g. Vunetrix Roundtrip Mail: {5E858D9C-AC70-466A-9B2A-55630165D276}). Use this field to place your custom text before the automatically created text.

Step 2: Check an IMAP Mailbox Until Email Arrives

In this step, you configure how the sent emails will be received.

IP-Address/DNS Name

Specify the IMAP server. Enter a valid IP address or DNS name.

Mailbox

Specify the IMAP Mailbox (resp. "IMAP folder") you want to check. Please enter the IMAP mailbox/folder name.

Port

Specify the port that will be used for the IMAP connection. For non-secure connections usually port 143 is used; usually port 993 for SSL connections. The actual setting depends on the server you are connecting to. Please enter an integer value. We recommend using the default value. If you do not get a connection, please try another port number.

TLS (Transport-Level Security)

Select if the IMAP connection will be secured via SSL. Choose between:

• Don't use: Do not use encryption for the SMTP connection.
• Use: Connect to the SMTP server using the SSL method selected below.

SSL-Method

This field is only visible when TLS is enabled above. Select the SSL method that will be used when connecting to the IMAP server. We recommend using the default value. If you experience connection problems, try another setting.

Connection Interval (Sec.)

Enter the number of seconds the sensor will wait between two connections to the IMAP server. Vunetrix will repeatedly check the mailbox in this interval until the email arrives. Please enter an integer value.

Maximum Trip Time (Sec.)

Enter the number of seconds an email may take to arrive in the IMAP mailbox. Vunetrix will repeatedly check the mailbox in the interval specified above until the email arrives. If it does not arrive within the maximum trip time, an error message will be triggered for the sensor. Please enter an integer value.

IMAP Authentication Type

Select the kind of authentication for the IMAP connection. Choose between:

• Username and Password (simple)
• Simple Authentication and Security Layer (SASL)

Username

Enter a username for IMAP authentication. Please enter a string.

Password

Enter a username for IMAP authentication. Please enter a string.

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel will always be displayed underneath the sensor's name. The available options depend on what channels are available for this sensor. Note: You can set another primary channel later by clicking on the pin symbol of a channel in the sensor's overview tab.

Chart Type

Define how different channels will be shown for this sensor.

• Show channels independently (default): Show an own graph for each channel.

• Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This will generate an easy-to-read graph which visualizes the different components of your total traffic. Note: This option cannot be used in combination with manual Vertical Axis Scaling (available in the Sensor Channels Settings settings).

Stack Unit

This setting is only available if stacked graphs are selected above. Choose a unit from the list. All channels with this unit will be stacked on top of each other. By default, you cannot exclude single channels from stacking, if they use the selected unit. However, there is an advanced procedure to do so.

Scanning Interval

Scanning Interval

The scanning interval determines the time the sensor waits between two scans. Select a scanning interval (seconds, minutes, or hours) from the list. You can change the available intervals in the system administration.

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be interrupted; the according settings from the parent objects will always be active. However, you can define additional settings here. They will be active in parallel to the parent objects' settings.

Schedule

Select a schedule from the list. Schedules can be used to monitor for a certain time span (days, hours) throughout the week. With the period list option it is also possible to pause monitoring for a specific time span. You can create new schedules and edit existing ones in the account settings. Note: Schedules are generally inherited. New schedules will be added to existing ones, so all schedules are active.

Maintenance Window

Specify if you want to set-up a one-time maintenance window. During a maintenance window this object and all child objects will not be monitored. They will enter a paused state then. Choose between:

• Not set (monitor continuously): No maintenance window will be set.
• Set up a one-time maintenance window: Pause monitoring within a maintenance window.

Maintenance Begins At

This field is only visible if maintenance window is enabled above. Use the date time picker to enter the start date and time of the maintenance window.

Maintenance End At

This field is only visible if maintenance window is enabled above. Use the date time picker to enter the end date and time of the maintenance window.

Dependency Type

Define a dependency type. Dependencies can be used to pause monitoring for an object depending on the status of another. You can choose between:

• Use parent: Pause the current sensor if the device it is created on is in a Down status, or if it is paused by another dependency.
• Select object: Pause the current sensor if the device it is created on is in an Down status, or if it is paused by another dependency. Additionally, pause the current sensor if a specific other object in the device tree is in a Down status, or if it is paused by another dependency. Select below.
• Master object for parent: Make this sensor the master object for its parent device. The sensor will influence the behavior of the device it is created on: If the sensor is in a Down status, the device will be paused. For example, it is a good idea to make a Ping sensor the master object for its parent device to pause monitoring for all other sensors on the device in case the device cannot even be pinged. Additionally, the sensor will be paused if the parent group of its parent device is in a Down status, or if it is paused by another dependency.

Note: Testing your dependencies is easy! Simply choose Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later all dependent objects should be paused.

Dependency

This field is only visible if the select object option is enabled above. Click on the reading-glass symbol and use the object selector to choose an object on which the current sensor will be dependent on.

Delay (Seconds)

Define a time span. After the master object for this dependency comes back to an Up status, monitoring of the depending objects will be additionally delayed by the defined time span. This can help avoid false alarms, for example, after a server restart, by giving systems more time for all services to start up. Please enter an integer value in seconds. Note: This setting is not available if you choose this sensor to be the Master object for parent. In this case, please define delays in the parent Device Settings or the superior Group Settings.

Access Rights

User Group Access

Define which user group(s) will have access to the object you're editing. A table with user groups and right is shown; it contains all user groups from your setup. For each user group you can choose from the following access rights:

• Inherited: Use the settings of the parent object.
• None: Users in this group cannot see or edit the object. The object does not show up in lists and in the device tree. Exception: If a child object is visible to the user, the object is visible in the device tree, though not accessible.
• Read: Users in this group can see the object and review its monitoring results.
• Write: Users in this group can see the object, review its monitoring results, and edit the object's settings. They cannot edit access rights settings.
• Full: Users in this group can see the object, review its monitoring results, edit the object's settings, and edit access rights settings.

You can create new user groups in the System Administration—User Groups settings. To automatically set all objects further down in the hierarchy to inherit this object's access rights, set a check mark for the Revert children's access rights to inherited option.

For more details about access rights, please see section User Access Rights.