Operation: | Add RED Device / Update RED Device
Description: | To configure RED.To configure RED.

Sample Configuration
    	<REDDevice>
    		<Status>Enable/Disable</Status>
    		<BranchName />
    		<Device>RED10/RED15/RED50</Device>
    		<REDDeviceID />
    		<TunnelID />
    		<UnlockCode />
    		<UTMHostName />
    		<SecondUTMHostName>
    		<!--For RED15 & RED50 -->
    		</SecondUTMHostName>
    		<Use2ndIPHostnameFor>
    		<!--For RED15 & RED50 -->
    		</Use2ndIPHostnameFor>
    		<Description />
    		<DeploymentMode>AutoDeployment/ManualDeployment
    		<!--Automatically via Provisioning Service/ Manually via USB Stick -->
    		</DeploymentMode>
    		<UplinkSettings>
    			<Uplink>
    				<Connection>DHCP/Static</Connection>
    				<!--Static configuration -->
    				<Address />
    				<Netmask />
    				<DefaultGateway />
    				<DNS />
    			</Uplink>
    			<SecondUplink>
    				<Connection>DHCP/Static</Connection>
    				<Address />
    				<Netmask />
    				<DefaultGateway />
    				<DNS />
    			</SecondUplink>
    			<SecondUplinkMode />
    			<UMTS3GFailover>Enable/Disable</UMTS3GFailover>
    			<FailOverSettings>
    				<Username />
    				<Password />
    				<Pin />
    				<MobileNetwork>GSM/CDMA</MobileNetwork>
    				<APN />
    				<DialString>*99#</DialString>
    			</FailOverSettings>
    		</UplinkSettings>
    		<NetworkSetting>
    			<OperationMode>Standard/Split/Transparent</OperationMode>
    			<StandardSplit>
    				<Networks>
    					<!--Hosts for network -->
    					<Network>
    						:
    					</Network>
    				</Networks>
    			</StandardSplit>
    			<TransparentSplit>
    				<DNS />
    				<Networks>
    					<!--Hosts for network -->
    					<Network>
    						:
    					</Network>
    				</Networks>
    				<Domains>
    					<!--Domains for network -->
    					<Domain>
    						:
    					</Domain>
    				</Domains>
    			</TransparentSplit>
    			<!--interface configuration -->
    			<IPAddress />
    			<NetMask />
    			<Zone />
    			<DhcpStatus>Enable/Disable</DhcpStatus>
    			<DhcpRange />
    			<MACFilter>
    				<FilterType>None/Whitelist/Blacklist</FilterType>
    				<MACAddress />
    			</MACFilter>
    			<TunnelCompression>Enable/Disable</TunnelCompression>
    		</NetworkSetting>
    		<!-- For RED50 Only -->
    		<SwitchSettings>
    			<LANPortMode>Switch/VLAN</LANPortMode>
    			<!-- VLAN configuration-->
    			<LANPortSettings>
    				<LAN1>
    					<Mode>Disabled/Untagged DropTagged/Untagged/Tagged</Mode>
    					<Vids />
    				</LAN1>
    				<LAN2>
    					<Mode>Unused/Untagged DropTagged/Untagged/Tagged</Mode>
    					<Vids />
    				</LAN2>
    				<LAN3>
    					<Mode>Unused/Untagged DropTagged/Untagged/Tagged</Mode>
    					<Vids />
    				</LAN3>
    				<LAN4>
    					<Mode>Unused/Untagged DropTagged/Untagged/Tagged</Mode>
    					<Vids />
    				</LAN4>
    			</LANPortSettings>
    		</SwitchSettings>
    	</REDDevice>

Attribute/Parameter Information :

Parameter | Mandatory | Default | Description
--- | --- | --- | ---
BranchName | Yes |  | Description: Enter the name for the remote location where the RED will be set up. BranchName confines to: Type is 'SCALAR'. Datatype is 'STRING'.
Device | No |  | Description: Select the client type depending on the type of RED device you want to connect. Device confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'red', 'red15', 'red15w', 'red50', 'red_firewall_server', 'red_firewall_server_legacy', 'red_firewall_client', 'red_firewall_client_legacy' are allowed.
REDDeviceID | Yes |  | Description: Enter the RED ID. REDDeviceID confines to: Type is 'SCALAR'. Datatype is 'STRING'.
tunnel_id | No |  | Description: Specify 'tunnel_id' confines to: Type is 'SCALAR'. Datatype is 'STRING'.
UnlockCode | No |  | Description: Enter the unlock code. UnlockCode confines to: Type is 'SCALAR'. Datatype is 'STRING'.
UTMHostName | Yes |  | Description: Enter the hostname of the UTM. UTMHostName confines to: Type is 'SCALAR'. Datatype is 'STRING'.
Connection | Yes | DHCP | Description: Select the connection type for the uplink. Connection confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'dhcp', 'manual' are allowed.
Address | No |  | Description: Enter an IPv4 address. Address confines to: Type is 'SCALAR'. Datatype is 'IPADDRESS'. Maximum characters allowed are 15. IP Class other than 'UNSPECIFIED' is allowed.
Netmask | No | /24 (255.255.255.0) | Description: Enter Netmask. Netmask confines to: Type is 'SCALAR'. Datatype is 'STRING'. Maximum characters allowed are 15. IPv4 Address should be between: [128,192,224,240,248,252,254,255].[0,128,192,224,240,248,252,254,255].[0,128,192,224,240,248,252,254,255].[0,128,192,224,240,248,252,254,255]
DefaultGateway | No |  | Description: Enter gateway IP address. DefaultGateway confines to: Type is 'SCALAR'. Datatype is 'IPADDRESS'. Maximum characters allowed are 15. IP Class other than 'UNSPECIFIED' is allowed.
DNS | No |  | Description: Enter DNS Server IP. DNS confines to: Type is 'SCALAR'. Datatype is 'IPADDRESS'.
SecondUTMHostName | No |  | Description: Enter the second hostname of the UTM. SecondUTMHostName confines to: Type is 'SCALAR'. Datatype is 'STRING'.
SecondUplinkMode | No | Failover | Description: Enable to activate active load balancing between both uplinks. SecondUplinkMode confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'balance', 'failover' are allowed.
Use2ndIPHostnameFor | No | Failover | Description: Enable to distribute traffic equally between, the primary and the secondary hosts. Use2ndIPHostnameFor confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'balance', 'failover' are allowed.
Connection | Yes | DHCP | Description: Configure what the second uplink should be used for. Connection confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'dhcp', 'manual' are allowed.
Address | No |  | Description: Enter the IP address of the RED device. Address confines to: Type is 'SCALAR'. Datatype is 'IPADDRESS'. Maximum characters allowed are 15. IP Class other than 'UNSPECIFIED' is allowed.
Netmask | No | /24 (255.255.255.0) | Description: Enter Netmask. Netmask confines to: Type is 'SCALAR'. Datatype is 'STRING'. Maximum characters allowed are 15. IPv4 Address should be between: [128,192,224,240,248,252,254,255].[0,128,192,224,240,248,252,254,255].[0,128,192,224,240,248,252,254,255].[0,128,192,224,240,248,252,254,255]
DefaultGateway | No |  | Description: Specify a default Gateway. DefaultGateway confines to: Type is 'SCALAR'. Datatype is 'IPADDRESS'. Maximum characters allowed are 15. IP Class other than 'UNSPECIFIED' is allowed.
Description | No |  | Description: Enter a description for the RED settings. Description confines to: Type is 'SCALAR'. Datatype is 'STRING'.
OperationMode | Yes | Standard/Unified | Description: Specify how the remote network must be integrated into your local network. OperationMode confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'default', 'split', 'fullbr' are allowed.
Network | No |  | Description: Add one or more split networks. Network confines to: Type is 'ARRAY'. Datatype is 'STRING'. Multiple values are allowed.
DNS | No |  | Description: Add an DNS Server. DNS confines to: Type is 'SCALAR'. Datatype is 'STRING'.
Domain | No |  | Description: Add one or more split domains. Domain confines to: Type is 'ARRAY'. Datatype is 'STRING'. Multiple values are allowed.
IPAddress | Yes |  | Description: Enter the IP address of the RED device. IPAddress confines to: Type is 'SCALAR'. Datatype is 'IPADDRESS'.
NetMask | Yes |  | Description: /24 (255.255.255.0) NetMask confines to: Type is 'SCALAR'. Datatype is 'STRING'. IPv4 Address should be between: [128,192,224,240,248,252,254,255].[0,128,192,224,240,248,252,254,255].[0,128,192,224,240,248,252,254,255].[0,128,192,224,240,248,252,254,255]
Zone | Yes |  | Description: Select the requested zone. Zone confines to: Type is 'SCALAR'. Datatype is 'STRING'. First character is to be Alphanumeric except ZERO '0' (1-9a-zA-Z). Alphanumeric (a-zA-Z0-9) and underscore (_) to be allowed for the remaining characters.
DHCPRange | No |  | Description: Enter the DHCP range RED is allowed to use. DHCPRange confines to: Type is 'ARRAY'. Datatype is 'STRING'. Multiple values are allowed.
FilterType | No |  | Description: Select the MAC filtering type to restrict the MAC addresses that can be connected to the RED device. FilterType confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'none', 'whitelist', 'blacklist' are allowed.
MACAddress | No |  | Description: The list of MAC addresses used to restrict access to the RED device. MACAddress confines to: Type is 'SCALAR'. Datatype is 'STRING'.
DeploymentMode | No | Automatically via Provisioning Service | Description: Select the requested deployment method. DeploymentMode confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'online', 'offline' are allowed.
Failover | No | Disable | Description: Enable/disable the 3G/UMTS failover function. Failover confines to: Type is 'SCALAR'. Datatype is 'INTEGER'. Only '0', '1' are allowed.
Username | No |  | Description: Enter a username for the mobile network. Username confines to: Type is 'SCALAR'. Datatype is 'STRING'.
Password | No |  | Description: Enter password for the mobile network. Password confines to: Type is 'SCALAR'. Datatype is 'STRING'.
Pin | No |  | Description: Enter the PIN of the SIM card if a PIN is configured. Pin confines to: Type is 'SCALAR'. Datatype is 'INTEGER'.
MobileNetwork | No | GSM | Description: Select the mobile network type. MobileNetwork confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'gsm', 'cdma' are allowed.
APN | No |  | Description: Enter provider's access point name information. APN confines to: Type is 'SCALAR'. Datatype is 'STRING'.
DialString | No | *99# | Description: Enter the dial string used by your provider. DialString confines to: Type is 'SCALAR'. Datatype is 'STRING'.
LANPortMode | No | Switch | Description: Configure LAN ports that can be configured either as simple switches or for intelligent VLAN usage. LANPortMode confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'switch', 'vlan' are allowed.
Mode | No |  | Description: Configure each LAN port separately. Mode confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'tagged', 'untagged', 'untagged_drop_tagged', 'unused' are allowed.
Vids | No |  | Description: Specify the VLAN IDs. Vids confines to: Type is 'SCALAR'. Datatype is 'STRING'.
Mode | No |  | Description: Configure each LAN port separately. Mode confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'tagged', 'untagged', 'untagged_drop_tagged', 'unused' are allowed.
Vids | No |  | Description: Specify the VLAN IDs. Vids confines to: Type is 'SCALAR'. Datatype is 'STRING'.
Mode | No |  | Description: Configure each LAN port separately. Mode confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'tagged', 'untagged', 'untagged_drop_tagged', 'unused' are allowed.
Vids | No |  | Description: Specify the VLAN IDs. Vids confines to: Type is 'SCALAR'. Datatype is 'STRING'.
Mode | No |  | Description: Configure each LAN port separately. Mode confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'tagged', 'untagged', 'untagged_drop_tagged', 'unused' are allowed.
Vids | No |  | Description: Specify the VLAN IDs. Vids confines to: Type is 'SCALAR'. Datatype is 'STRING'.
Status | No |  | Description: Shows the RED Device Status. Status confines to: Type is 'SCALAR'. Datatype is 'INTEGER'. Only '0', '1' are allowed.
DNS | No |  | Description: Enter DNS Server IP. DNS confines to: Type is 'SCALAR'. Datatype is 'IPADDRESS'.
TunnelCompression | No | Disable | Description: Enable/Disable the tunnel compression. TunnelCompression confines to: Type is 'SCALAR'. Datatype is 'INTEGER'. Only '0', '1' are allowed.
DHCPStatus | No |  | Description: Shows the status of the DHCP server. DHCPStatus confines to: Type is 'SCALAR'. Datatype is 'INTEGER'.

Status Message Information :

Operation | Status | Message
--- | --- | ---
Update RED Device | 200 |
Update RED Device | 500 |
Update RED Device | 501 |
Update RED Device | 502 |
Update RED Device | 503 |
Update RED Device | 504 |
Update RED Device | 512 |
Update RED Device | 513 |
Update RED Device | 514 |
Update RED Device | 515 |
Update RED Device | 516 |
Update RED Device | 517 |
Update RED Device | 518 |
Update RED Device | 519 |
Update RED Device | 526 |
Update RED Device | 541 |
Update RED Device | 542 |
Update RED Device | 544 |
Update RED Device | 543 |
Update RED Device | 545 |
Update RED Device | 546 |
Add RED Device | 200 |
Add RED Device | 500 |
Add RED Device | 501 |
Add RED Device | 502 |
Add RED Device | 503 |
Add RED Device | 504 |
Add RED Device | 512 |
Add RED Device | 513 |
Add RED Device | 514 |
Add RED Device | 515 |
Add RED Device | 516 |
Add RED Device | 517 |
Add RED Device | 518 |
Add RED Device | 519 |
Add RED Device | 520 |
Add RED Device | 521 |
Add RED Device | 522 |
Add RED Device | 526 |
Add RED Device | 541 |
Add RED Device | 542 |
Add RED Device | 544 |
Add RED Device | 543 |
Add RED Device | 545 |
Add RED Device | 546 |

) Copyright 2015 Sophos Limited. All rights reserved.
Sophos is registered trademarks of Sophos Limited and Sophos Group. All other product and company names mentioned are trademarks or registered trademarks of their respective owners.No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise unless you are either a valid licensee where the documentation can be reproduced in accordance with the license terms or you otherwise have the prior permission in writing of the copyright owner.