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>
    		<NATPolicy>None/{NAT policy}</NATPolicy>
    		<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>

Attribute/Parameter Information :

Parameter | Mandatory | Default | Description
--- | --- | --- | ---
Name | Yes |  | Description: Specify name of the gateway. Name confines to: Type is 'SCALAR'. Datatype is 'STRING'. Maximum characters allowed are 50.
GatewayIP | Yes |  | Description: 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', 'LINKLOCAL' is allowed.
Interface | Yes |  | Description: Select the Out interface for the gateway. Interface confines to: Type is 'SCALAR'. Datatype is 'STRING'.
NATPolicy | No |  | Description: Select the default NAT policy to be used for the gateway. NATPolicy confines to: Type is 'SCALAR'. Datatype is 'STRING'. Comma (,) is not allowed. UTF-8 character(s) are allowed.
HealthCheck | No |  | Description: Click to enable health check for monitoring the gateway. HealthCheck confines to: Type is 'SCALAR'. Datatype is 'INTEGER'. Only '0', '1' are allowed.
Interval | Yes |  | Description: 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.
Timeout | Yes |  | Description: 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.
Retries | Yes |  | Description: Specify the number of tries to probe the health of the gateway, after which the gateway will be declared unreachable. Retries confines to: Type is 'SCALAR'. Datatype is 'INTEGER'. Range 1 to 10 is allowed.
MailNotification | No |  | Description: Enable to receive an email notification if there is a change in gateway status. MailNotification confines to: Type is 'SCALAR'. Datatype is 'INTEGER'. Only '0', '1' are allowed.
Protocol | Yes |  | Description: 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.
Port | Yes |  | Description: 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.
IPAddress | Yes |  | Description: 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.
Condition | No |  | Description: 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.
IPFamily | Yes |  | Description: Select IP Family for the gateway. IPFamily confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only '0', '1' are allowed.

Status Message Information :

Operation | Status | Message
--- | --- | ---
Update Gateway Object | 200 |
Update Gateway Object | 500 |
Update Gateway Object | 503 |
Add Gateway Object | 200 |
Add Gateway Object | 500 |
Add Gateway Object | 502 |
Add Gateway Object | 503 |

) Copyright 2017 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.