router.rst

router

A router is a logical component that forwards data packets between networks. It also provides Layer 3 and NAT forwarding to provide external network access for servers on project networks.

Network v2

router add port

Add a port to a router

.. program:: router add port

os router add port
    <router>
    <port>

.. describe:: <router>

    Router to which port will be added (name or ID)

.. describe:: <port>

    Port to be added (name or ID)

router add subnet

Add a subnet to a router

.. program:: router add subnet

os router add subnet
    <router>
    <subnet>

.. describe:: <router>

    Router to which subnet will be added (name or ID)

.. describe:: <subnet>

    Subnet to be added (name or ID)

router create

Create new router

.. program:: router create

os router create
    [--project <project> [--project-domain <project-domain>]]
    [--enable | --disable]
    [--distributed]
    [--availability-zone-hint <availability-zone>]
    <name>

.. option:: --project <project>

    Owner's project (name or ID)

.. option:: --project-domain <project-domain>

    Domain the project belongs to (name or ID).
    This can be used in case collisions between project names exist.

.. option:: --enable

    Enable router (default)

.. option:: --disable

    Disable router

.. option:: --distributed

    Create a distributed router

.. option:: --availability-zone-hint <availability-zone>

    Availability Zone in which to create this router
    (Router Availability Zone extension required,
    repeat option to set multiple availability zones)

.. describe:: <name>

    New router name

router delete

Delete router(s)

.. program:: router delete

os router delete
    <router> [<router> ...]

.. describe:: <router>

    Router(s) to delete (name or ID)

router list

List routers

.. program:: router list

os router list
    [--long]

.. option:: --long

    List additional fields in output

router remove port

Remove a port from a router

.. program:: router remove port

os router remove port
    <router>
    <port>

.. describe:: <router>

    Router from which port will be removed (name or ID)

.. describe:: <port>

    Port to be removed and deleted (name or ID)

router remove subnet

Remove a subnet from a router

.. program:: router remove subnet

os router remove subnet
    <router>
    <subnet>

.. describe:: <router>

    Router from which subnet will be removed (name or ID)

.. describe:: <subnet>

    Subnet to be removed (name or ID)

router set

Set router properties

.. program:: router set

os router set
    [--name <name>]
    [--enable | --disable]
    [--distributed | --centralized]
    [--route destination=<subnet>,gateway=<ip-address> | --no-route]
    <router>

.. option:: --name <name>

    Set router name

.. option:: --enable

    Enable router

.. option:: --disable

    Disable router

.. option:: --distributed

    Set router to distributed mode (disabled router only)

.. option:: --centralized

    Set router to centralized mode (disabled router only)

.. option:: --route destination=<subnet>,gateway=<ip-address>

    Routes associated with the router
    destination: destination subnet (in CIDR notation)
    gateway: nexthop IP address
    (repeat option to set multiple routes)

.. option:: --no-route

    Clear routes associated with the router

.. describe:: <router>

    Router to modify (name or ID)

router show

Display router details

.. program:: router show

os router show
    <router>

.. describe:: <router>

    Router to display (name or ID)

router unset

Unset router properties

.. program:: router unset

os router unset
    [--route destination=<subnet>,gateway=<ip-address>]
    <router>

.. option:: --route destination=<subnet>,gateway=<ip-address>

    Routes to be removed from the router
    destination: destination subnet (in CIDR notation)
    gateway: nexthop IP address
    (repeat option to unset multiple routes)

.. describe:: <router>

    Router to modify (name or ID)