summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/network-segment.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/network-segment.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
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 <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/network-segment.rst')
-rw-r--r--doc/source/cli/command-objects/network-segment.rst133
1 files changed, 133 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/network-segment.rst b/doc/source/cli/command-objects/network-segment.rst
new file mode 100644
index 00000000..d6a66aa0
--- /dev/null
+++ b/doc/source/cli/command-objects/network-segment.rst
@@ -0,0 +1,133 @@
+===============
+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 create
+----------------------
+
+Create new network segment
+
+.. program:: network segment create
+.. code:: bash
+
+ openstack network segment create
+ [--description <description>]
+ [--physical-network <physical-network>]
+ [--segment <segment>]
+ --network <network>
+ --network-type <network-type>
+ <name>
+
+.. option:: --description <description>
+
+ Network segment description
+
+.. option:: --physical-network <physical-network>
+
+ Physical network name of this network segment
+
+.. option:: --segment <segment>
+
+ Segment identifier for this network segment which is
+ based on the network type, VLAN ID for vlan network
+ type and tunnel ID for geneve, gre and vxlan network
+ types
+
+.. option:: --network <network>
+
+ Network this network segment belongs to (name or ID)
+
+.. option:: --network-type <network-type>
+
+ Network type of this network segment
+ (flat, geneve, gre, local, vlan or vxlan)
+
+.. _network_segment_create-name:
+.. describe:: <name>
+
+ New network segment name
+
+network segment delete
+----------------------
+
+Delete network segment(s)
+
+.. program:: network segment delete
+.. code:: bash
+
+ openstack network segment delete
+ <network-segment> [<network-segment> ...]
+
+.. _network_segment_delete-segment:
+.. describe:: <network-segment>
+
+ Network segment(s) to delete (name or ID)
+
+network segment list
+--------------------
+
+List network segments
+
+.. program:: network segment list
+.. code:: bash
+
+ openstack 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 set
+-------------------
+
+Set network segment properties
+
+.. program:: network segment set
+.. code:: bash
+
+ openstack network segment set
+ [--description <description>]
+ [--name <name>]
+ <network-segment>
+
+.. option:: --description <description>
+
+ Set network segment description
+
+.. option:: --name <name>
+
+ Set network segment name
+
+.. _network_segment_set-segment:
+.. describe:: <network-segment>
+
+ Network segment to modify (name or ID)
+
+network segment show
+--------------------
+
+Display network segment details
+
+.. program:: network segment show
+.. code:: bash
+
+ openstack network segment show
+ <network-segment>
+
+.. _network_segment_show-segment:
+.. describe:: <network-segment>
+
+ Network segment to display (name or ID)