Operation: Cellular WAN
Description: Use this XML to configure, connect, or disconnect a cellular WAN network. 

Sample Configuration
<CellularWAN> <Action>Enable/Disable/Query/Set</Action> <!--query params --> <SerialPort>543</SerialPort> <ATCommand>string</ATCommand> <!--set params --> <DisconnectOnSystemDown>on/off</DisconnectOnSystemDown> </CellularWAN> <CellularWANSettings> <!-- InterfaceName is readonly --> <Name>Text</Name> <IPAssignment>PPP/DHCP</IPAssignment> <Connect>Auto/Manual</Connect> <ReconnectTries>Always/1/2/3</ReconnectTries> <ModemPort>Serial0/Serial1/.../Serial9</ModemPort> <PhoneNumber>phone number</PhoneNumber> <UserName>username</UserName> <Password>password</Password> <SIMCardPINCode>Text</SIMCardPINCode> <APN>Text</APN> <DHCPConnectCommand>Text</DHCPConnectCommand> <DHCPDisconnectCommand>Text</DHCPDisconnectCommand> <InitializationStrings> <String>Text</String> : </InitializationStrings> <GatewaySettings> <GatewayName>gatewayname</GatewayName> </GatewaySettings> <AssignmentType>Automatic/Manual</AssignmentType> <MTU>Number</MTU> <MSS>Number</MSS> <MACAddress>Default/{userdefined MAC Address}</MACAddress> <ConnectionStatus>Connected/Disconnected</ConnectionStatus> </CellularWANSettings>



Parameter Mandatory Default Description
IPAssignmentYes  
IP assignment method used by the modem.
IPAssignment confines to:
  • Type is 'SCALAR'.
  • Only 'PPP', 'DHCP' are allowed.
ConnectYes  
Mode for establishing the connection.
Connect confines to:
  • Type is 'SCALAR'.
  • Only 'Auto', 'Manual' are allowed.
ReconnectTriesYes  
Number of attempts to make when reconnecting to an access point.
ReconnectTries confines to:
  • Type is 'SCALAR'.
  • Only 'Always', '1', '2', '3' are allowed.
ModemPortNo  
Serial interface on which the modem establishes a connection.
ModemPort confines to:
  • Type is 'SCALAR'.
  • Only 'Serial0', 'Serial1', 'Serial2', 'Serial3', 'Serial4', 'Serial5', 'Serial6', 'Serial7', 'Serial8', 'Serial9' are allowed.
PhoneNumberNo  
Phone number to use for establishing the connection.
PhoneNumber confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 15.
UserNameNo  
Username required for the connection.
UserName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Characters not allowed: (^;'"\)
  • Maximum characters allowed are 60.
PasswordNo  
Password required for the connection.
Password confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 30.
SIMCardPINCodeNo  
Code to unlock a PIN-enabled SIM card.
SIMCardPINCode confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 60.
APNNo  
Access point name.
APN confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 50.
StringNo  
Turns some features on the wireless modem on or off.
String confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
DHCPConnectCommandNo  
DHCP command used to connect to the cellular WAN.
DHCPConnectCommand confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 60.
DHCPDisconnectCommandNo  
DHCP command used to disconnect from the cellular WAN.
DHCPDisconnectCommand confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 60.
GatewayNameYes  
Name of the gateway.
GatewayName confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 60.
MTUNo  
Largest packet size in bytes that the network can transmit.
MTU confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 576 to 9000 is allowed.
MSSNo  
Data in bytes that a TCP packet can transmit.
MSS confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 536 to 8960 is allowed.
MACAddressNo  
MAC address that overrides the default address.
MACAddress confines to:
  • Type is 'SCALAR'.
  • Datatype is 'MACADDRESS'.
  • Maximum characters allowed are 17.
AssignmentTypeYes  
Automatic or manual assignment for MTU and MSS.
AssignmentType confines to:
  • Type is 'SCALAR'.
  • Only 'Manual', 'Autometic' are allowed.
ConnectionStatusNo  
Status of the 3G, 4G, or 5G modem's connectivity.
ConnectionStatus confines to:
  • Type is 'SCALAR'.
  • Only 'Disconnected', 'Connected' are allowed.
NameNo  
Name of the cellular WAN interface.
Name confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 58.



Operation   Status   Message
Cellular WAN200
Cellular WAN201
Cellular WAN202
Cellular WAN500
Cellular WAN524
Cellular WAN502
Cellular WAN503
Cellular WAN504
Cellular WAN505
Cellular WAN506
Cellular WAN508
Cellular WAN509
Cellular WAN510
Cellular WAN521
Cellular WAN522
Cellular WAN523

© Copyright 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.