SCOM plugin

Visit our website to see the data that you can access if you use this plugin to add the data source to SquaredUp:

Monitor your SCOM environment, including Windows Computers, Enterprise Applications and more.

The SCOM data source is for accessing data in your on-premises SCOM environment, see How to add a SCOM data source

The SCOM Managed Instance data source is for accessing data in the PaaS monitoring service. See How to add a SCOM Managed Instance (MI) data source

Blog: SCOM MI data source

How to add a SCOM data source

Note: This data source is an on-premises data source.

Configure the agent for a SCOM data source

Why do agents for the SCOM data source need special configuration?

The SquaredUp agent service uses the local system identity by default. SCOM uses Windows authentication which requires at a minimum Network Service or a Domain User account, the agent you use for the SCOM data source needs to have its service identity changed to such an account.

When using a NetworkService account, the computer account the agent is running on must be added to a Read Only Operator Role. If using a domain account for the service, the service account must be added to SCOM in a Read Only Operator role.

Configure and deploy an agent

If you have already created an agent in SquaredUp that you can use for this data source, you can skip this step and choose the agent group you want to use while adding the data source.

Deploying an agent

Create a unique API key for your agent and add the agent to an agent group in SquaredUp.

You create an API key by creating an agent in SquaredUp:
1. Go to Settings > Relay and add an Agent.
2. Give the new agent a name and a description that helps you identify where the agent is installed. For example:
  Name: server1.domain.local
  
  Description: Test server in production domain
3. Choose the Agent Group for this agent:
  1. If you already have agent groups, assign it to an existing group and click create.
  2. If you don't have any agent groups yet or want to assign the new agent to a new group, leave the Agent Groups field empty and click create. Then create the agent group by clicking on Add Agent Group and select the new agent in the Agents field for the new group.
4. After you created the agent, the API key for this agent will be shown to you. Copy the key and store it until you inserted the key into the configuration of the agent you want to deploy on your machine.
  
  The API key will only be displayed to you once. If you lose this API key, you need to generate a new one (by creating a new agent) and any references to the old API key in the configuration of the agent you deployed on your machine will need to be updated.
5. The agent status will show as gray until the next stage of configuring the service is completed successfully.

Deploy the agent on a machine that has access to the service the data source connects to.

Download the latest release of the SquaredUp agent zip file, by clicking the download icon under Options next to the agent you have just added.
Prerequisites for agents
- The agent needs to run on a Windows machine that has access to the entry point for the on-premises data source.
- Make sure the agent is able to make outbound connections on port 443 to SquaredUp (api.squaredup.com / eu.api.squaredup.com, depending on your region), *.amazonaws.com and Microsoft Azure Relay (*.servicebus.windows.net) - this may include firewall rules and proxy server allow lists.
- If a Proxy is required, set a system environment variable named ALL_PROXY with the location of the proxy server, as modern .Net applications do not use the proxy as shown in netsh.
  
  The proxy server may be a hostname or IP address (optionally followed by a colon and port number) or it may be a http URL (optionally including a username and password for proxy authentication). A proxy URL must be started with http, not https, and cannot include any text after the hostname, IP, or port. If the agent is running as a service, you will need to restart it, and may need to restart the server itself in some cases in order to apply the environment variable.
- For information about Relay Agent versions see Release Notes - Relay Agent
On a Windows machine, with access to the entry point your data source needs to use, extract the downloaded zip file.

In the folder of the extracted zip file, open PowerShell as an administrator and run the following command:

Copy

./Install-SQUPAgent.ps1 -ApiKey "key" -AsService -ServiceSuffix "name" -ServiceAccount domain\username

Parameters to replace:

`-ApiKey "key"`	Mandatory	Replace `key` with the API key you created for the agent in SquaredUp
`-AsService`	Recommended	Run the agent as a service on the machine
`-ServiceSuffix "name"`	Optional	To change the default service name of squpagent replace `name` with your new service name.
`-ServiceAccount domain\username`	Optional	To run the agent as a domain service account (for example, for the SCOM data source), provide the username as `domain\username` and it will prompt for the password when it sets up the service
`-InstallPath`	Optional	Specify a folder location for where the agent will be installed. If this is not specified then the agent will be installed in the folder where the zip file is extracted.

Consider restricting access to the folder where the agent is installed to prevent anyone from updating or viewing the configuration files.

Adjust any permissions for the service and start the service.
How to start the agent service
You can start the agent service from Services > SquaredUp Cloud Agent, or using PowerShell using either:

Start-Service -Name <ServiceName>

Where <ServiceName> should be replaced with the service name shown in brackets in the upgrade script output (or Properties of the service).

For example:

Start-Service -Name squpagent

or

Start-Service -DisplayName <DisplayName>

Where <DisplayName> should be replaced with the service name shown before the brackets in the upgrade script output (or Properties of the service).
How to find the agent folder location or Service name in Properties
Look at the Properties of the SquaredUp Cloud Agent service:

On the server running the agent, open Services

Scroll down to the SquaredUp Cloud Agent in the list

Right-click on the SquaredUp Cloud Agent service and then Properties

Here you can see the Service name, Display name and Path to the agent folder.

You can also start or stop the service from here.
Check the agent status in SquaredUp Settings > Relay

For more information see Configuring an agent for on-premises data sources

Add a SCOM data source in SquaredUp

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.
Display Name:

Enter a name for your data source. This helps you to identify this data source in the list of your data sources.
Agent Group:

Select the Agent Group that contains the agent(s) you want to use.
SCOM Management Server:

Enter your SCOM management server as a FQDN, for example server.domain.local
Dashboard Server SCOM Edition URL:

Optional. If you use SquaredUp DS for SCOM, you can enter the URL to your instance. This will create a link from a SCOM object in SquaredUp to the same object in your SquaredUp DS for SCOM.

Enter the URL to the root domain including https, for example: https://myserver.mydomain/SquaredUp/

What is my SquaredUp DS for SCOM URL?

By default, the URL to your SquaredUp instance is: http://SquaredUpServer/SquaredUpInstance

SquaredUpServer is the name of the server where SquaredUp is installed.

By default, SquaredUpInstance is SquaredUp. For v5 it is SquaredUpv5 and for v4 SquaredUpv4. If you gave your SquaredUp instance a different application name when you installed it, use the name you chose.

Advanced Settings:

Optionally, select the Advanced Settings check box to display the Custom Classes section, which allows you to retrieve additional classes from SCOM.

Click the Add new custom classes button to display the entry fields.
Enter a name for the additional class in the Class name field. For example, Windows Computer.

Enter / paste the JSON for the class you want to import in the Custom class JSON field. For example:

Copy

[
   {
      "name":"Import class 'Microsoft.Windows.Computer'",
      "classId":"ea99500d-8d52-fc52-b5a5-10dcd1e9d2bd",
      "types":[
         {
            "className":"Microsoft.Windows.Server.DC.Computer",
            "type":"addomaincontroller"
         },
         {
            "className":"Microsoft.Windows.Computer",
            "type":"host"
         }
      ],
      "properties":[
         
      ],
      "children":[
         {
            "name":"Import related class 'Microsoft.Windows.LogicalDevice'",
            "classId":"3361982a-7dfd-288d-f48c-e04e85149750",
            "types":[
               {
                  "className":"Microsoft.Windows.LogicalDisk",
                  "type":"volume"
               },
               {
                  "className":"Microsoft.Windows.NetworkAdapter",
                  "type":"interface"
               }
            ],
            "properties":[
               
            ]
         }
      ]
   }
]

The properties parameter

The optional properties parameter is a special property that provides a mechanism to add or modify properties from the target class. Here is the basic structure of the properties parameter:

Copy

"properties":[
   {
      "name":"Parameters",
      "as":"monitorUrl",
      "XPath":"/Parameters/Parameter[@name='URL']",
      "transform":"url"
   }
]

Example

To add a new property, simply omit the XPath, jsonPath, and transform options. Here is a functional example that adds the NetbiosComputerName field to the Windows Computer class:

Copy

[
   {
      "name":"Import class 'Microsoft.Windows.Computer'",
      "classId":"ea99500d-8d52-fc52-b5a5-10dcd1e9d2bd",
      "types":[
         {
            "className":"Microsoft.Windows.Server.DC.Computer",
            "type":"addomaincontroller"
         },
         {
            "className":"Microsoft.Windows.Computer",
            "type":"host"
         }
      ],
      "properties":[
         {
            "name":"NetbiosComputerName",
            "as":"netbiosComputerName"
         }
      ],
      "children":[
         {
            "name":"Import related class 'Microsoft.Windows.LogicalDevice'",
            "classId":"3361982a-7dfd-288d-f48c-e04e85149750",
            "types":[
               {
                  "className":"Microsoft.Windows.LogicalDisk",
                  "type":"volume"
               },
               {
                  "className":"Microsoft.Windows.NetworkAdapter",
                  "type":"interface"
               }
            ],
            "properties":[
               
            ]
         }
      ]
   }
]

Optionally, click the Add another custom class button to add an additional class and enable another line of entry fields.

Example

Here is a functional example of Custom class JSON you can enter to imports the Web Application Test Web Test Base class from SCOM:

Copy

[
   {
      "name":"Import class 'Microsoft.SystemCenter.WebApplicationTest.WebTestBase'",
      "classId":"8e5cb3e8-3a88-4301-a703-553772fe72dd",
      "types":[
         {
            "className":"Microsoft.SystemCenter.WebApplicationTest.WebTestBase",
            "type":"monitor"
         }
      ],
      "properties":[
         {
            "name":"Parameters",
            "as":"monitorUrl",
            "XPath":"/Parameters/Parameter[@name='URL']",
            "transform":"url"
         }
      ],
      "children":[
         
      ]
   }
]

Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

Click Add.

You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

How to add a SCOM Managed Instance (MI) data source

The SCOM Managed Instance data source is for accessing data in the SCOM MI PaaS monitoring service. Use the instructions in this section to configure SCOM MI and add the SCOM MI data source to SquaredUp.

If you only have the traditional on-premises SCOM (and have followed the instructions to add the SCOM data source above) and do not have SCOM MI then you do not need to use this section to add the SCOM MI data source.

Configure SCOM Managed Instance in Azure

Log in to the Azure Portal.
Search for SCOM Managed Instance and click on the instance to connect to SquaredUp.
Under Reports click the PowerBI tab.
Copy DB Name and DB Host URL. You will use these in the next section adding the data source to SquaredUp.
Click the SquaredUp link at the bottom of the page to login to your SquaredUp organization, and follow the steps in the next section to add the data source.

Add a SCOM Managed Instance data source in SquaredUp

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.
Display Name:

Enter a name for your data source. This helps you to identify this data source in the list of your data sources.
DB Name:

The database name of the SCOM MI data warehouse. This value can be found in the Reports section of the SCOM MI instance.
DB Host URL:

The URL of the SCOM MI database server. This value can be found in the Reports section of the SCOM MI instance. Keep the comma and port after the URL.
Username:

Enter the username of a SQL account to logon to SCOM MI.

The username must have data warehouse reader permissions to access SCOM MI data.
Password:

Enter the password of the SQL account.

Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

Click Add.

You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

How to add a SCOM Managed Instance (MI) On-Premise data source

The SCOM Managed Instance On-Premise data source is for accessing on-premise data in the SCOM MI PaaS monitoring service. Use the instructions in this section to configure SCOM MI On-Premise and add the SCOM MI On-Premise data source to SquaredUp.

Configure SCOM Managed Instance in Azure

Log in to the Azure Portal.
Search for SCOM Managed Instance and click on the instance to connect to SquaredUp.
Under Reports click the PowerBI tab.
Copy DB Name and DB Host URL. You will use these in the next section adding the data source to SquaredUp.
Click the SquaredUp link at the bottom of the page to login to your SquaredUp organization, and follow the steps in the next section to add the data source.

Add a SCOM Managed Instance On-Premise data source in SquaredUp

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.
Display Name:

Enter a name for your data source. This helps you to identify this data source in the list of your data sources.
Agent Group:

Select the Agent Group that contains the agent(s) you want to use.
DB Name:

The database name of the SCOM MI data warehouse. This value can be found in the Reports section of the SCOM MI instance.
DB Host URL:

The URL of the SCOM MI database server. This value can be found in the Reports section of the SCOM MI instance. Keep the comma and port after the URL.
Username:

Enter the username of a SQL account to logon to SCOM MI.

The username must have data warehouse reader permissions to access SCOM MI data.
Password:

Enter the password of the SQL account.

Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

Click Add.

You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

Using the SCOM data streams

Data streams are installed with this data source.

Metric

This data stream calls an API endpoint to get metrics from your SCOM instance, and allows you to enter a custom object name, counter name and instance name.

In the tile editor, filter by the SCOM data source, select Metric from the data stream list and then click Next.
Select the objects that you want to use and then click Next.
Enter an Object Name, for example: LogicalDisk.
Enter a Counter Name, for example: Free Megabytes.
Optionally, enter an Instance Name.
Optionally, enter the Top N number of items you want to see.
Check Sort descending if you want to sort the results descending instead of ascending.
Click Save.

Cloud KB LIVE.10.log-183548538.zip
4 KB Download

Link to workspace	User can link the data source to any workspace they have at least Editor permissions for. Data from the data source can then be viewed by anyone with any access to the workspace. User can share the data source data with anyone they want. User cannot configure the data source in any way, or delete it.
Full Control	User can change the data source configuration, ACL, and delete the data source.

Link to workspace	User can link the data source to any workspace they have at least Editor permissions for. Data from the data source can then be viewed by anyone with any access to the workspace. User can share the data source data with anyone they want. User cannot configure the data source in any way, or delete it.
Full Control	User can change the data source configuration, ACL, and delete the data source.

Link to workspace	User can link the data source to any workspace they have at least Editor permissions for. Data from the data source can then be viewed by anyone with any access to the workspace. User can share the data source data with anyone they want. User cannot configure the data source in any way, or delete it.
Full Control	User can change the data source configuration, ACL, and delete the data source.