Fortinet Document Library

Version:


Table of Contents

Cyops System Monitoring

1.0.0
Copy Link

About the connector

FortiSOAR™ System Monitoring connector is fully integrated with your FortiSOAR™ machine and it utilizes the psutil library to gather disk, virtual memory, and CPU information of the running FortiSOAR™ instance.

This document provides information about the FortiSOAR™ System Monitoring connector, which facilitates collection of disk, virtual memory and CPU utilization information for the machine that the connector is running on using FortiSOAR™ playbooks. Add the FortiSOAR™ System Monitoring connector as a step in FortiSOAR™ playbooks and perform automated utilization operations.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.9.0.0-708 and later

 

Installing the connector

For the procedure to install a connector, click here.

 

Configuring the connector

You do not require to configure this connector since it is not connected to any third-party application. This connector only works on FortiSOAR™ and collects utilization information about the FortiSOAR™ machine it is running on.

For the description of the Connector page and other details, click here.

 

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 onwards:

 

Function Description Annotation and Category
Disk Utilization Retrieves information about disk utilization such as used, free, and total space on your FortiSOAR™ system. disk_utilization
Investigation
Virtual Memory Utilization Retrieves information about virtual memory utilization such as active, available, and total space on your FortiSOAR™ system. virtual_memory_utilization
Investigation
CPU Utilization Retrieves the percentage value of CPU usage on your FortiSOAR™ system. cpu_utilization
Investigation

 

operation: Disk Utilization

Input parameters

None.

Output

The JSON output contains detailed information about your FortiSOAR™ system's disk and its utilization.

Following image displays a sample output:

 

Sample output of the Disk Utilization operation

 

operation: Virtual Memory Utilization

Input parameters

None.

Output

The JSON output contains detailed information about your FortiSOAR™ system's virtual memory and its utilization.

Following image displays a sample output:

 

Sample output of the Virtual Memory Utilization operation

 

operation: CPU Utilization

Input parameters

None.

Output

The JSON output contains an integer value representing the current percentage of CPU utilization of your FortiSOAR™ system.

Following image displays a sample output:

 

Sample output of the CPU Utilization operation

 

Included playbooks

The Sample - CyOps System Monitoring - 1.0.0 playbook collection comes bundled with the CyOPs System Monitoring connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the CyOPs System Monitoring connector.

  • CPU Utilization
  • Disk Utilization
  • Virtual Memory Utilization

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

FortiSOAR™ System Monitoring connector is fully integrated with your FortiSOAR™ machine and it utilizes the psutil library to gather disk, virtual memory, and CPU information of the running FortiSOAR™ instance.

This document provides information about the FortiSOAR™ System Monitoring connector, which facilitates collection of disk, virtual memory and CPU utilization information for the machine that the connector is running on using FortiSOAR™ playbooks. Add the FortiSOAR™ System Monitoring connector as a step in FortiSOAR™ playbooks and perform automated utilization operations.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.9.0.0-708 and later

 

Installing the connector

For the procedure to install a connector, click here.

 

Configuring the connector

You do not require to configure this connector since it is not connected to any third-party application. This connector only works on FortiSOAR™ and collects utilization information about the FortiSOAR™ machine it is running on.

For the description of the Connector page and other details, click here.

 

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 onwards:

 

Function Description Annotation and Category
Disk Utilization Retrieves information about disk utilization such as used, free, and total space on your FortiSOAR™ system. disk_utilization
Investigation
Virtual Memory Utilization Retrieves information about virtual memory utilization such as active, available, and total space on your FortiSOAR™ system. virtual_memory_utilization
Investigation
CPU Utilization Retrieves the percentage value of CPU usage on your FortiSOAR™ system. cpu_utilization
Investigation

 

operation: Disk Utilization

Input parameters

None.

Output

The JSON output contains detailed information about your FortiSOAR™ system's disk and its utilization.

Following image displays a sample output:

 

Sample output of the Disk Utilization operation

 

operation: Virtual Memory Utilization

Input parameters

None.

Output

The JSON output contains detailed information about your FortiSOAR™ system's virtual memory and its utilization.

Following image displays a sample output:

 

Sample output of the Virtual Memory Utilization operation

 

operation: CPU Utilization

Input parameters

None.

Output

The JSON output contains an integer value representing the current percentage of CPU utilization of your FortiSOAR™ system.

Following image displays a sample output:

 

Sample output of the CPU Utilization operation

 

Included playbooks

The Sample - CyOps System Monitoring - 1.0.0 playbook collection comes bundled with the CyOPs System Monitoring connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the CyOPs System Monitoring 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.