Preparing a Configuration File

Configuration files can be used to set, add, or delete parameters that are normally only accessible from the Dell SonicWALL GMS UI. Additional examples of XML files are found in the SGMS2/CLI directory. The following is the format of an XML configuration file:

NOTE: For information on configuration parameters, see Configuration Parameters .

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<!DOCTYPE Configure [

<!ELEMENT Configure (Task*)>

<!ELEMENT Task (SetParam*,DelParam*,AddParam*)>

<!ATTLIST Task

displayname CDATA #REQUIRED

viewname CDATA #REQUIRED

updatetype CDATA #REQUIRED

tasktype CDATA #REQUIRED

description CDATA #REQUIRED>

<!ELEMENT SetParam EMPTY>

<!ATTLIST SetParam

setParamName CDATA #REQUIRED

setParamValue CDATA #REQUIRED>

<!ELEMENT DelParam EMPTY>

<!ATTLIST DelParam

delParamName CDATA #REQUIRED

delParamValue CDATA #REQUIRED>

<!ELEMENT AddParam EMPTY>

<!ATTLIST AddParam

addParamName CDATA #REQUIRED

addParamValue CDATA #REQUIRED>

]>

<Configure>

<Task

displayname="firewall_parameters"

viewname="view_name"

updatetype="update_type"

tasktype="task_type"

description="description"

>

<AddParam addParamName="add_parameter_name" addParamValue="add_parameter_value"/>

<AddParam setParamName="set_parameter_name" setParamValue="set_parameter_value"/>

</Task>

</Configure>

 

Table 107. Parameters

firewall_parameters	Required. Specifies the firewall or parameters of the firewalls that will updated. To specify a single firewall, enter the firewall name. For example: displayname="Firewall_42" To specify more than one firewall, enter each group parameter that applies to the firwall. For example: displayname="Country=USA:State=California:Department=Engineering"
view_name	Specifies the view to which the firewall or group of firewalls belongs. This allows you to apply changes to firewalls within a specific view. For example, to apply the changes to firewalls that meet the parameters that you specified in the view “USA_west_coast,” enter the following: viewname=”USA_west_coast”
update_type	Specifies the kind of update to be performed such as changing existing values, adding new values, or deleting values. Options include: • change_field—used to set a non-array-type field • add_array_field—used to add an array-type field • del_array_field—used to delete a value from an array-type field • special_action—used to perform special tasks, such as synchronizing or restarting a firewall
task_type	Specifies the task type. Options include: • Configure_FW—used to configure SonicWALL firewalls • Configure_RC—used to configure Ravlin devices • Register—used to register SonicWALL appliances
description	Description of the tasks you are performing. This information appears in the log files.
Parameter Settings	Used to add, delete, or set parameters. Change Fields Used to set independent firewall parameters. • set_parameter_name—specifies the name of the parameter. • set_parameter_value—specifies the new setting. For example, to create a task to change the time zone of the firewall (the timezone parameter), enter the following: updatetype=change_field tasktype=Configure_FW description=Change Timezone setParamName=timezone setParamValue=829   Add Fields Used to add new firewall parameters. • add_parameter_name—specifies the name of the parameter. • add_parameter_value—specifies the new parameter setting. For example, to add a rule (such as Allow File Transfer (FTP)), use the following text: updatetype=add_array_field tasktype=Configure_FW description=Add Rule, Allow File Transfer (FTP) setParamName=serviceNameInRule setParamValue=File Transfer (FTP)   Delete Fields Used to delete firewall parameters. • del_parameter_name—specifies the name of the parameter. • del_parameter_value—specifies the setting to delete. For example, to remove a rule (such as Allow File Transfer (FTP)), use the following text: updatetype=del_array_field tasktype=Configure_FW description=Delete Rule, Allow File Transfer (FTP) setParamName=serviceNameInRule setParamValue=File Transfer (FTP)   Special Action Used to execute special actions such as a resetting a firewall. • set_parameter_name—specifies the name of the parameter. • set_parameter_value—specifies the action to execute. For example, to restart a firewall, use the following text: updatetype=special_action tasktype=Configure_FW description=Restart Firewall setParamName=cgi_action setParamValue=restart