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

Sample Configuration
<REDDevice transactionid=""> <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> <Certificate> <Cert>RED cert for registration</Cert> <Key /> <CA /> </Certificate> <Authorized /> <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>



Parameter Mandatory Default Description
BranchNameYes  
Enter the name for the remote location where the RED will be set up.
BranchName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
DeviceNo  
Select the client type depending on the type of RED device you want to connect.
Device confines to:
  • Type is 'SCALAR'.
  • Only 'RED10', 'RED15', 'RED15W', 'RED50', 'RED_FIREWALL_SERVER', 'RED_FIREWALL_SERVER_LEGACY', 'RED_FIREWALL_CLIENT', 'RED_FIREWALL_CLIENT_LEGACY' are allowed.
REDDeviceIDYes  
Enter the RED ID.
REDDeviceID confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
TunnelIDNo  
Specify 'tunnel_id'
TunnelID confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
UnlockCodeNo  
Enter the unlock code.
UnlockCode confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
UTMHostNameYes  
Enter the hostname of the UTM.
UTMHostName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
ConnectionYes DHCP 
Select the connection type for the uplink.
Connection confines to:
  • Type is 'SCALAR'.
  • Only 'DHCP', 'Static' are allowed.
AddressNo  
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.
NetmaskNo /24 (255.255.255.0) 
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]
DefaultGatewayNo  
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.
DNSNo  
Enter DNS Server IP.
DNS confines to:
  • Type is 'SCALAR'.
  • Datatype is 'IPADDRESS'.
SecondUTMHostNameNo  
Enter the second hostname of the UTM.
SecondUTMHostName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
SecondUplinkModeNo Failover 
Enable to activate active load balancing between both uplinks.
SecondUplinkMode confines to:
  • Type is 'SCALAR'.
  • Only 'balance', 'failover' are allowed.
Use2ndIPHostNameForNo Failover 
Enable to distribute traffic equally between, the primary and the secondary hosts.
Use2ndIPHostNameFor confines to:
  • Type is 'SCALAR'.
  • Only 'Loadbalancing', 'Failover' are allowed.
ConnectionYes DHCP 
Configure what the second uplink should be used for.
Connection confines to:
  • Type is 'SCALAR'.
  • Only 'DHCP', 'Static' are allowed.
AddressNo  
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.
NetmaskNo /24 (255.255.255.0) 
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]
DefaultGatewayNo  
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.
DescriptionNo  
Enter a description for the RED settings.
Description confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
OperationModeYes Standard/Unified 
Specify how the remote network must be integrated into your local network.
OperationMode confines to:
  • Type is 'SCALAR'.
  • Only 'Standard', 'Split', 'Transparent' are allowed.
NetworkNo  
Add one or more split networks.
Network confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
DNSNo  
Add an DNS Server.
DNS confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
DomainNo  
Add one or more split domains.
Domain confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
IPAddressYes  
Enter the IP address of the RED device.
IPAddress confines to:
  • Type is 'SCALAR'.
  • Datatype is 'IPADDRESS'.
NetMaskYes  
/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]
ZoneYes  
Select the requested zone.
Zone confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Allowed first characters: Alphanumeric characters (A-Za-z1-9) and not a zero (0). For other characters: (A-Za-z0-9_)
DHCPRangeNo  
Enter the DHCP range RED is allowed to use.
DHCPRange confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
FilterTypeNo  
Select the MAC filtering type to restrict the MAC addresses that can be connected to the RED device.
FilterType confines to:
  • Type is 'SCALAR'.
  • Only 'None', 'Whitelist', 'Blacklist' are allowed.
MACAddressNo  
The list of MAC addresses used to restrict access to the RED device.
MACAddress confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
DeploymentModeNo Automatically via Provisioning Service 
Select the requested deployment method.
DeploymentMode confines to:
  • Type is 'SCALAR'.
  • Only 'AutoDeployment', 'ManualDeployment' are allowed.
UMTS3GFailoverNo Disable 
Enable/disable the 3G/UMTS failover function.
UMTS3GFailover confines to:
  • Type is 'SCALAR'.
  • Only 'Disable', 'Enable' are allowed.
UsernameNo  
Enter a username for the mobile network.
Username confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
PasswordNo  
Enter password for the mobile network.
Password confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
PinNo  
Enter the PIN of the SIM card if a PIN is configured.
Pin confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 15.
MobileNetworkNo GSM 
Select the mobile network type.
MobileNetwork confines to:
  • Type is 'SCALAR'.
  • Only 'GSM', 'CDMA' are allowed.
APNNo  
Enter provider's access point name information.
APN confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
DialStringNo *99# 
Enter the dial string used by your provider.
DialString confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
LANPortModeNo Switch 
Configure LAN ports that can be configured either as simple switches or for intelligent VLAN usage.
LANPortMode confines to:
  • Type is 'SCALAR'.
  • Only 'Switch', 'VLAN' are allowed.
CertNo  
Enter the certificate of the firewall appliance
Cert confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
VidsNo  
Specify the VLAN IDs.
Vids confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
AuthorizedNo 
Enter weather the device should be authorized or not
Authorized confines to:
  • Type is 'SCALAR'.
  • Only '0', '1' are allowed.
VidsNo  
Specify the VLAN IDs.
Vids confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
ModeNo  
Configure each LAN port separately.
Mode confines to:
  • Type is 'SCALAR'.
  • Only 'Tagged', 'Untagged', 'Untagged DropTagged', 'Unused' are allowed.
VidsNo  
Specify the VLAN IDs.
Vids confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
ModeNo  
Configure each LAN port separately.
Mode confines to:
  • Type is 'SCALAR'.
  • Only 'Tagged', 'Untagged', 'Untagged DropTagged', 'Unused' are allowed.
VidsNo  
Specify the VLAN IDs.
Vids confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
REDMTUYes 1500 
Enter the MTU of the RED device.
REDMTU confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 576 to 1500 is allowed.
TunnelCompressionNo Disable 
Enable/Disable the tunnel compression.
TunnelCompression confines to:
  • Type is 'SCALAR'.
  • Only 'Disable', 'Enable' are allowed.
ModeNo  
Configure each LAN port separately.
Mode confines to:
  • Type is 'SCALAR'.
  • Only 'Tagged', 'Untagged', 'Untagged DropTagged', 'Unused' are allowed.
DHCPStatusNo  
Shows the status of the DHCP server.
DHCPStatus confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
StatusNo  
Shows the RED Device Status.
Status confines to:
  • Type is 'SCALAR'.
  • Only 'Disable', 'Enable' are allowed.
KeyNo  
Enter the private key of the RED device
Key confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
CANo  
Enter the CA-certificate that RED uses
CA confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
ModeNo  
Configure each LAN port separately.
Mode confines to:
  • Type is 'SCALAR'.
  • Only 'Tagged', 'Untagged', 'Untagged DropTagged', 'Disabled' are allowed.
DNSNo  
Enter DNS Server IP.
DNS confines to:
  • Type is 'SCALAR'.
  • Datatype is 'IPADDRESS'.



Operation   Status   Message
Add RED Device200
Add RED Device500
Add RED Device501
Add RED Device502
Add RED Device503
Add RED Device504
Add RED Device512
Add RED Device513
Add RED Device514
Add RED Device515
Add RED Device516
Add RED Device517
Add RED Device518
Add RED Device519
Add RED Device520
Add RED Device521
Add RED Device522
Add RED Device526
Add RED Device541
Add RED Device542
Add RED Device544
Add RED Device543
Add RED Device545
Add RED Device546
Add RED Device547
Update RED Device200
Update RED Device500
Update RED Device501
Update RED Device502
Update RED Device503
Update RED Device504
Update RED Device512
Update RED Device513
Update RED Device514
Update RED Device515
Update RED Device516
Update RED Device517
Update RED Device518
Update RED Device519
Update RED Device526
Update RED Device541
Update RED Device542
Update RED Device544
Update RED Device543
Update RED Device545
Update RED Device546


© Copyright 2019 Sophos Firewall Limited. All rights reserved.
Sophos Firewall is registered trademarks of Sophos Firewall Limited and Sophos Firewall 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.