Skip to content

router.rst

Latest commit

 

History

History
149 lines (92 loc) · 2.53 KB

router.rst

File metadata and controls

149 lines (92 loc) · 2.53 KB

router

Network v2

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 (requires the Router
    Availability Zone extension, this option can be repeated).


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

Set router properties

.. program:: router set

os router set
    [--name <name>]
    [--enable | --disable]
    [--distributed | --centralized]
    [--route destination=<subnet>,gateway=<ip-address> | --clear-routes]
    <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.
    Repeat this option to set multiple routes.
    destination: destination subnet (in CIDR notation).
    gateway: nexthop IP address.


.. option:: --clear-routes

    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)