Change Auditor 7.5 - User Guide

Working with a Quest IT Security Search subscriptions through the client

Working with a Quest IT Security Search subscriptions through the client

To create a IT Security Search subscription

1	From the Administration Tasks, select Configuration | Event Subscriptions.

2	Click Add IT Security Search Subscription to enter the required information.

3	Specify where to send the event data by entering the event URL.

Use https://[hostname]:[port]/warehouse/changeauditor/events.

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

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

6	Click Finish.

To view existing IT Security Search 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 (Event URL), the subscription status (Enabled or Disabled), and when the last event was sent (Last Event).

To edit the IT Security Search subscription

1	From the Administration Tasks, select Configuration | Event Subscriptions.

2	Select the required subscription and click Edit.

3	If required, enter the new URL and click Next.

4	If required, add and remove the subsystems included in the subscription.

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

New-CAITSSEventSubscription

New-CAITSSEventSubscription

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

Table 2. Available parameters

Parameter	Description
-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. • 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.
-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.
-StartTimeUTC (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: • 20 July, 2020 12:01 PM uses local time • 2020-07-20 12:10:00Z uses UTC time 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. 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.
-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: 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

Get-CAITSSEventSubscriptions

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

NOTE: The “Batches sent”, “Last event time in UTC”, “Last event response” and “Events sent” are all indicators that the events are being received by IT Security Search. Any failures receiving the data populate the “Last event response” property in the object with information on why the data was not received.

Table 16. Available parameters

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

Example: List defined IT Security Search subscriptions

Get-CAITSSEventSubscriptions -Connection $connection

Command output

The command returns the following information.

Table 17. Available configuration information

Setting	Description
Id	The subscription ID.
WebhookSubscriptionId	The webhook subscription ID.
ITSSUrl	The URL where event data is sent.
StartTimeUTC	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.
LastEventTimeUTC	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).
LastHeartbeatTimeUTC	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 Microsoft 365 and Microsoft Entra ID events.

Set-CAITSSEventSubscription

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