Operation: Add health check profile / Update the health check profile
Description: Health check to determine if the object is active. 

Sample Configuration
<HealthCheckProfile> <Name>{HealthCheckProfileName}</Name> <IPFamily>{IPv4/IPv6}</IPFamily> <ProbeInterval /> <ResponseTimeout /> <ProbesResponseFailure /> <ProbeResponseSuccess /> <ProbeTargets> <ProbeTarget> <monitormethod /> <monitorip /> <port /> <operator /> </ProbeTarget> <ProbeTarget> <monitormethod /> <monitorip /> <port /> <operator /> </ProbeTarget> </ProbeTargets> <Status /> </HealthCheckProfile>



Parameter Mandatory Default Description
IPFamilyNo IPv4 
Specify IPv4 or IPv6.
IPFamily confines to:
  • Type is 'SCALAR'.
  • Maximum characters allowed are 1.
  • Only 'IPv4', 'IPv6' are allowed.
ProbeIntervalNo 60 
Interval between health check probes.
ProbeInterval confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 1 to 65535 is allowed.
ProbesResponseFailureNo 1 
Number of consecutive responses required to activate the object.
ProbesResponseFailure confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 1 to 10 is allowed.
ProbeResponseSuccessNo 3 
Number of consecutive probes without a response before deactivating the object.
ProbeResponseSuccess confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 1 to 10 is allowed.
monitormethodYes  
Protocol used in health check probes.
monitormethod confines to:
  • Type is 'SCALAR'.
  • Only 'TCP', 'PING' are allowed.
monitoripNo  
IP address to monitor.
monitorip confines to:
  • Type is 'SCALAR'.
  • Datatype is 'IPADDRESS','IPADDRESS6','DOMAINNAMELOOKUP'.
  • Maximum characters allowed are 45.
  • IP Class other than 'MULTICAST', 'RESERVED', 'LOCALHOST', 'UNSPECIFIED', 'BROADCAST' is allowed.
portNo  
Port to monitor.
port confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 1 to 65535 is allowed.
  • Maximum digits allowed are 5.
operatorNo | 
Allows you to add a list of objects.
operator confines to:
  • Type is 'SCALAR'.
  • Only '&', '|' are allowed.
ProbeTargetsNo  
Specify 'monitorDetails'
ProbeTargets confines to:
  • Type is 'ARRAY'.
  • Datatype is 'OBJECT'.
  • monitorDetails
  • Multiple values are allowed.
ResponseTimeoutNo 2 
Time in which the object must respond to indicate its status.
ResponseTimeout confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 1 to 10 is allowed.
NameYes  
Name of the health check profile.
Name confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Character not allowed: Comma (,)
  • Maximum characters allowed are 125.
  • UTF-8 character(s) are allowed.



Operation   Status   Message
Add health check profile200
Add health check profile500
Add health check profile502
Update the health check profile200
Update the health check profile500

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