How to use the OMS tile

The Squared Up OMS tile has been superseded by the Azure Log Analytics tile which is available in v3.4 and above. We recommend that you upgrade to the latest version of Squared Up and use the Log Analytics tile.

For a period of time both the OMS tile and Log Analytics tile will be available in Squared Up:

  • The OMS tile queries Log Analytics using the old query language. It enforces SCOM role-based access control (RBAC), but this does mean you cannot query Log Analytics for objects that are not in SCOM. It can only be used to query a single workspace on your Squared Up instance. The OMS tile will no longer work when Microsoft stops the old language API.

  • The Log Analytics tile queries Log Analytics using the new query language. It does not enforce RBAC. The configuration uses the provider config which may take slightly longer to set up, but you can clearly see what is configured in Azure, and if the correct permissions are missing. See How to use the Log Analytics tile.

Overview

The OMS tile allows you to query OMS for event data in the context of objects within SCOM and display that information as part of your Squared Up dashboard.

Using this tile you can unify data held within SCOM and OMS on the same screen to bring all collected monitoring information together into a single pane of glass.

To see the OMS tile in action take a look at the webinar ‘OMS Integration’:

Prerequisites

  • Squared Up v3 with an Enterprise Application Monitoring license – this gives you the OMS tile. See An Overview of Squared Up Licensing for more information.

  • A Microsoft Azure OMS instance

  • Azure subscription administrator role

  • Azure AD User Admin role

Squared Up v3.3 and above supports workspaces that have been upgraded to the new query language. Queries in the OMS tile must be formatted in the legacy language, the Log Analytics API then converts it to the new language and returns it in a format that is similar to the old language. Squared Up v3.4 and above supports the new query language via the Log Analytics tile.

Setting up the OMS service account

  1. On a suitable computer (does not need to be the Squared Up web server), install the Azure PowerShell SDK:

    http://aka.ms/webpi-azps

    The script has been tested on Azure SDK version 3.1
  2. Download the OMS setup script.

  3. Open an Azure PowerShell command prompt and run the OMS setup script.

  4. Follow the script prompts. You will need to know:

    • The name of your Azure subscription where OMS is activated

    • The name of your OMS instance

  5. As instructed by the script, copy the resulting settings from the output window to C:\inetpub\wwwroot\squaredupv3\user\configuration\oms.json

    If oms.json doesn’t exist in that location, paste into Notepad and Save As oms.json with the Save as type set to All Files.

  6. In IIS recycle the SquaredUpv3 application pool for the configuration to take effect.

Walkthrough: Adding an OMS query

The OMS feature appears as a new tile type in Squared Up.

  1. On the top navigation bar in Squared Up click the + to create a new dashboard, and give your dashboard a title.

  2. Click on the OMS tile.

    OMS tile button

  3. Click on the OMS (Grid) tile. Use OMS (Grid) when data is returned as a table, and OMS (Scalar) when a single figure is returned.

    OMS Grid button

  4. Scope the section as you normally would, for example to a group of servers. By doing so Squared Up will automatically filter the OMS results to only include the scoped objects, and will apply SCOM role-based access control. For this walkthrough you can click on group and then type All Windows Computers.

    If you want to scope your OMS data based on a SCOM class that is not hosted on a computer, you will need to modify the filterSourceProperty and filterTargetProperty settings for the tile using the JSON editor. See the JSON Reference section below for further information.
  5. Click next.

  6. Paste an OMS query into the query box. It’s useful to use the OMS portal to prepare and test your queries first. For this walkthrough try one of the following queries:

    • Recent interactive logons:

      Type=SecurityEvent EventID=4624 AND (LogonTypeName="10 - RemoteInteractive") | select TimeGenerated, Computer, Account

    • Recent software updates:

      Type=ConfigurationChange ConfigChangeType=Software | select TimeGenerated, Computer, SoftwareName, ChangeCategory

  7. Click outside the query box and you should see data appear after the tile.

    OMS data

  8. Click next and leave the limit set to 10.

  9. Click next.

  10. In the grid columns section click on the edit link next to the TimeGenerated column name. You see that a custom template has been applied which takes the unix time stamp and converts it to show how long ago the configuration change happened. You may like you can change this custom template to show the date:

  11. Click done.

Troubleshooting

Rollback: How to remove the OMS service account

  1. Log on to the Azure portal (not the preview portal): https://manage.windowsazure.com

  2. Select Active Directory in the left-hand navigation menu

  3. Select the Azure AD instance associated with your OMS instance

  4. Select Applications in the tab menu

  5. Change the Show dropdown to Applications my company owns and click the tick button

  6. Select squaredup-oms-plugin in the list and click Delete

JSON Reference

Sample Configuration

{
    "_type": "tile/oms-as-table",
    "config": {
        "context": {
            "scope": {
                "groupId": "",
                "classId": "ea99500d-8d52-fc52-b5a5-10dcd1e9d2bd",
                "criteria": ""
            }
        },
        "source": {
            "filterSourceProperty": "displayName",
            "filterTargetProperty": "Computer",
            "query": {
                "query": "Type = ConfigurationChange ConfigChangeType = Software | Select TimeGenerated , Computer, ChangeCategory",
                "limit": 10
            }
        },
        "display": {
            "columns": ["TimeGenerated","ChangeCategory","Computer"]
            "columnOverrides": {
                "TimeGenerated": {
                    "template": "{{timeago(value)}}",
                    "displayName": "TimeGenerated"
                }
            }
        }
    },
    "title": "Sample OMS tile",
    "description": "Displays Configuration changes on computers"
}

Schema reference

Name Values Required Designer Comments
Title text True True The name of the tile as displayed on the dashboard.
Description text True True The subheading of the tile as displayed on the dashboard.
objectIds Array of SCOM Id False True A list of specific SCOM objects for which will be used to filter the OMS data, specified by their IDs. This option is ignored if groupId or classId is specified.
groupId SCOM Id False True The GUID of a SCOM group, the members of which will be used to filter the OMS data. If omitted, the tile will show all instances of the specified class.
classId SCOM Id False True The GUID of a SCOM class, instances of which will be used to filter the OMS data. If groupId is specified, OMS data will be filtered only by members of the group that match the specified class (this includes objects contained in the top level items).
criteria text False True Criteria used to limit which objects will be used to filter OMS data. See How to use criteria when scoping objects for more information.
filterSourceProperty text True False The name of the SCOM object property that will have its value compared to the filterTargetProperty value in OMS to filter data.
filterTargetProperty text True False The name of the OMS object property that will have its value compared to the filterSourceProperty value in SCOM to filter data.
query text True True The query used to gather OMS data. Note that it will automatically have further filters applied based on the scope and source configuration settings.
limit integer True True Only displays the first n records, where n is the number specified.
columns Array of text False False Allows you to specify the exact list of columns you want shown in the tile, and their order. Any columns not listed will be removed. If omitted, all columns are shown.
columnOverrides JSON object False False Allows you to override the name of the column, and how data is displayed. Use the name of the column as a child property name, and then specify the template and/or displayname values to transform the column data or rename the column.

How to use the Log Analytics tile

An Overview of Squared Up Licensing

How to use criteria when scoping objects

How to use the Grid designer when configuring tiles label: How to use the OMS tile keywords: OMS Tile log analytics operations management suite azure language timeago kusto