Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Microsoft System Center Operations Manager (SCOM) is a cross-platform data center monitoring system for operating systems and hypervisors. It uses a single interface to display state, health, and performance information of computer systems. It also generates alerts for availability, performance, configuration, or security situations that get identified.

This document provides information about the Microsoft SCOM connector, which facilitates automated interactions, with a Microsoft SCOM server using FortiSOAR™ playbooks. Add the Microsoft SCOM connector as a step in FortiSOAR™ playbooks and perform automated operations, such as fetching a list of endpoints and alerts available on the SCOM server and retrieving information about all devices.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.9.0.0-708

Authored By: Fortinet

Certified: Yes

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-microsoft-scom

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

  • You must have the URL of Microsoft SCOM server to which you will connect and perform automated operations and credentials to access that server.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the connectors page, select the Microsoft SCOM connector and click Configure to configure the following parameters:

Parameter Description
Server Address

IP address of the Microsoft SCOM server to which you will connect and perform automated operations.

Username Username to access the Microsoft SCOM server.
Password Password to access the Microsoft SCOM server.
WinRM Port WinRM Port on the Microsoft SCOM server.
WinRM Protocol Protocol used to remotely connect to the Microsoft SCOM server. Choose between http or https.

By default, https is used.

Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
List Endpoints Fetches a list of all endpoints that are available on the SCOM server or specific endpoints based on the domain name you have specified. get_endpoints
Investigation
Get Alerts Fetches a list of all alerts that are available on the SCOM server or specific list of alerts based on the computer name you have specified. get_alerts
Investigation
Get Device Information Retrieves information about all devices on the SCOM server or specific devices based on the IP and computer name you have specified. get_endpoint
Investigation
Set Resolution State Sets the resolution state of an alert on the SCOM server based on the alert ID and resolution state you have specified. set_state
Containment
Update Alert Updates an alert on the SCOM server based on the alert ID you have specified. update_alert
Containment
Close Alert Closes an alert on the SCOM server based on the alert ID you have specified. close_alert
Remediation

operation: List Endpoints

Input parameters

Parameter Description
Domain (Optional) Name of the domain for which you want to retrieve the list of endpoints.
Note: If  you do not specify this parameter, then no filter criterion is applied and an unfiltered list is returned.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": [ 
         { 
             "LastModified": "", 
             "InstalledBy": "", 
             "RequestCompression": "", 
             "NetworkName": "", 
             "MaximumQueueSizeBytes": "", 
             "PrincipalName": "", 
             "PatchList": "", 
             "ActionAccountIdentity": "", 
             "HealthState": "", 
             "HostedHealthService": "", 
             "HeartbeatInterval": "", 
             "ManagementGroup": "", 
             "Version": "", 
             "InstallTime": "", 
             "Domain": "", 
             "ManuallyInstalled": "", 
             "Id": "", 
             "Name": "", 
             "CreateListener": "", 
             "DisplayName": "", 
             "ProxyingEnabled": "", 
             "AuthenticationName": "", 
             "HostComputer": "", 
             "ManagementGroupId": "", 
             "ComputerName": "", 
             "MaximumSizeOfAllTransferredFilesBytes": "", 
             "CommunicationPort": "", 
             "PrimaryManagementServerName": "", 
             "IPAddress": "" 
         } 
     ] 
}

operation: Get Alerts

Input parameters

Parameter Description
Computer Name (Optional) Name of the computer that contains the alerts that you want to retrieve.
Note: If  you do not specify this parameter, then no filter criterion is applied and an unfiltered list is returned.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": [ 
         { 
             "LastModified": "", 
             "Context": "", 
             "CustomField6": "", 
             "RuleId": "", 
             "ConnectorId": "", 
             "PrincipalName": "", 
             "TimeResolutionStateLastModified": "", 
             "ResolutionState": "", 
             "TfsWorkItemId": "", 
             "TimeRaised": "", 
             "ManagementGroupId": "", 
             "CustomField9": "", 
             "Parameters": "", 
             "StateLastModified": "", 
             "Severity": "", 
             "CustomField2": "", 
             "MonitoringObjectName": "", 
             "MonitoringObjectId": "", 
             "MonitoringObjectPath": "", 
             "Priority": "", 
             "MonitoringObjectFullName": "", 
             "MonitoringRuleId": "", 
             "Description": "", 
             "TimeAdded": "", 
             "MaintenanceModeLastModified": "", 
             "CustomField1": "", 
             "ClassId": "", 
             "TfsWorkItemOwner": "", 
             "ResolvedBy": "", 
             "MonitoringClassId": "", 
             "CustomField3": "", 
             "MonitoringObjectInMaintenanceMode": "", 
             "CustomField4": "", 
             "LastModifiedBy": "", 
             "CustomField5": "", 
             "CustomField10": "", 
             "NetbiosComputerName": "", 
             "ConnectorStatus": "", 
             "ManagementGroup": "", 
             "SiteName": "", 
             "LastModifiedByNonConnector": "", 
             "Name": "", 
             "CustomField8": "", 
             "ProblemId": "", 
             "Id": "", 
             "IsMonitorAlert": "", 
             "CustomField7": "", 
             "Owner": "", 
             "TimeResolved": "", 
             "NetbiosDomainName": "", 
             "UnformattedDescription": "", 
             "RepeatCount": "", 
             "Category": "", 
             "TicketId": "", 
             "MonitoringObjectDisplayName": "", 
             "MonitoringObjectHealthState": "" 
         } 
     ] 
}

operation: Get Device Information

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criteria is applied and an unfiltered list is returned. 

Parameter Description
IP Address IP address for which you want to retrieve information, such as Name, HeartbeatInterval, and HealthState for all devices.
Computer Name Name for which you want to retrieve information, such as Name, HeartbeatInterval, and HealthState for all devices.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": { 
         "LastModified": "", 
         "InstalledBy": "", 
         "RequestCompression": "", 
         "NetworkName": "", 
         "MaximumQueueSizeBytes": "", 
         "PrincipalName": "", 
         "PatchList": "", 
         "ActionAccountIdentity": "", 
         "HealthState": "", 
         "HostedHealthService": "", 
         "HeartbeatInterval": "", 
         "ManagementGroup": "", 
         "Version": "", 
         "InstallTime": "", 
         "Domain": "", 
         "ManuallyInstalled": "", 
         "Id": "", 
         "Name": "", 
         "CreateListener": "", 
         "DisplayName": "", 
         "ProxyingEnabled": "", 
         "AuthenticationName": "", 
         "HostComputer": "", 
         "ManagementGroupId": "", 
         "ComputerName": "", 
         "MaximumSizeOfAllTransferredFilesBytes": "", 
         "CommunicationPort": "", 
         "PrimaryManagementServerName": "", 
         "IPAddress": "" 
     } 
}

operation: Set Resolution State

Input parameters

Parameter Description
Alert ID ID of the alert whose resolution state you want to change.
Resolution State Resolution state that you want to assign to the specified alert.
Choose between New, Closed, Acknowledge, Assigned to Engineering, Awaiting Evidence, Resolved, and Scheduled.
You can also specify Custom State that has been created as a resolution state.
Custom Resolution State ID

(Optional) ID of the Custom resolution state that you want to assign to the alert. You must specify the Custom ResolutionState ID only if you have selected Custom State in the Resolution State field.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": "" 
}

operation: Update Alert

Input parameters

Parameter Description
Alert ID ID of the alert that you want to update.
Owner (Optional) If you want to update the owner of the alert, then add the updated owner in this field.
Ticket ID (Optional) If you want to update the ticket ID of the alert, then add the updated ticket ID in this field.
Custom Fields (Optional) You can add or update custom fields, in the JSON format, that you want to update in the alert:
For example:
{  
"CustomField1": "",
"CustomField2": "",
"CustomField3": "",
}
Resolution State (Optional) Resolution state that you want to assign to the specified alert.
Choose between New, Closed, Acknowledge, Assigned to Engineering, Awaiting Evidence, Resolved, and Scheduled.
You can also specify Custom State that has been created as a resolution state.
Custom Resolution State ID

(Optional) ID of the Custom resolution state that you want to assign to the alert. You must specify the Custom ResolutionState ID only if you have selected Custom State in the Resolution State field.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": "" 
}

operation: Close Alert

Input parameters

Parameter Description
Alert ID ID of the alert that you want to close.
Comment (Optional) Comment containing the reason for closing the alert.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": "" 
}

Included playbooks

The Sample - Microsoft SCOM - 1.0.0 playbook collection comes bundled with the Microsoft SCOM connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Microsoft SCOM connector.

  • Close Alert
  • Get Alerts
  • Get Device Information
  • List Endpoints
  • Set Resolution State
  • Update Alert

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.

About the connector

Microsoft System Center Operations Manager (SCOM) is a cross-platform data center monitoring system for operating systems and hypervisors. It uses a single interface to display state, health, and performance information of computer systems. It also generates alerts for availability, performance, configuration, or security situations that get identified.

This document provides information about the Microsoft SCOM connector, which facilitates automated interactions, with a Microsoft SCOM server using FortiSOAR™ playbooks. Add the Microsoft SCOM connector as a step in FortiSOAR™ playbooks and perform automated operations, such as fetching a list of endpoints and alerts available on the SCOM server and retrieving information about all devices.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.9.0.0-708

Authored By: Fortinet

Certified: Yes

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-microsoft-scom

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the connectors page, select the Microsoft SCOM connector and click Configure to configure the following parameters:

Parameter Description
Server Address

IP address of the Microsoft SCOM server to which you will connect and perform automated operations.

Username Username to access the Microsoft SCOM server.
Password Password to access the Microsoft SCOM server.
WinRM Port WinRM Port on the Microsoft SCOM server.
WinRM Protocol Protocol used to remotely connect to the Microsoft SCOM server. Choose between http or https.

By default, https is used.

Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
List Endpoints Fetches a list of all endpoints that are available on the SCOM server or specific endpoints based on the domain name you have specified. get_endpoints
Investigation
Get Alerts Fetches a list of all alerts that are available on the SCOM server or specific list of alerts based on the computer name you have specified. get_alerts
Investigation
Get Device Information Retrieves information about all devices on the SCOM server or specific devices based on the IP and computer name you have specified. get_endpoint
Investigation
Set Resolution State Sets the resolution state of an alert on the SCOM server based on the alert ID and resolution state you have specified. set_state
Containment
Update Alert Updates an alert on the SCOM server based on the alert ID you have specified. update_alert
Containment
Close Alert Closes an alert on the SCOM server based on the alert ID you have specified. close_alert
Remediation

operation: List Endpoints

Input parameters

Parameter Description
Domain (Optional) Name of the domain for which you want to retrieve the list of endpoints.
Note: If  you do not specify this parameter, then no filter criterion is applied and an unfiltered list is returned.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": [ 
         { 
             "LastModified": "", 
             "InstalledBy": "", 
             "RequestCompression": "", 
             "NetworkName": "", 
             "MaximumQueueSizeBytes": "", 
             "PrincipalName": "", 
             "PatchList": "", 
             "ActionAccountIdentity": "", 
             "HealthState": "", 
             "HostedHealthService": "", 
             "HeartbeatInterval": "", 
             "ManagementGroup": "", 
             "Version": "", 
             "InstallTime": "", 
             "Domain": "", 
             "ManuallyInstalled": "", 
             "Id": "", 
             "Name": "", 
             "CreateListener": "", 
             "DisplayName": "", 
             "ProxyingEnabled": "", 
             "AuthenticationName": "", 
             "HostComputer": "", 
             "ManagementGroupId": "", 
             "ComputerName": "", 
             "MaximumSizeOfAllTransferredFilesBytes": "", 
             "CommunicationPort": "", 
             "PrimaryManagementServerName": "", 
             "IPAddress": "" 
         } 
     ] 
}

operation: Get Alerts

Input parameters

Parameter Description
Computer Name (Optional) Name of the computer that contains the alerts that you want to retrieve.
Note: If  you do not specify this parameter, then no filter criterion is applied and an unfiltered list is returned.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": [ 
         { 
             "LastModified": "", 
             "Context": "", 
             "CustomField6": "", 
             "RuleId": "", 
             "ConnectorId": "", 
             "PrincipalName": "", 
             "TimeResolutionStateLastModified": "", 
             "ResolutionState": "", 
             "TfsWorkItemId": "", 
             "TimeRaised": "", 
             "ManagementGroupId": "", 
             "CustomField9": "", 
             "Parameters": "", 
             "StateLastModified": "", 
             "Severity": "", 
             "CustomField2": "", 
             "MonitoringObjectName": "", 
             "MonitoringObjectId": "", 
             "MonitoringObjectPath": "", 
             "Priority": "", 
             "MonitoringObjectFullName": "", 
             "MonitoringRuleId": "", 
             "Description": "", 
             "TimeAdded": "", 
             "MaintenanceModeLastModified": "", 
             "CustomField1": "", 
             "ClassId": "", 
             "TfsWorkItemOwner": "", 
             "ResolvedBy": "", 
             "MonitoringClassId": "", 
             "CustomField3": "", 
             "MonitoringObjectInMaintenanceMode": "", 
             "CustomField4": "", 
             "LastModifiedBy": "", 
             "CustomField5": "", 
             "CustomField10": "", 
             "NetbiosComputerName": "", 
             "ConnectorStatus": "", 
             "ManagementGroup": "", 
             "SiteName": "", 
             "LastModifiedByNonConnector": "", 
             "Name": "", 
             "CustomField8": "", 
             "ProblemId": "", 
             "Id": "", 
             "IsMonitorAlert": "", 
             "CustomField7": "", 
             "Owner": "", 
             "TimeResolved": "", 
             "NetbiosDomainName": "", 
             "UnformattedDescription": "", 
             "RepeatCount": "", 
             "Category": "", 
             "TicketId": "", 
             "MonitoringObjectDisplayName": "", 
             "MonitoringObjectHealthState": "" 
         } 
     ] 
}

operation: Get Device Information

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criteria is applied and an unfiltered list is returned. 

Parameter Description
IP Address IP address for which you want to retrieve information, such as Name, HeartbeatInterval, and HealthState for all devices.
Computer Name Name for which you want to retrieve information, such as Name, HeartbeatInterval, and HealthState for all devices.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": { 
         "LastModified": "", 
         "InstalledBy": "", 
         "RequestCompression": "", 
         "NetworkName": "", 
         "MaximumQueueSizeBytes": "", 
         "PrincipalName": "", 
         "PatchList": "", 
         "ActionAccountIdentity": "", 
         "HealthState": "", 
         "HostedHealthService": "", 
         "HeartbeatInterval": "", 
         "ManagementGroup": "", 
         "Version": "", 
         "InstallTime": "", 
         "Domain": "", 
         "ManuallyInstalled": "", 
         "Id": "", 
         "Name": "", 
         "CreateListener": "", 
         "DisplayName": "", 
         "ProxyingEnabled": "", 
         "AuthenticationName": "", 
         "HostComputer": "", 
         "ManagementGroupId": "", 
         "ComputerName": "", 
         "MaximumSizeOfAllTransferredFilesBytes": "", 
         "CommunicationPort": "", 
         "PrimaryManagementServerName": "", 
         "IPAddress": "" 
     } 
}

operation: Set Resolution State

Input parameters

Parameter Description
Alert ID ID of the alert whose resolution state you want to change.
Resolution State Resolution state that you want to assign to the specified alert.
Choose between New, Closed, Acknowledge, Assigned to Engineering, Awaiting Evidence, Resolved, and Scheduled.
You can also specify Custom State that has been created as a resolution state.
Custom Resolution State ID

(Optional) ID of the Custom resolution state that you want to assign to the alert. You must specify the Custom ResolutionState ID only if you have selected Custom State in the Resolution State field.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": "" 
}

operation: Update Alert

Input parameters

Parameter Description
Alert ID ID of the alert that you want to update.
Owner (Optional) If you want to update the owner of the alert, then add the updated owner in this field.
Ticket ID (Optional) If you want to update the ticket ID of the alert, then add the updated ticket ID in this field.
Custom Fields (Optional) You can add or update custom fields, in the JSON format, that you want to update in the alert:
For example:
{  
"CustomField1": "",
"CustomField2": "",
"CustomField3": "",
}
Resolution State (Optional) Resolution state that you want to assign to the specified alert.
Choose between New, Closed, Acknowledge, Assigned to Engineering, Awaiting Evidence, Resolved, and Scheduled.
You can also specify Custom State that has been created as a resolution state.
Custom Resolution State ID

(Optional) ID of the Custom resolution state that you want to assign to the alert. You must specify the Custom ResolutionState ID only if you have selected Custom State in the Resolution State field.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": "" 
}

operation: Close Alert

Input parameters

Parameter Description
Alert ID ID of the alert that you want to close.
Comment (Optional) Comment containing the reason for closing the alert.

Output

The output contains the following populated JSON schema:

     "op_status": "", 
     "op_result": "" 
}

Included playbooks

The Sample - Microsoft SCOM - 1.0.0 playbook collection comes bundled with the Microsoft SCOM connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Microsoft SCOM connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.