Chat now with support
Chat with Support

Change Auditor 7.0.3 - SIEM Integration Guide

New-CAITSSEventSubscription

Use this command to create the subscription required to send Change Auditor event data to IT Security Search.

Table 2. Available parameters

-Connection

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

-ITSSUrl

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

-Subsystems

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.

-Credential

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.

-StartTime (Optional)

Specifies date and time from which events should be sent. The default is to start sending events from the time when the subscription is created.

For example:

The time will be local unless you specify the required flag to convert to UTC.

-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.

-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.

-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 Office 365 and Azure Active Directory events. When set to false, the additionalDetails field is not included.

By default, this is set to true.

Example: Create a subscription to send all subsystems event data to an IT Search instance

$allSubsystems = Get-CAEventExportSubsystems -Connection $connection

New-CAITSSEventSubscription -Connection $connection -ITSSUrl $ITSSUrl -Credential $Credential -Subsystems $allSubsystems

Get-CAITSSEventSubscriptions

Use this command to see the details of the current IT Security Search subscriptions.

-Connection

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

-SubscriptionId (optional)

The ID of an existing IT Security Search subscription.

If specified, the command will only return the subscription with that ID. If not specified, all IT Security Search subscriptions are returned.

You can find this by running this command using just the connection information. It is also returned by the New-CAITSSEventSubscription command.

Get-CAITSSEventSubscriptions -Connection $connection

Command output

The command returns the following information.

Id

The subscription ID.

WebhookSubscriptionId

The webhook subscription ID.

ITSSUrl

The URL where event data is sent.

StartTime

Starting point in time for events being sent.

Subsystems

Subsystems that contain the event data you want to send.

Enabled

Whether the subscription is enabled.

HeartbeatUrl

URL for heartbeat notifications.

LastEventTime

When the last event was sent.

LastEventResponse

Last event response.

For example, statusCode = OK (200), statusCode = Bad Request (400), or statusCode = Internal Server Error (500).

LastHeartbeatTime

When the last heartbeat was sent.

LastHeartbeatResponse

Last heartbeat response.

For example, statusCode = OK (200), statusCode = Bad Request (400), or statusCode = Internal Server Error (500).

EventsSent

Number of events sent.

BatchesSent

Number of batches sent.

HeartbeatsSent

Number of heartbeats sent.

NotificationInterval

How often (in milliseconds) notifications are sent.

HeartbeatInterval

How often (in milliseconds) heartbeat notificaitons are sent to the HeartbeatURL.

BatchSize

Batch size. (The maximum number of events that the active batch size can increase to.)

ActiveBatchSize

The current batch size. (The current number of events to include in a single notification message.) The batch size is automatically adjusted based on network throughput and system performance. Its value never exceeds the specified batch size.

AllowedCoordinators

List of coordinators permitted to send events.

LastCoordinator

The coordinator that is sending events. If the subscription is disabled, this is the last coordinator sending the events.

IncludeO365AADDetails

Identifies whether or not the additionalDetails field with the raw JSON string is included for Office 365and Azure Active Directory events.

Set-CAITSSEventSubscription

Use this command to modify an IT Security Search subscription.

Table 2. Available parameters

-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.

-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.

-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.

-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.

-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 Office 365 and Azure Active Directory 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.

-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.

Remove-CAITSSEventSubscription -Connection $connection -SubscriptionId $subscriptionId

 

Related Documents