Adding a Route

Description

This command adds an IPv4 or IPv6 route to an existing Virtual System or Virtual Router object.

Note - This command detects IPv4 and IPv6 automatically.

Syntax

add route vd <Name of VS or VR Object> destination {<IP Address>[/<IP Prefix>] | default | default6} [{netmask <IP Netmask> | prefix <IP Prefix>}] {next_hop <Next Hop IP Address> | leads_to <Name of VS or VR Object>} [propagate {true | false}]

Parameters

Parameter

Value

Notes

vd <Name of VS or VR Object>

Object name

Specifies the name of the Virtual System or Virtual Router object.

Mandatory parameter, if this is the first command in a transaction.

destination {<IP Address>[/<IP Prefix>] | default | default6}

See the Notes column on the right

Specifies the route destination settings:

  • <IP Address> - IPv4 or IPv6 address

  • <IP Prefix> -

    • For IPv4 - Integer between 1 and 32

    • For IPv6 - Integer between 64 and 128

  • default - Use the default IPv4 route

  • default6 - Use the default IPv6 route

netmask <IP Netmask>

Number

Specifies an IP Netmask:

  • For IPv4 - Number in a format X.X.X.X

  • For IPv6 - Number in a format XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX

prefix <IP Prefix>

Integer

Specifies the IP address prefix length:

  • For IPv4 - Integer between 1 and 32

  • For IPv6 - Integer between 64 and 128

next_hop <Next Hop IP Address>

IP Address

Specifies the IP address of the next hop of the route.

Notes:

  • This IP address must be on a subnet of an existing interface.

  • You must use the "next_hop" or "leads_to" parameter, but not both.

leads_to <Name of VS or VR Object>

Object name

Specifies the name of the Virtual System or Virtual Router object, which is the next hop for the configured route.

Note - You must use the "next_hop" or "leads_to" parameter, but not both.

propagate {true | false}

  • true

  • false

Controls how to propagate the IP routes to adjacent Virtual Devices:

  • true - Propagate the IP routes

  • false - Do not propagate the IP routes (default)

Note - The "propagate" parameter is applicable only if you specified the "next_hop" parameter.

Example - Adding a route on the Virtual System "VS1" that uses the default IPv4 route as a destination and the Virtual Router "VR3" as a next hop

vsx_provisioning_tool -s localhost -u admin -p mypassword -o add route vd VS1 destination default leads_to VR3