Before you start
- Your firewalls are managed in Network Security Manager in the cloud (
nsm-uswest.sonicwall.comornsm-eucentral.sonicwall.com), with at least an NSM Essentials licence, which SonicWall requires for API access. - API access is enabled for your MySonicWall account. If MySonicWall does not offer Generate My API Key, ask SonicWall support to enable API access.
1. Generate the API key in MySonicWall
1
Sign in as the right user
Sign in to MySonicWall as a user who can see every tenant you want Neo to reach. The key has that user’s access in MySonicWall and NSM, so a read-only user’s key cannot make changes.
2
Generate the key
Open My Workspace > User Groups > User List (on monthly billing accounts, Access Management > Users) and click Generate My API Key. Give it a description. Leave Source IP Address empty, or add Neo’s IP addresses from IP Whitelisting.
3
Copy the key
Copy the key before you close the window: MySonicWall does not show it again. A key lasts at most one year; generate a new one and save it in Neo before it expires.
2. Add the key in Neo
1
Open Integrations
In the Neo Dashboard, open Integrations → SonicWall, under Networking.
2
Save the key
Pick your NSM region, paste the API key, and click Save settings. Neo lists your tenants and signs in to NSM for one of them before saving, so a wrong key or region is rejected straight away.
3. Turn SonicWall on per agent
1
Open the agent's integrations
Open the agent in the Neo Dashboard and go to its Integrations tab.
2
Pick an access profile
Under SonicWall, pick an access profile, or set each permission group by hand.
See SonicWall API for every permission group.
3
Tell the agent what to do
Add an instruction, for example: “Every Monday, list the SonicWall firewalls of every client whose licences expire in the next 30 days, with the service and the date, and post it as a report.” Or: “When a VPN tunnel goes down, check the tunnel and the WAN link status in SonicWall and write what you find in an internal note.”