From 6b76860c451251fd3c95e1e0e1af12c560bf4043 Mon Sep 17 00:00:00 2001 From: Richard Theis Date: Fri, 1 Apr 2016 16:16:08 -0500 Subject: 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 --- doc/source/command-objects/network.rst | 41 +++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 13 deletions(-) (limited to 'doc/source/command-objects/network.rst') 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 Owner's project (name or ID) - (Network v2 only) + + *Network version 2 only* .. option:: --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 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 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 Name of the physical network over which the virtual network is implemented - (Network v2 only) + + *Network version 2 only* .. option:: --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:: @@ -148,6 +161,8 @@ network set Set network properties +*Network version 2 only* + .. program:: network set .. code:: bash -- cgit v1.2.1