Richard Theis 6a55e05cbf Add network segment command object
Add network segment command object in support of routed networks.
This patch set includes documentation, unit tests and functional
tests (currently skipped until segments enabled in neutron by
default) for the following new commands:
  - "os network segment list"
  - "os network segment show"

These new commands are currently marked as beta commands.

Change-Id: I1a79b48dc6820fe2a39fcceb11c8cae3bda413a0
Partially-Implements: blueprint routed-networks
2016-05-27 12:58:25 -05:00

55 lines
1.2 KiB
ReStructuredText

===============
network segment
===============
A **network segment** is an isolated Layer 2 segment within a network.
A network may contain multiple network segments. Depending on the
network configuration, Layer 2 connectivity between network segments
within a network may not be guaranteed.
Network v2
network segment list
--------------------
List network segments
.. caution:: This is a beta command and subject to change.
Use global option ``--enable-beta-commands`` to
enable this command.
.. program:: network segment list
.. code:: bash
os network segment list
[--long]
[--network <network>]
.. option:: --long
List additional fields in output
.. option:: --network <network>
List network segments that belong to this network (name or ID)
network segment show
--------------------
Display network segment details
.. caution:: This is a beta command and subject to change.
Use global option ``--enable-beta-commands`` to
enable this command.
.. program:: network segment show
.. code:: bash
os network segment show
<network-segment>
.. _network_segment_show-segment:
.. describe:: <network-segment>
Network segment to display (ID only)