Richard Theis 6b76860c45 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
2016-04-08 08:00:17 -05:00

3.9 KiB

network

Compute v2, Network v2

network create

Create new network

network create

os network create
    [--project <project> [--project-domain <project-domain>]]
    [--enable | --disable]
    [--share | --no-share]
    [--availability-zone-hint <availability-zone>]
    [--external [--default | --no-default] | --internal]
    [--provider-network-type <provider-network-type>]
    [--provider-physical-network <provider-physical-network>]
    [--provider-segment <provider-segment>]
    <name>

--project <project>

Owner's project (name or ID)

Network version 2 only

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

Network version 2 only

--enable

Enable network (default)

Network version 2 only

--disable

Disable network

Network version 2 only

--share

Share the network between projects

--no-share

Do not share the network between projects

--availability-zone-hint <availability-zone>

Availability Zone in which to create this network (requires the Network Availability Zone extension, this option can be repeated).

Network version 2 only

--subnet <subnet>

IPv4 subnet for fixed IPs (in CIDR notation)

Compute version 2 only

--external

Set this network as an external network. Requires the "external-net" extension to be enabled.

Network version 2 only

--internal

Set this network as an internal network (default)

Network version 2 only

--default

Specify if this network should be used as the default external network

Network version 2 only

--no-default

Do not use the network as the default external network. By default, no network is set as an external network.

Network version 2 only

--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 version 2 only

--provider-physical-network <provider-physical-network>

Name of the physical network over which the virtual network is implemented

Network version 2 only

--provider-segment <provider-segment>

VLAN ID for VLAN networks or Tunnel ID for GRE/VXLAN networks

Network version 2 only

New network name

network delete

Delete network(s)

network delete

os network delete
    <network> [<network> ...]




Network(s) to delete (name or ID)

network list

List networks

network list

os network list
    [--external]
    [--long]

--external

List external networks

--long

List additional fields in output

network set

Set network properties

Network version 2 only

network set

os network set
    [--name <name>]
    [--enable | --disable]
    [--share | --no-share]
    <network>

--name <name>

Set network name

--enable

Enable network

--disable

Disable network

--share

Share the network between projects

--no-share

Do not share the network between projects

Network to modify (name or ID)

network show

Display network details

network show

os network show
    <network>




Network to display (name or ID)