Component routes

Documentation | Support

Go to the table of contents

Go to the previous page

Go to the next page

View or print as PDF

Forcepoint Appliances Command Line Interface > Appliance interface configuration > Component routes

Component routes

Although the appliance management interface (C) is typically reserved for management traffic, in some deployments it is necessary or desirable to route some web or email traffic through the C interface rather than P1/P2 or E1/E2.

The component route table has a maximum limit of 5000 entries.

show component_route

Display the list of configured component routes.

show component_route

Usage guidelines

Outputs a table displaying route destination, netmask, module name, and active status.

Related commands


Command	Description
set component_route	Configure traffic between components for routing through the appliance.
delete component_route	Delete routing between components.
show route	Display the list of configured static IPv4 routes.
show route6	Display the list of configured static IPv6 routes.

set component_route

Configure traffic between components for routing through the appliance.

set component_route --dest <ipv4_address> --mask <ipv4_netmask> --module <proxy|email>


Parameter	Description
dest	Destination IP address in IPv4 format.
mask	Netmask address in IPv4 format.
module	Appliance module; Proxy or Email.

(config)# set component_route --dest 11.0.0.0 --mask 255.0.0.0 --module email

Related commands


Command	Description
show component_route	Display the list of configured component routes.
delete component_route	Delete routing between components.
show route	Display the list of configured static IPv4 routes.
show route6	Display the list of configured static IPv6 routes.

delete component_route

Delete routing between components.

delete component_route --dest <ipv4_address> --mask <ipv3_netmask> --module <proxy|email>


Parameter	Description
dest	Destination address in IPv4 format.
mask	Netmask address in IPv4 format.
module	Appliance module; Proxy or Email.

(config)# delete component_route --dest 11.0.0.0 --mask 255.0.0.0 --module email

Related commands


Command	Description
show component_route	Display the list of configured component routes.
set component_route	Configure traffic between components for routing through the appliance.
show route	Display the list of configured static IPv4 routes.
show route6	Display the list of configured static IPv6 routes.

Display the list of configured static IPv4 routes.

Usage guidelines

Outputs a table displaying route destination, netmask, next hop, device, and active status.

Related commands


Command	Description
show component_route	Display the list of configured component routes.
set component_route	Configure traffic between components for routing through the appliance.
delete component_route	Delete routing between components.
show route6	Display the list of configured static IPv6 routes.

Display the list of configured static IPv6 routes.

Forcepoint Web Security.

Usage guidelines

Outputs a table displaying route destination, netmask, next hop, device, and active status.

Related commands


Command	Description
show component_route	Display the list of configured component routes.
set component_route	Configure traffic between components for routing through the appliance.
delete component_route	Delete routing between components.
show route	Display the list of configured static IPv4 routes.

Add a static route in IPv4 format.

set route --dest <ipv4_address> --interface <c|p1|p2|e1|e2> --mask <ipv4_netmask> --gateway <ipv4_address>


Parameter	Description
dest	Destination IP address in IPv4 format.
interface	Interface name must be P1 or P2.
mask	Netmask address in IPv4 format.
gateway	Gateway definition in IPv4 format.

(config)# set route --dest 11.0.0.0 --mask 255.0.0.0 --gateway 10.206.7.254 --interface c

Related commands


Command	Description
show component_route	Display the list of configured component routes.
set component_route	Configure traffic between components for routing through the appliance.
delete component_route	Delete routing between components.
show route	Display the list of configured static IPv4 routes.

Add a static route in IPv6 format.

set route6 --dest <ipv6_address> --interface <c|p1|p2|e1|e2> --prefixlen <integer> --gateway <ipv6_address>


Parameter	Description
dest	Destination IP address in IPv6 format.
interface	Interface name must be P1 or P2.
prefixlen	Prefix length of the IPv6 address. Must be an integer between 1 and 128.
gateway	Gateway definition in IPv6 format.

Forcepoint Web Security.

(config)# set route6 --dest 2222:3333:4444:5555::0 --interface p1 --prefixlen 64 --gateway 1234:5678::8765:4321

Related commands


Command	Description
show component_route	Display the list of configured component routes.
set component_route	Configure traffic between components for routing through the appliance.
delete component_route	Delete routing between components.
show route	Display the list of configured static IPv4 routes.

Delete a single IPv4 static route.

delete route --dest <ip_address> --mask <ipv4_netmask> --interface <c|p1|p2|e1|e2> --gateway <ipv4_address>


Parameter	Description
dest	Destination IP address in IPv4 format.
mask	Netmask address in IPv4 format.
interface	Interface name must be P1 or P12.
gateway	Gateway definition in IPv4 format.

Usage guidelines

To delete multiple IPv4 routes in a batch, use the command load route.

(config)# delete route --dest 1.0.0.0 --mask 255.0.0.0 --gateway 10.0.0.1 --interface c

Related commands


Command	Description
show component_route	Display the list of configured component routes.
set component_route	Configure traffic between components for routing through the appliance.
delete component_route	Delete routing between components.
load route	Add or delete one or more IPv4 static route definitions via a text file.

Delete a single IPv6 static route.

delete route6 --dest <ipv6_address> --prefixlen <integer> [--interface <c|p1|p2|e1|e2>] [--gateway <ipv6_address>]


Parameter	Description
dest	Destination IP address in IPv6 format.
interface	Interface name; C, P1, P2, E1, or E2.
prefixlen	Prefix length of the IPv6 address.
gateway	Gateway definition in IPv6 format.

Forcepoint Web Security.

Usage guidelines

To delete multiple IPv6 routes in a batch, use the command load route6.

(config)# delete route6 --dest 8765:4321::0 --gateway 1234:5678::8765:4321 --interface p1 --prefixlen 64

Related commands


Command	Description
load route6	Add or delete one or more IPv6 static route definitions via a text file.
save route6	Export IPv6 static routes.
show component_route	Display the list of configured component routes.
set component_route	Configure traffic between components for routing through the appliance.

Export IPv4 static routes to a remote storage location defined by the command set filestore.

save route --location <filestore_alias> [--url <url>] [--save-path <filepath>] [--auth-required]


Parameter	Description
location	(Optional) Remote storage location defined by the command set filestore.
save-path	(Optional) Directory on the filestore in which to save the file.
url	The URL of the storage location. Format: <url type>://<user>@<ip or hostname>/<filepath> See usage guidelines.
auth-required	Used with URL option to specify that a password is needed.

Usage guidelines

URL components:

url type - smb, tftp, or ftp. Required.

user - username if required to access the URL. Optional.

ip / hostname - Destination you want to connect to. Required.

filepath - The directory on the host where you want to store the route file. Required.

(config)# save route --location samba-fs5

Related commands


Command	Description
set filestore	Define a remote location to host backup and configuration files.
show route	Display the list of configured static IPv4 routes.
set route	Add a static route in IPv4 format.
delete route	Delete a single IPv4 static route.

Export IPv6 static routes to a remote storage location defined by the command set filestore.

save route6 --location <filestore_alias> [--save-path <filepath>] [--url <url>] [--auth-required]


Parameter	Description
location	Remote location defined by the command set filestore.
save-path	(Optional) Directory on the filestore in which to store the file.
url	(Optional) The URL of the storage location. Format: <url type>://<user>@<ip or hostname>/<filepath> See usage guidelines.
auth-required	(Optional) Used with URL parameter to specify that a password is required.

Usage guidelines

Forcepoint Web Security.

URL components:

url type - smb, tftp, or ftp. Required.

user - username if required to access the URL. Optional.

ip / hostname - Destination you want to connect to. Required.

filepath - The directory on the host where you want to store the route file. Required.

(config)# save route6 --location samba-fs5

Related commands


Command	Description
set filestore	Define a remote location to host backup and configuration files.
show route6	Display a list of configured static IPv6 routes.
set route6	Add a static route in IPv6 format.
delete route6	Delete a single IPv6 static route.

Add or delete one or more IPv4 static route definitions via text file.

load route --file <file_name> --location <filestore_alias> [--url <ipv4_route_url>] [<--auth-required] [--no-cert-verification>] --action <add|del>


Parameter	Description
file	Name of the text file. Each line in the text file defines one route. The system can handle a maximum of 5000 routes. The line format is: <destination> <netmask> <gateway> <interface> A blank space separates parameters on a single line. The following characters serve as separators between lines (individual routes): \r\n
location	Any defined remote filestore alias.
url	(Optional) URL of the IPv4 route file to load, if adding from a URL rather than from a filestore. Format: <url type>://<user>@<ip or hostname>/<filepath>
auth-required	(Optional) Use with the --url parameter to specify whether a password is needed.
no-cert-verification	(Optional) Use with the --url parameter to ignore SSL certificate checks. Only valid with HTTPS.
action	Specify whether to add or delete the routes in a file, as a batch.

(config)# load route --file add_ipv4.txt --location myfilestore --action add

Related commands


Command	Description
save route	Export IPv4 static routes to a remote filestore location.
delete route	Delete a single IPv4 static route.
set route	Add a static route in IPv4 format.
show route	Display the list of configured static IPv4 routes.

Add or delete one or more IPv6 static route definitions via a text file.

load route6 --file <file_name> --location <filestore_alias> [--url <ipv6_route_url>] [<--auth-required>] [<--no-cert-verification>] --action <add|del>


Parameter	Description
file	Name of the text file. Each line in the file defines one route. The system can handle a maximum of 5000 routes. The line format is: <destination> <prefix_length> <gateway> <interface> A blank space separates parameters on a single line. The following character serves as a separator between lines (individual routes): \n
location	Any defined remote filestore alias.
url	(Optional) URL of the IPv6 route file to load, if adding from a URL rather than from a filestore.
auth-required	(Optional) Use with the --url parameter to specify whether a password is needed.
no-cert-verification	(Optional) Use with the --url parameter to ignore SSL certificate checks. Only valid with HTTPS.
action	Specify whether to add or delete the routes in a file, as a batch.

Forcepoint Web Security.

(config)# load route6 --file add_ipv6.txt --location myfilestore --action add

Related commands


Command	Description
save route6	Export IPv6 static routes to a remote storage location.
delete route6	Delete a single IPv6 static route.
set route6	Add a static route in IPv6 format.
show route6	Display the list of configured static IPv6 routes.

Go to the table of contents

Go to the previous page

Go to the next page

View or print as PDF

Forcepoint Appliances Command Line Interface > Appliance interface configuration > Component routes

Copyright 2020 Forcepoint. All rights reserved.