How to Edit the Configuration File
Applies To: Exchange Server, Operations Manager 2007
This section describes the configuration file used to configure the Exchange Server 2003 Management Pack. The configuration file is an XML file that lets users control configuration options by using the Exchange Server 2003 Management Pack Configuration Wizard. It also lets users script the configuration and view a report of the current configuration options.
The following table lists the container objects in a configuration file. Use the container objects to help find sections in the configuration file you want to modify.
Container Object |
Description |
AdministrativeGroup |
This node is a container object for <Servers> elements. It also has an <AdministrativeGroupName> element. The AdministrativeGroupName element contains the name of an administrative group as displayed by Exchange System Manager. There must be exactly one instance of the AdministrativeGroupName element and exactly one instance of the Servers element. Parent: AdministrativeGroups. |
AdministrativeGroups |
This node is a container object of administrative groups listed in the configuration file. It must contain at least one <AdministrativeGroup> element. Parent: Configuration. |
BackEnd |
This node is a container object for the following configuration options, which can be set for a back-end server running Exchange: <ServerName>, <MonitorMessageTracking>, <ServicesToMonitor>, <MailBoxAccessAccount>, <MDBAvailabilityMonitoring>, and <MailFlowMonitoring>. The ServerName object contains the fully qualified domain name (FQDN) or the NetBIOS name of the server as a string. The MonitorMessageTracking object contains a Boolean value that specifies whether Message Tracking is enabled. The other three objects are container objects for other configuration elements. For an input configuration file, each BackEnd node must contain either zero or one instance of each of these objects. The only exception is the ServerName element. Each BackEnd instance must contain exactly one instance of the ServerName element. For the other elements, not specifying an element means that it will not be configured. An output report must contain exactly one instance of each of these objects. Parent: Servers |
Configuration |
This is the root node for the XML file. It can contain one child object, the <AdministrativeGroups> object, which is a container object for AdministrativeGroup configuration information. There must be at least one AdministrativeGroup object. There can be more than one AdministrativeGroup object. Parent: None |
FrontEnd |
This node is a container element for configuration information for a front-end server running Exchange. It must contain exactly one <ServerName> element, which is a string that contains the FQDN of the server. It can also contain <ServicesToMonitor>, <FrontEndAvailabilityMonitoring>, <MailBoxAccessAccount>, and <MonitorMessageTracking> objects (previously defined). Parent: Servers |
MailBoxAccessAccount |
This node contains the account information for the MailBoxAccessAccount for the current server. It contains <username> and <domain> elements, which are strings and contain the user name and domain name of the Mailbox Access Account, respectively. This object is used only in the output configuration report. It is ignored when importing a configuration file, and the user is prompted to enter a user name and password for the Mailbox Access Account when running the tool from the command line. Parent: BackEnd and FrontEnd |
MailFlowMonitoring |
This node contains four elements:
They contain the NetBIOS name of the server they are expecting mail from or are supposed to send mail to, respectively. SendMailToMailbox is used to specify custom mailboxes (instead of servers) to which the server is supposed to send messages. This element enables customers to use "custom test mailboxes." When using SendMailToMailbox, it is mandatory to add <ServerMailToServer>Custom</SendMailToServer> to the mail flow configuration; otherwise, no mail flow message will be sent to the customer mailboxes. There can be multiple instances of all elements. TestMailBox, an optional element that can be used to send or receive mail flow messages, should be specified whenever using customer mailboxes to monitor mail flow. Parent: BackEnd |
MDBAvailabilityMonitoring |
This node contains <MDBToMonitor> objects. The MDBToMonitor object contains the configuration of each MDB. If empty, it means that the configuration will disable MAPI logon availability. Parent: BackEnd |
MDBToMonitor |
This node contains the following three elements:
They specify information about an MDB. The first two elements are required, and exactly one instance of each element must exist under this node. The TestMailBox element can be present, but it is not required. If it is present, this name is used for the mailbox monitoring account. If it is not present, the default naming scheme is used. Parent: MDBAvailabilityMonitoring |
Servers |
This node is a container object for <BackEnd> and <FrontEnd> objects. FrontEnd and BackEnd objects contain the configuration information for front-end or back-end servers, respectively. There can be multiple instances of the FrontEnd and BackEnd objects under the server container. No other elements can be in the Servers container object. Parent: AdministrativeGroup |
ServicesToMonitor |
This node contains the services to monitor. It contains the <ServiceName> element, which is a string and contains the system name of the service to monitor; for example, SMTPSVC or MSExchangeIS, not Simple Mail Transfer Protocol or Microsoft Exchange Information Store service. This is a repeating element (). Parent: FrontEnd or BackEnd |
Note
The MailBoxAccessAccount elements are ignored when importing the configuration file. They are used only for output reporting.
Sample File Format
The following sample configuration file enables custom front-end monitoring.
Note
Some lines in the following code snippet have been displayed in multiple lines for better readability only. These should be entered in a single line.
<Configuration>
<AdministrativeGroups>
<AdministrativeGroup>
<AdministrativeGroupName>First Administrative Group
</AdministrativeGroupName>
<Servers>
<FrontEnd>
<ServerName>MAILSRV</ServerName>
<FrontEndAvailabilityMonitoring>
<Enabled>true</Enabled>
<BackEndAccount>customBEAcct</BackEndAccount>
</FrontEndAvailabilityMonitoring>
</FrontEnd>
</Servers>
</AdministrativeGroup>
</AdministrativeGroups>
</Configuration>
The following sample configuration file is the typical configuration for one computer.
Note
Some lines in the following code snippet have been displayed in multiple lines for better readability only. These should be entered in a single line.
<Configuration>
<AdministrativeGroups>
<AdministrativeGroup>
<AdministrativeGroupName>First Administrative Group
</AdministrativeGroupName>
<Servers>
<BackEnd>
<ServerName>MAILSRV</ServerName>
<MonitorMessageTracking>true</MonitorMessageTracking>
<MailBoxAccessAccount>
<Username>mbaccess</Username>
<Domain>tidev</Domain>
</MailBoxAccessAccount>
<ServicesToMonitor>
<ServiceName>MSExchangeIS</ServiceName>
<ServiceName>MSExchangeMGMT</ServiceName>
<ServiceName>MSExchangeMTA</ServiceName>
<ServiceName>MSExchangeSA</ServiceName>
<ServiceName>SMTPSVC</ServiceName>
<ServiceName>W3SVC</ServiceName>
</ServicesToMonitor>
<MDBAvailabilityMonitoring>
<MDBToMonitor>
<StorageGroup>SG01</StorageGroup>
<MDBName>mailboxStore01</MDBName>
<TestMailBox>MAILSRVMOM</TestMailBox>
</MDBToMonitor>
</MDBAvailabilityMonitoring>
<MailFlowMonitoring>
<SendMailtoServer>OTHERMAILSRV</SendMailtoServer>
<SendMailtoServer>MAILSRV</SendMailtoServer>
<ExpectMailFrom>OTHERMAILSRV</ExpectMailFrom>
<ExpectMailFrom>MAILSRV</ExpectMailFrom>
<TestMailBox>MAILSRVMOM</TestMailBox>
</MailFlowMonitoring>
</BackEnd>
</Servers>
</AdministrativeGroup>
</AdministrativeGroups>
</Configuration>
The following sample file configures mail flow.
<Configuration>
<AdministrativeGroups>
<AdministrativeGroup>
<AdministrativeGroupName>SouthAmerica</AdministrativeGroupName>
<Servers>
<BackEnd>
<ServerName>BOLIVIA</ServerName>
<MailFlowMonitoring>
<ExpectMailFrom>COLOMBIA</ExpectMailFrom>
<TestMailBox>customAcct01</TestMailBox>
</MailFlowMonitoring>
</BackEnd>
<BackEnd>
<ServerName>ARGENTINA</ServerName>
<MailFlowMonitoring>
<ExpectMailFrom>COLOMBIA</ExpectMailFrom>
<TestMailBox>customAcct02</TestMailBox>
</MailFlowMonitoring>
</BackEnd>
</Servers>
</AdministrativeGroup>
<AdministrativeGroup>
<AdministrativeGroupName>Africa</AdministrativeGroupName>
<Servers>
<BackEnd>
<ServerName>KENYA</ServerName>
<MailFlowMonitoring>
<ExpectMailFrom>COLOMBIA</ExpectMailFrom>
<TestMailBox>customAcct03</TestMailBox>
</MailFlowMonitoring>
</BackEnd>
<BackEnd>
<ServerName>NIGERIA</ServerName>
<MailFlowMonitoring>
<ExpectMailFrom>COLOMBIA</ExpectMailFrom>
<TestMailBox>customAcct04</TestMailBox>
</MailFlowMonitoring>
</BackEnd>
</Servers>
</AdministrativeGroup>
<AdministrativeGroup>
<AdministrativeGroupName>Oceania</AdministrativeGroupName>
<Servers>
<BackEnd>
<ServerName>AUSTRALIA</ServerName>
<MailFlowMonitoring>
<ExpectMailFrom>COLOMBIA</ExpectMailFrom>
<TestMailBox>customAcct05</TestMailBox>
</MailFlowMonitoring>
</BackEnd>
</Servers>
</AdministrativeGroup>
<AdministrativeGroup>
<AdministrativeGroupName>NorthAmerica</AdministrativeGroupName>
<Servers>
<BackEnd>
<ServerName>MEXICO</ServerName>
<MailFlowMonitoring>
<ExpectMailFrom>COLOMBIA</ExpectMailFrom>
<TestMailBox>customAcct06</TestMailBox>
</MailFlowMonitoring>
</BackEnd>
<BackEnd>
<ServerName>CANADA</ServerName>
<MailFlowMonitoring>
<ExpectMailFrom>COLOMBIA</ExpectMailFrom>
<TestMailBox>customAcct07</TestMailBox>
</MailFlowMonitoring>
</BackEnd>
<BackEnd>
<ServerName>COLOMBIA</ServerName>
<MailFlowMonitoring>
<SendMailtoMailbox>customAcct01</SendMailtoMailbox>
<SendMailtoMailbox>customAcct02</SendMailtoMailbox>
<SendMailtoMailbox>customAcct03</SendMailtoMailbox>
<SendMailtoMailbox>customAcct04</SendMailtoMailbox>
<SendMailtoMailbox>customAcct06</SendMailtoMailbox>
<SendMailtoMailbox>customAcct05</SendMailtoMailbox>
<SendMailtoMailbox>customAcct07</SendMailtoMailbox>
<SendMailtoServer>Custom</SendMailtoServer>
<TestMailBox>customAcct08</TestMailBox>
</MailFlowMonitoring>
</BackEnd>
</Servers>
</AdministrativeGroup>
</AdministrativeGroups>
</Configuration>