Bug Fixes¶

• Fix occurrences of thenetworkagentdelete command failing with newerreleases of python-openstacksdk.[Bug1711301]

• Fix theprojectpurge command to correctly delete only images owned by thespecified project ID when run by an administrative user.[Bug1717130]

• Remove the client-side check for valid--policy values in theservergroupcreate command. Specify--os-compute-api-version2.15or higher for thesoft-affinity orsoft-anti-affinity policy.[Bug1732938]

New Features¶

• Add--default and--no-default options tonetworkqospolicycreate andnetworkqospolicysetcomamnds.[Bug1639220]

• Thevirtio-forwarder VNIC type has been added as another option forsetting the--vnic-type property on theportset andportcreate commands. This requests a low-latency virtio port insidethe instance, likely backed by hardware acceleration. Currently theAgilio OVS external plugin provides support for this, with support fromother vendors following soon.

• Addnetworkagentaddrouter andnetworkagentremoveroutercommands for adding/removing routers to network l3 agents.[Blueprinthttps://blueprints.launchpad.net/python-openstackclient/+spec/network-l3-commands]

• Add--router option tonetworkagentlist to filter by router,and--agent option torouterlist command to filter by agent.[Blueprinthttps://blueprints.launchpad.net/python-openstackclient/+spec/network-l3-commands]

• Added support fortags to the following resources:network,subnet,port,router andsubnetpool.[Blueprinthttps://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.(networkunset command is introduced to support the tag operation)

  • Add--tags,--any-tags,--not-tags and--not-any-tagsoptions to corresponding “list” commands.

• Add commandopenstackprojectpurge to clean a project’s resources.[Bug1584596]

• Added--egress and--ingress options tonetworkqosrulecreate andnetworkqosruleset commands.This adds directionality to Network QoSbandwidth-limit rule type.[Bug1614121]

• Add--human-readable option toimageshow to displayimage size in human readable format (such as K, M, G, T,..)[Bug1640086]

• Add--default-quota option tosubnetpoolcreateandsubnetpoolset commands.[Bug1667294]

• Add--data-plane-status option toportset andportunset commands. [Bug1684989]

• Added the--domain option to theidentityprovidercreate command toassociate an existing domain with an identity provider on its creation.

  [Bug1698390]

• Add--name and--status options toimagelist commandto filter images based on name and status respectively.[Bug1698742]

• Add--user and--type option tocredentiallist commandto filter list result by different user or type.

• Add support for streaming Swift objects to stdout when using theobjectsave command by specifying- as a file name:--filename-.

• Add--no-name-lookup option toserverlist command to skip the lookup offlavor and image names. This can save a significant amount of time on clouds witha large number of images.-n is an alias for this option.

Bug Fixes¶

• Change column nameDisplayName toName involumelist output.Currentvolumelist--name command usesdisplay_name as search_optsto send to cinder API, and show the result table withDisplayNameas column title. Replace allDisplayName byName to be consistentwith other list commands.

  Support a mapping for volume list -cDisplayName (Volume v1 and v2)and volume create/show -cdisplay_name (Volume v1) to maintain backwardcompatibility until the next major release.[Bug1657956]

• Make theroleassignmentlist command callable without administratorpermissions if restricted to the user’s own project with the--project option.[Bug1658189]

• Clarify the--block-device-mapping option of theservercreatecommand: fix ValueError when the--block-device-mapping option’sargument is in the wrong format; support creating a block device froma snapshot; add details to the help output about the option format.[Bug1667266]

• Allow the--security-group option from theservercreate commandto be specified by name or ID. This also checks that the security group existbefore creating the server.[Bug1687814]

• Raise exact exception when extension don’t exist inextensionshowcommand, and keep the column display order consist inextensionlistwith and without--long option.[Bug1689233]

• Fixed an issue where a trust could not be created if multiple roles hadthe same name. A role’s ID is now sent to the identity service instead.[Bug1696111]

• Fix an issue with the--domain option when used with theprojectshow,usershow anduserset commands. The domain filter did not work whenthe login user’s project name or user name is the same as the requested resourcename in the specified domain.[Bug1704097]

• Add--community and--shared options to theimagecreate andimageset 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-vlanfromnetworkset, because updatingvlan-transparentis not supported in Neutron.[Bug1691776]

Bug Fixes¶

• Fix issue inportlist command when no Compute endpoint is in theService Catalog.[Bug1688194]

New Features¶

• Add support for Network Flavor Profile commands:networkflavorprofilecreate,networkflavorprofiledelete,networkflavorprofilelist,networkflavorprofileshow andnetworkflavorprofileset[Blueprinthttps://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-flavors]

• Add--share,--no-share,--project,--project-domain options toqospolicylist command. [Blueprintnetwork-commands-options]

• Addquotalist command with--compute,--volumeand--network options.[Blueprintquota-list]

• Addserveraddport andserverremoveport commands which enable toadd/remove ports to/from a server[Bug1678137]

• Add--no-ha option to theroutercreate command[Bug1675514]

• Add--fixed-ip-address option to theserveraddfloatingip command[Bug1624524]

• Add--fixed-ip-address option to theserveraddfixedip command[Bug1678140]

• Addedextensionshow command to display the details of an extension.Currently works only for network extensions.[Blueprintextension-show]

• Add network dhcp-agent related commandsnetworkagentaddnetwork,networkagentremovenetwork,networkagentlist--network andnetworklist--agent for adding/removing network to dhcp agent.[Blueprinthttps://blueprints.launchpad.net/python-openstackclient/+spec/network-dhcp-adv-commands]

• Add support to add/remove multi users bygroupadd/removeuser command.[Blueprinthttps://blueprints.launchpad.net/python-openstackclient/+spec/support-multi-add-remove]

• Add--private-key option forkeypaircreate command to specify theprivate key file to save when a keypair is created, removing the need tocopy the output and paste it into a new file. This is a convenient wayto save private key in OSC interactive mode.[Bug1549410]

• Add--sort support toprojectlist by sorting items in client sideBy default project list will be sorted by name.[Bug1596818]

• Add--qos-policy option toportcreate,portset andportunset commands.[Bug1612136]

• Add--network and--port options toservercreate commandas alternatives to--nic option.[Bug1612898]

• Theprojectlist command lists all projects when called by anadmin user. For non-admin users it will now list projects for theauthenticated user instead of exiting with an authorization failure.The--my-projects option has also been added to theprojectlistcommand to allow admin users to list their own projects.[Bug1627555]

• Addservereventlist andservereventshow 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.[Bug1642030]

• Addfloatingipset andfloatingipunset commands.[Bug 1560297]

• Addnetworkflavoraddprofile andnetworkflavorremoveprofile commands.[Blueprinthttps://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-flavors]

Deprecation Notes¶

• volumetransferrequestaccept has been changed to move theauth-keypositional argument to a requried option--auth-key. This leavesthe transfer request ID as the only positional arguemnt, as per theOpenStackClient command format. The old format is still functional, but isdeprecated and will be removed in the next major release.

Bug Fixes¶

• Fixvolumetransferrequestaccept to not fail the transfer requestname/ID lookup for non-admin users as the Volume API does not allow non-adminusers access to transfers in other projects.[Bug1633582]

• Change the output column order involumetransferrequestlist to haveID followed byName then the remaining columns.

• Now the positional parameter<snapshot-name> ofvolumesnapshotcreatecommand is no longer optional, it should be always present.[Bug1659894]

• securitygrouplist command now can display project IDs in theProject columnof the command output.[Bug1659967]

• Allow users to create centralized (distributed=False)routers using the--centralized option inroutercreate.Without this, routers are created based on the defaultneutron configuration of the deployment, which, for example,could be ‘distributed’.[Bug1664255]

• Add--mac-address option toportset command.[Bug1670707]

• Narrow acceptable negative response codes forgroupcontainsuser[Bug1672634]

• Fix creating a server with a block-device-mapping when volume_sizeis empty.[Bug1677236]

New Features¶

• Add support for thenetworkautoallocatedtopology command forcreating and deleting auto allocated topologies.[Blueprinthttps://blueprints.launchpad.net/python-openstackclient/+spec/network-auto-allocated-topology]

• Add support to clear/overwrite all flavor properties using--no-property option withflavorset command.[Blueprinthttps://blueprints.launchpad.net/python-openstackclient/+spec/allow-overwrite-set-options]

• Addvolumehostfailover command.[Blueprintcinder-command-support]

• Add--fixed-ip option to theportlist command.[Bug1634799]

• Add--encryption-provider,--encryption-cipher,--encryption-key-sizeand--encryption-control-location options tovolumetypeset andvolumetypecreate commands.Add--encryption-type option tovolumetypeunset,volumetypelistandvolumetypeshow commands.[Bug1651117]

• Add--group option to thecommandlist command to filter thecommands by group name:openstackcommandlist--groupvolume willlist 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 comamndsavailable for specific APIs. Note that the--group argument is used asa simple substring search in the Command Group column.[Bug1666780]

• Added support for Volume API v3 for the following block storage commandresources:consistencygroup,consistencygroupsnapshot,volume,volumebackup,volumehost,volumesnapshot,volumetype,volumeqos,volumeservice,volumetransferrequest. Note that microversion support for Volume APIv3 is not yet implemented, each command will assume the API version is3.0.

• Addnetworkflavorcreate,networkflavordelete,networkflavorlist, Addnetworkflavorshow andnetworkflavorset command[Blueprinthttps://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client-flavors]

• Add--no-property option involumeset, this removes all properties from a volume.[Blueprintallow-overwrite-set-options]

Bug Fixes¶

• Fix--parents and--children options inprojectshow command.[Bug1499657]

• Fixed theportset andportunset command failures(AttributeError) when--security-group option is included.[Bug1656788]

• Fix wrong behavior of parsing plugin service name when the service name endwith keywordos, like: antiddos. That cause the service api versionspecified by users don’t work.[Bug1658614]

• Fixmodulelist--all command failed, and enhance the related unittests and funcational tests.[Bug1661814]

• Fixservercreate command failed when--nic auto or none.auto andnone options was added into –nic argument of servercreate command, but that don’t work and raise internal error when executecommand. The patch fix that issue.[Bug1663520]

• Allow--default and--no-default options innetworkcreate command tobe recognized when--external is not present.[Bug1665231]

• Fix theEthertype column output ofsecuritygrouprulelist command.[Bug1667699]