openstack/python-openstackclient
Code Issues Proposed changes
36391a81a3
python-openstackclient/doc/source/command-objects/network.rst

146 lines
2.1 KiB
ReStructuredText
Raw Normal View History

Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
=======
network
=======
Network v2
network create
--------------
Create new network
.. program:: network create
.. code:: bash
os network create
fix confused domain argument for network create v2 we have used domain scope arguments --project-domain, --user-domain and --group-domain in identity commands, for example, role add v3, to prevent resources conflict from same resource name existence. To keep with the style of identity commands, it's better to rename --domain to --project-domain. Closes-Bug: #1468988 Change-Id: Ic6ccb895cf9be4a3d5f0001525e3b80cd340da8b
2015-06-26 12:07:58 +08:00
[--project <project> [--project-domain <project-domain>]]
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
[--enable | --disable]
[--share | --no-share]
<name>
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-02-16 23:21:00 -08:00
.. option:: --project <project>
Owner's project (name or ID)
fix confused domain argument for network create v2 we have used domain scope arguments --project-domain, --user-domain and --group-domain in identity commands, for example, role add v3, to prevent resources conflict from same resource name existence. To keep with the style of identity commands, it's better to rename --domain to --project-domain. Closes-Bug: #1468988 Change-Id: Ic6ccb895cf9be4a3d5f0001525e3b80cd340da8b
2015-06-26 12:07:58 +08:00
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
.. 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]
Begin low-level API for Network v2 api.network.APIv2 starts with network_list() support to flush out the skeleton of the Network API. list_dhcp_agent() supports the --dhcp option of 'network list' Change-Id: I9a2b90cde84eced1f2ea6a014b769e2bae668211
2014-09-18 10:35:15 -05:00
[--dhcp <dhcp-id>]
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
[--long]
.. option:: --external
List external networks
Begin low-level API for Network v2 api.network.APIv2 starts with network_list() support to flush out the skeleton of the Network API. list_dhcp_agent() supports the --dhcp option of 'network list' Change-Id: I9a2b90cde84eced1f2ea6a014b769e2bae668211
2014-09-18 10:35:15 -05:00
.. option:: --dhcp <dhcp-id>
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
Begin low-level API for Network v2 api.network.APIv2 starts with network_list() support to flush out the skeleton of the Network API. list_dhcp_agent() supports the --dhcp option of 'network list' Change-Id: I9a2b90cde84eced1f2ea6a014b769e2bae668211
2014-09-18 10:35:15 -05:00
DHCP agent ID
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
.. 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)
Copy Permalink