Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ServiceNow - append syslog transactions logs #36880

Merged
merged 49 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from 44 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
ec2cc5e
appending syslog transactions logs
inbalapt1 Oct 29, 2024
8cb3def
fixes pre-commit
inbalapt1 Oct 29, 2024
025b1f8
unittests
inbalapt1 Oct 30, 2024
da51b86
unittests fixes
inbalapt1 Oct 30, 2024
65292fa
readme-fixes
inbalapt1 Oct 30, 2024
d3e1ca8
readme update
inbalapt1 Oct 30, 2024
8af6f73
Merge branch 'master' into ia_service-now-event-collector
inbalapt1 Oct 30, 2024
f088aca
update name
inbalapt1 Oct 31, 2024
0e2b541
release-notes
inbalapt1 Oct 31, 2024
d181092
update last_run
inbalapt1 Nov 3, 2024
3a3461a
max_fetch
inbalapt1 Nov 3, 2024
53c8d7e
get-audit-logs bc
inbalapt1 Nov 3, 2024
ca7601b
test
inbalapt1 Nov 3, 2024
2ed5e9e
unittests fix
inbalapt1 Nov 3, 2024
ace9b71
limit
inbalapt1 Nov 3, 2024
47855c3
RELEAS NOTES FIX
inbalapt1 Nov 3, 2024
e595b32
Merged master into current branch.
Nov 3, 2024
52fd1f2
Bump pack from version ServiceNow to 2.6.12.
Nov 3, 2024
e485a50
Merged master into current branch.
Nov 3, 2024
8c096ad
Bump pack from version ServiceNow to 2.6.13.
Nov 3, 2024
44a9152
update limit default
inbalapt1 Nov 4, 2024
39ee6b1
add get-syslog function + update unittests
inbalapt1 Nov 5, 2024
1c4a1c0
readme updates
inbalapt1 Nov 5, 2024
ca7e9c4
update release notes
inbalapt1 Nov 5, 2024
9b972f6
docker image
inbalapt1 Nov 6, 2024
ddec4e8
Merge remote-tracking branch 'origin' into ia_service-now-event-colle…
inbalapt1 Nov 6, 2024
7423e98
update release notes
inbalapt1 Nov 6, 2024
9ecb458
types change
inbalapt1 Nov 7, 2024
10f6e29
from date update
inbalapt1 Nov 7, 2024
990cd5e
pre-commit
inbalapt1 Nov 7, 2024
a2c74a7
update titles and limit descriptions
inbalapt1 Nov 10, 2024
1a89601
unittests update
inbalapt1 Nov 10, 2024
956a7b0
description
inbalapt1 Nov 10, 2024
dfd2c81
limit fix
inbalapt1 Nov 10, 2024
dfbc870
Merge remote-tracking branch 'origin' into ia_service-now-event-colle…
inbalapt1 Nov 13, 2024
a4e353c
Merge remote-tracking branch 'origin' into ia_service-now-event-colle…
inbalapt1 Nov 13, 2024
e5fd226
Update Packs/ServiceNow/Integrations/ServiceNowEventCollector/Service…
inbalapt1 Nov 13, 2024
6238950
Update Packs/ServiceNow/Integrations/ServiceNowEventCollector/Service…
inbalapt1 Nov 13, 2024
b96da10
update by code review
inbalapt1 Nov 13, 2024
f33542c
code review updates
inbalapt1 Nov 13, 2024
c4a4b57
Merge branch 'master' into ia_service-now-event-collector
inbalapt1 Nov 14, 2024
de7d4da
Merge branch 'master' into ia_service-now-event-collector
inbalapt1 Nov 14, 2024
4ab92f0
release notes
inbalapt1 Nov 14, 2024
6b469c3
pre-commit fix
inbalapt1 Nov 17, 2024
3e02f6f
Merge remote-tracking branch 'origin' into ia_service-now-event-colle…
inbalapt1 Nov 18, 2024
1b22583
doc review changes
inbalapt1 Nov 18, 2024
b22ec91
test fix
inbalapt1 Nov 18, 2024
9b06150
unit test fix
inbalapt1 Nov 18, 2024
701dd1a
pre-commit
inbalapt1 Nov 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 59 additions & 30 deletions Packs/ServiceNow/Integrations/ServiceNowEventCollector/README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,33 @@
Use this integration to fetch audit logs from ServiceNow as Cortex XSIAM events.
Use this integration to fetch audit and syslog transactions logs from ServiceNow as Cortex XSIAM events.
This integration was integrated and tested with Vancouver version of ServiceNow API.

## Configure ServiceNow Event Collector on Cortex XSOAR
## Configure ServiceNow Event Collector in Cortex

inbalapt1 marked this conversation as resolved.
Show resolved Hide resolved
1. Navigate to **Settings** > **Integrations** > **Servers & Services**.
inbalapt1 marked this conversation as resolved.
Show resolved Hide resolved
2. Search for ServiceNow Event Collector.
3. Click **Add instance** to create and configure a new integration instance.

| **Parameter** | **Description** | **Required** |
| --- |------------------------------------------------------------------------------------------| --- |
| ServiceNow URL | ServiceNow URL in the format https://company.service-now.com/ | True |
| Username | | True |
| Password | | True |
| Client ID | | False |
| Client Secret | | False |
| ServiceNow API Version (e.g. 'v1') | | False |
| Use OAuth Login | Select this checkbox to use OAuth 2.0 authentication. See \(?\) for more information. | False |
| Maximum number of events per fetch | Default value is 1000 | False |
| Events Fetch Interval | | False |
| Trust any certificate (not secure) | | False |
| Use system proxy settings | | False |

4. Click **Test** to validate the URLs, token, and connection.
| **Parameter** | **Description** | **Required** |
| --- | --- | --- |
| ServiceNow URL, in the format https://company.service-now.com/ | | True |
| Username | | True |
| Password | | True |
| Client ID | | False |
| Client Secret | | False |
| ServiceNow API Version (e.g., 'v1') | | False |
| Use OAuth Login | Select this checkbox to use OAuth 2.0 authentication. | False |
| Event Types To Fetch | Event types to fetch. defaults to 'Audit' if no type is specified. | False |
| Maximum audit events to fetch | Maximum number of audit events per fetch. Recommended 10000. | False |
inbalapt1 marked this conversation as resolved.
Show resolved Hide resolved
| Maximum syslog transactions events to fetch | Maximum number of syslog transactions events per fetch. Recommended 10000. | False |
| Events Fetch Interval | | False |
| Trust any certificate (not secure) | | False |
| Use system proxy settings | | False |

## Commands

You can execute these commands from the Cortex XSIAM CLI, as part of an automation, or in a playbook.
You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.
inbalapt1 marked this conversation as resolved.
Show resolved Hide resolved

### service-now-get-audit-logs

***
Returns audit logs events extracted from ServiceNow. This command is used for developing/debugging and is to be used with caution, as it can create events, leading to event duplication and exceeding the API request limitation.
Returns events extracted from ServiceNow. This command is used for developing/debugging and is to be used with caution, as it can create events, leading to event duplication and exceeding the API request limitation.

#### Base Command

Expand All @@ -42,7 +38,39 @@ Returns audit logs events extracted from ServiceNow. This command is used for de
| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| should_push_events | Set this argument to True in order to create events, otherwise the command will only display them. Possible values are: True, False. Default is False. | Required |
| limit | The maximum number of events to return. Default is 1000. | Optional |
| limit | Maximum audit events to fetch. Default is 1000. Default is 1000. | Optional |
| from_date | The date and time of the earliest event. The time format is "{yyyy}-{mm}-{dd} {hh}:{mm}:{ss}". Example: "2021-05-18 13:45:14" indicates May 18, 2021, 1:45PM. | Optional |
inbalapt1 marked this conversation as resolved.
Show resolved Hide resolved
| offset | Starting record index from which to begin retrieving records. | Optional |

#### Context Output

There is no context output for this command.

### Human Readable

>### Audit Events
>|_time|documentkey|fieldname|newvalue|record_checkpoint|sys_created_on|sys_id|tablename|
>|---|---|---|---|---|---|---|---|
>| 2024-01-28T13:21:43Z | 3 | DELETED | DELETED | -1 | 2024-01-28 13:21:43 | 3 | audit |
>| 2024-01-28T13:21:43Z | 3 | DELETED | DELETED | -1 | 2024-01-28 13:21:43 | 3 | audit |
>| 2024-01-28T13:21:43Z | 3 | DELETED | DELETED | -1 | 2024-01-28 13:21:43 | 3 | audit |
>| 2024-01-28T13:21:43Z | 3 | DELETED | DELETED | -1 | 2024-01-28 13:21:43 | 3 | audit |

### service-now-get-syslog-transactions

***
Returns syslog transactions events extracted from ServiceNow. This command is used for developing/debugging and is to be used with caution, as it can create events, leading to event duplication and exceeding the API request limitation.

#### Base Command

`service-now-get-syslog-transactions`

#### Input

| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| should_push_events | Set this argument to True in order to create events, otherwise the command will only display them. Possible values are: True, False. Default is False. | Required |
| max_fetch_syslog_transactions | Maximum syslog transactions events to fetch. Default is 1000. Default is 1000. | Optional |
| from_date | The date and time of the earliest event. The time format is "{yyyy}-{mm}-{dd} {hh}:{mm}:{ss}". Example: "2021-05-18 13:45:14" indicates May 18, 2021, 1:45PM. | Optional |
inbalapt1 marked this conversation as resolved.
Show resolved Hide resolved
| offset | Starting record index from which to begin retrieving records. | Optional |

Expand All @@ -52,10 +80,11 @@ There is no context output for this command.

### Human Readable

>### Audit Logs List:
>|Time|Documentkey|Fieldname|Newvalue|Record Checkpoint|Sys Created On|Sys Id|Tablename|
>### Syslog Transactions Events
>|_time|acl_time|business_rule_count|client_transaction|cpu_time|sys_created_on|sys_id|source_log_type|
>|---|---|---|---|---|---|---|---|
>| 2024-01-28T13:21:43Z | 3 | DELETED | DELETED | -1 | 2024-01-28 13:21:43 | 3 | test_table |
>| 2024-01-28T13:21:43Z | 3 | DELETED | DELETED | -1 | 2024-01-28 13:21:43 | 3 | test_table |
>| 2024-01-28T13:21:43Z | 3 | DELETED | DELETED | -1 | 2024-01-28 13:21:43 | 3 | test_table |
>| 2024-01-28T13:21:43Z | 3 | DELETED | DELETED | -1 | 2024-01-28 13:21:43 | 3 | test_table |
>| 2024-01-28T13:21:43Z | 3 | 1 | false | 6 | 2024-01-28 13:21:43 | 3 | syslog transaction |
>| 2024-01-28T13:21:43Z | 3 | 1 | false | 6 | 2024-01-28 13:21:43 | 3 | syslog transaction |
>| 2024-01-28T13:21:43Z | 3 | 1 | false | 6 | 2024-01-28 13:21:43 | 3 | syslog transaction |
>| 2024-01-28T13:21:43Z | 3 | 1 | false | 6 | 2024-01-28 13:21:43 | 3 | syslog transaction |

Loading
Loading