Configuring SonicWall Capture Client Connectors

A SonicWall Capture Client connector allows you to disconnect host, initiate scan, restart machine, or shut down using Stellar Cyber (as long as those hosts are managed by SonicWall Capture Client), and ingest SonicWall Capture Client logs, discover assets, and see vulnerabilities.

There can be any number of SonicWall Capture Client connectors active.

Stellar Cyber connectors with the Collect function (collectors) may skip collecting some data when the ingestion volume is large, which potentially can lead to data loss. This can happen when the processing capacity of the collector is exceeded.

Connector Overview: SonicWall Capture Client

Capabilities

Collect: Yes
Respond: Yes
Native Alerts Mapped: No
Runs on: DP
Interval: Configurable

Collected Data

Content Type	Index	Locating Records
ATP Host Log Threat Vulnerabilities	Syslog Scans Assets (for Host) Linux	msg_class: `sonicwallcc_`<content type> msg_class example: sonicwallcc_atp msg_origin.source: sonicwallcc msg_origin.vendor: N/A msg_origin.category: endpoint

Content Type

Index

Locating Records

ATP

Host

Log

Threat

Vulnerabilities

Syslog

Scans

Assets (for Host)

Linux

msg_class:

sonicwallcc_<content type>

msg_class example:

sonicwallcc_atp

msg_origin.source:

sonicwallcc

msg_origin.vendor:

N/A

msg_origin.category:

endpoint

Domain

where <Host URL> is a variable from the configuration of this connector

Response Actions

Action	Required Fields
Initiate Scan	`device.deviceId` and `device.InstallToken`
Disconnect Host	`device.deviceId` and `device.InstallToken`
Restart Machine	`device.deviceId` and `device.InstallToken`
Shut Down Host	`device.deviceId` and `device.InstallToken`

Third Party Native Alert Integration Details

N/A

Required Credentials

Host URL, Email, Password, Sonicwall Tenant ID

Adding a SonicWall Capture Client Connector

To add a SonicWall Capture Client connector:

Configure SonicWall log management
Add the connector in Stellar Cyber
Test the connector
Verify ingestion

Configuring SonicWall Log Management

You must configure SonicWall log management before you add the connector in Stellar Cyber. You must also have the Tenant ID for an administrative user. MySonicWall credentials are not supported with the APIs.

To get the Tenant ID:

Log in to the SonicWall Capture Client console (https://captureclient.sonicwall.com) as an administrative user.
Navigate to Management | TENANT SETTINGS.
Copy the Tenant ID.

Adding the Connector in Stellar Cyber

To add a SonicWall Capture Client connector in Stellar Cyber:

Log in to Stellar Cyber.
Click System | Connectors (under Integrations). The Connector Overview appears.
Click Create. The General tab of the Add Connector screen appears. The information on this tab cannot be changed after you add the connector.

The asterisk (*) indicates a required field.
Choose Endpoint Security from the Category drop-down.
Choose SonicWall Capture Client from the Type drop-down.
Choose the Function: Collect to collect logs; Respond to enable endpoint actions.
Enter a Name.

This field does not accept multibyte characters.
Choose a Tenant Name. The Interflow records created by this connector include this tenant name.
Choose the device on which to run the connector.
- Certain connectors can be run on either a Sensor or a Data Processor. The available devices are displayed in the Run On menu. If you want to associate your collector with a sensor, you must have configured that sensor prior to configuring the connector or you will not be able to select it during initial configuration. If you select Data Processor, you will need to associate the connector with a Data Analyzer profile as a separate step. That step is not required for a sensor, which is configured with only one possible profile.
- If the device you're connecting to is on premises, we recommend you run on the local sensor. If you're connecting to a cloud service, we recommend you run on the DP.
(Optional) When the Function is Collect, you can apply Log Filters. For information, see Managing Log Filters.
Click Next. The Configuration tab appears.

The asterisk (*) indicates a required field.
Enter the Host URL.

For release versions prior to v4.3.4, ensure the URL does not include a trailing "/" symbol.
Enter the Email.
Enter the Password.

The password should not include non-ASCII special characters.
Enter the Sonicwall Tenant ID you copied earlier, if you chose Collect.
Enter the Interval (min) if you chose Collect. This is how often the logs are collected.
Choose the Content Type you would like to collect, if you chose Collect. The logs for ATP, Host, Log, Threat, and Vulnerabilities are supported.
Click Next. The final confirmation tab appears.
Click Submit.

To pull data, a connector must be added to a Data Analyzer profile if it is running on the Data Processor.
If you are adding rather than editing a connector with the Collect function enabled and you specified for it to run on a Data Processor, a dialog box now prompts you to add the connector to the default Data Analyzer profile. Click Cancel to leave it out of the default profile or click OK to add it to the default profile.
- This prompt only occurs during the initial create connector process when Collect is enabled.
- Certain connectors can be run on either a Sensor or a Data Processor, and some are best run on one versus the other. In any case, when the connector is run on a Data Processor, that connector must be included in a Data Analyzer profile. If you leave it out of the default profile, you must add it to another profile. You need the Administrator Root scope to add the connector to the Data Analyzer profile. If you do not have privileges to configure Data Analyzer profiles, a dialog displays recommending you ask your administrator to add it for you.
- The first time you add a Collect connector to a profile, it pulls data immediately and then not again until the scheduled interval has elapsed. If the connector configuration dialog did not offer an option to set a specific interval, it is run every five minutes. Exceptions to this default interval are the Proofpoint on Demand (pulls data every 1 hour) and Azure Event Hub (continuously pulls data) connectors. The intervals for each connector are listed in the Connector Types & Functions topic.
The Connector Overview appears.

The new connector is immediately active.

Testing the Connector

When you add (or edit) a connector, we recommend that you run a test to validate the connectivity parameters you entered. (The test validates authentication and connectivity).

Click System | Connectors (under Integrations). The Connector Overview appears.
Locate the connector by name that you added, or modified, or that you want to test.
Click Test at the right side of that row. The test runs immediately.

Note that you may run only one test at a time.

Stellar Cyber conducts a basic connectivity test for the connector and reports a success or failure result. A successful test indicates that you entered all of the connector information correctly.

To aid troubleshooting your connector, the dialog remains open until you explicitly close it by using the X button. If the test fails, you can select the button from the same row to review and correct issues.

The connector status is updated every five (5) minutes. A successful test clears the connector status, but if issues persist, the status reverts to failed after a minute.

Repeat the test as needed.

Display sample messages...

If the test fails, the common HTTP status error codes are as follows:

HTTP Error Code	HTTP Standard Error Name	Explanation	Recommendation
400	Bad Request	This error occurs when there is an error in the connector configuration.	Did you configure the connector correctly?
401	Unauthorized	This error occurs when an authentication credential is invalid or when a user does not have sufficient privileges to access a specific API.	Did you enter your credentials correctly? Are your credentials expired? Are your credentials entitled or licensed for that specific resource?
403	Forbidden	This error occurs when the permission or scope is not correct in a valid credential.	Did you enter your credentials correctly? Do you have the required role or permissions for that credential?
404	Not Found	This error occurs when a URL path does not resolve to an entity.	Did you enter your API URL correctly?
429	Too Many Requests	This error occurs when the API server receives too much traffic or if a user’s license or entitlement quota is exceeded.	The server or user license/quota will eventually recover. The connector will periodically retry the query. If this occurs unexpectedly or too often, work with your API provider to investigate the server limits, user licensing, or quotas.

For a full list of codes, refer to HTTP response status codes.

Verifying Ingestion

To verify ingestion:

Click Investigate | Threat Hunting. The Interflow Search tab appears.
Change the Indices to Syslog if you chose the Log or Threat content type. The table immediately updates to show ingested Interflow records.
Change the Indices to Assets if you chose the Host content type. The table immediately updates to show ingested Interflow records. Also, hosts discovered through this connector show SonicWall Capture Client as a data source.
Change the Indices to Linux Events if you chose the Vulnerabilities content type. The table immediately updates to show ingested Interflow records.
Change the Indices to Scans if you chose the ATP content type. The table immediately updates to show ingested Interflow records.