openstack-python-openstackc.../doc/source/command-objects/network.rst
Colleen Murphy 6c224f5acf Add project and domain params to network create
Without this patch, openstackclient has no way to specify to which
project a network belongs upon creation. Instead, it uses the project
ID that the user is authenticating with to fill the tenant_id column.
This is a problem because an admin user is unable to specify a project
for a non-admin network. To fix this and to improve feature parity with
the neutron client, this patch adds project and domain parameters to
the network create command and uses the given project name to look up
the project ID.

Neutron does not allow the project to be changed after creation, so no
such parameter has been added to the neutron set command.

Neutron calls the field 'tenant_id', but this change exposes the
parameter as '--project' to support the newer terminology.

If no project is specified, the client defaults to the previous
behavior of using the auth project.

Change-Id: Ia33ff7d599542c5b88baf2a69b063a23089a3cc4
2015-03-19 23:49:02 -07:00

145 lines
2 KiB
ReStructuredText

=======
network
=======
Network v2
network create
--------------
Create new network
.. program:: network create
.. code:: bash
os network create
[--domain <domain>]
[--enable | --disable]
[--project <project>]
[--share | --no-share]
<name>
.. option:: --domain <domain>
Owner's domain (name or ID)"
.. option:: --project <project>
Owner's project (name or ID)
.. option:: --enable
Enable network (default)
.. option:: --disable
Disable network
.. option:: --share
Share the network between projects
.. option:: --no-share
Do not share the network between projects
.. _network_create-name:
.. describe:: <name>
New network name
network delete
--------------
Delete network(s)
.. program:: network delete
.. code:: bash
os network delete
<network> [<network> ...]
.. _network_delete-project:
.. describe:: <network>
Network to delete (name or ID)
network list
------------
List networks
.. program:: network list
.. code:: bash
os network list
[--external]
[--dhcp <dhcp-id>]
[--long]
.. option:: --external
List external networks
.. option:: --dhcp <dhcp-id>
DHCP agent ID
.. option:: --long
List additional fields in output
network set
-----------
Set network properties
.. program:: network set
.. code:: bash
os network set
[--name <name>]
[--enable | --disable]
[--share | --no-share]
<network>
.. option:: --name <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
.. _network_set-name:
.. describe:: <network>
Network to modify (name or ID)
network show
------------
Display network details
.. program:: network show
.. code:: bash
os network show
<network>
.. _network_show-name:
.. describe:: <network>
Network to display (name or ID)