From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: reorganize existing documentation according to the new standard layout Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann --- doc/source/cli/command-objects/router.rst | 357 ++++++++++++++++++++++++++++++ 1 file changed, 357 insertions(+) create mode 100644 doc/source/cli/command-objects/router.rst (limited to 'doc/source/cli/command-objects/router.rst') diff --git a/doc/source/cli/command-objects/router.rst b/doc/source/cli/command-objects/router.rst new file mode 100644 index 00000000..50e791ea --- /dev/null +++ b/doc/source/cli/command-objects/router.rst @@ -0,0 +1,357 @@ +====== +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 +.. code:: bash + + openstack router add port + + + +.. _router_add_port: + +.. describe:: + + Router to which port will be added (name or ID) + +.. describe:: + + Port to be added (name or ID) + +router add subnet +----------------- + +Add a subnet to a router + +.. program:: router add subnet +.. code:: bash + + openstack router add subnet + + + +.. _router_add_subnet: + +.. describe:: + + Router to which subnet will be added (name or ID) + +.. describe:: + + Subnet to be added (name or ID) + +router create +------------- + +Create new router + +.. program:: router create +.. code:: bash + + openstack router create + [--project [--project-domain ]] + [--enable | --disable] + [--distributed | --centralized] + [--ha | --no-ha] + [--description ] + [--availability-zone-hint ] + + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --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 + + The default router type (distributed vs centralized) is determined by a + configuration setting in the OpenStack deployment. Since we are unable + to know that default wihtout attempting to actually create a router it + is suggested to use either :option:`--distributed` or :option:`--centralized` + in situations where multiple cloud deployments may be used. + +.. option:: --centralized + + Create a centralized router + + See the note in :option:`--distributed` regarding the default used when + creating a new router. + +.. option:: --ha + + Create a highly available router + +.. option:: --no-ha + + Create a legacy router + +.. option:: --description + + Set router description + +.. option:: --availability-zone-hint + + Availability Zone in which to create this router + (Router Availability Zone extension required, + repeat option to set multiple availability zones) + +.. _router_create-name: +.. describe:: + + New router name + +router delete +------------- + +Delete router(s) + +.. program:: router delete +.. code:: bash + + openstack router delete + [ ...] + +.. _router_delete-router: +.. describe:: + + Router(s) to delete (name or ID) + +router list +----------- + +List routers + +.. program:: router list +.. code:: bash + + openstack router list + [--name ] + [--enable | --disable] + [--long] + [--project [--project-domain ]] + +.. option:: --long + + List additional fields in output + +.. option:: --name + + List routers according to their name + +.. option:: --enable + + List enabled routers + +.. option:: --disable + + List disabled routers + +.. option:: --project + + List routers according to their project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +router remove port +------------------ + +Remove a port from a router + +.. program:: router remove port +.. code:: bash + + openstack router remove port + + + +.. _router_remove_port: + +.. describe:: + + Router from which port will be removed (name or ID) + +.. describe:: + + Port to be removed and deleted (name or ID) + +router remove subnet +-------------------- + +Remove a subnet from a router + +.. program:: router remove subnet +.. code:: bash + + openstack router remove subnet + + + +.. _router_remove_subnet: + +.. describe:: + + Router from which subnet will be removed (name or ID) + +.. describe:: + + Subnet to be removed (name or ID) + +router set +---------- + +Set router properties + +.. program:: router set +.. code:: bash + + openstack router set + [--name ] + [--enable | --disable] + [--distributed | --centralized] + [--description ] + [--route destination=,gateway= | --no-route] + [--ha | --no-ha] + [--external-gateway [--enable-snat|--disable-snat] [--fixed-ip subnet=,ip-address=]] + + +.. option:: --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:: --description + + Set router description + +.. option:: --route destination=,gateway= + + 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. + Specify both --route and --no-route to overwrite + current value of route. + +.. option:: --ha + + Set the router as highly available (disabled router only) + +.. option:: --no-ha + + Clear high availablability attribute of the router (disabled router only) + +.. option:: --external-gateway + + External Network used as router's gateway (name or ID) + +.. option:: --enable-snat + + Enable Source NAT on external gateway + +.. option:: --disable-snat + + Disable Source NAT on external gateway + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet (name or ID) on external gateway: + subnet=,ip-address= + (repeat option to set multiple fixed IP addresses) + +.. _router_set-router: +.. describe:: + + Router to modify (name or ID) + +router show +----------- + +Display router details + +.. program:: router show +.. code:: bash + + openstack router show + + +.. _router_show-router: +.. describe:: + + Router to display (name or ID) + +router unset +------------ + +Unset router properties + +.. program:: router unset +.. code:: bash + + openstack router unset + [--route destination=,gateway=] + [--external-gateway] + + +.. option:: --route destination=,gateway= + + Routes to be removed from the router + destination: destination subnet (in CIDR notation) + gateway: nexthop IP address + (repeat option to unset multiple routes) + +.. option:: --external-gateway + + Remove external gateway information from the router + +.. _router_unset-router: +.. describe:: + + Router to modify (name or ID) -- cgit v1.2.1