Operation: Add Unicast Route / Update Unicast Route
Description: To Add/Update Unicast Route. A Route provides the appliance with the information it needs to forward a packet to a particular destination. 

Sample Configuration
<UnicastRoute> <IPFamily>IPv4/IPv6</IPFamily> <DestinationIP>ipaddress</DestinationIP> <Netmask>0.0.0.0</Netmask> <Gateway>ipaddress</Gateway> <Interface>{interface}/Blackhole</Interface> <Distance>0</Distance> <AdministrativeDistance>1</AdministrativeDistance> <Blackhole>Enable/Disable</Blackhole> <Status>ON/OFF</Status> <Description /> <OldConfiguration> <DestinationIP>ipaddress</DestinationIP> <Netmask>0.0.0.0</Netmask> <Gateway>ipaddress</Gateway> <Interface>{interface}/Blackhole</Interface> <Distance>0</Distance> <AdministrativeDistance>1</AdministrativeDistance> <Blackhole>Enable/Disable</Blackhole> <Status>ON/OFF</Status> <Description /> </OldConfiguration> </UnicastRoute>



Parameter Mandatory Default Description
DestinationIPYes  
Specify destination IPv4/IPv6 address.
DestinationIP confines to:
  • Type is 'SCALAR'.
  • Datatype is 'IPADDRESS6'.
  • Maximum characters allowed are 45.
  • IP Class other than 'MULTICAST', 'LOCALHOST' is allowed.
NetmaskYes  
Select Network Subnet mask prefix from the available options.
Netmask confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 0 to 128 is allowed.
GatewayNo  
Specify Gateway IPv4 address.
Gateway 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.
InterfaceNo  
Select interface from the options available.
Interface confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
DistanceNo 0 
Specify metric for routing.
Distance confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 0 to 255 is allowed.
  • Maximum digits allowed are 3.
IPFamilyNo IPv4 
Specify 'ipfamily'
IPFamily confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
AdministrativeDistanceNo 1 
Specify administrative distance for routing.
AdministrativeDistance confines to:
  • Type is 'SCALAR'.
  • Datatype is 'INTEGER'.
  • Range 1 to 255 is allowed.
  • Maximum digits allowed are 3.
BlackholeNo  
Creates or removes a blackhole route.
Blackhole confines to:
  • Type is 'SCALAR'.
  • Only 'Enable', 'Disable' are allowed.
StatusNo ON 
To turn the static route on or off.
Status confines to:
  • Type is 'SCALAR'.
  • Only 'ON', 'OFF' are allowed.
DescriptionNo  
Description for the static route.
Description confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 255.



Operation   Status   Message
Add Unicast Route200
Add Unicast Route500
Add Unicast Route502
Add Unicast Route541
Add Unicast Route510
Add Unicast Route511
Add Unicast Route527
Add Unicast Route528
Update Unicast Route200
Update Unicast Route500
Update Unicast Route502
Update Unicast Route541
Update Unicast Route510
Update Unicast Route511
Update Unicast Route526
Update Unicast Route527
Update Unicast Route528

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