Chapter 1 Overview........................1 This chapter covers the features of the Isode M-Switch required by Operators of M-Switch. It gives detailed descriptions of the monitoring and control features and components, especially the Graphical Management tools. It also provides links to the complementary volumes,...
Page 3
M-Switch Operator's Guide Chapter 14 Message Switch Console Views................54 This chapter lists the MConsole Operator Views, providing a summary and links to further information. M-Switch Operator's Guide...
Page 4
Isode software is copyright Isode Limited 2002-2018, all rights reserved. Isode software is a compilation of software of which Isode Limited is either the copyright holder or licensee. Acquisition and use of this software and related materials for any purpose requires a written licence agreement from Isode Limited, or a written licence from an organization licensed by Isode Limited to grant such a licence.
Page 5
M-Switch Operator's Guide Software version This guide is published in support of Isode M-Switch R17.0. It may also be pertinent to later releases. Please consult the release notes for further details. Readership This guide is intended for operators who plan to monitor and operate the Isode M-Switch message switch.
M-Switch Operator's Guide Chapter 1 Overview This chapter covers the features of the Isode M-Switch required by Operators of M-Switch. It gives detailed descriptions of the monitoring and control features and components, especially the Graphical Management tools. It also provides links to the complementary...
On Unix systems to start MConsole, ensure is included in your path, and type: (BINDIR) mconsole On Windows right click on Start → Isode → MConsole and choose Run As Administrator. 2.1.1.1 Starting MConsole First Time You are recommended to encrypt your Bind Profile, so when MConsole starts up you are prompted for your password.
Views. Live Operations These are Views used by operators in order to manage Isode messaging systems in real time. These are documented in this manual, but further information (in particular how to configure these views) is in the M-Switch Administrator's Guide •...
Introduction The Isode M-Switch Server comprises a number of “Services” depending on the Features required. These Services are usually started and stopped by an Administrator but some Operators may also be granted permission to do this.
Page 11
Starting and Stopping Services on Unix is done using standards SVR4 scripts or systemctld depending on the platform. 4.1.2.1 Systems using SVR4 This command line shuts down the single M-Switch service. Notice how several sub services such as SMTP are also shutdown. Starting and Stopping...
Page 12
Shutting down Isode Switch SMTP server Shutting down Isode Alert daemon However most deployments of M-Switch will have Multiple services which also need to be started and stopped. The following command line shuts down the commonly used M-Switch Services for a MIXER system, i.e.
Page 13
M-Switch Operator's Guide 4.1.2.3 Starting and Stopping using systemctld On systems which use systemctld, such as Debian and Red Hat 7/CentOS7, legacy SVR4 startup and shutdown procedures must be used, as described in Section 4.1.2.1, “Systems using SVR4 ”. Starting and Stopping...
The Switch Operations view connects to the Queue Manager of each configured Switch. The connection parameters for each Switch need to be set up by an Administrator. These parameters include a username (SASL ID) and password.These are set up by the M-Switch Administrator.
Page 15
M-Switch Operator's Guide • recipients of the queued messages, • active connections to remote MTAs, By selecting a Switch, Channel or Peer MTA item you can use an option from the popup menu (launched using the right mouse button) to access the configuration of that item in the Directory.
Page 16
M-Switch Operator's Guide • Enable inbound connections, allowing the channel to accept new inbound connections. This may be a no-op for some channels. • Disable inbound connections, preventing the channel from accepting new inbound connections. Existing inbound connections are unaffected. This may be a no-op for some channels.
Page 17
M-Switch Operator's Guide • Disable outbound connections, preventing the channel from making new outbound connections to this Peer MTA. Existing outbound connections are unaffected. This may be a no-op for some channels. • Clear delay. This clears any delay which may have been applied to the Peer MTA.
Page 18
M-Switch Operator's Guide • Resume. If the message is currently being transferred to a Peer MTA and is paused, this will resume the transfer. This is a no-op for some channels. • Forward as attachment. This uses the built-in User Agent to forward the selected message as an attachment to a new message.
Figure 6.1. Event viewer Events Overview In the Event Viewer view you can display events recorded in the log files by M-Switch and other Isode applications like M-Vault, M-Box, etc. The Event Viewer is capable of showing either log files that can be locally accessed or showing log files that are accessed remotely by using the SOM protocol to communicate with a SOM Server such as a Queue Manager.
Page 20
Source section. Selecting the log files to work with Since the different Isode programs write their events in their respective log files, the Event Viewer provides a log file selector which allows only the relevant logs to be shown. To select which log files are shown, click on the Select button in the corresponding section, and the Log File Selector dialog is shown.
Page 21
M-Switch Operator's Guide options. As you check and uncheck the options you will see the files in the log file selection table showing which files will be selected automatically. When you select log files manually, you can use the check boxes next to each file in the log file selection table to select them.
Page 22
M-Switch Operator's Guide The first button is used to refresh the content of the log table. This is only activated in Review mode. The second button is used to clear the content of the log table. This is used when the log table fills up or when you want to remove old events. The third button is used to copy the selected events to the clipboard.
• internal MConsole events The Alerts View allows the administrator to configure the type of alert notification based on the Isode Events which are listed in the Isode Events Catalogue. This is done with the build-in Alert Configuration Editor. To understand the Alerts View, it is important to be familiar with the Isode Event Catalogue and the configuration of logging in general.
Page 24
• an alert viewer at the bottom of the window, which displays information about the selected alert. It is made up of two sections: the Alert Details pane, where information from the Isode Events Catalogue is shown, and the Alert Status pane, where information about the selected alert is shown.
Page 25
When an alert is selected in the Alerts Table, the two views at the bottom of the window are updated with information about the selected alert. The Alert Details box shows the information taken from the Isode Events Catalogue, like Facility Name, Error Description, Action and the full text of the alert message.
Page 26
If the new event is found to match one of the events configured in the Alert Editor, the corresponding set of Alert Actions will be performed. Isode events are made of a Level, a Facility and a Description, for example E-MTA-TLSRequired is level "E" (an Error), the facility is "MTA" and the description (or name) is "TLSRequired".
M-Switch Operator's Guide Chapter 8 Message Tracking This chapter describes the AuditDB views used for message tracing and searching. MConsole Message Tracking 8.1.1 Message Tracking View The Message Tracking View allows you to query the database for information about messages using various search options. Some boxes such as Sender and Recipient have a checkbox which allow you to specify whether an exact match is required or simply that the value in the database contains that string.
Page 28
LHS and RHS tables. If this does not appear, you need to configure the Message Archiving rule as described in MTA Configuration Securing Your System sections of the M-Switch Administration Guide. 8.1.2 Message History View This view can be used to display a quick summary of messages that are sent and received by the the MTA for the day.
Page 29
M-Switch Operator's Guide Figure 8.4. Message History View 8.1.3 Message Transfers History View This view displays the transfer history for messages displaying the local MTA, remote MTA, sender, recipients and other message attributes. Figure 8.5. Message Transfers View 8.1.4 Statistics View This view displays a range of statistics of messaging events in different formats.
Page 30
M-Switch Operator's Guide Figure 8.6. Statistics View Forwarding Messages from MConsole (User Agent) Operators can forward a message by right clicking on the message in the Message Tracking View. This will display a User Agent View. Figure 8.7. User Agent View: Forwarding a Message...
Page 31
M-Switch Operator's Guide Resubmit Messages from MConsole Operators can resubmit a message by clicking the resubmit tool item on the Message Content View toolbar. This will display a dialog that allows you to resubmit the message to its original recipients or new recipients.
M-Switch Operator's Guide Chapter 9 ACP142 View This chapter describes how ACP142 features of M-Switch are monitored and operated. This is performed using the M-Console ACP142 View. The ACP142 Message Transfer View is used to monitor incoming and outgoing ACP142 messages.
Page 33
M-Switch Operator's Guide Message Queue Outbound This tab shows a list of currently queued messages waiting to be transferred. The Msg Queue Tab has the following buttons: • If a user selects the Refresh the messages are reread from the ACP142 channel.
Page 34
M-Switch Operator's Guide The Delete... option allows an operator to remove a message from the queue. This can only be done if the message is not being transferred. Any message currently being transferred will first have to be aborted. The Abort button allows the operator to cancel an ongoing transmission. Note that any bytes which have already been written out to an S'5066 server will still be broadcast.
Page 35
M-Switch Operator's Guide Selecting a message in the view causes the Message Content to be displayed. Figure 9.2. ACP142 Messages Sent View ACP142 Messages Received View Each tab for the ACP142 channel for an MTA has a Messages Received tab. This tab connects to the Audit Database configured in the Options view.
M-Switch Operator's Guide Chapter 10 ACP127 This chapter describes how ACP127 features of M-Switch are monitored and operated. This is performed using the M-Switch ACP127 View. 10.1 ACP127 View There are various ACP127 sub-views which are consolidated into a single View: the ACP127 View.
Page 38
M-Switch Operator's Guide Some parts of the ACP127 View also use the Audit DB features to return information about messages, such as displaying content. You should configure the AuditDB access in the Options View as described in Figure 10.1, “Configuring ACP127 Views in the Options View”.
Page 39
M-Switch Operator's Guide Figure 10.3. ACP127 Circuit Monitor View (Message Queue) Tab The Msg Queue Tab has the following buttons: • If a user selects the Refresh the messages are reread from the ACP127 channel. • The Refresh Every checkbox can be checked to generate periodic refreshes at regular intervals.
Page 40
M-Switch Operator's Guide Transmitting to Sent as the segment is successfully sent and acknowledged, and the segment count in the message updated to reflect the number of segments successfully sent so far. If a user selects the Transferred button for a segment, the Send button lights up and can be used to send another segment.
Page 41
M-Switch Operator's Guide Displays the ZPW as a new table column. This will force the table to be resized if needed. The ZPW will only be shown if present. This option also allows further actions to be taken on the ZPW.
Page 42
M-Switch Operator's Guide Figure 10.4. ACP127 Circuit Monitor View (Compose Service Message) The pull down menu attached to Default allows you to choose a Service Message type from a list of commonly used types. Custom SIG allows a service message type that is not in the commonly used list to be sent by specifying it directly.
Page 43
M-Switch Operator's Guide Figure 10.5. ACP127 Circuit Monitor View (Send Data) Note: The default directory which contains the test templates can be changed by altering the Template Directory within the ACP127 Monitoring tab of the Edit Message Switch dialog. This dialog can be found by right clicking on your Switch and selecting Modify, in either the Switch Operations view or the ACP 127 View.
Page 44
M-Switch Operator's Guide Figure 10.6. ACP127 Repair Queue 10.1.3 ACP127 Messages Sent View Broadcast and Point to Point senders have a View which shows the messages sent, as shown below. Figure 10.7. ACP127 Messages Sent View The Messages Sent view connects to the Audit Database. The Audit Database is configured in the Options view.
Page 45
M-Switch Operator's Guide 10.1.4 ACP127 Messages Received View Broadcast and Point to Point receivers have a View which shows the messages received, as shown below. Figure 10.8. ACP127 Messages Received View The Messages Received view connects to the Audit Database. The Audit Database is configured in the Options view.
Page 46
M-Switch Operator's Guide 10.1.5 ACP127 Tx Serial Log Figure 10.9. ACP127 Tx Serial Log View Logging of data sent can be captured in log files and viewed in the Tx Serial Log Viewer tab. 10.1.6 ACP127 Rx Serial Log Figure 10.10. ACP127 Rx Serial Log View Logging of data received can be captured in log files and viewed in the Rx Serial LOg Viewer tab.
Page 47
M-Switch Operator's Guide 10.1.7 ACP127 OTAM View Figure 10.11. ACP127 OTAM View The OTAM process connects to the ACP127 process, and monitors outbound traffic. It also connects to a receiver, allowing traffic that is being transmitted to be received. By comparing the two streams of read and write data, it is possible to spot errors when transmitting and allow the operator to assess the quality of the signal.
Page 48
M-Switch Operator's Guide Figure 10.12. ACP127 OTAM View Advanced The Advanced tab allows a user to: • Refresh the error information and connection status • Check the read connection. • Check the write connection • Check the 1 / 5 / 15 minute rolling average error information.
Page 49
M-Switch Operator's Guide The UI provides operations for discarding and submitting messages back to the server. The Show Matches button displays the possible matches for the message in a dialog as shown in the figure below. Figure 10.13. ACP127 Duplicate Queue 10.1.8.2...
Page 50
M-Switch Operator's Guide 10.1.8.3 Intercept Queue The intercept queue lists the messages received that are not explicitly meant for this station. This tab will only appear if the circuit has been configured to send intercepted messages to the intercept queue as explained in M-Switch Administration Guide.
Page 51
• Set Stop bits to 1 • Set Flow Control to Hardware Note: In this example a data rate of 300bps is being set for the COM device. M-Switch will be told to transfer data at a higher rate to prevent buffer underflows. ACP127...
Page 52
M-Switch Operator's Guide 10.2.3 Configuring the ACP127 circuit to use the COM device Figure 10.17. ACP127 OTAM View Using the COM device Select the circuit you wish to configure within the Switch Configuration Management view of MConsole. Select the Circuit tab.
MTAs. Authorization Rules are described in the M-Switch Administrator's Guide The Vetting View is very like the standard Switch Operations view, except that it only displays messages which are in the "held"...
M-Switch Operator's Guide Chapter 12 Diversions This chapter describes the M-Switch Diversions View is used. 12.1 Diversions and Nexus Overview The Diversions View enables an Operator to Enable or Disable certain routes, so that they are ignored for Routing purposes. This allows the Operator to respond to lack of availability of certain MTAs or networks.
M-Switch Operator's Guide Chapter 13 Correction View This chapter describes the Corrections View which allows operators to correct messages which would otherwise be non-delivered. 13.1 Correction View Once the corrector channel has been set up correctly, and at least one user has been configured to manage the messages in the corrector channel, the Message Correction GUI can be used to process the messages that are pending in the corrector channel.
Page 56
When a message is queued in the corrector channel it will be picked up by the Message Correction GUI automatically. There may be a delay before the message is shown, and this is controlled by the M-Switch Administrator, by default the messages are refreshed every 10 seconds.
Page 57
M-Switch Operator's Guide To select a message for correction, simply click on it, and the message details will be shown. 13.1.3 Operating on messages The following figure shows the message correction editor. The operator is presented first with the error message that caused the message to be sent to the corrector channel. In the case of this example, it was “X.400 Message too large: policy violation”.
Page 58
M-Switch Operator's Guide 13.1.4 Performing Message Correction As there are several reasons why the message have been sent to the correction channel, the operator has a choice of message correction actions to perform on a message. The actions include: • Removing a message bodypart.
Page 59
These Views can be broken down into the following groups: • Live Operations These are Views used by operators in order to manage Isode messaging systems in real time. These are documented in this manual, but further information (in particular how to configure these views) is in the M-Switch Administrator's Guide •...
Page 60
M-Switch Administration Guide • Message Tracking These are Views used by operators in order to manage Isode messaging systems in near real time by displaying information about messaging events in one or more Isode MTAs. The use by Operators of these features is documented in Chapter 8, Message Tracking.
Need help?
Do you have a question about the M-Switch and is the answer not in the manual?
Questions and answers