Adding SonicWALL Appliances

Appendices : Accessing the CLI

Adding SonicWALL Appliances

To add one or more SonicWALL appliances to Dell SonicWALL GMS using the CLI, use the addunit command.

sgms> addunit xml_file

Syntax

Table 87. Syntax

xml_file

XML file that contains SonicWALL appliance information.

Usage Guidelines

The XML file should contain the following:

<?xml version ="1.0" ?>

<sgmscommand>

: <command>addUnit</command>

: <FirewallList>

: <FirewallInfo>

: <SonicwallName>sonicwall_name</sonicwallName>

: <SonicwallPassword>password</sonicwallPassword>

: <IpAddress>ip_address</ipAddress>

: <retainManual>1</retainManual>

: <userName>username</userName>

: <SerialNumber>serial_number</serialNumber>

: <SAencryptionKey>encrypt_key</SAencryptionKey>

: <SAAuthKey>auth_key</SAAuthKey>

: <AntivirusPassword>av_password</antivirusPassword>

: <SchedulerIPAddress>scheduler_ip</schedulerIPAddress>

: <StandbySchedulerIP>standby_ip</standbySchedulerIP>

: <UseVPN>use_vpn</useVPN>

: <supportRavlin>ravlin_bit</supportRavlin>

: <snmpRead>read_string</snmpRead>

: <snmpWrite>write_string</snmpWrite>

: <httpsMgmt>https_bit</httpsMgmt>

: <managedOnLanIP>managedon_lanip</managedOnLanIP>

: <StandbyManagedAtWan>standbymanaged_atwan</standbyManagedAtWan>

: <CustomInfo>

: <Customfield01>field_01</Customfield01>

: <Customfield02>field_02</Customfield02>

: ...

: <Customfield10>field_10</Customfield10>

: </CustomInfo>

: <userList>

: <user>user_01</user>

: <user>user_02</user>

: ...

: </userList>

: </FirewallInfo>

: <FirewallInfo>

: (SonicWALL Configuration Information)

: </FirewallInfo>

: <FirewallInfo>

: (SonicWALL Configuration Information)

: </FirewallInfo>

: </FirewallList>

</sgmscommand>

Table 88. Usage guidelines

sonicwall_name

Required. Descriptive name for the SonicWALL appliance.

ip_address

If the WAN IP address of the SonicWALL appliance is static, enter the IP address. If the WAN IP address of the SonicWALL appliance changes dynamically, leave this field blank.

retainManual

Optional. This will retain Manual Mode and the specified IP address will not be overwritten. Enter 1 in this field to enable the feature. An IP Address has to be specified for the tag “ipAddress” when using this feature.

userName

Required. Enter the Administrator login name for the SonicWALL appliance. If you are the Administrator of the appliance, you can also enter a Local User or a Remote User name (as configured on the Firewall) for GMS Management. If using Local User or Remote User names, they must be specified in the user list.

password

Required. Password used to access the SonicWALL appliance.

serial_number

Required. Serial number of the SonicWALL appliance.

encrypt_key

Required. Enter a 16-character encryption key. The key must be exactly 16 characters long and comprised of hexadecimal characters. Valid hexadecimal characters are “0” to “9”, and “a” to “f” (such as 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, a, b, c, d, e, f). For example, a valid key would be 1234567890abcdef.

This key must match the encryption key of the SonicWALL appliance.

auth_key

Required. Enter a 32-character authentication key. The key must be exactly 32 characters long and comprised of hexadecimal characters. For example, a valid key would be 1234567890abcdef1234567890abcdef.

This key must match the authentication key of the SonicWALL appliance.

av_password

If the SonicWALL appliance uses the Anti-Virus feature, enter the Anti-Virus password. Otherwise, leave the field blank.

scheduler_ip

Required. Enter the IP address of the Dell SonicWALL GMS server that will manage the SonicWALL appliance:

If Dell SonicWALL GMS is configured in a two-tier distributed environment, you can select any Agent. However, the IP address must match the IP address that you specified when configuring the SonicWALL appliance for Dell SonicWALL GMS management.

If Dell SonicWALL GMS is in a single server environment, enter the IP address of the Dell SonicWALL GMS server.

standby_ip

Enter the IP address of the standby Dell SonicWALL GMS server. The standby Dell SonicWALL GMS server will automatically manage the SonicWALL appliance in the event of a primary failure. Any Agent can be configured as the standby.

If SonicWALL GMS is in a single server environment, leave this field blank.

use_vpn

Specifies whether Dell SonicWALL GMS will need a VPN tunnel to reach the SonicWALL appliance (default: yes). If yes, enter use_vpn. If no, leave it blank.

ravlin_bit

Specifies whether this is a Ravlin device (default: no). If yes, enter 1. If no, enter 0. If this entry does not appear in the file, Dell SonicWALL GMS assumes it is
SonicWALL appliance.

read_string

Specifies the SNMP read string for Ravlin devices.

write_string

Specifies the SNMP write string for Ravlin devices.

https_bit

Specifies whether this device uses HTTPS instead of a VPN tunnel (default: no). If yes, enter 1. If no, enter 0.

managedon_lanip

Specifies the device will be managed from the LAN interface. If you will use HTTPS, this setting must be enabled.

standbymanaged_atwan

Specifies whether the SonicWALL appliance will establish a VPN tunnel to the standby scheduler (default: yes). If yes, standbymanaged_atwan. If no, leave it blank.

field_01...field_10

Specifies the values of each custom field.

user_01...

Specifies the usernames of non-administrator Dell SonicWALL GMS users that have access to this SonicWALL appliance through the Dell SonicWALL GMS UI.

Example

In the following example, two new SonicWALL appliances are added to the GMS. The first appliance is determining the IP address automatically, and being managed by the administrator. The second appliance is using a manually enter IP address that is set to be sticky (retained), and management permissions are given to the gmsuser.

sgms> addunit new_sonicwall.xml

The following is the content of new_sonicwall.xml.

<?xml version ="1.0" ?>

<sgmscommand>

: <command>addUnit</command>

: <FirewallList>

: <FirewallInfo>

: <sonicwallName>ABC14</sonicwallName>

: <sonicwallPassword>abc</sonicwallPassword>

: <ipAddress></ipAddress>

: <userName>admin</userName>

: <serialNumber>00F12211F114</serialNumber>

: <SAencryptionKey>1234567812345678</SAencryptionKey>

: <SAuthKey>12345678123456781234567812345678</SAuthKey>

: <antivirusPassword>avpass</antivirusPassword>

: <schedulerIPAddress>192.168.168.168</schedulerIPAddress>

: <useVPN>1</useVPN>

: <standbyManagedAtWan>1</standbyManagedAtWan>

: <standbySchedulerIP>192.168.168.23</standbySchedulerIP>

: <supportRavlin>1</supportRavlin>

: <snmpRead>abcdef12</snmpRead>

: <snmpWrite>abcdef12</snmpWrite>

: <httpsMgmt>0</httpsMgmt>

: <manageOnLanIP>0</manageOnLanIP>

: <CustomInfo>

: <Company>SonicWAll</Company>

: <Country>China</Country>

: <State>California</State>

: <Department>Engineering</Department>

: </CustomInfo>

: <userList>

: <user>billb</user>

: <user>dana</user>

: </userList>

: </FirewallInfo>

: <FirewallInfo>

: <sonicwallName>XYZ26</sonicwallName>

: <sonicwallPassword>abc</sonicwallPassword>

: <ipAddress>10.10.10.100</ipAddress>

: <retainManual>1</retainManual>

: <userName>gmsuser</userName>

: <serialNumber>00F1434CE265</serialNumber>

: <SAencryptionKey>1234567812345678</SAencryptionKey>

: <SAuthKey>123456781234567812345678abcdef89</SAuthKey>

: <antivirusPassword></antivirusPassword>

: <schedulerIPAddress>192.168.168.168</schedulerIPAddress>

: <useVPN>1</useVPN>

: <standbyManagedAtWan>1</standbyManagedAtWan>

: <standbySchedulerIP>192.168.168.23</standbySchedulerIP>

: <httpsMgmt>0</httpsMgmt>

: <manageOnLanIP>0</manageOnLanIP>

: <CustomInfo>

: <Company>SonicWAll</Company>

: <Country>China</Country>

: <State>California</State>

: <Department>Engineering</Department>

: </CustomInfo>

: </FirewallInfo>

: </FirewallList>

</sgmscommand>

sonicwall_name	Required. Descriptive name for the SonicWALL appliance.
ip_address	If the WAN IP address of the SonicWALL appliance is static, enter the IP address. If the WAN IP address of the SonicWALL appliance changes dynamically, leave this field blank.
retainManual	Optional. This will retain Manual Mode and the specified IP address will not be overwritten. Enter 1 in this field to enable the feature. An IP Address has to be specified for the tag “ipAddress” when using this feature.
userName	Required. Enter the Administrator login name for the SonicWALL appliance. If you are the Administrator of the appliance, you can also enter a Local User or a Remote User name (as configured on the Firewall) for GMS Management. If using Local User or Remote User names, they must be specified in the user list.
password	Required. Password used to access the SonicWALL appliance.
serial_number	Required. Serial number of the SonicWALL appliance.
encrypt_key	Required. Enter a 16-character encryption key. The key must be exactly 16 characters long and comprised of hexadecimal characters. Valid hexadecimal characters are “0” to “9”, and “a” to “f” (such as 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, a, b, c, d, e, f). For example, a valid key would be 1234567890abcdef. This key must match the encryption key of the SonicWALL appliance.
auth_key	Required. Enter a 32-character authentication key. The key must be exactly 32 characters long and comprised of hexadecimal characters. For example, a valid key would be 1234567890abcdef1234567890abcdef. This key must match the authentication key of the SonicWALL appliance.
av_password	If the SonicWALL appliance uses the Anti-Virus feature, enter the Anti-Virus password. Otherwise, leave the field blank.
scheduler_ip	Required. Enter the IP address of the Dell SonicWALL GMS server that will manage the SonicWALL appliance: If Dell SonicWALL GMS is configured in a two-tier distributed environment, you can select any Agent. However, the IP address must match the IP address that you specified when configuring the SonicWALL appliance for Dell SonicWALL GMS management. If Dell SonicWALL GMS is in a single server environment, enter the IP address of the Dell SonicWALL GMS server.
standby_ip	Enter the IP address of the standby Dell SonicWALL GMS server. The standby Dell SonicWALL GMS server will automatically manage the SonicWALL appliance in the event of a primary failure. Any Agent can be configured as the standby. If SonicWALL GMS is in a single server environment, leave this field blank.
use_vpn	Specifies whether Dell SonicWALL GMS will need a VPN tunnel to reach the SonicWALL appliance (default: yes). If yes, enter use_vpn. If no, leave it blank.
ravlin_bit	Specifies whether this is a Ravlin device (default: no). If yes, enter 1. If no, enter 0. If this entry does not appear in the file, Dell SonicWALL GMS assumes it is SonicWALL appliance.
read_string	Specifies the SNMP read string for Ravlin devices.
write_string	Specifies the SNMP write string for Ravlin devices.
https_bit	Specifies whether this device uses HTTPS instead of a VPN tunnel (default: no). If yes, enter 1. If no, enter 0.
managedon_lanip	Specifies the device will be managed from the LAN interface. If you will use HTTPS, this setting must be enabled.
standbymanaged_atwan	Specifies whether the SonicWALL appliance will establish a VPN tunnel to the standby scheduler (default: yes). If yes, standbymanaged_atwan. If no, leave it blank.
field_01...field_10	Specifies the values of each custom field.
user_01...	Specifies the usernames of non-administrator Dell SonicWALL GMS users that have access to this SonicWALL appliance through the Dell SonicWALL GMS UI.