Pike Series Release Notes¶
3.12.1¶
Bug Fixes¶
Fix occurrences of the
network agent delete
command failing with newer releases of python-openstacksdk. [Bug 1711301]
Fix the
project purge
command to correctly delete only images owned by the specified project ID when run by an administrative user. [Bug 1717130]
Remove the client-side check for valid
--policy
values in theserver group create
command. Specify--os-compute-api-version 2.15
or higher for thesoft-affinity
orsoft-anti-affinity
policy. [Bug 1732938]
3.12.0¶
New Features¶
Add
--default
and--no-default
options tonetwork qos policy create
andnetwork qos policy set
comamnds. [Bug 1639220]
The
virtio-forwarder
VNIC type has been added as another option for setting the--vnic-type
property on theport set
andport create
commands. This requests a low-latency virtio port inside the instance, likely backed by hardware acceleration. Currently the Agilio OVS external plugin provides support for this, with support from other vendors following soon.
Add
network agent add router
andnetwork agent remove router
commands for adding/removing routers to network l3 agents. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/network-l3-commands]
Add
--router
option tonetwork agent list
to filter by router, and--agent
option torouter list
command to filter by agent. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/network-l3-commands]
Added support for
tags
to the following resources:network
,subnet
,port
,router
andsubnet pool
. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-tag]Add
--tag
and--no-tag
options to corresponding “create” commands.Add
--tag
and--no-tag
options to corresponding “set” commands.Add
--tag
and--all-tag
options to corresponding “unset” commands. (network unset
command is introduced to support the tag operation)Add
--tags
,--any-tags
,--not-tags
and--not-any-tags
options to corresponding “list” commands.
Add command
openstack project purge
to clean a project’s resources. [Bug 1584596]
Added
--egress
and--ingress
options tonetwork qos rule create
andnetwork qos rule set
commands. This adds directionality to Network QoSbandwidth-limit
rule type. [Bug 1614121]
Add
--human-readable
option toimage show
to display image size in human readable format (such as K, M, G, T,..) [Bug 1640086]
Add
--default-quota
option tosubnet pool create
andsubnet pool set
commands. [Bug 1667294]
Add
--data-plane-status
option toport set
andport unset
commands. [Bug 1684989]
Added the
--domain
option to theidentity provider create
command to associate an existing domain with an identity provider on its creation.[Bug 1698390]
Add
--name
and--status
options toimage list
command to filter images based on name and status respectively. [Bug 1698742]
Add
--user
and--type
option tocredential list
command to filter list result by different user or type.
Add support for streaming Swift objects to stdout when using the
object save
command by specifying-
as a file name:--filename -
.
Add
--no-name-lookup
option toserver list
command to skip the lookup of flavor and image names. This can save a significant amount of time on clouds with a large number of images.-n
is an alias for this option.
Bug Fixes¶
Change column name
Display Name
toName
involume list
output. Currentvolume list --name
command usesdisplay_name
as search_opts to send to cinder API, and show the result table withDisplay Name
as column title. Replace allDisplay Name
byName
to be consistent with other list commands.Support a mapping for volume list -c
Display Name
(Volume v1 and v2) and volume create/show -cdisplay_name
(Volume v1) to maintain backward compatibility until the next major release. [Bug 1657956]
Make the
role assignment list
command callable without administrator permissions if restricted to the user’s own project with the--project
option. [Bug 1658189]
Clarify the
--block-device-mapping
option of theserver create
command: fix ValueError when the--block-device-mapping
option’s argument is in the wrong format; support creating a block device from a snapshot; add details to the help output about the option format. [Bug 1667266]
Allow the
--security-group
option from theserver create
command to be specified by name or ID. This also checks that the security group exist before creating the server. [Bug 1687814]
Raise exact exception when extension don’t exist in
extension show
command, and keep the column display order consist inextension list
with and without--long
option. [Bug 1689233]
Fixed an issue where a trust could not be created if multiple roles had the same name. A role’s ID is now sent to the identity service instead. [Bug 1696111]
Fix an issue with the
--domain
option when used with theproject show
,user show
anduser set
commands. The domain filter did not work when the login user’s project name or user name is the same as the requested resource name in the specified domain. [Bug 1704097]
Add
--community
and--shared
options to theimage create
andimage set
commands to allow image owners to share images across multiple projects without explicitly creating image members. “Community images” will not appear in user’s default image listings.
Remove
--transparent-vlan
and--no-transparent-vlan
fromnetwork set
, because updatingvlan-transparent
is not supported in Neutron. [Bug 1691776]
3.11.0¶
Bug Fixes¶
Fix issue in
port list
command when no Compute endpoint is in the Service Catalog. [Bug 1688194]
3.10.0¶
New Features¶
Add support for Network Flavor Profile commands:
network flavor profile create
,network flavor profile delete
,network flavor profile list
,network flavor profile show
andnetwork flavor profile set
[Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-flavors]
Add
--share
,--no-share
,--project
,--project-domain
options toqos policy list
command. [Blueprint network-commands-options]
Add
quota list
command with--compute
,--volume
and--network
options. [Blueprint quota-list]
Add
server add port
andserver remove port
commands which enable to add/remove ports to/from a server [Bug 1678137]
Add
--no-ha
option to therouter create
command [Bug 1675514]
Add
--fixed-ip-address
option to theserver add floating ip
command [Bug 1624524]
Add
--fixed-ip-address
option to theserver add fixed ip
command [Bug 1678140]
Added
extension show
command to display the details of an extension. Currently works only for network extensions. [Blueprint extension-show]
Add network dhcp-agent related commands
network agent add network
,network agent remove network
,network agent list --network
andnetwork list --agent
for adding/removing network to dhcp agent. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/network-dhcp-adv-commands]
Add support to add/remove multi users by
group add/remove user
command. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/support-multi-add-remove]
Add
--private-key
option forkeypair create
command to specify the private key file to save when a keypair is created, removing the need to copy the output and paste it into a new file. This is a convenient way to save private key in OSC interactive mode. [Bug 1549410]
Add
--sort
support toproject list
by sorting items in client side By default project list will be sorted by name. [Bug 1596818]
Add
--qos-policy
option toport create
,port set
andport unset
commands. [Bug 1612136]
Add
--network
and--port
options toserver create
command as alternatives to--nic
option. [Bug 1612898]
The
project list
command lists all projects when called by an admin user. For non-admin users it will now list projects for the authenticated user instead of exiting with an authorization failure. The--my-projects
option has also been added to theproject list
command to allow admin users to list their own projects. [Bug 1627555]
Add
server event list
andserver event show
commands.A server event is the event record of actions performed on a server, including: event type(create, delete, reboot and so on), event result(success, error), start time, finish time and others. [Bug 1642030]
Add
floating ip set
andfloating ip unset
commands. [Bug 1560297]
Add
network flavor add profile
andnetwork flavor remove profile
commands. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-flavors]
Deprecation Notes¶
volume transfer request accept
has been changed to move theauth-key
positional argument to a requried option--auth-key
. This leaves the transfer request ID as the only positional arguemnt, as per the OpenStackClient command format. The old format is still functional, but is deprecated and will be removed in the next major release.
Bug Fixes¶
Fix
volume transfer request accept
to not fail the transfer request name/ID lookup for non-admin users as the Volume API does not allow non-admin users access to transfers in other projects. [Bug 1633582]
Change the output column order in
volume transfer request list
to haveID
followed byName
then the remaining columns.
Now the positional parameter
<snapshot-name>
ofvolume snapshot create
command is no longer optional, it should be always present. [Bug 1659894]
security group list
command now can display project IDs in theProject
column of the command output. [Bug 1659967]
Allow users to create centralized (distributed=False) routers using the
--centralized
option inrouter create
. Without this, routers are created based on the default neutron configuration of the deployment, which, for example, could be ‘distributed’. [Bug 1664255]
Add
--mac-address
option toport set
command. [Bug 1670707]
Narrow acceptable negative response codes for
group contains user
[Bug 1672634]
Fix creating a server with a block-device-mapping when volume_size is empty. [Bug 1677236]
3.9.0¶
New Features¶
Add support for the
network auto allocated topology
command for creating and deleting auto allocated topologies. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/network-auto-allocated-topology]
Add support to clear/overwrite all flavor properties using
--no-property
option withflavor set
command. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/allow-overwrite-set-options]
Add
volume host failover
command. [Blueprint cinder-command-support]
Add
--fixed-ip
option to theport list
command. [Bug 1634799]
Add
--encryption-provider
,--encryption-cipher
,--encryption-key-size
and--encryption-control-location
options tovolume type set
andvolume type create
commands. Add--encryption-type
option tovolume type unset
,volume type list
andvolume type show
commands. [Bug 1651117]
Add
--group
option to thecommand list
command to filter the commands by group name:openstack command list --group volume
will list all Volume commands for the selected API version. Use--os-XXXX-api-version
to select a specific API version for the desired APIs.This provides an alternative to searching help output to list the comamnds available for specific APIs. Note that the
--group
argument is used as a simple substring search in the Command Group column. [Bug 1666780]
Added support for Volume API v3 for the following block storage command resources:
consistency group
,consistency group snapshot
,volume
,volume backup
,volume host
,volume snapshot
,volume type
,volume qos
,volume service
,volume transfer request
. Note that microversion support for Volume API v3 is not yet implemented, each command will assume the API version is3.0
.
Add
network flavor create
,network flavor delete
,network flavor list
, Addnetwork flavor show
andnetwork flavor set
command [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-flavors]
Add
--no-property
option involume set
, this removes all properties from a volume. [Blueprint allow-overwrite-set-options]
Bug Fixes¶
Fix
--parents
and--children
options inproject show
command. [Bug 1499657]
Fixed the
port set
andport unset
command failures (AttributeError) when--security-group
option is included. [Bug 1656788]
Fix wrong behavior of parsing plugin service name when the service name end with keyword
os
, like: antiddos. That cause the service api version specified by users don’t work. [Bug 1658614]
Fix
module list --all
command failed, and enhance the related unit tests and funcational tests. [Bug 1661814]
Fix
server create
command failed when--nic
auto or none.auto
andnone
options was added into –nic argument of server create command, but that don’t work and raise internal error when execute command. The patch fix that issue. [Bug 1663520]
Allow
--default
and--no-default
options innetwork create
command to be recognized when--external
is not present. [Bug 1665231]
Fix the
Ethertype
column output ofsecurity group rule list
command. [Bug 1667699]