Pike Series Release Notes¶
3.12.1¶
Bug Fixes¶
Fix occurrences of the
network agent deletecommand failing with newer releases of python-openstacksdk. [Bug 1711301]
Fix the
project purgecommand 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
--policyvalues in theserver group createcommand. Specify--os-compute-api-version 2.15or higher for thesoft-affinityorsoft-anti-affinitypolicy. [Bug 1732938]
3.12.0¶
New Features¶
Add
--defaultand--no-defaultoptions tonetwork qos policy createandnetwork qos policy setcomamnds. [Bug 1639220]
The
virtio-forwarderVNIC type has been added as another option for setting the--vnic-typeproperty on theport setandport createcommands. 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 routerandnetwork agent remove routercommands for adding/removing routers to network l3 agents. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/network-l3-commands]
Add
--routeroption tonetwork agent listto filter by router, and--agentoption torouter listcommand to filter by agent. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/network-l3-commands]
Added support for
tagsto the following resources:network,subnet,port,routerandsubnet pool. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-tag]Add
--tagand--no-tagoptions to corresponding “create” commands.Add
--tagand--no-tagoptions to corresponding “set” commands.Add
--tagand--all-tagoptions to corresponding “unset” commands. (network unsetcommand is introduced to support the tag operation)Add
--tags,--any-tags,--not-tagsand--not-any-tagsoptions to corresponding “list” commands.
Add command
openstack project purgeto clean a project’s resources. [Bug 1584596]
Added
--egressand--ingressoptions tonetwork qos rule createandnetwork qos rule setcommands. This adds directionality to Network QoSbandwidth-limitrule type. [Bug 1614121]
Add
--human-readableoption toimage showto display image size in human readable format (such as K, M, G, T,..) [Bug 1640086]
Add
--default-quotaoption tosubnet pool createandsubnet pool setcommands. [Bug 1667294]
Add
--data-plane-statusoption toport setandport unsetcommands. [Bug 1684989]
Added the
--domainoption to theidentity provider createcommand to associate an existing domain with an identity provider on its creation.[Bug 1698390]
Add
--nameand--statusoptions toimage listcommand to filter images based on name and status respectively. [Bug 1698742]
Add
--userand--typeoption tocredential listcommand to filter list result by different user or type.
Add support for streaming Swift objects to stdout when using the
object savecommand by specifying-as a file name:--filename -.
Add
--no-name-lookupoption toserver listcommand 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.-nis an alias for this option.
Bug Fixes¶
Change column name
Display NametoNameinvolume listoutput. Currentvolume list --namecommand usesdisplay_nameas search_opts to send to cinder API, and show the result table withDisplay Nameas column title. Replace allDisplay NamebyNameto 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 listcommand callable without administrator permissions if restricted to the user’s own project with the--projectoption. [Bug 1658189]
Clarify the
--block-device-mappingoption of theserver createcommand: fix ValueError when the--block-device-mappingoption’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-groupoption from theserver createcommand 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 showcommand, and keep the column display order consist inextension listwith and without--longoption. [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
--domainoption when used with theproject show,user showanduser setcommands. 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
--communityand--sharedoptions to theimage createandimage setcommands 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-vlanand--no-transparent-vlanfromnetwork set, because updatingvlan-transparentis not supported in Neutron. [Bug 1691776]
3.11.0¶
Bug Fixes¶
Fix issue in
port listcommand 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 showandnetwork flavor profile set[Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-flavors]
Add
--share,--no-share,--project,--project-domainoptions toqos policy listcommand. [Blueprint network-commands-options]
Add
quota listcommand with--compute,--volumeand--networkoptions. [Blueprint quota-list]
Add
server add portandserver remove portcommands which enable to add/remove ports to/from a server [Bug 1678137]
Add
--no-haoption to therouter createcommand [Bug 1675514]
Add
--fixed-ip-addressoption to theserver add floating ipcommand [Bug 1624524]
Add
--fixed-ip-addressoption to theserver add fixed ipcommand [Bug 1678140]
Added
extension showcommand 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 --networkandnetwork list --agentfor 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 usercommand. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/support-multi-add-remove]
Add
--private-keyoption forkeypair createcommand 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
--sortsupport toproject listby sorting items in client side By default project list will be sorted by name. [Bug 1596818]
Add
--qos-policyoption toport create,port setandport unsetcommands. [Bug 1612136]
Add
--networkand--portoptions toserver createcommand as alternatives to--nicoption. [Bug 1612898]
The
project listcommand 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-projectsoption has also been added to theproject listcommand to allow admin users to list their own projects. [Bug 1627555]
Add
server event listandserver event showcommands.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 setandfloating ip unsetcommands. [Bug 1560297]
Add
network flavor add profileandnetwork flavor remove profilecommands. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-flavors]
Deprecation Notes¶
volume transfer request accepthas been changed to move theauth-keypositional 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 acceptto 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 listto haveIDfollowed byNamethen the remaining columns.
Now the positional parameter
<snapshot-name>ofvolume snapshot createcommand is no longer optional, it should be always present. [Bug 1659894]
security group listcommand now can display project IDs in theProjectcolumn of the command output. [Bug 1659967]
Allow users to create centralized (distributed=False) routers using the
--centralizedoption 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-addressoption toport setcommand. [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 topologycommand 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-propertyoption withflavor setcommand. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/allow-overwrite-set-options]
Add
volume host failovercommand. [Blueprint cinder-command-support]
Add
--fixed-ipoption to theport listcommand. [Bug 1634799]
Add
--encryption-provider,--encryption-cipher,--encryption-key-sizeand--encryption-control-locationoptions tovolume type setandvolume type createcommands. Add--encryption-typeoption tovolume type unset,volume type listandvolume type showcommands. [Bug 1651117]
Add
--groupoption to thecommand listcommand to filter the commands by group name:openstack command list --group volumewill list all Volume commands for the selected API version. Use--os-XXXX-api-versionto 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
--groupargument 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 showandnetwork flavor setcommand [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-flavors]
Add
--no-propertyoption involume set, this removes all properties from a volume. [Blueprint allow-overwrite-set-options]
Bug Fixes¶
Fix
--parentsand--childrenoptions inproject showcommand. [Bug 1499657]
Fixed the
port setandport unsetcommand failures (AttributeError) when--security-groupoption 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 --allcommand failed, and enhance the related unit tests and funcational tests. [Bug 1661814]
Fix
server createcommand failed when--nicauto or none.autoandnoneoptions 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
--defaultand--no-defaultoptions innetwork createcommand to be recognized when--externalis not present. [Bug 1665231]
Fix the
Ethertypecolumn output ofsecurity group rule listcommand. [Bug 1667699]