New Features¶

• Add support for compute API microversion 2.47, which changes how flavordetails are included in server detail responses. In 2.46 and below,only the flavor ID was shown in the server detail response. Starting in2.47, flavor information is embedded in the server response. The newerbehavior is now supported.

Bug Fixes¶

• Filtering servers by tags (serverlist--tag,serverlist--not-tag) now works correctly.[Bug1946816]

• Fixed create image from volume command. If user wants topassvisibility andprotected fields, they need tospecify volume microversion 3.1 or greater by passingos-volume-api-version3.1 with the command.

• Fixed a bug in “access rule” subcommands where the client logic incorrectlyassumed that access rules have a “name” property which resulted inunpredictable behaviors. e.g. “access rule delete {non-existent-id}” nowresults in a not-found error instead of sometimes deleting an unrelatedrule.

New Features¶

• Add--progress option toimagecreate command to enable a progressbar when creating and uploading an image.

• Add--project and--project-domain``optionsto``imagelistcommand to filter by owner.

• It is now possible to list the keypairs for all users in a project usingthe--project parameter. This is an admin-only action by default andrequires Compute API microversion 2.10 or later.

• It is now possible to list the keypairs for a specific user using the--user parameter. This is an admin-only action by default and requiresCompute API microversion 2.10 or later.

• Add--limit and--marker options tohypervisorlist command, toconfigure pagination of results.

• Add--limit and--marker options tokeypairlist command, toconfigure pagination of results.

• Add a number of additional options to theservercreate command:

  • --snapshot

  • --ephemeral

  • --swap

  • --block-device

• Add--force option toserverdelete command, allowing users toforce delete a server. This is admin-only by default.

• Add--limit and--offset options toservergrouplist command,to configure pagination of results.

• Add--limit,--marker,--change-since and--changes-beforeoptions toservergrouplist command, to configure pagination ofresults and filter results by last modification, respectively.

• Add--property option toserverimagecreate command, allowingusers to record arbitrary key/value metadata tometa_data.json onthe metadata server.

• Add a number of additional options to theserverlist command:

  • --availability-zone

  • --key-name

  • --config-drive,--no-config-drive

  • --progress

  • --vm-state

  • --task-state

  • --power-state

• Add a number of additional options to theserverrebuild command:

  • --name

  • --preserve-ephemeral,--no-preserve-ephemeral

  • --user-data,--no-user-data

  • --trusted-image-cert,--no-trusted-image-certs

• Add--no-password option toserverset command, allowing usersto clear the admin password from the metadata service. Note that this doesnot actually change the server password.

• Add support for project cleanup based on the OpenStackSDK withcreate/update time filters. In the long run this will replaceopenstack project purge command.

• Addserverevacuate command. This command will recreate an instancefrom scratch on a new host and is intended to be used when the originalhost fails.

• Addservermigrationshow commands. This can be used to show detailedinformation about an ongoing server migration.

• The--nic option of theservercreate command now supports anoptionaltag=<tag> key-value pair. This can be used to set a tag forthe interface in server metadata, which can be useful to maintainpersistent references to interfaces during various operations.

• Addservervolumelist command, to list the volumes attached to aninstance.

• Addservervolumeupdate command, to update the volumes attached toan instance.

• Add support for--offload and--wait options forservershelve.--offload allows users to explicitly request offloading of a shelvedserver in environments where automatic offloading is not configured, while--wait allows users to wait for the shelve and/or shelve offloadoperations to complete.

• Add support--wait option forservershelve.

• Add--tag option toserveraddfixedip command when adding a fixed IP to server. Only available starting with--os-compute-api-version2.49.

• Add--tag option toserveraddnetwork command when add network to server. Only available starting with--os-compute-api-version2.49.

• Add--tag option toserveraddport command when add a port to server. Only available starting with--os-compute-api-version2.49.

• Add--tag option toserveraddvolume command when add a volume to server. Only available starting with--os-compute-api-version2.49.

• Add--id and--enabled option toidentityproviderlist command.

• Add--name and--domain option todomainlist command.

• By default listing security group rules now shows the direction.The--long argument is now redundant and is now ignored as itwas only used to display the direction.

• Theservermigrate command will now automatically determine whetherto use block or shared migration during a live migration operation. Thisrequires Compute API microversion 2.25 or greater.

• Addservermigrationlist command. This command allowsusers to list the status of ongoing server migrations.

• Add--remote-address-group option tosecuritygrouprulecreatecommand for using an address group as the source/destination in securitygroup rules. Also add fieldremote_address_group_id to the output ofsecuritygroupruleshow and add columnRemoteAddressGroup tothe output ofsecuritygrouprulelist.[Blueprintaddress-groups-in-sg-rules]

• Addaddressgroupcreate,addressgroupdelete,addressgrouplist,addressgroupset,addressgroupshow andaddressgroupunset commands to support Neutron address group CRUD operations. [Blueprintaddress-groups-in-sg-rules]

• Add--password option toservercreate command, allowing users toset the admin password when creating a new instance.

• Addservermigrationabort command to abort ongoing live migrations.

• Addservermigrationforcecomplete command to force complete ongoing live migrations.

• Theopenstackflavorlist command now accepts two additionaloptions,--min-disk and--min-ram, to filter flavor byminimum disk and minimum RAM, respectively.

• Add--key-type option tokeypaircreate command to set keypair type. Can be ssh or x509. Note that--os-compute-api-version2.2 or later is required.

• Add--user option to thekeypaircreate,keypairdelete, andkeypairshow commands. Only available starting with--os-compute-api-version2.10.

• Add device profile toportcreate command.

• Addaddress_group as a valid--type value for thenetworkrbaccreate andnetworkrbaclist commands.

• Add--tag option toservercreate command to add tags when creating a server. Only available starting with--os-compute-api-version2.52.

• Add--tag option toserverset command to add a tag to an existing server. Only available starting with--os-compute-api-version2.26.

• Add--tag options toserverunset command to remove a tag from an existing server. Only available starting with--os-compute-api-version2.26.

• Add--tags and--not-tags options toserverlist command to list instances with and without the specified tag(s), respectively. Only available starting with--os-compute-api-version2.26.

• Add support for--rule option forservergroupcreate.

• Add--cproject_id|user_id|created_at toopenstackserverlist command to get these columns as an output.

• Theserverdelete,serverstart andserverstop commands nowsupport the--all-projects option. This allows you to perform thespecified action on a server in another project using the server name.This is an admin-only action by default.

• Add support foropenstackservershow--topology flag, which willinclude NUMA topology information in the output.

• Switch aggregate operations to use SDK

• Adds ‘aggregate cache image’ operation

• Switch console logs operation to use SDK

• Switch compute.flavor operations from direct API calls (novaclient) to OpenStackSDK.

Upgrade Notes¶

• Theopenstackserverlist--status parameter will now validate therequested status.

• The--key-unset option of theserverrebuild command has beenreplaced by--no-key-name. An alias is provided.

• Theserverset--root-password option has been deprecated in favour ofa non-interactive--password option.

• Theservercreate command will now error out if the--file optionis specified alongside--os-compute-api-version of2.57 or greater.This reflects the removal of this feature from the compute service in thismicroversion.

• The deprecated--live option of theservermigrate command hasbeen removed. This was problematic as it required a host argument andwould result in a forced live migration to a host, bypassing thescheduler. It has been replaced by a--live-migration option andoptional--host option.

• Theservermigrateconfirm andservermigraterevert commands,introduced in OSC 5.0, have been deprecated in favour ofservermigrationconfirm andservermigrationrevert respectively.The deprecated commands will be removed in a future major version.

• A warning will now be emitted when using the--disk-overcommitor--no-disk-overcommit flags of theservermigrate command onCompute API microversion 2.25 or greater. This feature is only supportedbefore this microversion and previously the flag was silently ignored onnewer microversions. This warning will become an error in a futurerelease.

Deprecation Notes¶

• The--block-device-mapping option of theservercreate commandhas been deprecated in favour of--block-device. The format of the--block-device-mapping option is based on the limited “BDM v1”format for block device maps introduced way back in the v1 nova API. The--block-device option instead exposes the richer key-value based“BDM v2” format.

• Deprecate the--long option for thesecuritygrouplistcommand. This is no longer needed to display all columns.

• The--config-drive option on theopenstackservercreate commandhas been deprecated in favour of the--use-config-drive and--no-config-drive arguments. The--config-drive option expectedeither a string or bool-like argument, but the nova API has only supportedboolean values since API v2.1 was introduced.

Bug Fixes¶

• Fix ‘-f json’ output of the flavor properties to return valid json object instead of stringying it.

• Stream image download to avoid buffering data in memory which rapidly exhausts memory resulting in OOM kill or system crash for all but the smallest of images. Fixeshttps://storyboard.openstack.org/#!/story/2007672

• Restore default behavior of ‘openstack image save’ to send data to stdout Relates tohttps://storyboard.openstack.org/#!/story/2007672.

• Theaddresses andflavor fields of theservershow command willnow be correctly rendered as a list of objects and an object, respectively.

• Thenetworks andproperties fields of theserverlist commandwill now be rendered as objects. In addition, thepower_state fieldwill now be humanized and rendered as a string value when using the tableformatter.

• Theusagelist andusageshow commands will now display the nameof the project being queried rather than the ID when using the tableformatter. In addition, theserver_usages,total_memory_mb_usage,total_vcpus_usage andtotal_local_gb_usage values will only behumanized when using the table formatter.

• Thepolicies (orpolicy, on newer microversions) andmembersfields of theservergrouplist andservergroupshow commandswill now be rendered correctly as lists.

• Thecpu_info field of thehypervisorshow output is nowcorrectly decoded and output as an object.

• Fixes default behaviour ofopenstack image create in allowing imageswith the same name. In version 5.2.0 this changed to not allowduplicates by default.

• Associating a floating IP with a server using theserveraddfloatingip command requires the server have at least one port associated with it.Previously, this was not validated, meaning the operation would silentlyfail. This has been resolved.

• Theopenstackservergroupcreate command will now validate the policyvalue requested with--policy, restricting it to the valid valuesallowed by given microversions.

• Add missingopenstacksubnetunset--gateway<subnet-id>.

Other Notes¶

• Remove deprecated neutron-lbaas results fromquotashow command.