Chat now with support
Chat with Support

Change Auditor 7.6 - SIEM Integration User Guide

Integrating Change Auditor and SIEM Tools Subscription Management
Adding the PowerShell module Viewing available commands and help Connecting to Change Auditor Managing subscriptions Working with event subscriptions in the client Managing a Splunk integration Managing an IBM QRadar integration Managing a Micro Focus Security ArcSight Logger and Enterprise Security Manager (ESM) integration Managing a Quest IT Security Search integration (Preview) Managing a Syslog integration Managing a Microsoft Sentinel integration
Webhook technical insights

Set-CAITSSEventSubscription

Use this command to modify an IT Security Search subscription.

Table 2. Available parameters

Parameter
Description

-Connection

A connection obtained by using the Connect-CAClient command. See the Change Auditor Command Guide for details.

-Subscription

The PSCAITSSSubscriptionStatus object that corresponds to the subscription to modify. This parameter is required if the SubscriptionId parameter is not specified. Use the Get-CAITSSEventSubscriptions command to get a list of objects.

-SubscriptionId

The ID of the subscription to modify. This parameter is required if the Subscription parameter is not specified. Use the Get-CAITSSEventSubscriptions command to find the ID.

-ITSSUrl

Specifies the address of your IT Security Search instance that will receive the event data.

•
By default, this is set to http://[hostname]:[port]/warehouse/changeauditor/events.
Hostname is the IT Security Search instance and the default port is 8087.

-Credential (Optional)

Domain\Username and password used for authenticating with the IT Security Search server.

Enter the username and password used to sign into the IT Security Search client.

-BatchSize (Optional)

Specifies the maximum number of events to include in a single notification. The default is 10000 events.

-Enabled (Optional)

Specifies whether the subscription is enabled or disabled. By default it is enabled.

-HeartbeatUrl (Optional)

Specifies where (URL) to send heartbeat notifications.

NOTE: If no value is specified, heartbeat notifications are not sent.

-NotificationInterval (Optional)

Specifies how often (in milliseconds) notifications are sent to the IT Security Search instance. By default this is set to 0 which results in a continuous stream of events.

-HeartbeatInterval (Optional)

Specifies how often (in milliseconds) heartbeat notifications are sent to the HeartbeatURL. By default, this is set to every 5 minutes. Setting this to 0 disables the heartbeat notifications.

-AllowedCoordinators (Optional)

Specifies the DNS or NetBIOS name of the coordinators permitted to send events. By default, any coordinator can send the events.

NOTE: The list order does not determine which coordinator is selected to send events.

-Subsystems (Optional)

Specifies an array of event subsystems from which to send events. This can be single or multiple subsystems.

NOTE: To obtain an array of subsystems, use the Get-CAEventExportSubsystems command and filter the list to specify the required subsystems.
NOTE: The subsystems specified override the current subsystems included in the subscription.

-IncludeO365AADDetails (Optional)

Specifies whether to include the raw JSON event details provided by Microsoft. When set to true, the event will include a field named additionalDetails, containing the raw JSON string for Microsoft 365 and Microsoft Entra ID events. When set to false, the additionalDetails field is not included.

By default, this is set to true.

Example: Disable a subscription

Set-CAITSSEventSubscription -Connection $connection -ITSSUrl $ITSSUrl -SubscriptionId $SubscriptionId -Enabled $false

Example: Edit the subsystems included in an IT Security Search subscription

$newSubsystems = Get-CAEventExportSubsystems -Connection $connection | ? { $_.DisplayName -eq "File System" -or $_.DisplayName -eq "Active Directory" }

Set-CAITSSEventSubscription -Connection $connection -ITSSUrl $ITSSUrl -SubscriptionId cd87b774-8e65-46e1-8520-da478c60c4c3 -Subsystems $newSubsystems

Remove-CAITSSEventSubscription

Use this command to remove an IT Security Search subscription.

Table 18. Available parameters
Parameter
Description

-Connection

A connection obtained by using the Connect-CAClient command. See the Change Auditor Command Guide for details.

-Subscription

The PSCAITSSSubscriptionStatus object that corresponds to the subscription to remove. This parameter is required if the SubscriptionId parameter is not specified.

-SubscriptionId

The ID of the subscription to remove. This parameter is required if the Subscription parameter is not specified. Use the Get-CAITSSEventSubscriptions command to find the ID.

Example: Remove an IT Security Search subscription

Remove-CAITSSEventSubscription -Connection $connection -SubscriptionId $subscriptionId

3
 

Managing a Syslog integration

Managing a Syslog integration

To send the rich events gathered by Change Auditor to a Syslog server, you need to create an event subscription with Change Auditor. The subscription contains information about where to send the notifications and heartbeats and the event subsystems to include.

•
Working with Syslog subscriptions through the client
•
New-CASyslogEventSubscription
•
Get-CASyslogEventSubscriptions
•
Set-CASyslogEventSubscription
•
Remove-CASyslogEventSubscription

Working with Syslog subscriptions through the client

To create a subscription
1
From the Administration Tasks, select Configuration | Event Subscriptions.
2
Click Add Syslog Subscription to enter the required information.
3
Specify the IPv4 address or FQDN (fully qualified domain name) of the computer where the Syslog server is installed.
4
Specify the port number.
5
Specify the message format (LEEF or CEF) and whether TLS encryption is required. By default, this is enabled.
6
Click Next to select the events to forward based on subsystem and event date. Once the subscription is created the starting event date and time cannot be changed.
•
By default, events start sending after the subscription is created. To change when to begin sending events, click Send events starting and select the desired date and time.
•
Select the subsystems to include in the subscription.
7
Click Finish.
To view existing subscription details:
1
From the Administration Tasks, select Configuration | Event Subscriptions.
2
Expand the required subscription.
The summary page displays the type of subscription (Target), where the events are being sent (Destination), the subscription status (Enabled or Disabled), and when the last event was sent (Last Event).
To edit a subscription
1
From the Administration Tasks, select Configuration | Event Subscriptions.
2
Select the required subscription and click Edit.
3
If required, enter the server and port.
4
If required, select the message format (LEEF or CEF) and whether TLS encryption is required.
5
Click Next.
6
If required, add and remove the subsystems included in the subscription.
7
Click Finish.
To remove a subscription
1
From the Administration Tasks, select Configuration | Event Subscriptions.
2
Select the required subscription and click Delete.
3
Confirm the removal.
To enable and disable a subscription
•
When viewing the summary information, select the status column and choose to enable or disable the subscription as required.
To refresh the summary information
1
From the Administration Tasks, select Configuration | Event Subscriptions.
2
Click Refresh.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating