Page tree
Skip to end of metadata
Go to start of metadata

Installing the SCOM Connector

Download

The current connector for download is available here SCOM-Connector-Advanced-4.2.zip.

The following requirements should met before installing the SCOM Connector:

  • Internet Information Services 6.0 should be enabled for viewing the Status GUI.
  • Windows Server 2012 or Windows Server 2016.
A user must have administrative privileges to install the SCOM Connector.
The SCOM Connector monitors only a single management group of SCOM Server. To monitor multiple management groups, multiple SCOM Connectors have to be installed. For each management group, there should be an installed 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. To install the connector, follow the steps mentioned below:

It is advisable to have the IP address and port of the REST Server that will be installed by the SCOM Connector, as it is to be entered in the installer GUI. The installer will install the REST Server using the entered IP addresses and ports.

  1. Unzip the downloaded SCOMConnectorInstaller folder on the SCOM Server or any other Windows Server 2012 machine.
  2. In the SCOMConnectorInstaller folder, double click on SCOMConnectorInstaller. The SCOM Connector Installer window will appear as shown below:


  3. Click the Add SCOM Server button. The SCOM Server Connection dialog will appear.
  4. Enter the following details in the dialog box and click the Add Connection button. The SCOM Servers are added in the SCOM Servers section:
    • Domain: The domain name of the SCOM Server.
    • SCOM Server Host Name: The host name of the SCOM Server, e.g. Winsvr1.
    • User Id: The user name of the SCOM Server. e.g. Administrator or someuser@corp.
    • Password: The user password.

  5. To add another SCOM Server, click the Add SCOM Server button and enter the details as explained above. This will add another SCOM Server from where the SCOM Connector will fetch alerts/events.

    The SCOM Servers of the same Management Group will be added here.

    The SCOM Servers which are added here will get a priority automatically. The SCOM Connector communicates with the SCOM Server with the highest priority, if the server goes down, then the SCOM Connector tries to communicate with the SCOM server with the next highest priority, and so on. The priority assigned to the SCOM Server can be changed in the SCOMConnectorConfig.json config file.

  6. Click the Add Moog Server button. The Moog Server Connection dialog will appear.
  7. Enter the following details in the dialog box and then click Add Connection. The Moog Servers are added in the Moog Servers section:
    • Moog URL: Enter the URL of the SCOM LAM.
    • Moog IP: The IP address of the SCOM LAM.
    • Moog Port: The port of the SCOM LAM.
    • Enable SSL: Select the checkbox to enable ssl authentication , uncheck it to bypass ssl key authentication.
    • PublicKey: The path of the SSL certificate. You can add a Public Key file by clicking the Browse button.



    • Proxy Authentication Required: Select the check box if proxy authentication is required for communication with the SCOM LAM.
    • Username: Enter the username along with the domain e.g. moogsoft\user1.
    • Password: Enter the password for the given username.
    • Proxy IP: Enter the IP address of the Proxy.
    • Proxy Port: Enter the port of the Proxy.  


    • If you have provided the Moog URL, then the Moog IP and Moog Port fields will become grayed out, and if you are specifying the details in the Moog IP and Moog Port fields, then the Moog URL field will be grayed out.

  8. Click the Add Moog Server button, and to add another Moog Server, enter the details as explained above.

  9. Enter the Connector URL in the Connector URL field. The connector URL is the IP address of the machine on which the connector will be installed and the port number is any available open port. Enter the IP address and port in the format: http://<IP Address>:<port>.

    After installation, REST server for the connector is installed with the given IP address and Port in the Connector URL field.

    The port given here should be a free port. In case of multiple installation of SCOM Connector, the port used by one connector should not be used with any other SCOM Connector.

  10. In the Connector Details tab, enter the Connector Service Name and the Connector Display Name. The Connector Service Name and the Connector Display Name should be unique. The installer installs the service with the name given in the Connector Display Name field.

    To install another SCOM connector on the same machine, make sure that for this connector, the Connector Service Name and the Connector Display Name are unique.

    The SCOM Connector (Basic) can also be installed along with the SCOM advanced Connector, but make sure that the advanced SCOM Connector is not installed with the service name SCOMConnector. With this service name, the basic SCOM Connector can not be installed; by default, it will install the service with the name SCOMConnector and this can lead to the failure of basic SCOM Connector installation.

    The fields HA Service Name and the HA Display Name can be left blank. To configure the HA for SCOM Connector, enter the names in these fields.

    There should be no space between the names entered in the Connector Service Name field.

  11. Click the Config tab, and then enter the alert storm threshold in the Alert Storm Threshold field. This is a threshold limit set to prevent an alert storm. If the number of alerts received by the SCOM Connector crosses the specified value, then a message will be sent to Moogsoft AIOps that the threshold is breached. By default, it is set to 10000. The threshold value can also be changed after installation in the SCOMConnectorConfig.json file.


  12. Select the Auto Start Service on Installation checkbox to start the SCOM Connector automatically after installation.


    If the Auto Start Service on Installation checkbox is not selected, then the SCOM Connector service has to be started manually from the Services view. The Services view can be opened by entering services.msc in the Windows RUN menu.

  13. Click Install. The SCOM Connector and its services will be installed.

    To Configure HA for SCOM Connector, select the HA Installation Mode checkbox, and enter the information for both Primary and Secondary HA Connector; In this case clikcing on Install button is not required. If HA is not to be configured for SCOM Connector, then simply click Install.

    The SCOMConnectorInstaller folder after installation will have all the files required for the SCOM Connector to function. So do not delete this folder. It will contain the log files of the SCOM Connector in the logs folder, the config files in the config folder, the uninstaller, and the screen to edit the configuration.

    After installation, all the files required for the functioning of the SCOM Connector will be avilable in the SCOMConnectorInstaller folder. Do not delete this folder, it contains the log files of the SCOM Connector in the logs folder, the config files in the config folder, the uninstaller, and the screen to edit the configuration.

For Installing another SCOM Connector on the same machine copy the SCOMConnectorInstaller folder to any other directory and follow the above procedure. In the same directory you can also make its copy and rename it e.g. SCOMConnectorInstaller1 and install it as explained above

The configurations entered during the installation are saved in the SCOMConnectorConfig.json file. The file is saved in the config folder within the SCOMConnectorInstaller folder.

The log file named SCOMConnector.log is generated in the logs folder of the SCOMConnectorInstaller folder after installation. All the logs of the installed SCOM Connector can be found in this folder. The location of the log file can be changed in the SCOMConnector.exe.config file, present in the SCOMConnectorInstaller folder.

The SCOM servers and the Windows server machine on which the connector will be installed should be in the same domain.

In the SCOM Connector multiple Moog Server configuration, if a connection with any of the connected Moog Server breaks, then a critical alarm is sent by the connector to all the other Moog Servers about the connection failure.

While restarting the SCOM connector, always make sure that it has stopped completely before starting the SCOM Connector again. There should be a gap of 3-4 minutes before starting the connector.

Editing the SCOM Connector Configuration from GUI

The configurations entered during installation can be changed after the installation. To make the changes:

  1. Click ScomConnectorInstaller in the SCOMConnectorinstaller folder. The SCOM Connector Installer window will appear as shown below:

    All the configurations and installation files of each installed connector is present in its respective SCOMConnectorinstaller folder. While making the changes to the configuration of SCOM Connector, it is advisable to check the correct SCOMConnectorinstaller folder of the connector.



  1. Click Stop Service.
  2. To add a SCOM Server or a Moog Server, click Add SCOM Server and enter the details as described in the above procedure.
  3. To remove any SCOM Server or a Moog Server, select the respective server and click Remove.
  4. Change the values in Connector URLHA URLSibling HA URL or Sibling Connector URL fields as required.

    The Connector URLHA URLSibling HA URL, and Sibling Connector URL fields will be editable only when the SCOM Connector is installed in a HA Configuration.

  5. Select the Config tab, and change the Alarm Storm Threshold as required.
  6. Click Update Config


  7. Click Start Service to start the SCOM Connector.

The changes done to the SCOM Connector are updated and saved to the SCOMConnectorConfig.json file. 

If any other configuration change is to be made for the SCOM Connector, then it can be done in the SCOMConnectorConfig.json file situated in the config folder of the SCOMConnectorInstaller folder.

Configuring the SCOM Connector

The user can configure the SCOM Connector according to their requirements. The configurations are done in the SCOMConnectorConfig.json file. An example of the configuration file is as follows:

      
  {
  "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",
  "AlertStormThreshold": 10000,
  "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.0 (Advanced)"
}

It is recommended to make changes to the SCOMConnectorConfig.json file only when it is required. As this config file determines how the SCOM Connector functions, and any wrong change may break the connector.


The SCOMConnectorConfig.json config file has the following 3 sections:

  • SCOM Servers: The information of the SCOM Servers added during installation, and its priority is saved in this section. The user can only change the priority here. If anything else other then the priority is changed, then the SCOM Connector can break. The highest priority is "1", and it decreases thereon e.g. "2", "3" etc.
  • Moog Servers: The information of the Moog Servers added during the installation and the proxy information, if configured, is saved in this section. The user does not have to make any changes here.
  • Other configurations: The configurations other than the SCOM Server and the Moog Server which is related to how the Connector will work can be done here. Some configurations are here only for informational purpose and should not be changed. The configurations that can be changed are as follows:

    • AlertStormThreshold: If the number of alerts received by the SCOM Connector crosses the given value, then a message is sent to Moogsoft AIOps that the threshold is breached. By default, it is set to 10000.
    • AlertPollCycleTime: The time period for polling the SCOM Connector to fetch alerts from SCOM. By default, it is set to 45 seconds. 
    • IsActiveEventPolling: If set to "true", the SCOM connector will fetch the events. If set to "false", the SCOM connector will not fetch the events. By default, it is set to false.
    • EventPollCycleTime: The time period for polling the SCOM Connector to fetch events from SCOM. By default, it is set to 45 seconds.

    • AmountOfTimeouts: The number of retry attempts is entered here. If it is set to "-1", then the SCOM Connector continuously retries to connect with the configured SCOM Servers. If any other positive integer is entered e.g. "4", then after a connection failure, it will try 4 times to connect with each configured SCOM server. If it is unable to connect, then the SCOM Connector will stop and an alert will be sent to the Moog.

    • LowerTimeoutBound: The LowerTimeoutBoundUpperTimeoutBound, and AmountOfTimeouts collectively decide the time duration after which a retry is attempted.

    • UpperTimeoutBound: The UpperTimeoutBound time is entered here.

    • Connector Name: The name of the connector is entered here.

    • ConnectorDescription: The description of the connector. 

    • ConnectorDisplayName: The display name of the connector.

    • MaxPollRetryAttempt: The number of retry attempts in case the SCOM Server fails to send the data to the SCOM Connector. This scenario occurs if SCOM Server has to send a large amount of data, and it fails in sending the data.

    • WinAuthOverrid: To enable Windows authentication for accessing the SCOM Server. If set to "true", then windows authentication will not be used for accessing SCOM. The override can be used when the SCOM and SCOM Connector are located on the same machine. By default, it is set to "False".
    • AuthTokenRequired: Set to true if auth token is also to be configured in SSL.

    • AuthTokenCode: Enter the auth token for SSL communication.

    • Version: The version of the installed SCOM Connector.

    Do not change the IsPrimary field, it is for informational purpose only.
    The fields SCOMConnectorRestUrl and the SiblingConnectorUrl are saved here from the entries made during installation and should not be changed.

    The SCOM Connector does not fetch the events from the SCOM Server, to start fetching the events, set the field IsActiveEventPolling to true.

    Before making any changes in the SCOMConnectorConfig.json file, stop the service of the connector in which the changes are to be made. After saving the changes, start the service again.

While restarting the SCOM connector, always make sure that it has stopped completely before starting the SCOM Connector again. There should be a gap of 3-4 minutes before starting the connector.

The last poll time on which the SCOM Connector polled the SCOM Server is stored in the config file SCOMLastPollTime.json, located in the Configs folder of the SCOMConnectorInstaller folder. The SCOM Connector after a communication failure resumes fetching events from the last poll time saved here.

In case of a long communication failure, the SCOM Connector will fetch alerts only up to 10 times the "AlertPollCycleTime". This is the case if the duration from the last poll time is greater than 10 times of "AlertPollCycleTime" . If the duration is less than 10 times the "AlertPollCycleTime", then the alerts are fetched from the last poll time.

SCOM Connector Logging

The user can configure the SCOM Connector logging according to their requirements. The configurations are done in the SCOMConnector.exe.config file. An example of the configuration file is as follows:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" requirePermission="false" />
  </configSections>
  <uri>
    <iriParsing enabled="true" />
  </uri>
  <log4net>
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
      <file value=".\logs\SCOMConnector.log" />
      <appendToFile value="true" />
      <rollingStyle value="Size"/>
      <datePattern value=".yyyy-MM-dd-hh_mm_ss"/>
      <maxSizeRollBackups value="5" />
      <maximumFileSize value="10MB"/>
      <staticLogFileName value="false" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %level %logger - %message%newline" />
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <levelMin value="INFO" />
        <levelMax value="FATAL" />
      </filter>
    </appender>
    <appender name="EventLogAppender" type="log4net.Appender.EventLogAppender" >
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %level %logger - %message%newline" />
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <levelMin value="INFO" />
        <levelMax value="FATAL" />
      </filter>
    </appender>
    <logger name="FileLogger">
      <level value="ALL" />
      <appender-ref ref="RollingFileAppender" />
      <appender-ref ref="EventLogAppender" />
    </logger>
  </log4net>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
  </startup>
  <system.web>
    <membership defaultProvider="ClientAuthenticationMembershipProvider">
      <providers>
        <add name="ClientAuthenticationMembershipProvider" type="System.Web.ClientServices.Providers.ClientFormsAuthenticationMembershipProvider, System.Web.Extensions, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" serviceUri="" />
      </providers>
    </membership>
    <roleManager defaultProvider="ClientRoleProvider" enabled="true">
      <providers>
        <add name="ClientRoleProvider" type="System.Web.ClientServices.Providers.ClientRoleProvider, System.Web.Extensions, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" serviceUri="" cacheTimeout="86400" />
      </providers>
    </roleManager>
  </system.web>
</configuration>

The following configurations can be made in the SCOMConnector.exe.config file:

  • Logging type: The file logging and event logging are by default enabled. The file logging setting is in the <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender"> section while the event logging section is in the <appender name="EventLogAppender" type="log4net.Appender.EventLogAppender" > .

  • Logging level: The log level of the SCOM can be changed in the <filter> section of the file logging as well as event logging. In this section navigate to <filter type="log4net.Filter.LevelRangeFilter"> and within its tags, change the <levelMin value= ""/> and the <levelMax ""value=/>. The values entered here include messages from all the log levels, from the defined min level to the defined max level. For example, if "DEBUG" is entered in <levelMin value= ""/> and "FATAL" in  <levelMax ""value=/>, then the messages of the log levels from DEBUGINFOWARNERROR and FATAL will be logged in the log file. The following log levels from max level to min level are as follows:

    • OFF
    • FATAL
    • ERROR
    • WARN
    • INFO
    • DEBUG
    • ALL

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

    By default, only the log levels from INFO to FATAL are included in logs. If the DEBUG level is to be included, then change accordingly as described above.

    Before making any changes in the SCOMConnector.exe.config file, stop the SCOM Connector service. After saving the changes, start the service again.

While restarting the SCOM connector, always make sure that it has stopped completely before starting the SCOM Connector again. There should be a gap of 3-4 minutes before starting the connector.

Installing the SCOM Connector HA

The HA Configuration in SCOM Connector includes installing separate REST Servers for HA. The IP addresses and port that are provided in the GUI creates individual REST Servers for HA communication. The arrangement of HA connectors are as follows:

After Installation of the SCOM Connector with HA, 2 services, one for HA communication and other for communication with SCOM Server are installed as per the service name given in the GUI. To understand the HA flow, lets take an example where MCM Service is the HA service name and SCOM Connector is the SCOM Connector Service name.

The services manage the REST servers installed with the installation of the connector. The SCOM Connector Service manages REST Server and Client of the Connector that Receives alerts/events from SCOM Server and send it to Moogsoft AIOps. The MCM Service manages the REST Server and Client used for establishing communication between the Primary and Secondary SCOM Connectors.

In HA Configuration the Primary SCOM Connector receives all the alerts/events from the SCOM Servers and the Secondary SCOM Connector remains inactive. The MCM Service monitors the SCOM Connector service, the MCM Service takes the Heartbeat of the connection between the SCOM Server and the SCOM Connector Service and forwards it to the SCOM Secondary Connector.

The Secondary SCOM Connector continuously receives the Heartbeat of the Primary SCOM Connector. The MCM Service at the Secondary SCOM Connector monitors the Heartbeat. In the case of a connection failure between the Primary SCOM Connector and SCOM Servers, the Heartbeat will not be received by the MCM Service of the Secondary SCOM Connector, and it will then initiate the handover. In initiating the handover, the SCOM Connector service (the Connector REST Servers ) of the Secondary SCOM Connector establishes the connection with the SCOM Servers and Moogsoft AIOps.

The steps to configure HA is as follows:

It is advisable to have information of all the IP addresses and ports of the REST Servers that will be installed, as these are to be entered in the installer GUI. The installer will install the REST Servers using these entered IP addresses and ports.

Install the Primary SCOM Connector before the Secondary SCOM Connector.


Installing the Primary SCOM Connector

  1. Add the SCOM Servers and the Moog Servers. Enter the value in the Connector URL field in the SCOM Connector Installer window as explained in the above procedure.


  2. Select the HA Installation Mode check box, then click the Primary Mode  radio button.
  3. In HA URL field, Enter the URL of the machine on which the connector is installed. For Example, if the connector is installed on the machine with IP 10.142.24.55 and 8084 is a free port, then the URL will be http://10.142.24.20:8084.

    Do not enter the port used in the Connector URL field.

  4. Enter the URL of the HA REST Server of the Secondary SCOM Connector installed on the another machine in the Sibling HA URL field.
  5. Enter the URL of the Secondary SCOM Connector REST server in the Sibling Connector URL field.
  6. Enter the HA Service Name and the HA Display Name.

    There should be no space between the names entered in the HA Service Name field.

  7. Click Install.

The SCOM Connector along with the services given in the HA Service Name and Connector Service Name are installed on the server.

The HA configurations entered during the installation are saved in the MCMServiceConfig.json file. The file is saved in the Configs folder of the SCOMConnectorInstaller folder.

Installing the Secondary SCOM Connector

  1. Open the installer by clicking ScomConnectorInstaller on another machine where you want to install the Secondary SCOM Connector.
  2. Add the SCOM Servers and the Moog Servers. Enter the value in the Connector URL field in the SCOM Connector Installer window as explained in the above procedure.



  3. Select the HA Installation Mode check box, and then click the Secondary Mode radio button.
  4. Enter the URL of the machine on which the connector is installed in Primary mode along with a free open port in the HA URL field. For Example, if the connector is installed on the machine with IP 10.142.24.63 and 8084 is a free port, then the URL will be http://10.142.24.63:8084.

    Do not enter the port used in the Connector URL field.

  5. Enter the URL of the HA REST Server of the Primary SCOM Connector installed on the another machine in the Sibling HA URL field.
  6. Enter the URL of the Primary SCOM Connector REST server in the Sibling Connector URL field.
  7. Enter the HA Service Name and the HA Display Name.

    There should be no space between the names entered in the HA Service Name field.

  8. Click Install.

The SCOM Connector along with the services given in the HA Service Name and Connector Service Name are installed on the server.

The HA configurations entered during the installation are saved in the MCMServiceConfig.json file. The file is saved in the Configs folder of the SCOMConnectorInstaller folder.

SCOM Connector HA Configuration

The HA configurations entered during the HA connector installation are saved in the MCMServiceConfig.json file. An example of the configuration file is as follows:

{
  "IsHaPrimary": true,
  "HaServiceUrl": "http://10.142.24.86:8012",
  "SiblingHaUrl": "http://10.142.24.16:8012",
  "ConnectorUrl": "http://10.142.24.86:8011",
  "SiblingConnectorUrl": "http://10.142.24.16:8011",
  "MCMServiceName": "SCOMMCM1",
  "MCMServiceDisplayName": "SCOMMCM1",
  "ConnectorName": "SCOMHA1"
}

The user does not have to make any changes in the above file.

SCOM Connector HA Logging

The logging levels and path for the HA logs can be changed in the MCMservice.exe.config file. To change the logging levels and path, refer the SCOM Connector Logging section.

Before making any changes in the MCMservice.exe.config file, stop the MCM Service. After saving the changes, start the service again.

HA Failure Scenarios

Scenario 1: Primary Connector is fully operational

  • The Secondary Connector will periodically communicate with the Primary MCM to check connectivity and operational readiness.
  • The Primary Connector will periodically communicate with the Secondary MCM to check connectivity and operational readiness.

Scenario 2: The Primary Connector loses connection with Moog

  • The connector receives the alerts from SCOM and puts it in the queue at the time of connection break with Moogsoft AIOps.
  • Once the connection is re-established, the events in the queue will be sent to Moogsoft AIOps.

Scenario 3: The Primary Connector loses connection with SCOM

  • The Primary Connector retries to re-connect with SCOM Server until all the retry attempts are exhausted.
  • The Secondary Connector checks the Primary MCM to see if the Primary Connector is fully operational.
  • The Secondary Connector recognizes that the Primary connector is not fully operational.
  • The Secondary Connector starts downloading the alerts from last known successful Poll Time.

  • The Secondary Connector periodically checks with the Primary MCM to see if Primary is fully operational again.
  • If the Primary MCM is fully operational again, the Secondary Connector completes its cycle and goes into standby.

Scenario 4: The Primary Connector is NOT fully operational, and the Secondary Connector loses connection with SCOM

  • The Secondary Connector retries to re-connect with SCOM Server, till all the retry attempts are exhausted and after exhausting the retry attempts the Connector goes down.

Scenario 5: The Primary Connector is NOT fully operational, and the Secondary Connector loses connection with Moog

  • The Secondary Connector receives the alerts from SCOM and puts it in the queue at the time of connection break with Moogsoft AIOps. Once the connection is re-established, it sends the saved data to Moogsoft AIOps.
  • Errors are logged locally.

Scenario 6: The Primary MCM can't connect to the Primary Connector

  • The Secondary Connector becomes operational.

Scenario 7: The Secondary Connector can't connect to the Primary MCM

  • The Secondary Connector starts downloading the alerts from last known successful Poll Time.
  • The Secondary Connector periodically checks with the Primary MCM to see if it is fully operational again.
  • If the Primary MCM and Primary is fully operational again, the Secondary Connector completes its cycle and goes into standby.
If both Primary and Secondary Connectors are down, then start the services for both the connectors form the installer GUI. This will update the required config files.

Uninstalling the SCOM Connector v3.0 and above

To uninstall the SCOM Connector:

  1. Navigate to the SCOMConnectorinstaller folder of the connector. It is the same folder from where you have installed the SCOM Connector.
  2. Click UninstallSCOMConnector present in the folder.

The SCOM Connector and its services are uninstalled.

Uninstalling the SCOM Connector v2.2 or below

To uninstall the SCOM Connector:

  1. Click the Windows button, and then search for uninstall SCOM connector. 
  2. Click Uninstall SCOM Connector.

  3. Click Yes to uninstall the connector, else click No.



Alternatively, the user can also uninstall the Connector from Windows Programs and Features in Control Panel. Uninstall the program ScomConnectorInstaller.

The Uninstall SCOM Connector can also be accessed from the shortcut present on the desktop.

Hosting the Status Page on IIS

The status page provides information of the up and down status of the SCOM Connector, SCOM Server, and the SCOM LAM. To host the status page on IIS (Internet Information Services) proceed as follows:

  1. Navigate to the ScomConnectorInstaller  > WebUI folder.

    ScomConnectorInstaller is the same folder that was unzipped and copied to the machine for installing the SCOM connector.

  2. Open the Index.html file in notepad. 
  3. Replace the port "8085" present in the file with the port given in the Connector URL field of the installer GUI. Refer the above Installing the SCOM Connector section in this guide.

    This is the port of the REST server which is installed on the machine by the Connector installer.

  4. Click the Windows Start button, and then select the Administrative Tools. 
  5. Double click on Internet Information Services (IIS) Manager. The Internet Information Services (IIS) Manager view will appear as shown below:
  6. Navigate to Default Web Site in the Connection section, then open the context menu and select Add Virtual Directory. The Add Virtual Directory dialog box will appear as shown below:
  7. 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.
  8.  To open the status page, click the Browse *:80(http) from the Actions menu.

The status page is hosted on the Internet Information Services (IIS) Manager.


The status page is to be hosted for every installed SCOM Connector.


Viewing the status of SCOM Server, SCOM Connector, and SCOM LAM

The status page provides the following information:

  • The number of alerts processed and sent to Moogsoft AIOps by the SCOM Connector in a session is shown in the Total Alerts Processed field.
  • The number of events processed and sent to Moogsoft AIOps by the SCOM Connector in a session is shown in the field Total Events Processed field.
  • The status of the connected Moogsoft AIOps SCOM LAMs is shown in the MOOG Server Status section.
  • The status of the SCOM Servers connected with the SCOM Connector is shown in the SCOM Server Status section.


The user can open this page by entering http://localhost/alias name> in a browser on the machine where the SCOM Connector is installed.

The user can open the status page in the same domain as SCOM server and connector, with administrative privileges.

The user can open the status page only on the machine on which it was hosted.

The status page will show only the SCOM Server with the highest priority or the server from which the SCOM Connector is fetching events.

MOOBOT Configuration

The MOOBOT sends the update about the status change in alerts/events to the SCOM Connector. The SCOM Connector then updates the changes to alerts/events on SCOM Server.

The MOOBOT is configured as follows:

  1. Uncomment the AlertMgr section in the Moog_farmd.conf file in the /usr/share/moogsoft/config directory.

                        {
                             name                 : "AlertMgr",
                             classname            : "CEmptyMoolet",
                             run_on_startup       : true,
                             persist_state        : false,
                             metric_path_moolet   : false,
                             moobot               : "AlertMgr.js",
                            
                             Listens for alerts events (on the /alerts
                             topics).
                            
                             event_handlers    : [
                                                    "AlertClose",
                                                    "AlertUpdate",
                                                    "Alert"
                                                 ]
                        }
  2. Update the function updateAlert in the MOOBOT AlertMgr.js in the directory /usr/share/moogsoft/bots/moobots according to the example mentioned below:

    function updateAlert(alert)
    {
        //
        // Post change to remote service
        //
        var alertId = alert.value("external_id");
        var customInfo = alert.getCustomInfo();
        var alrt_status = alert.value("state");
        var sql = "select name from status where status_id='"+alrt_status+"'"; 
        var entities = moogdb.query(sql); 
        while(entities && entities.hasNext())
         {
            var entity = entities.next();
            var name = entity.value('name');
         } 
        if (customInfo !== null)
         {
            var remoteId = customInfo.remoteId;
            if (remoteId !== null)
            {
                var info =
                {
                    id: alertId,
                    description:alert.value("description"),
                    detail: name
                };
    
                var response = rest.sendPost("http://10.142.24.20:8085/event_post/", JSON.stringify(info));
                var text =  JSON.stringify(response);
                var obj = JSON.parse(text);          
                if (obj.status_code !== "200")
                {
                    var response1 = rest.sendPost("http://10.142.24.15:8085/event_post/", JSON.stringify(info)); 
                }
            }
        }
        alert.set("description", "New description here");
        alert.set("severity", "3");
        alert.set("manager", "New manager here");
    
        var result=moogdb.updateAlert(alert);
    
        if (result === false)
        {
            logger.warning("Alert ID: " + alert.value("alert_id") + " update attempt was not successful");
        }
    }

    All the IP address mentioned in the AlertMgr.js file has to be changed to the IP Addresses of the REST Servers of SCOM connector.

    Enter the Primary SCOM Connector address in the line var response = rest.sendPost("http://10.142.24.20:8085/event_post/", JSON.stringify(info));.

    Enter the Secondary SCOM address in the line var response1 = rest.sendPost("http://10.142.24.15:8085/event_post/", JSON.stringify(info));.

    The above MOOBOT configuration caters to the HA of SCOM Connectors,  the line var response = rest.sendPost("http://10.142.24.20:8085/event_post/", JSON.stringify(info)); sends the update to the Primary SCOM Connector and if it fails, then it sends the update to the Secondary SCOM Connector, as per the line var response1 = rest.sendPost("http://10.142.24.15:8085/event_post/", JSON.stringify(info));. In case of non HA Configuration, remove the following lines from the above code:

                if (obj.status_code !== "200")
                {
                    var response1 = rest.sendPost("http://10.142.24.15:8085/event_post/", JSON.stringify(info)); 
                }

SSL Configuration

To configure SSL, the following configurations are required:

  1. Create a new folder. Open command prompt and navigate to the newly created folder.

  2. Run the following command in the command prompt. A Server certificate and a server.key file is generated in the above created folder.

    openssl req -new -x509 -days 365 -nodes -subj "/C=''/ST=''/L=''/O='moogsoft'/OU=''/CN=localhost" -out server.crt -keyout server.key > /dev/null 2>&1
    

    In the above command, for the part /CN=localhost, instead of localhost, enter the hostname of the machine where the SCOM LAM is running.

    Copy the generated certificates to the machine where SCOM LAM is running.

  3. Enter the following parameters in the monitor section of the SCOM LAM:
    • Enter the port on which the SSL communication will be done in the field port, e.g. 48002.
    • Set the field use_ssl to true.
    • Enter the path of the directory where the Server certificate is copied, in the path_to_ssl_files, e.g.  "../config".
    • Enter the name of the Server certificate in the field ssl_key_filename, e.g. "server.key".
    • Enter the name of the Server certificate in the ssl_cert_filename, e.g. "server.crt".
    • Set the field use_client_certificates to false.
    • Select TLSv1.2 in ssl_protocols.

The SSL is configured for SCOM.

Maintenance Mode

In the 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. The following URL is to be entered in a browser for starting the Maintenance Mode.

http://Secondary connector Ip: port/set_isolation_mode/

Upgrading the SCOM Connector

To upgrade the SCOM Connector proceed as follows:

  1.  Take the backup of the following SCOM configuration files:
    • SCOMConnectorConfig.json file is located in the Configs folder of the SCOMConnectorInstaller folder.
    • SCOMConnector.exe.config file is located in the SCOMConnectorInstaller folder.
    • MCMServiceConfig.json file located in the Configs folder of SCOMConnectorInstaller folder. This file has to be saved on both the machines where the Primary and the Secondary SCOM Connectors are installed.

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

      The MCMService.exe.config and the MCMServiceConfig.json files have to be saved only if HA is configured for SCOM Connector, otherwise, it can be ignored.

  2. Uninstall the existing connector using the UninstallSCOMConnector 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 any configuration changes are to be made, then edit the newly created configuration file. The user can refer the backed up configuration file for any previous configuration that is to be made in the new configuration file.

    Do not replace the newly created configuration file with the backed up configuration file.

The SCOM Connector is upgraded.

SCOM Connector Version Information

Connector Version

Tool Version

Verified by

Expected to Work

1.0

SCOM 2012 & SCOM 2016

Yes

Yes

2.0SCOM 2012 & SCOM 2016YesYes
2.1SCOM 2012 & SCOM 2016YesYes
2.2SCOM 2012 & SCOM 2016YesYes
3.0SCOM 2012 & SCOM 2016YesYes
3.1SCOM 2012 & SCOM 2016YesYes
3.2SCOM 2012 & SCOM 2016YesYes
3.3SCOM 2012 & SCOM 2016YesYes
4.0SCOM 2012 & SCOM 2016YesYes

New Features in SCOM Connector (Advanced) v4.0

  • Enhanced User Interface to provide URL/FQDN for Moog Server (e.g.: https://example.moogsoft.io/scom)
  • Enhanced User Interface to specify ssl certificate per moog server.
  • Option to bypass ssl certificate authentication in https mode.

New Features in SCOM Connector (Advanced) v3.3

  • All the implementations will now get signed by using a Moogsoft Certificate. 
  • An auth token support bug has been fixed.

New Features in SCOM Connector (Advanced) v3.2

  • Timezone issue in which the SCOM does not receive alerts for timezones having time greater than UTC time is fixed.

New Features in SCOM Connector (Advanced) v3.1

  • Bi-Directional flow issue with the SCOM Connector is fixed.

New Features in SCOM Connector (Advanced) v3.0

  • Multiple SCOM Connectors can be installed on the same machine.
  • The service names of the SCOM Connectors installed are now configured through the Installer GUI. Once configured, the service name cannot be changed.
  • Management Group support for SCOM Connectors; one Connector supports only one Management Group. To fetch events from multiple Management Groups, multiple SCOM Connectors are to be installed.
  • The SCOM servers added to a SCOM Connector are assigned a priority, the SCOM Connector fetches the alerts from the server having the highest priority. If the server with the highest priority fails, then the SCOM Connector connects with the other available server with a lower priority.
  • Infinite retry attempts is supported. Enter "-1" in the "AmountOfTimeouts" field of SCOMConnectorConfig.json file. By default, it is set to "-1".
  • The SCOM Connector can now fetch alerts only up to 10 times the "AlertPollCycleTime". This is the case if the duration from the last poll time is greater than 10 times of "AlertPollCycleTime" . If the duration is less than 10 times the "AlertPollCycleTime", then the alerts are fetched from the last poll time.
  • The SCOM Connector now has separate folders for logs and config files. The Config file is saved in the Configs directory of the Installer folder, while the logs are saved in the Logs directory of the Installer folder.
  • The configurations are saved even after uninstallation. Uninstalling the SCOM Connector and then reinstalling it from the same folder, will automatically fill the previous configurations in the installer GUI.
  • The status page will show either the SCOM Server with the highest priority or the server from which the SCOM Connector is fetching events.

New Features in SCOM Connector (Advanced) v2.2

  • Automatic Service Restart of the SCOM Connector service and the MCM Service.
  • Separate config file to save the last poll time stamp. The name of this config file is SCOMLastPollTime.json.
  • Changed Master-Slave to Primary-Secondary.
  • Different SCOM Servers can be added to Primary and Secondary SCOM Connectors.

New Features in SCOM Connector (Advanced) v2.1

  • SCOM Connector supports communication through proxy with SCOM LAM.
  • New uninstaller for the SCOM Connector.
  • Windows Event Logging is now supported by the SCOM Connector.
  • During installation, the user can select to stop SCOM Connector from starting automatically after installation.
  • Alert Storm Threshold can be entered during installation.
  • Configurations entered during installation can be edited from the GUI.
  • Support for Multiple Moog.
  • If any of the added SCOM Server goes down, then the alert will be sent to Moog .
  • If one of the Moog in a Multi Moog setup goes down, then the alert will be sent to other Moogs.
  • No labels