From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: 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 --- doc/source/cli/command-objects/network.rst | 414 +++++++++++++++++++++++++++++ 1 file changed, 414 insertions(+) create mode 100644 doc/source/cli/command-objects/network.rst (limited to 'doc/source/cli/command-objects/network.rst') diff --git a/doc/source/cli/command-objects/network.rst b/doc/source/cli/command-objects/network.rst new file mode 100644 index 00000000..ed9fd13d --- /dev/null +++ b/doc/source/cli/command-objects/network.rst @@ -0,0 +1,414 @@ +======= +network +======= + +A **network** is an isolated Layer 2 networking segment. There are two types +of networks, project and provider networks. Project networks are fully isolated +and are not shared with other projects. Provider networks map to existing +physical networks in the data center and provide external network access for +servers and other resources. Only an OpenStack administrator can create +provider networks. Networks can be connected via routers. + +Compute v2, Network v2 + +network create +-------------- + +Create new network + +.. program:: network create +.. code:: bash + + openstack network create + [--project [--project-domain ]] + [--enable | --disable] + [--share | --no-share] + [--description ] + [--availability-zone-hint ] + [--enable-port-security | --disable-port-security] + [--external [--default | --no-default] | --internal] + [--provider-network-type ] + [--provider-physical-network ] + [--provider-segment ] + [--qos-policy ] + [--transparent-vlan | --no-transparent-vlan] + + +.. option:: --project + + Owner's project (name or ID) + + *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 version 2 only* + +.. option:: --enable + + Enable network (default) + + *Network version 2 only* + +.. option:: --disable + + Disable network + + *Network version 2 only* + +.. option:: --share + + Share the network between projects + +.. option:: --no-share + + Do not share the network between projects + +.. option:: --description + + Set network description + + *Network version 2 only* + +.. option:: --availability-zone-hint + + Availability Zone in which to create this network + (Network Availability Zone extension required, + repeat option to set multiple availability zones) + + *Network version 2 only* + +.. option:: --enable-port-security + + Enable port security by default for ports created on + this network (default) + + *Network version 2 only* + +.. option:: --disable-port-security + + Disable port security by default for ports created on + this network + + *Network version 2 only* + +.. option:: --subnet + + IPv4 subnet for fixed IPs (in CIDR notation) + + *Compute version 2 only* + +.. option:: --external + + Set this network as an external network + (external-net extension required) + + *Network version 2 only* + +.. option:: --internal + + Set this network as an internal network (default) + + *Network version 2 only* + +.. option:: --default + + Specify if this network should be used as + the default external network + + *Network version 2 only* + +.. option:: --no-default + + Do not use the network as the default external network + (default) + + *Network version 2 only* + +.. option:: --provider-network-type + + The physical mechanism by which the virtual network is implemented. + The supported options are: flat, geneve, gre, local, vlan, vxlan. + + *Network version 2 only* + +.. option:: --provider-physical-network + + Name of the physical network over which the virtual network is implemented + + *Network version 2 only* + +.. option:: --provider-segment + + VLAN ID for VLAN networks or Tunnel ID for GENEVE/GRE/VXLAN networks + + *Network version 2 only* + +.. option:: --qos-policy + + QoS policy to attach to this network (name or ID) + + *Network version 2 only* + +.. option:: --transparent-vlan + + Make the network VLAN transparent + + *Network version 2 only* + +.. option:: --no-transparent-vlan + + Do not make the network VLAN transparent + + *Network version 2 only* + +.. _network_create-name: +.. describe:: + + New network name + +network delete +-------------- + +Delete network(s) + +.. program:: network delete +.. code:: bash + + openstack network delete + [ ...] + +.. _network_delete-network: +.. describe:: + + Network(s) to delete (name or ID) + +network list +------------ + +List networks + +.. program:: network list +.. code:: bash + + openstack network list + [--external | --internal] + [--long] + [--name ] + [--enable | --disable] + [--project [--project-domain ]] + [--share | --no-share] + [--status ] + [--provider-network-type ] + [--provider-physical-network ] + [--provider-segment ] + [--agent ] + +.. option:: --external + + List external networks + + *Network version 2 only* + +.. option:: --internal + + List internal networks + + *Network version 2 only* + +.. option:: --long + + List additional fields in output + + *Network version 2 only* + +.. option:: --name + + List networks according to their name + + *Network version 2 only* + +.. option:: --enable + + List enabled networks + + *Network version 2 only* + +.. option:: --disable + + List disabled networks + + *Network version 2 only* + +.. option:: --project + + List networks according to their project (name or ID) + + *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 version 2 only* + +.. option:: --share + + List networks shared between projects + + *Network version 2 only* + +.. option:: --no-share + + List networks not shared between projects + + *Network version 2 only* + +.. option:: --status + + List networks according to their status + ('ACTIVE', 'BUILD', 'DOWN', 'ERROR') + +.. option:: --provider-network-type + + List networks according to their physical mechanisms. + The supported options are: flat, geneve, gre, local, vlan, vxlan. + + *Network version 2 only* + +.. option:: --provider-physical-network + + List networks according to name of the physical network + + *Network version 2 only* + +.. option:: --provider-segment + + List networks according to VLAN ID for VLAN networks + or Tunnel ID for GENEVE/GRE/VXLAN networks + + *Network version 2 only* + +.. option:: --agent + + List networks hosted by agent (ID only) + +network set +----------- + +Set network properties + +*Network version 2 only* + +.. program:: network set +.. code:: bash + + openstack network set + [--name ] + [--enable | --disable] + [--share | --no-share] + [--description ] + [--enable-port-security | --disable-port-security] + [--external [--default | --no-default] | --internal] + [--provider-network-type ] + [--provider-physical-network ] + [--provider-segment ] + [--qos-policy | --no-qos-policy] + + +.. option:: --name + + Set network name + +.. option:: --enable + + Enable network + +.. option:: --disable + + Disable network + +.. option:: --share + + Share the network between projects + +.. option:: --no-share + + Do not share the network between projects + +.. option:: --description + + Set network description + +.. option:: --enable-port-security + + Enable port security by default for ports created on + this network + +.. option:: --disable-port-security + + Disable port security by default for ports created on + this network + +.. option:: --external + + Set this network as an external network. + (external-net extension required) + +.. option:: --internal + + Set this network as an internal network + +.. option:: --default + + Set the network as the default external network + +.. option:: --no-default + + Do not use the network as the default external network. + +.. option:: --provider-network-type + + The physical mechanism by which the virtual network is implemented. + The supported options are: flat, gre, local, vlan, vxlan. + +.. option:: --provider-physical-network + + Name of the physical network over which the virtual network is implemented + +.. option:: --provider-segment + + VLAN ID for VLAN networks or Tunnel ID for GRE/VXLAN networks + +.. option:: --qos-policy + + QoS policy to attach to this network (name or ID) + +.. option:: --no-qos-policy + + Remove the QoS policy attached to this network + +.. _network_set-network: +.. describe:: + + Network to modify (name or ID) + +network show +------------ + +Display network details + +.. program:: network show +.. code:: bash + + openstack network show + + +.. _network_show-network: +.. describe:: + + Network to display (name or ID) -- cgit v1.2.1