Open Stack

We are exuberant to announce the release of:

python-openstackclient 3.4.0: OpenStack Command-line Client

This release is part of the ocata release series.

The source is available from:

    https://git.openstack.org/cgit/openstack/python-openstackclient

Download the package from:

    https://pypi.python.org/pypi/python-openstackclient

Please report issues through launchpad:

    https://bugs.launchpad.net/python-openstackclient

For more details, please see below.

3.4.0
^^^^^


New Features
************

* Add support to update high-availability property of a router by
  adding "--ha" and "--no-ha" option to "router set" CLI. [Bug 1631492
  (https://bugs.launchpad.net/bugs/1631492)]

* Add support for Network QoS policies commands: "network qos policy
  create", "network qos policy delete", "network qos policy list",
  "network qos policy show" and "network qos policy set" [Bug 1609037
  (https://bugs.launchpad.net/bugs/1609037)]

* Add "--all-projects" option to the "volume backup list" command to
  list volume backups accross all projects.

* Add "--read-only" and "--read-write" options to "volume set"
  command. [Blueprint cinder-command-support
  (https://blueprints.launchpad.net/python-openstackclient/+spec
  /cinder-command-support)]

* Add "--description" option to "security group rule create"
  command. [Blueprint :oscbp:`network-commands-options`]

* Add "--description" option to "port set" and "port create"
  commands. [Blueprint :oscbp:`neutron-client-descriptions`]

* "openstack floating ip" now provides "Floating Network" and
  "Project" to identify to which network and project the floating-ip
  belongs to. [Bug 1566090 (https://bugs.launchpad.net/bugs/1566090)]

* Add "--security-group" and "--no-security-group" options to "port
  create", "port set" and "port unset" commands. [Bug 1612136
  (https://bugs.launchpad.net/python-openstackclient/+bug/1612136)]

* Add "--ingress", "--egress" and "--protocol" options to "security
  group rule list" command. [Bug 1613533
  (https://bugs.launchpad.net/bugs/1613533)]

* Add a new column "status" and "--long" option to the result of the
  "os port list" command. [Bug 1613995
  (https://bugs.launchpad.net/bugs/1613995)] [Bug 1614321
  (https://bugs.launchpad.net/bugs/1614321)]

* Add support to allow filtering ports via "--mac-address" option to
  the "port list" command. [Bug 1634333
  (https://bugs.launchpad.net/bugs/1634333)]

* Add "--provider-network-type", "--provider-physical-network",  and
  " --provider-segment" options to the "network list" command. [Bug
  1635580 (https://bugs.launchpad.net/bugs/1635580)]

* Add "--long" option and more columns to the "hypervisor list"
  command. [Bug 1637074 (https://bugs.launchpad.net/bugs/1637074)]

* Add "--name", "--enable", "--disable" options to "router list"
  command. [Bug 1637945 (https://bugs.launchpad.net/bugs/1637945)]

* Add "--name", "--status", "--volume", "--marker" and "--limit"
  options to "volume backup list" command [Bug 1639712
  (https://bugs.launchpad.net/bugs/1639712)]

* "rbac_object" parameter in "network rbac create" command now can
  be a QoS policy name.

* Add "volume migrate" command. [Blueprint cinder-command-support
  (https://blueprints.launchpad.net/python-openstackclient/+spec
  /cinder-command-support)]


Upgrade Notes
*************

* Rename the "--src-group" and "--src-ip" options in the "security
  group rule create" command to "--remote-group" and "--remote-ip".
  The "--src-group" and "--src-ip" options are deprecated but still
  supported, and will be removed in a future release. [Bug 1637365
  (https://bugs.launchpad.net/python-openstackclient/+bug/1637365)]


Bug Fixes
*********

* Fix the "--block-migration" and "--shared-migration" options for
  "server migrate" to send the correct values to the Compute API. [Bug
  1518059 (https://bugs.launchpad.net/bugs/1518059)]:

* A warning message will be shown when an empty password is used for
  "user create" and "user set" operations. [Bug 1607959
  (https://bugs.launchpad.net/bugs/1607959)]

* Fix "router unset --route" to correctly removed routes. [Bug
  1631471 (https://bugs.launchpad.net/bugs/1631471)]

* Fix "--no-allocation-pool" option for "subnet set" command to send
  the correct value to the Network API. [Bug 1518059
  (https://bugs.launchpad.net/bugs/1518059)]:

* Cliff 2.3.0: The shell formatter would emit invalid shell variable
  names for field names that contain colons ('":"') and dashes
  ('"-"'), these are now replaced by underscores ('"_"'). [Bug 1616323
  (https://bugs.launchpad.net/bugs/1616323)]

Changes in python-openstackclient 3.3.0..3.4.0
----------------------------------------------

0ef8535 translate all command help strings
6eef327 Updated from global requirements
ad5ae83 3.4.0 release note cleanup
0ac4370 Do proper deprecation for security group rule create
76c7a0a TrivialFix: Insert blank space for readability
4cd336b Updated from global requirements
0b5655f Updated from global requirements
52279b1 network.common.NetworkAndComputeShowOne: catch HttpException
a1ed375 Updated from global requirements
52c4a55 Add 'description' option
55669b9 Add 'all-projects' option to 'volume backup list'
e07b0e0 Add options to "volume backup list" command
0e3e050 Updated from global requirements
3a915b5 Not appropriate name sg rule attribute
86a3c7a SDK refactor: Prepare floating ip commands
970b0e0 Updated from global requirements
84beac5 Add filtering options --name,--enable,--disable to router list
960b265 Support --provider-* options in the network list command
8ca1cc6 Add --long option and more columns to the hypervisor list command
5055074 Adds information about private key generation for instance access
f4f1a51 Updated coverage configuration file
151c161 Avoid duplicated project_id when show network
be9306f Updated from global requirements
09eb816 update openstackclient page url
586ac02 update volume and zone commands
65a08d6 Improve a network testcase
292608d Use FakeImage class to replace duplicated image info in volume test
e0aa1ac Updated from global requirements
e6fb658 Correct help string of the subnet pool list options
57d5f94 Allow input the QoS policy name in network rbac create command
fee1a31 Updated from global requirements
a1e3056 Add option to allow filtering by mac-address on port list
6eff90c Updated from global requirements
3770ad0 Warning for empty password set for user create/set
d373d76 Reset allocation pools to [] instead of ''
acc3967 Rename variable to avoid shadowing of built-in name
daffce3 Add "--read-only" and "--read-write" options in "volume set"
d7c8bb8 Add "volume migrate" command
c99ec28 Add description field port create & port set
bae09c3 Add support make a router HA
8f8a844 Add necessary info to Floating IP list
82af038 properly format error messages for volume resizing
a58bacc Updated from global requirements
928fecd Update the doc for Zaqar v2
3a27163 Updated from global requirements
291b66e Add direction and protocol options to os security group rule list cmd
43d1646 Updated from global requirements
2c1282c Add a new column and a new option the 'os port list' cmd
66a04ab Add security groups options to "port create/set/unset"
694a24c Fix --shared/block-migration options in server migrate command
3205dad Add network support for Network QoS policies
2bbb482 Fix router unset --route option
29f7850 Redefine set/unset command devref
407e164 Refactor image v1 unit tests with FakeImage class
d6cc50f SDK Refactor: Prepare subnet pool commands
368a250 SDK Refactor: Prepare network segment commands
70cb628 SDK Refactor: Prepare address scope commands
c4ab086 fix doc information in the limit.rst
28b6645 Add translation markers for object commands


Diffstat (except docs and test files)
-------------------------------------

.coveragerc                                        |   1 -
openstackclient/common/availability_zone.py        |   2 +-
openstackclient/common/configuration.py            |   2 +-
openstackclient/common/extension.py                |   2 +-
openstackclient/common/limits.py                   |   2 +-
openstackclient/common/module.py                   |   4 +-
openstackclient/common/quota.py                    |   4 +-
openstackclient/compute/v2/agent.py                |   8 +-
openstackclient/compute/v2/aggregate.py            |  16 +-
openstackclient/compute/v2/console.py              |   4 +-
openstackclient/compute/v2/fixedip.py              |   4 +-
openstackclient/compute/v2/flavor.py               |  12 +-
openstackclient/compute/v2/floatingip.py           |   4 +-
openstackclient/compute/v2/host.py                 |   7 +-
openstackclient/compute/v2/hypervisor.py           |  16 +-
openstackclient/compute/v2/hypervisor_stats.py     |   4 +-
openstackclient/compute/v2/keypair.py              |  23 +-
openstackclient/compute/v2/server.py               |  81 ++---
openstackclient/compute/v2/server_backup.py        |   2 +-
openstackclient/compute/v2/server_group.py         |   8 +-
openstackclient/compute/v2/server_image.py         |   2 +-
openstackclient/compute/v2/service.py              |   6 +-
openstackclient/compute/v2/usage.py                |   4 +-
openstackclient/identity/v2_0/catalog.py           |   4 +-
openstackclient/identity/v2_0/ec2creds.py          |   8 +-
openstackclient/identity/v2_0/endpoint.py          |   8 +-
openstackclient/identity/v2_0/project.py           |  12 +-
openstackclient/identity/v2_0/role.py              |  14 +-
openstackclient/identity/v2_0/role_assignment.py   |   2 +-
openstackclient/identity/v2_0/service.py           |   8 +-
openstackclient/identity/v2_0/token.py             |   4 +-
openstackclient/identity/v2_0/user.py              |  18 +-
openstackclient/identity/v3/catalog.py             |   4 +-
openstackclient/identity/v3/consumer.py            |  10 +-
openstackclient/identity/v3/credential.py          |  10 +-
openstackclient/identity/v3/domain.py              |  10 +-
openstackclient/identity/v3/ec2creds.py            |   8 +-
openstackclient/identity/v3/endpoint.py            |  10 +-
openstackclient/identity/v3/federation_protocol.py |  10 +-
openstackclient/identity/v3/group.py               |  16 +-
openstackclient/identity/v3/identity_provider.py   |  10 +-
openstackclient/identity/v3/mapping.py             |  12 +-
openstackclient/identity/v3/policy.py              |  10 +-
openstackclient/identity/v3/project.py             |  10 +-
openstackclient/identity/v3/region.py              |  10 +-
openstackclient/identity/v3/role.py                |  16 +-
openstackclient/identity/v3/role_assignment.py     |   4 +-
openstackclient/identity/v3/service.py             |  10 +-
openstackclient/identity/v3/service_provider.py    |  10 +-
openstackclient/identity/v3/token.py               |  10 +-
openstackclient/identity/v3/trust.py               |   8 +-
openstackclient/identity/v3/unscoped_saml.py       |   4 +-
openstackclient/identity/v3/user.py                |  24 +-
openstackclient/image/v1/image.py                  |  12 +-
openstackclient/image/v2/image.py                  |  20 +-
openstackclient/network/common.py                  |  17 +-
openstackclient/network/sdk_utils.py               |  40 +++
openstackclient/network/v2/address_scope.py        |  38 ++-
openstackclient/network/v2/floating_ip.py          |  36 +-
openstackclient/network/v2/floating_ip_pool.py     |   4 +-
openstackclient/network/v2/ip_availability.py      |   4 +-
openstackclient/network/v2/network.py              |  43 ++-
openstackclient/network/v2/network_agent.py        |   8 +-
openstackclient/network/v2/network_qos_policy.py   | 231 +++++++++++++
openstackclient/network/v2/network_rbac.py         |  19 +-
openstackclient/network/v2/network_segment.py      |  23 +-
openstackclient/network/v2/port.py                 | 190 ++++++++---
openstackclient/network/v2/router.py               |  74 +++-
openstackclient/network/v2/security_group.py       |  10 +-
openstackclient/network/v2/security_group_rule.py  | 136 ++++++--
openstackclient/network/v2/subnet.py               |  14 +-
openstackclient/network/v2/subnet_pool.py          |  66 ++--
openstackclient/object/v1/account.py               |  16 +-
openstackclient/object/v1/container.py             |  48 +--
openstackclient/object/v1/object.py                |  68 ++--
.../network/v2/test_network_qos_policy.py          |  55 +++
.../unit/network/v2/test_network_qos_policy.py     | 380 +++++++++++++++++++++
.../unit/network/v2/test_security_group_rule.py    | 226 +++++++++++-
openstackclient/volume/v1/backup.py                |  63 +++-
openstackclient/volume/v1/qos_specs.py             |  16 +-
openstackclient/volume/v1/service.py               |   4 +-
openstackclient/volume/v1/snapshot.py              |  12 +-
openstackclient/volume/v1/volume.py                | 107 +++++-
.../volume/v1/volume_transfer_request.py           |  10 +-
openstackclient/volume/v1/volume_type.py           |  12 +-
openstackclient/volume/v2/backup.py                |  84 ++++-
openstackclient/volume/v2/consistency_group.py     |   2 +-
openstackclient/volume/v2/qos_specs.py             |  16 +-
openstackclient/volume/v2/service.py               |   4 +-
openstackclient/volume/v2/snapshot.py              |  12 +-
openstackclient/volume/v2/volume.py                |  84 ++++-
.../volume/v2/volume_transfer_request.py           |  10 +-
openstackclient/volume/v2/volume_type.py           |  12 +-
.../add-ha-to-router-update-6a38a73cc112b2fc.yaml  |   7 +
.../add-network-qos-policy-b8ad1e408d73c279.yaml   |   8 +
..._list_all-projects_option-4bb23e0b9b075cac.yaml |   4 +
...bp-cinder-command-support-3db775ba331e113d.yaml |   5 +
...utron-client-descriptions-b65dd776f78b5a73.yaml |   9 +
.../notes/bug-1518059-e2dbe6e4b2473f10.yaml        |   6 +
.../notes/bug-1566090_64726dc7df5b1572.yaml        |   7 +
.../notes/bug-1607959-a52aa93e3793f28a.yaml        |   6 +
.../notes/bug-1612136-051b5f94796e3b51.yaml        |   6 +
.../notes/bug-1613533-93279179c6f70117.yaml        |   6 +
.../notes/bug-1613995-10bb3895d702c063.yaml        |   7 +
.../notes/bug-1631471-beb0a1c9b4a932cb.yaml        |   5 +
.../notes/bug-1634333-a2b04d33ca39440e.yaml        |   6 +
.../notes/bug-1634672-7ce577f3adc34eed.yaml        |   6 +
.../notes/bug-1635580-54e0039b469ad5a6.yaml        |   6 +
.../notes/bug-1637074-1b0e409f30f715ca.yaml        |   5 +
.../notes/bug-1637365-b90cdcc05ffc7d3a.yaml        |   8 +
.../notes/bug-1637945-f361c834381d409c.yaml        |   6 +
.../notes/bug-1639712-a7b9d1a35a042049.yaml        |   6 +
.../notes/cliff-2.3.0-7ead18fae9ceea80.yaml        |   7 +
.../fix-network-rbac-create-d1f4de77ad2dd421.yaml  |   4 +
.../volume-migrate-command-52cf6edd62fe17a7.yaml   |   4 +
requirements.txt                                   |  14 +-
setup.cfg                                          |   8 +
test-requirements.txt                              |   6 +-
154 files changed, 3989 insertions(+), 837 deletions(-)


Requirements updates
--------------------

diff --git a/requirements.txt b/requirements.txt
index ac7323f..c31670b 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -4 +4 @@
-pbr>=1.6 # Apache-2.0
+pbr>=1.8 # Apache-2.0
@@ -8,4 +8,4 @@ Babel>=2.3.4 # BSD
-cliff>=2.2.0 # Apache-2.0
-keystoneauth1>=2.10.0 # Apache-2.0
-openstacksdk>=0.9.7 # Apache-2.0
-osc-lib>=1.0.2 # Apache-2.0
+cliff>=2.3.0 # Apache-2.0
+keystoneauth1>=2.14.0 # Apache-2.0
+openstacksdk>=0.9.10 # Apache-2.0
+osc-lib>=1.2.0 # Apache-2.0
@@ -13 +13 @@ oslo.i18n>=2.1.0 # Apache-2.0
-oslo.utils>=3.16.0 # Apache-2.0
+oslo.utils>=3.18.0 # Apache-2.0
@@ -15 +15 @@ python-glanceclient>=2.5.0 # Apache-2.0
-python-keystoneclient!=2.1.0,>=2.0.0 # Apache-2.0
+python-keystoneclient>=3.6.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index d799f5a..b7a04c4 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6 +6 @@ hacking<0.11,>=0.10.0
-coverage>=3.6 # Apache-2.0
+coverage>=4.0 # Apache-2.0
@@ -11 +11 @@ oslotest>=1.10.0 # Apache-2.0
-reno>=1.8.0 # Apache2
+reno>=1.8.0 # Apache-2.0
@@ -16 +16 @@ stevedore>=1.17.1 # Apache-2.0
-os-client-config!=1.19.0,!=1.19.1,!=1.20.0,!=1.20.1,!=1.21.0,>=1.13.1 # Apache-2.0
+os-client-config>=1.22.0 # Apache-2.0