Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.airmdr.com/llms.txt

Use this file to discover all available pages before exploring further.

Purpose

The SonicWall integration enables AirMDR to connect with a SonicWall firewall and retrieve security, network, and firewall-related information for investigation, enrichment, and automated response workflows. This guide explains how to collect the following values from the SonicWall UI:
Required FieldDescription
Firewall IPIP address used to access the SonicWall firewall management interface
UsernameSonicWall administrator or read-only administrator username
PasswordPassword for the selected SonicWall user account
Use a dedicated read-only or least-privilege administrator account wherever possible.

Supported Versions

ComponentSupported Details
ProductSonicWall Firewall
Management InterfaceSonicOS web-based management UI
Recommended AccessHTTPS management interface
Authentication TypeUsername and password
API SupportSonicOS API, if enabled
SonicWall confirms that SonicOS firewalls can be managed through the local web-based management interface by accessing the LAN or WAN IP address and signing in with an administrator account.

Authentication

AirMDR uses SonicWall firewall credentials to authenticate with the SonicWall firewall.

Required Credentials

FieldRequiredExample
Firewall IPYeshttps://192.168.1.1
UsernameYesairmdr-readonly
PasswordYes********

Role-Based Access Considerations

Recommended user role:
Role TypeRecommendation
Read-only administratorPreferred for monitoring and investigation
Full administratorUse only if AirMDR requires response or configuration actions
Shared admin accountAvoid
Do not use a personal admin account for integrations. Create a dedicated SonicWall user account for AirMDR

Pre-requisites

Users must have Administrator access to the SonicWall management UI with sufficient privileges to create or manage users and verify firewall settings.
The SonicWall management interface must be accessible from the AirMDR Remote Agent over HTTPS (default port 443).
AirMDR Remote Agent and Network Connectivity installed and active (if required by deployment model).

Setup Steps

1

Identify the SonicWall Firewall IP

  1. Log in to the SonicWall firewall UI using an administrator account.
    https://<sonicwall-firewall-ip>
    
  2. Navigate to Network → System → Interfaces.
  3. In the Interface Settings table, locate the interface used for management access. Common examples:
    InterfaceTypical Use
    X0 / LANInternal firewall management
    X1 / WANExternal management, if enabled
    MGMTDedicated management interface
  4. Copy the IP address shown for the selected interface.
  5. Use this value as the Firewall IP in AirMDR.
    SonicWall’s interface table lists configured interfaces and their zones, including LAN, WAN, WLAN, DMZ, and MGMT where applicable.
    Prefer the internal LAN or dedicated MGMT IP. Avoid exposing firewall management over the public WAN unless required and secured.
2

Verify HTTPS Management Access

  1. Navigate to Device → Settings → Administration.
  2. Open the Management section.
  3. Confirm that HTTPS management is enabled.
  4. Confirm the HTTPS port.
    Default: 443
    Test browser access: https://<firewall-ip>
    SonicWall recommends using HTTPS to log in to the SonicOS management interface, while HTTP management is disabled by default.
    Avoid using HTTP for firewall administration because credentials may be exposed in transit.
3

Create a Dedicated SonicWall User

  1. Log in to SonicWall UI.
  2. Navigate to Device → Users → Local Users & Groups.
  3. Click Add User.
  4. In the Settings tab, enter:
    FieldExample
    Nameairmdr-readonly
    PasswordEnter a strong password
    Confirm PasswordRe-enter password
  5. Save the user.
    SonicWall documentation states that local users are managed from Device → Users → Local Users & Groups.
4

Assign User to the Required Group

  1. In the same user configuration window, open the Groups tab.
  2. Add the user to the required administrator group. Recommended options:
    GroupUse Case
    Read-Only AdminsMonitoring, investigation, log review
    SonicWall AdministratorsFull administrative access
  3. Click Save or Accept.
    SonicWall allows local users to be assigned to groups from the Groups tab under local user settings.
    For AirMDR monitoring-only use cases, assign the minimum permissions required.

Integration Credential Requirements

Use the following placeholder values while configuring the SonicWall integration in AirMDR.
FieldPlaceholderDescription
Firewall IPhttps://<sonicwall-firewall-ip>SonicWall management interface IP or hostname
Username<sonicwall-admin-username>SonicWall administrator or read-only username
Password<sonicwall-password>Password associated with the SonicWall user account
Remote Agent<remote-agent-name>AirMDR Remote Agent used to establish connectivity
HTTPS Port443Default SonicWall management HTTPS port
API Access (Optional)Enabled / DisabledIndicates whether SonicOS API access is enabled

SonicWall Credential Reference Table

Credential / FieldWhere to Find in SonicWall UIDescription
Firewall IPNetwork > System > InterfacesDisplays the management IP address configured on interfaces such as X0, X1, or MGMT
UsernameDevice > Users > Local Users & GroupsDisplays the local administrator or read-only user accounts configured on the firewall
PasswordDevice > Users > Local Users & GroupsPassword is not visible after creation. It can only be set or reset by editing the user account
HTTPS Management PortDevice > Settings > AdministrationShows the HTTPS management port used to access the SonicWall UI (default: 443)
SonicOS API AccessDevice > Settings > Administration > SonicOS APIUsed to verify whether API access is enabled for integrations
User Role / PermissionsDevice > Users > Local Users & Groups > Edit User > GroupsDisplays the administrator or read-only groups assigned to the integration user
Remote Management SettingsDevice > Settings > AdministrationUsed to verify whether HTTPS management access is enabled internally or externally
Firmware / SonicOS VersionDevice > Settings > Firmware & Backupsor System > StatusDisplays the current SonicOS version running on the firewall
Firewall HostnameDevice > System > AdministrationDisplays the configured firewall device name or hostname
Interface Zone DetailsNetwork > System > InterfacesDisplays whether the interface belongs to LAN, WAN, DMZ, or MGMT zones

Validate Connectivity

Use the following sample token request only for validation from an approved secure environment:
Parameter Details:
ParameterDescription
-kIgnores SSL certificate validation for self-signed certificates
-uSupplies SonicWall username and password
-X GETSends a GET request
/api/sonicos/versionSonicOS API endpoint used to validate connectivity and authentication
curl -k -u "<username>:<password>" \
-X GET "https://<firewall-ip>/api/sonicos/version"
“status”: “success”: true , “firmware_version”: “SonicOS 7.0.1”, “model”: “NSa 2700”, “serial_number”: “123456789”, “hostname”: “sonicwall-fw”
“status”:“success”: false,“message”: “Authentication failed”
curl: (7) Failed to connect to 192.168.1.1 port 443: Connection refused
Common Causes
ErrorPossible Cause
Authentication failedIncorrect username or password
Connection refusedFirewall IP unreachable or HTTPS disabled
SSL certificate issueSelf-signed or invalid certificate
401 UnauthorizedInsufficient permissions or invalid credentials
API endpoint not foundSonicOS API not enabled

Configure Salesforce in AirMDR Integrations Dashboard

  1. Navigate to AirMDR, provide the credentials and click Login
  2. Navigate to the AirMDR Integrations Dashboard in the left navigation pane and select Integrations.
  3. Use the search option, enter the keyword “SonicWall”, select the Connections tab, and click + Create button.
  4. Enter an unique name to the Instance (e.g., your org name-SonicWall) to easily identify the user connection by AirMDR.
  5. Enter the application credentials like Firewall IP, Username and Password in the Authentication Details field params, and click Save.

Skills provided by this Integration

Skill IDPurpose
Get SonicWall IPv4 NAT PoliciesRetrieve IPv4 NAT policies from SonicWall firewall.
Get SonicWall IPv4 Route PoliciesRetrieve IPv4 route policies from SonicWall firewall.
Get SonicWall IPv4 Access RulesRetrieve IPv4 access rules from SonicWall firewall.
Get SonicWall IPv4 InterfacesRetrieve IPv4 interfaces from SonicWall firewall.
Get SonicWall Service GroupsRetrieve service groups from SonicWall firewall.
Get SonicWall ZonesRetrieve zones from SonicWall firewall.
To view the details of Input Parameters and Output for the respective skills
  • Go to AirMDR → SonicWall Integration page.
  • Select the Skills tab and click on the required listed skills.

Additional Information

IssuePossible CauseResolution
Connection failedFirewall IP is incorrectVerify the IP from Network > System > Interfaces
Authentication failedIncorrect username or passwordReset password or verify credentials
Access deniedUser lacks required permissionsAssign user to correct admin/read-only group
TimeoutRemote agent cannot reach firewallCheck routing, firewall rules, and port access
API request failedSonicOS API disabledEnable SonicOS API in Administration settings
SSL certificate warningSelf-signed firewall certificateValidate certificate trust policy before allowing connection

SonicWall UI Logs

Navigate to 
Monitor → Logs → System Logs
or
Investigate → Logs
depending on SonicOS version.

What to Monitor

Log TypePurpose
Login eventsValidate AirMDR authentication attempts
Admin activityTrack configuration or access changes
API activityConfirm API requests, if enabled
System eventsIdentify firewall-side errors

Sample Log Entry

User login successful: user=airmdr-readonly source=<remote-agent-ip>User login failed: user=airmdr-readonly reason=Invalid credentials
Best PracticeDescription
Use Least-Privilege AccessAssign only the minimum permissions required for the integration. Prefer read-only administrator roles whenever possible.
Use Dedicated Integration AccountsCreate a separate SonicWall account specifically for AirMDR integration to improve auditing and access tracking.
Enforce Strong Password PoliciesUse complex passwords with uppercase, lowercase, numbers, and special characters. Rotate passwords periodically based on organizational policy.
Restrict Management AccessLimit SonicWall management UI access to trusted IP ranges or internal management networks only.
Use HTTPS OnlyEnsure the firewall management interface is accessible only over HTTPS to protect credentials during transmission.
Enable Audit LoggingMonitor administrator logins, configuration changes, and authentication failures through SonicWall system logs.
Periodically Review PermissionsRegularly validate user roles, access groups, and API permissions associated with the integration account.
Disable Unused Management ServicesTurn off unused services such as HTTP or WAN management access if not required.
Protect Remote Agent ConnectivityEnsure secure communication between the AirMDR Remote Agent and SonicWall firewall using approved firewall and network policies.
Review Failed Login AttemptsInvestigate repeated authentication failures or suspicious login activity immediately.
  • 📧 Contact AirMDR Support through your designated support channel.
  • 🔁 Rotate credentials regularly. Recommended cadence: Every 90 days or as per internal security policy
  • 🔄 Reconnect in AirMDR when secrets are changed.
  • Access Review Review the SonicWall integration user periodically.
    Review ItemRecommended Frequency
    User account statusQuarterly
    Assigned permissionsQuarterly
    API accessQuarterly
    Firewall management exposureAfter every major network change

Data Exchanged

Data TypeDescription
Firewall metadataDevice and interface details
Security eventsFirewall alerts, events, and logs
Network detailsIPs, zones, sessions, or policy-related information
Authentication dataUsername/password used for connection

Ports and Endpoints

PurposeProtocolDefault Port
SonicWall HTTPS managementHTTPS443
SonicWall HTTP managementHTTP80
API communicationHTTPS443
Allow connectivity from the AirMDR remote agent to the SonicWall management IP on the required port.