Function add

Add new route.

Throws

ParametersError - Throws when passed parameters are invalid.

Throws

CommandError - Throws when the executed command fails.

Example

Import module

import { route } from 'iproute';
Copy

Unicast type route (the default if not specified)

await route.add({
  to:	'10.0.0.0/24',
  via:	{
    address: '192.168.56.1'
  }
});
Copy

Multipath route with load balance between devices

await route.add({
  to:	  'default',
  scope:	AddressScopes.Global,
  nexthops:  [{
    nexthop: true,
    dev:     'ppp0'
  },
  {
    nexthop: true,
    dev:     'ppp1'
  }]
});
Copy

A NAT route

await route.add({
  type:	RoutingTableTypes.Nat,
  to:	    '10.0.0.0/24',
  table:	300,
  via:	{
    address: '192.168.56.1'
  }
});
Copy