Operation: Add Gateway Object / Update Gateway Object
Description: To Add/Edit Gateway Object. 

Sample Configuration
<GatewayHost> <Name>Default</Name> <IPFamily>IPv4/IPv6</IPFamily><!-- default IPv4 --> <GatewayIP>ip</GatewayIP> <Interface>{interface}</Interface> <NetworkZone>{zonename}</NetworkZone> <HealthCheck>{0/1}</HealthCheck> <MailNotification>ON/OFF</MailNotification> <Interval /> <Timeout /> <Retries /> <MonitoringCondition> <Rule> <Protocol>PING/TCP</Protocol> <Port>Number</Port> <IPAddress>ip</IPAddress> <Condition>AND/OR</Condition><!-- Rule order matters as this condition will apply on next condition --> </Rule> : </MonitoringCondition> </GatewayHost>



Parameter Mandatory Default Description
NameYes  
Specify name of the gateway.
Name confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Character not allowed: Comma (,)
  • Maximum characters allowed are 50.
  • UTF-8 character(s) are allowed.
GatewayIPYes  
Specify IP Address of the gateway.
GatewayIP confines to:
  • Type is 'SCALAR'.
  • Datatype is 'IPADDRESS','IPADDRESS6'.
  • Maximum characters allowed are 45.
  • IP Class other than 'MULTICAST', 'RESERVED', 'LOCALHOST', 'UNSPECIFIED', 'BROADCAST' is allowed.
InterfaceYes  
Select the Out interface for the gateway.
Interface confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
HealthcheckNo  
Click to enable health check for monitoring the gateway.
Healthcheck confines to:
  • Type is 'SCALAR'.
  • Only 'OFF', 'ON' are allowed.
IntervalYes  
Specify the time interval in seconds after which the health should be monitored.
Interval confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 5 to 65535 is allowed.
TimeoutYes  
Specify the time interval in seconds within which the gateway must respond.
Timeout confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 1 to 10 is allowed.
FailureRetriesYes  
Specify the number of tries to probe the health of the gateway, after which the gateway will be declared unreachable.
FailureRetries confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 1 to 10 is allowed.
MailNotificationNo  
Enable to receive an email notification if there is a change in gateway status.
MailNotification confines to:
  • Type is 'SCALAR'.
  • Only 'OFF', 'ON' are allowed.
ProtocolYes  
Select the communication protocol depending on the service to be tested for the gateway's health
Protocol confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
  • Duplicate values will not be ignored.
PortYes  
Specify the port number for TCP communication
Port confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
  • Duplicate values will not be ignored.
IPAddressYes  
Specify the IP address of the computer or the network device which is permanently running or most reliable
IPAddress confines to:
  • Type is 'ARRAY'.
  • Datatype is 'IPADDRESS','IPADDRESS6'.
  • Multiple values are allowed.
  • Duplicate values will not be ignored.
ConditionNo  
Select the operator for the monitoring condition. AND: All the conditions must be satisfied for the gateway to be considered alive. OR: At least one condition must be satisfied for the gateway to be considered alive.
Condition confines to:
  • Type is 'ARRAY'.
  • Datatype is 'STRING'.
  • Multiple values are allowed.
  • Duplicate values will not be ignored.
IPFamilyYes  
Select IP Family for the gateway.
IPFamily confines to:
  • Type is 'SCALAR'.
  • Only 'IPv4', 'IPv6' are allowed.
NetworkZoneNo None 
Zone to which the gateway belongs.
NetworkZone confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.



Operation   Status   Message
Add Gateway Object200
Add Gateway Object500
Add Gateway Object502
Add Gateway Object503
Add Gateway Object504
Update Gateway Object200
Update Gateway Object500
Update Gateway Object503

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