About the connector
Kaseya is IT management and monitoring tool used to perform operations for agent procedure, audit and patch scan.
This document provides information about the Kaseya connector, which facilitates automated interactions with Kaseya using FortiSOAR™ playbooks. Add the Kaseya connector as a step in FortiSOAR™ playbooks and perform automated operations, such as running and scheduling agent procedures, running and scheduling audits and patch scans etc., on Kaseya.
Version information
Connector Version: 1.0.0
FortiSOAR™ Version Tested on: 4.12.1-253
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-kaseya
For the detailed procedure to install a connector, click here
Prerequisites to configuring the connector
- You must have the URL of Kaseya server to which you will connect and perform automated operations and credentials (username-password pair) 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, click the Kaseya connector row, and in the Configuration tab enter the required configuration details.
| Parameter |
Description |
| Server URL |
URL of the Kaseya server to which you will connect and perform the automated operations. |
| Username |
Username for the Kaseya server to which you will connect and perform the automated operations.. |
| Password |
Password for the Kaseya server to which you will connect and perform the automated operations. |
| 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 |
| Get Agents |
Retrieves an array of agent records from the Kaseya server. |
get_agents
Investigation |
| Get Agent Procedures |
Retrieves an array of agent procedures from the Kaseya server. |
get_agent_procedures
Investigation |
| Run Agent Procedure |
Runs a specific agent procedure on a specific agent on the Kaseya server, based on the Agent ID and Agent Procedure ID that you have specified. |
run_agent_procedure
Investigation |
| Schedule Agent Procedure |
Schedules a specific agent procedure on a specific agent on the Kaseya server based on the the Agent ID, Agent procedure ID, and other input parameters and schedule properties that you have specified. |
schedule_agent_procedure
Investigation |
| Cancel Agent Procedure |
Cancels a scheduled agent procedure running on a specific agent machine on the Kaseya server, based on the Agent ID and Agent Procedure ID that you have specified. |
cancel_agent_procedure
Investigation |
| Run Latest Audit |
Runs a latest audit on a specific agent on the Kaseya server based on the Agent ID that you have specified. |
run_latest_audit
Investigation |
| Schedule Latest Audit |
Schedules the latest audit for a specific agent on the Kaseya server, based on the the Agent ID and other input parameters and schedule properties that you have specified. |
schedule_latest_audit
Investigation |
| Get List of All Add/Remove Programs |
Retrieves an array of program entries that are present in the add/remove list of Windows machines from the Kaseya server, based on the Agent ID that you have specified. |
get_add_remove_programs
Investigation |
| Get Audit Summary |
Retrieves the audit summary for a specific agent machine from the Kaseya server, based on the Agent ID that you have specified. |
get_audit_summary
Investigation |
| Run Patch Scan |
Runs an immediate scan for missing patches on a specific agent machine on the Kaseya server, based on the Agent ID that you have specified. |
run_patch_scan
Investigation |
| Get Patch Status |
Retrieves the patch status of a specific agent machine from the Kaseya server, based on the Agent ID that you have specified. |
get_patch_status
Investigation |
operation: Get Agents
Input parameters
None.
Output
The output contains the following populated JSON schema:
[
{
"Result": [
{
"RamMBytes": "",
"AgentFlags": "",
"LastLoggedInUser": "",
"ShowToolTip": "",
"IPv6Address": "",
"AgentVersion": "",
"DomainWorkgroup": "",
"PrimaryKServer": "",
"OperatingSystem": "",
"Online": "",
"ToolTipNotes": "",
"SecondaryWINS": "",
"OrgId": "",
"MachineGroupId": "",
"SecondaryKServer": "",
"DNSServer2": "",
"OSInfo": "",
"PrimaryWINS": "",
"Country": "",
"DefaultGateway": "",
"CpuSpeed": "",
"CurrentUser": "",
"Attributes": {},
"FirstCheckIn": "",
"OSType": "",
"OSVersion": "",
"ComputerName": "",
"LastRebootTime": "",
"CpuType": "",
"ConnectionGatewayIP": "",
"LastCheckInTime": "",
"AgentId": "",
"TimeZone": "",
"DHCPServer": "",
"Contact": "",
"DNSServer1": "",
"CpuCount": "",
"MachineGroup": "",
"AgentName": "",
"IPAddress": ""
}
],
"Error": "",
"Status": "",
"TotalRecords": "",
"ResponseCode": ""
}
]
operation: Get Agent Procedures
Input parameters
None.
Output
The output contains the following populated JSON schema:
[
{
"Result": [
{
"Path": "",
"AgentProcedureId": "",
"Description": "",
"AgentProcedureName": "",
"Attributes": {}
}
],
"Error": "",
"Status": "",
"TotalRecords": "",
"ResponseCode": ""
}
]
operation: Run Agent Procedure
Input parameters
| Parameter |
Description |
| Agent ID |
ID of the agent on which you want to run the specific agent procedure on the Kaseya server. |
| Agent Procedure ID |
ID of the agent procedure that you want to run on a specific agent, on the Kaseya server. |
Output
The output contains the following populated JSON schema:
{
"Status": "",
"Message": ""
}
operation: Schedule Agent Procedure
Input parameters
| Parameter |
Description |
| Agent ID |
ID of the agent machine on which you want to schedule the specific agent procedure, on the Kaseya server. |
| Agent Procedure ID |
ID of the agent procedure that you want to schedule on a specific agent, on the Kaseya server. |
| Recurrence |
Recurrence with which you want to schedule the specific agent procedure to be run on a specific agent on the Kaseya server. Note: Currently only the Weekly recurrence schedule is supported. |
| Distribution Interval |
Distribution interval for scheduling the specific agent procedure to be run on a specific agent on the Kaseya server. You can choose to set the distribution interval in Min, Hr, or Day. |
| Distribution Magnitude |
Distribution magnitude for scheduling the specific agent procedure to be run on a specific agent on the Kaseya server. |
| On |
Day/s of the week on which you want to schedule the specific agent procedure to be run on a specific agent on the Kaseya server. |
| Start On |
Time at which you want to start running the specific agent procedure to be run on a specific agent on the Kaseya server. |
| Ending On |
Time at which you want to end running the specific agent procedure to be run on a specific agent on the Kaseya server. |
| Every |
(Optional) Recurrence intervals in weeks for scheduling the specific agent procedure to be run on a specific agent on the Kaseya server.
By default this is set to 1, which means the specific agent procedure will run on the specific agent once a week on the day you have specified. |
| Time Preference |
(Optional) Select this option to schedule the specific agent procedure to run on the timezone of the agent (rather than server). |
| Skip if offline |
(Optional) If you select this option then the scheduled agent procedure run is skipped if your machine is offline.
If you also select the Power up if offline option, then the scheduled agent procedure run is skipped, if power up also fails. |
| Power up if offline |
(Optional) Select this option if you want to power up your machine if it is offline when the scheduled agent procedure is supposed to run.
Note: If you select this option then you must have Wake-On-LAN, vPro, or any another managed system on the same LAN. |
Output
The output contains the following populated JSON schema:
{
"Status": "",
"Message": ""
}
operation: Cancel Agent Procedure
Input parameters
| Parameter |
Description |
| Agent ID |
ID of the agent machine on which you want to cancel the specific agent procedure on the Kaseya server. |
| Agent Procedure ID |
ID of the agent procedure that you want to cancel on a specific agent, on the Kaseya server. |
Output
The output contains the following populated JSON schema:
{
"Status": "",
"Message": ""
}
operation: Run Latest Audit
Input parameters
| Parameter |
Description |
| Agent ID |
ID of the agent machine on which you need to run latest audit on the Kaseya server. |
Output
The output contains the following populated JSON schema:
{
"Status": "",
"Message": ""
}
operation: Schedule Latest Audit
Input parameters
| Parameter |
Description |
| Agent ID |
ID of the agent machine on which you want to schedule the latest audit on the Kaseya server. |
| Recurrence |
Recurrence with which you want to schedule the latest audit to be run on a specific agent on the Kaseya server. Note: Currently only the Weekly recurrence schedule is supported. |
| Distribution Interval |
Distribution interval for scheduling the latest audit to be run on a specific agent on the Kaseya server. You can choose to set the distribution interval in Min, Hr, or Day. |
| Distribution Magnitude |
Distribution magnitude for scheduling the latest audit to be run on a specific agent on the Kaseya server. |
| On |
Day/s of the week on which you want to schedule the latest audit to be run on a specific agent on the Kaseya server. |
| Start On |
Time at which you want to start running the latest audit to be run on a specific agent on the Kaseya server. |
| Ending On |
Time at which you want to end running the latest audit to be run on a specific agent on the Kaseya server. |
| Every |
(Optional) Recurrence intervals in weeks for scheduling the latest audit to be run on a specific agent on the Kaseya server.
By default this is set to 1, which means the latest audit will run on the specific agent once a week on the day you have specified. |
| Time Preference |
(Optional) Select this option to schedule the latest audit to run on the timezone of the agent (rather than server). |
| Skip if offline |
(Optional) If you select this option then the scheduled audit run is skipped if your machine is offline.
If you also select the Power up if offline option, then the scheduled audit run is skipped, if power up also fails. |
| Power up if offline |
(Optional) Select this option if you want to power up your machine if it is offline when the scheduled audit run is suppose to run.
Note: If you select this option then you must have Wake-On-LAN, vPro, or any another managed system on the same LAN. |
Output
The output contains the following populated JSON schema:
{
"Status": "",
"Message": ""
}
operation: Get List of All Add/Remove Programs
Input parameters
| Parameter |
Description |
| Agent ID |
ID of the agent machine for which you would like to retrieve an array of program entries that are present in the add/remove list of Windows machines from the Kaseya server, |
Output
The output contains the following populated JSON schema:
[
{
"Result": [
{
"DisplayName": "",
"UninstallString": ""
}
],
"Error": "",
"Status": "",
"TotalRecords": "",
"ResponseCode": ""
}
]
operation: Get Audit Summary
Input parameters
| Parameter |
Description |
| Agent ID |
ID of the agent machine whose audit summary you want to retreive from the Kaseya server. |
Output
The output contains the following populated JSON schema:
[
{
"Result": {
"LastAudit": "",
"CustomFields": {},
"Chassis": {
"ChassisVersion": "",
"ChassisType": "",
"ChassisAssetTag": "",
"ChassisSerialNumber": "",
"ChassisManufacturer": ""
},
"NetworkInfo": {
"Ipv6Address": "",
"SubnetMask": "",
"WINsEnabled": "",
"MacAddr": "",
"DhcpServer": "",
"ConnectionGatewayIp": "",
"SecondaryWINS": "",
"DnsServer": "",
"IpAddress": "",
"DhcpEnabled": "",
"DefaultGateway": "",
"PrimaryWINS": "",
"Country": ""
},
"CPURAM": {
"RamMBytes": "",
"CpuDescription": "",
"MemorySlots": "",
"ProcessorCurrentSpeed": "",
"ProcessorMaxSpeed": "",
"ProcessorFamily": "",
"ProcessorManufacturer": "",
"ProcessorVersion": "",
"CpuCount": "",
"CpuSpeedMHz": "",
"MaxMemorySize": ""
},
"BIOS": {
"BiosVendor": "",
"BiosVersion": "",
"BiosReleaseDate": ""
},
"Attributes": {},
"SystemSlots": [
{
"Designator": "",
"Usage": "",
"Type": "",
"ID": ""
}
],
"TimeInfo": {
"LastCheckin": "",
"KServerTime": "",
"AgentTime": "",
"LastReboot": "",
"AgentTimeZone": "",
"FirstCheckin": ""
},
"PortConnectors": [
{
"InternalRef": "",
"PortType": "",
"ExternalRef": "",
"ConnectionType": ""
}
],
"NextAudit": "",
"Motherboard": {
"MotherboardSerialNumber": "",
"MotherboardVersion": "",
"ExternalBusSpeed": "",
"MotherboardProduct": "",
"MotherboardManufacturer": ""
},
"OnBoardDevices": [
{
"Type": "",
"Description": ""
}
],
"SystemInfo": {
"SysSerialNumber": "",
"Manufacturer": "",
"ProductName": "",
"Version": ""
},
"MemoryDevices": [
{
"BankLocation": "",
"Form": "",
"Detail": "",
"Size": "",
"DeviceLocation": "",
"Type": "",
"Speed": ""
}
]
},
"Error": "",
"Status": "",
"ResponseCode": ""
}
]
operation: Run Patch Scan
Input parameters
| Parameter |
Description |
| Agent ID |
ID of the agent machine on which you immediately need to run a scan for missing patches. |
Output
The output contains the following populated JSON schema:
{
"Status": "",
"Message": ""
}
operation: Get Patch Status
Input parameters
| Parameter |
Description |
| Agent ID |
ID of the agent machine whose patch status you want to retrieve from the Kaseya sever. |
Output
The output contains the following populated JSON schema:
[
{
"Result": {
"NextRunTime": "",
"Reset": "",
"MonthPeriod": "",
"NextPatchScan": "",
"ScheduledScanScriptSchedType": "",
"RunCount": "",
"PatchFailedAlert": "",
"AgentType": "",
"NoRebootEmail": "",
"SourceType": "",
"ExecPeriod": "",
"LastPatchScan": "",
"DestUseAgentDrive": "",
"RebootTime": "",
"LanCacheName": "",
"SourceLocal": "",
"AlertEmail": "",
"RebootDay": "",
"InvalidCredentialAlert": "",
"ExecScriptTime": "",
"PreRebootScriptName": "",
"ScheduledScanScriptId": "",
"Attributes": {},
"ScanRunAtTime": "",
"RunAtTime": "",
"ScanNextRunTime": "",
"SourceMachineGuid": "",
"NewPatchAlert": "",
"PostRebootScriptName": "",
"SourcePath": "",
"ScanResultsPending": "",
"WINAUChangedAlert": "",
"UseInternetSrcFallback": "",
"RbWarn": ""
},
"Error": "",
"Status": "",
"ResponseCode": ""
}
]
Included playbooks
The Sample - Kaseya - 1.0.0 playbook collection comes bundled with the Kaseya 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 Kaseya connector.
- Cancel Agent Procedure
- Get Add Remove Programs
- Get Agent Procedures
- Get Agents
- Get Audit Summary
- Get Patch Status
- Run Agent Procedure
- Run Latest Audit
- Run Patch Scan
- Schedule Agent Procedure
- Schedule Latest Audit
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.
