Merge "Add more contents about CLI usage"
This commit is contained in:
Jenkins
@@ -53,3 +53,139 @@ supply ``--os-auth-strategy`` or set the environment variable.
|
||||
.. code-block:: shell
|
||||
|
||||
export OS_AUTH_STRATEGY=noauth
|
||||
|
||||
Display options
|
||||
---------------
|
||||
|
||||
Filtering
|
||||
~~~~~~~~~
|
||||
|
||||
Neutron API supports filtering in the listing operation.
|
||||
**neutron** CLI supports this feature too.
|
||||
|
||||
To specify a filter in ``*-list`` command, you need to pass a pair of an
|
||||
attribute name and an expected value with the format of ``--<attribute> <value>``.
|
||||
The example below retrieves ports owned by compute instances.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ neutron port-list --device_owner network:dhcp
|
||||
+--------------------------------------+------+-------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| id | name | mac_address | fixed_ips |
|
||||
+--------------------------------------+------+-------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| 8953d683-29ad-4be3-b73f-060727c7849b | | fa:16:3e:4b:9e:0a | {"subnet_id": "6b832dfe-f271-443c-abad-629961414a73", "ip_address": "10.0.0.2"} |
|
||||
| | | | {"subnet_id": "cdcc616b-0cff-482f-96f5-06fc63d21247", "ip_address": "fd12:877c:1d66:0:f816:3eff:fe4b:9e0a"} |
|
||||
+--------------------------------------+------+-------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
You can also specify multiple filters.
|
||||
The example below retrieves security group rules applied to IPv4 traffic
|
||||
which belongs to a security group bfa493f9-2b03-46d2-8399-b9b038a53bc1.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ neutron security-group-rule-list --security-group-id bfa493f9-2b03-46d2-8399-b9b038a53bc1 --ethertype IPv4
|
||||
+--------------------------------------+----------------+-----------+-----------+---------------+-----------------+
|
||||
| id | security_group | direction | ethertype | protocol/port | remote |
|
||||
+--------------------------------------+----------------+-----------+-----------+---------------+-----------------+
|
||||
| 65489805-0400-4bce-9bd9-16a81952263c | default | egress | IPv4 | any | any |
|
||||
| 9429f336-4947-4643-bbd9-24528cc65648 | default | ingress | IPv4 | any | default (group) |
|
||||
+--------------------------------------+----------------+-----------+-----------+---------------+-----------------+
|
||||
|
||||
.. note::
|
||||
|
||||
Looking up UUID from name is not supported when specifying a filter.
|
||||
You need to use UUID to specify a specific resource.
|
||||
|
||||
.. note::
|
||||
|
||||
Filtering for dictionary or list attributes is not supported.
|
||||
|
||||
Changing displayed columns
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you want displayed columns in a list operation, ``-c`` option can be used.
|
||||
``-c`` can be specified multiple times and the column order will be same as
|
||||
the order of ``-c`` options.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ neutron port-list -c id -c device_owner -c fixed_ips
|
||||
+--------------------------------------+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| id | device_owner | fixed_ips |
|
||||
+--------------------------------------+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| 41ca1b9b-4bbd-4aa8-bcaa-31d3d5704205 | network:router_interface | {"subnet_id": "6b832dfe-f271-443c-abad-629961414a73", "ip_address": "10.0.0.1"} |
|
||||
| 8953d683-29ad-4be3-b73f-060727c7849b | network:dhcp | {"subnet_id": "6b832dfe-f271-443c-abad-629961414a73", "ip_address": "10.0.0.2"} |
|
||||
| | | {"subnet_id": "cdcc616b-0cff-482f-96f5-06fc63d21247", "ip_address": "fd12:877c:1d66:0:f816:3eff:fe4b:9e0a"} |
|
||||
| a9da29f8-4504-4526-a5ce-cd3624fbd173 | neutron:LOADBALANCER | {"subnet_id": "6b832dfe-f271-443c-abad-629961414a73", "ip_address": "10.0.0.3"} |
|
||||
| | | {"subnet_id": "cdcc616b-0cff-482f-96f5-06fc63d21247", "ip_address": "fd12:877c:1d66:0:f816:3eff:feb1:ab71"} |
|
||||
| d6a1ff96-0a99-416f-a4d6-65d9614cf64e | compute:nova | {"subnet_id": "6b832dfe-f271-443c-abad-629961414a73", "ip_address": "10.0.0.4"} |
|
||||
| | | {"subnet_id": "cdcc616b-0cff-482f-96f5-06fc63d21247", "ip_address": "fd12:877c:1d66:0:f816:3eff:fe2c:348e"} |
|
||||
| f4789225-26d0-409f-8047-82d2c7a87a95 | network:router_interface | {"subnet_id": "cdcc616b-0cff-482f-96f5-06fc63d21247", "ip_address": "fd12:877c:1d66::1"} |
|
||||
+--------------------------------------+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Extra argument mechanism
|
||||
------------------------
|
||||
|
||||
[TODO: Write the extra argument mechanism. It is the most tricky area around
|
||||
neutron CLI usage.]
|
||||
|
||||
Debugging
|
||||
---------
|
||||
|
||||
Display API-level communication
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``-v`` (or ``--verbose``, ``--debug``) option displays a detail interaction
|
||||
with your neutron server. It is useful to debug what happens in the API level.
|
||||
|
||||
Here is an sample output of ``net-show`` command.
|
||||
|
||||
The first line show what parameters are recognized by neutronclient.
|
||||
It is sometimes useful to check if command-line parameters you specify are recognized properly.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ neutron -v net-show mynetwork
|
||||
DEBUG: neutronclient.neutron.v2_0.network.ShowNetwork get_data(Namespace(columns=[], fields=[], formatter='table', id=u'mynetwork', max_width=0, noindent=False, prefix='', request_format='json', show_details=False, variables=[]))
|
||||
|
||||
Next, neutronclient sends an authentication request to keystone to get a token
|
||||
which is used in further operations.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
DEBUG: keystoneauth.session REQ: curl -g -i -X GET http://172.16.18.47:5000 -H "Accept: application/json" -H "User-Agent: keystoneauth1"
|
||||
DEBUG: keystoneauth.session RESP: [300] Content-Length: 593 Vary: X-Auth-Token Keep-Alive: timeout=5, max=100 Server: Apache/2.4.7 (Ubuntu) Connection: Keep-Alive Date: Fri, 27 Nov 2015 20:10:54 GMT Content-Type: application/json
|
||||
RESP BODY: {"versions": {"values": [{"status": "stable", "updated": "2015-03-30T00:00:00Z", "media-types": [{"base": "application/json", "type": "application/vnd.openstack.identity-v3+json"}], "id": "v3.4", "links": [{"href": "http://172.16.18.47:5000/v3/", "rel": "self"}]}, {"status": "stable", "updated": "2014-04-17T00:00:00Z", "media-types": [{"base": "application/json", "type": "application/vnd.openstack.identity-v2.0+json"}], "id": "v2.0", "links": [{"href": "http://172.16.18.47:5000/v2.0/", "rel": "self"}, {"href": "http://docs.openstack.org/", "type": "text/html", "rel": "describedby"}]}]}}
|
||||
|
||||
DEBUG: keystoneauth.identity.v3.base Making authentication request to http://172.16.18.47:5000/v3/auth/tokens
|
||||
|
||||
Neutronclient looks up a network ID corresponding to a given network name.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
DEBUG: keystoneauth.session REQ: curl -g -i -X GET http://172.16.18.47:9696/v2.0/networks.json?fields=id&name=mynetwork -H "User-Agent: python-neutronclient" -H "Accept: application/json" -H "X-Auth-Token: {SHA1}39300e7398d53a02afd183f13cb6afaef95ec4e5"
|
||||
DEBUG: keystoneauth.session RESP: [200] Date: Fri, 27 Nov 2015 20:10:55 GMT Connection: keep-alive Content-Type: application/json; charset=UTF-8 Content-Length: 62 X-Openstack-Request-Id: req-ccebf6e4-4f52-4874-a1ab-5499abcba378
|
||||
RESP BODY: {"networks": [{"id": "3698d3c7-d581-443e-bf86-53c4e3a738f7"}]}
|
||||
|
||||
Finally, neutronclient retrieves a detail of a given network using the resolved ID.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
DEBUG: keystoneauth.session REQ: curl -g -i -X GET http://172.16.18.47:9696/v2.0/networks/3698d3c7-d581-443e-bf86-53c4e3a738f7.json -H "User-Agent: python-neutronclient" -H "Accept: application/json" -H "X-Auth-Token: {SHA1}39300e7398d53a02afd183f13cb6afaef95ec4e5"
|
||||
DEBUG: keystoneauth.session RESP: [200] Date: Fri, 27 Nov 2015 20:10:55 GMT Connection: keep-alive Content-Type: application/json; charset=UTF-8 Content-Length: 272 X-Openstack-Request-Id: req-261add00-d6d3-4ea7-becc-105b60ac7369
|
||||
RESP BODY: {"network": {"status": "ACTIVE", "subnets": [], "name": "mynetwork", "admin_state_up": true, "tenant_id": "8f0ebf767043483a987736c8c684178d", "mtu": 0, "router:external": false, "shared": false, "port_security_enabled": true, "id": "3698d3c7-d581-443e-bf86-53c4e3a738f7"}}
|
||||
|
||||
+-----------------------+--------------------------------------+
|
||||
| Field | Value |
|
||||
+-----------------------+--------------------------------------+
|
||||
| admin_state_up | True |
|
||||
| id | 3698d3c7-d581-443e-bf86-53c4e3a738f7 |
|
||||
| mtu | 0 |
|
||||
| name | mynetwork |
|
||||
| port_security_enabled | True |
|
||||
| router:external | False |
|
||||
| shared | False |
|
||||
| status | ACTIVE |
|
||||
| subnets | |
|
||||
| tenant_id | 8f0ebf767043483a987736c8c684178d |
|
||||
+-----------------------+--------------------------------------+
|
||||
|
||||
Reference in New Issue
Block a user