Moogsoft Docs

Configure the SCOM Connector

The SCOM Connector establishes the communication between the SCOM Server and the SCOM LAM in Moogsoft AIOps. Installing the connector installs the REST Servers which enables the connector to receive and forward alarms/events to Moogsoft AIOps.

Install the SCOM Connector

See Microsoft SCOM for instructions on how to install the connector on your SCOM server.

Edit the configuration file

Edit SCOMConnectorConfig.json to control the behavior of the SCOM Connector.

Some properties in the file are commented out by default. Before making any changes to the file, stop the service of the SCOM Connector you want to configure. After saving the changes, allow 3-4 minutes before restarting.

The configuration file consists of the following sections:

  • SCOM Servers: You can find details of the SCOM Servers you added during installation in this section. You can only change the priority here; changing anything other than the priority can result in the the SCOM Connector becoming unstable.

  • Moog Servers: You can find details of the Moog Servers you added during the installation and any proxies you have configured in this section.

  • Other configurations: You can find all of the other configurations here. Some configurations are only for informational purposes and we do not recommend changing them.

    The table below describes the configurable properties.

    Property

    Description

    AlertPollCycleTime

    The time period for polling the SCOM Connector to fetch alerts from SCOM. Defaults to 45 seconds.

    In case of a long communication failure, the SCOM Connector will fetch alerts only up to 10 times this property's value, as long as the duration from the last poll time is greater than 10 times the property's value.

    If the duration is less than 10 times the AlertPollCycleTime, the alerts are fetched from the last poll time.

    IsActiveEventPolling

    Determines whether the SCOM Connector fetches events. Defaults to False.

    EventPollCycleTime

    The time period for polling the SCOM Connector to fetch events from SCOM. Defaults to 45 seconds.*

    AmountOfTimeouts

    The number of attempts to try to reconnect with the SCOM Servers after a timeout. If set to "-1", the SCOM Connector continuously retries to connect with the configured SCOM Servers. Entering a positive integer will cause the SCOM Connector to make the specified number of attempts, and if it is unsuccessful in reconnecting, an alert is sent to Moogsoft AIOps.

    LowerTimeoutBound, UpperTimeoutBound and AmountOfTimeouts

    TheLowerTimeoutBound, UpperTimeoutBound, and AmountOfTimeouts collectively decide the time duration after which a retry is attempted.

    Connector Name

    The name of the connector.

    ConnectorDescription

    The description of the connector.

    ConnectorDisplayName

    The display name of the connector.

    MaxPollRetryAttempt

    If the SCOM Server fails to send data to the SCOM Connector, the number of retry attempts it makes.

    WinAuthOverrid

    Determines whether to enable Windows authentication for accessing the SCOM Server. If the SCOM and SCOM Connector are on the same machine, setting this to True overrides Windows Authentication. Defaults to False.

    AuthTokenRequired

    Determines whether an authentication token is required for SSL.

    AuthTokenCode

    The authentication token for SSL.

    Version

    The version of the installed SCOM Connector.

    MaxPayloadSizeInMB and MinPayloadSizeInMB

    Determines the size of alerts to send individually, alerts are sent in batches. We recommend keeping the minimum value at 1MB.

    PollCriteriaDateFormat

    The time format to use for polling data from the API. We do recommend changing the default value. For more details see SCOM Connector Troubleshooting.SCOM Connector Troubleshooting

    IsPrimary, SCOMConnectorRestUrl and SiblingConnectorUrl

    For informational purposes only; do not edit.

*The last poll time on which the SCOM Connector polled the SCOM Server is stored in SCOMConnectorInstaller/Configs/SCOMLastPollTime.json. After a communication failure, the SCOM Connector resumes fetching events from the last poll time saved in this file.

Code Example
{ "ScomServers": [ 
        { 
                "ScomAddressHost": "WIN-9R4CQNMLGCS", 
                "Domain": "moogsoftadmin.com", 
                "UserId": "administrator", 
                "Password": "5wZmZrCfMPH2PJ5/gQmFLg==", 
                "Guid": "4271cd94-b7c8-4385-8cdb-be2aa7b954e0", 
                "Priority": 1 
        } ], 
        "MoogServers": [ 
        { 
                "MoogUrl": "https://mandeepmoog63/events/scom_lam_microsoftscom1", 
                "MoogIp": "", 
                "MoogPort": "", 
                "MoogAddressDisplay": "https://mandeepmoog63/events/scom_lam_microsoftscom1", 
                "MoogPublicKey": "C:\\server.crt", 
                "IsSslEnabled": true, 
                "IsProxyRequired": false, 
                "ProxyUsername": "", 
                "ProxyPassword": "", 
                "MoogProxyIP": "", 
                "MoogProxyPort": "", 
                "Url": "", 
                "IsConnected": false 
        }, 
        { 
                "MoogUrl": "", 
                "MoogIp": "10.142.24.82", 
                "MoogPort": "48003", 
                "MoogAddressDisplay": "10.142.24.82:48003", 
                "MoogPublicKey": "C:\\server.crt", 
                "IsSslEnabled": true, 
                "IsProxyRequired": true, 
                "ProxyUsername": "proxy", 
                "ProxyPassword": "MIg1FG7XrUWys9N/FSgQQQ==", 
                "MoogProxyIP": "10.142.24.92", 
                "MoogProxyPort": "808", 
                "Url": "", "IsConnected": false 
        } ], 
        "IsPrimary": true, 
        "SCOMConnectorRestUrl": "http://10.142.24.165:2373", 
        "SiblingConnectorUrl": "http://10.142.24.164:2373", 
        "IsActiveAlertPolling": true, 
        "AlertPollCycleTime": 45, 
        "IsActiveEventPolling": false, 
        "EventPollCycleTime": 45, 
        "AmountOfTimeouts": -1, 
        "LowerTimeoutBound": 10, 
        "UpperTimeoutBound": 360, 
        "ConnectorName": "SCOMConnectorv5", 
        "ConnectorDescription": "SCOM Connector", 
        "ConnectorDisplayName": "SCOMConnectorv5", 
        "HAServiceName": "SCOMConnectorha", 
        MaxPollRetryAttempt": 3, 
        "WinAuthOverride": false, 
        "AuthTokenRequired": false, 
        "AuthTokenCode": "", 
        "Version": "4.3 (Advanced)",
        "MaxPayloadSizeInMB": 10.0, 
        "PollCriteriaDateFormat": "MM/dd/yyyy HH:mm:ss" 
}
Upgrade the SCOM Connector

To upgrade the SCOM connector to the latest version:

  1. Take a backup of the following SCOM configuration files:

    • SCOMConnectorInstaller/Configs/SCOMConnectorConfig.json.

    • SCOMConnectorInstaller/SCOMConnector.exe.config.

    Additionally, if you have configured the SCOM Connector for high availability, take a backup of these files:

    • SCOMConnectorInstaller/Configs/MCMServiceConfig.json. This file has to be saved on both the machines where the Primary and the Secondary SCOM Connectors are installed.

    • SCOMConnectorInstaller/Configs/MCMService.exe.config. This file has to be saved on both the machines where the Primary and the Secondary SCOM Connectors are installed.

  2. Uninstall the existing connector using the UninstallSCOM Connector uninstaller.

  3. Delete the SCOMConnectorInstaller folder or copy it to any other location.

  4. Unzip the new release of the SCOMConnectorInstaller folder.

  5. Install the connector using the installer from the newly delivered connector installer folder.

  6. Host the status page from the newly delivered connector installer folder.

  7. If you need to make any configuration changes, edit the newly created configuration file. You can refer to the backed up configuration file, but do not replace the newly created configuration file with it.

Host the Status Page on IIS

The Status page displays status information for the SCOM Connector, SCOM Server, and the SCOM LAM. If you have installed multiple connectors, you will need to host separate status pages for each of them.

To host the status page on IIS (Internet Information Services):

  1. Navigate to ScomConnectorInstaller\WebUI\Index.html and change the REST server's port from 8085 to the port given in the Connector URL field of the installer.

  2. Navigate to Administrative Tools\Internet Services (IIS) Manager. In the Connections section, drill down to Default Web Site and right-click and select Add Virtual Directory.

  3. In the dialog that opens, complete the Alias field with a name for the status page and set the Physical Path to the WebUI folder, appending an extra "\" to the end of the path.

  4. Enter an alias e.g. Connector-status in the Alias field, then browse and select the WebUI folder. The WebUI folder is present in the ScomConnectorInstaller folder in the Physical path field. After selecting the path, append "\" at the end of the path.

  5. To open the status page, click the Browse *:80(http) from the Actions menu.

    29961194.png
View the statuses

The Status page displays the following information:

  • The number of events and alerts the SCOM Connector has processed and sent to Moogsoft AIOps is shown in the Total Alerts Processed field.

  • The status of the connected Moogsoft AIOps SCOM LAMs is shown in the MOOG Server Status section.

  • The status of the SCOM Server currently fetching events from the SCOM Connector (typically the server with the highest priority) is shown in the SCOM Server Status section.

You can also open this page by entering http://localhost/<aliasname> in a browser on the machine where the SCOM Connector is installed. If you have administrative privileges, you can also open the page in the same domain as the SCOM server and connector.

Configure logging

You can configure the SCOM Connector logging in the SCOMConnector.exe.config file. Before making any changes, stop the SCOM Connector service. After saving the changes, allow 3-4 minutes before restarting the service.

The table below describes the configurable properties in the SCOMConnector.exe.config file.

Field

Description

Logging type

  • The file logging setting is in the <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender"> section. Defaults to enabled.

  • The event logging setting is in the <appender name="EventLogAppender" type="log4net.Appender.EventLogAppender" > section. Defaults to enabled.

Logging Level

  • Navigate to the <filter> section of the file logging and event logging to configure the logging level.

  • Use <levelMin value= ""/> and <levelMax ""value=/> to set the levels, placing one of the following values within each tag: OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL.

  • The values entered here include messages from all the log levels, from the defined min level to the defined max level.

  • If OFF is entered in <levelMin value= ""/>, then no log messages will be added to log.

  • if ALL is entered in <levelMin value= ""/>, then the messages from all the log levels will be added in the log.

Maintenance Mode

In Maintenance Mode, the Primary Connector is manually stopped for maintenance and the communication is handled by the Secondary Connector. After maintenance, the Primary connector starts and takes over the communication automatically.

To start the Connector in Maintenance Mode, enter the following into your browser:

http://<SecondaryConnectorIP>: port/set_isolation_mode/

Where <SecondaryConnectorIP> is the IP address of your secondary SCOM Connector.