summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/network.rst
diff options
context:
space:
mode:
authorRichard Theis <rtheis@us.ibm.com>2016-04-01 16:16:08 -0500
committerRichard Theis <rtheis@us.ibm.com>2016-04-08 08:00:17 -0500
commit6b76860c451251fd3c95e1e0e1af12c560bf4043 (patch)
treee3aa3a425ca064c6aeee725d59f1a79190151957 /doc/source/command-objects/network.rst
parent9f2e7039e1ac631a4e83fe96d945e9e220db9ad8 (diff)
downloadpython-openstackclient-6b76860c451251fd3c95e1e0e1af12c560bf4043.tar.gz
Doc: Fix network command documentation issues
Fix the following network command documentation issues: - Fix format of subnet pool positional arguments - Update port set options to match help - Fix network command documentation for Network v2 versus Compute v2 options and commands - Fix subnet command documentation errors and formatting problems in help text Change-Id: I808c2a70ca62eafc9e42d6873539cdd142ffe50c Related-Bug: #1558677
Diffstat (limited to 'doc/source/command-objects/network.rst')
-rw-r--r--doc/source/command-objects/network.rst41
1 files changed, 28 insertions, 13 deletions
diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst
index 3d01f253..029e82e3 100644
--- a/doc/source/command-objects/network.rst
+++ b/doc/source/command-objects/network.rst
@@ -26,23 +26,27 @@ Create new network
.. option:: --project <project>
Owner's project (name or ID)
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --enable
Enable network (default)
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --disable
Disable network
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --share
@@ -56,51 +60,60 @@ Create new network
Availability Zone in which to create this network (requires the Network
Availability Zone extension, this option can be repeated).
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --subnet <subnet>
IPv4 subnet for fixed IPs (in CIDR notation)
- (Compute v2 network only)
+
+ *Compute version 2 only*
.. option:: --external
Set this network as an external network.
Requires the "external-net" extension to be enabled.
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --internal
Set this network as an internal network (default)
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --default
Specify if this network should be used as
the default external network
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --no-default
Do not use the network as the default external network.
By default, no network is set as an external network.
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is implemented.
The supported options are: flat, gre, local, vlan, vxlan
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --provider-physical-network <provider-physical-network>
Name of the physical network over which the virtual network is implemented
- (Network v2 only)
+
+ *Network version 2 only*
.. option:: --provider-segment <provider-segment>
VLAN ID for VLAN networks or Tunnel ID for GRE/VXLAN networks
- (Network v2 only)
+
+ *Network version 2 only*
.. _network_create-name:
.. describe:: <name>
@@ -148,6 +161,8 @@ network set
Set network properties
+*Network version 2 only*
+
.. program:: network set
.. code:: bash