Current Release Notes

8.0.0-18

New Features

• Add support for the new spice-direct console type, as well as the exposing the ability for admins to lookup console connection information via the new console connection show command.

Upgrade Notes

• The openstack server set command has been extended with a new parameter --auto-approve and the existing --state parameter has been modified to require confirmation before resetting the state.

• Support for Python 3.9 has been dropped.

8.0.0

New Features

• Added four new network agent types to the list method filter: ovn-controller, ovn-controller-gateway, ovn-metadata and ovn-agent.

• The router creation command now has the parameter --qos-policy, that allows to set a QoS policy for the provided external gateways (one or many). It is mandatory to define an external gateway if the QoS policy is set.

Upgrade Notes

• The following commands have been migrated to SDK:

  • endpoint create

  • endpoint delete

  • endpoint list

  • endpoint show

  • endpoint set

• Support for the Block Storage (Cinder) v1 API has been officially removed as it had been broken for some time. If you haven’t noticed then you likely don’t need to do anything. However, in the unlikely event that your cloud is using the Block Storage v1 API - or incorrectly advertises the Block Storage v1 API - consider overriding the API version to use v2 as this behaves very similarly. It may also be necessary to set an endpoint override for the Block Storage API if your clouds service catalog is not configured correctly. For example:

  example:
    regions:
      - name: regionOne
        values:
          block_storage_endpoint_override: 'https://blockstorage.api.cloud.example/'
    volume_api_version: 2
  

  If using a public cloud provider, there may also be a profile already published that sets these. These are listed in the Vendor Support doc. For example:

  example:
    profile: rackspace
  

  Alternatively, consider use versions of OSC < 3.19 and python-cinderclient < 5.0 (both Stein), since these were the last versions to fully support Cinder v1.

7.4.0

New Features

• Add --enable-uplink-status-propagation option and --disable-uplink-status-propagation option to port update command.

7.3.0

New Features

• Add trusted attribute to the port create and port set commands. It can be set to true with --trusted and to false with --not-trusted CLI arguments passed to the port create and port set commands``

• Add qinq-vlan and no-qinq-vlan arguments to the network create command. It will enable/disable QinQ feature for the created network. This new argument is mutually exclusive with the transparent-vlan - only one of them can be set to True for the network.

• The server create command now supports a --no-security-group option. When provided, no security groups will be associated with ports created and attached to the server during server creation. This does not affect pre-created ports.

• Listing volume backups now shows the created_at column when volume v3 API is used.

Upgrade Notes

• The following commands have been migrated to SDK:

  • credential create

  • credential delete

  • credential list

  • credential set

  • credential show

• The following commands have been migrated to SDK:

  • region create

  • region list

  • region delete

  • region set

  • region show

• The following commands have been migrated to SDK:

  • service provider create

  • service provider delete

  • service provider set

  • service provider list

  • service provider show

• The following commands have been migrated to SDK:

  • trust create

  • trust list

  • trust delete

  • trust show

Bug Fixes

• Fixed the output of volume backup restore command.

• Fixed the openstack volume backup show command to show a backup by name.

7.2.1

Bug Fixes

• The quota set and limits show commands will now check for the block-storage and block-store service types along with volume, volumev2 and volumev3.

  [Bug 2084580]

7.2.0

New Features

• Add --status option to port list command. [Bug 1672680]

• The server add security group and server remove security group commands now accept multiple security groups.

Upgrade Notes

• Support for Python 3.8 has been dropped.

• The following commands have been migrated to SDK:

  • access rule list

  • access rule delete

  • access rule show

7.1.0

New Features

• The aggregate list command will now include the UUIDs of the aggregates when the cloud supports it.

7.0.0

New Features

• Added the Cluster and Backend State columns to openstack volume service list command. Note that the Cluster parameter is available since microversion 3.7 and Backend State parameter is available since microversion 3.49.

• Add image metadef object property show command which shows a particular property inside metadef object.

• Added image metadef resource type association list to list resource type associations for the image service. This is equivalent to the md-namespace-resource-type-list command in glance.

• Added image metadef resource type association create to create a resource type association for the image service. This is equivalent to the md-resource-type-associate command in glance.

• Added image metadef resource type association delete to delete a resource type association for the image service. This is equivalent to the md-resource-type-deassociate command in glance.

• Add a new NUMA affinity policy option: “socket”. That applies to any new port (using port create) or any existing port (using port set).

• Added support for unmanaging snapshots with the openstack snapshot delete --remote command.

• Add support for managing volumes with openstack volume create --remote-source <key=val> --host <host> command.

• Add support for unmanaging volumes with openstack volume delete --remote <volume> command.

• The following commands have been migrated to SDK:

  • application credential create

  • application credential delete

  • application credential list

  • application credential show

• Migrate role assignment commands from keystoneclient to SDK.

• The server set and server unset commands have been migrated to SDK.

• The following commands have been migrated to SDK:

  • service create

  • service delete

  • service set

  • service list

  • service show

• Migrated volume attachment commands to SDK.

• The quota set command now supports a --default option. When provided, this will allow you to set quotas for the default quota class which is the only quota class supported by the Compute and Block Storage services. This replaces the deprecated quota set --class option.

Upgrade Notes

• The compute agent * commands have been migrated to SDK.

• The host set command has been migrated to SDK.

• The limits show command has been migrated to SDK.

• The server evacuate command has been migrated to SDK.

• The openstack quota set command previously defaulted to --force behavior for network quotas. This behavior has now changed and the command now defaults to --no-force behavior. Users should specify the --force option if they wish to retain previous behavior.

• The --class options of the quota show command, which was deprecated in 6.1.0 (Antelope), has now been removed in favour of the --default option. Quota classes were never fully implemented and the compute and volume services only support a single default quota class while the network service does not support quota classes at all.

• The volume set --retype-policy parameter has been renamed to --migration-policy to better convey the correct meaning of the options usage. The migration policy determines whether we are going to perform the migration in the retype opearation or not and is not related to the actual retype which just changes the volume type of the volume.

Bug Fixes

• The router create --flavor-id parameter has been deprecated in favour of the --flavor parameter, which accepts both flavor names and flavor IDs.

• Fixed issue with creating incremental volume backup. Previously, incremental value was not passed in the API request which is now included in the backup create request.

6.6.0

New Features

• Add image metadef object update command which updates the attributes of an object.

6.5.0

New Features

• Add image member get command which accepts an image_id and member_id and displays the detail of the particular meber associated to the image.

• Add the port hardware offload attribute to the port create command. Once defined, the value cannot be modified.

• The server create command now accepts a new option, --server-group, which is a shortcut for configuring the group scheduler hint.

6.4.0

New Features

• Add default security group rule create, default security group rule delete, default security group rule list and default security group rule show commands to support Neutron Default Security Group Rule CRUD operations. [Bug 1983053]

• Add commands for the image Cache API, to list, queue, delete and clear images in the cache.

• Add image metadef object show command to create the metadata definitions objects inside a specific namespace

• Add image metadef object list command to list the metadata definitions objects inside a specific namespace

• Add image metadef object show command to show the metadata definitions objects inside a specific namespace

• Add image metadef property create command to create a new metadef property inside a specific namespace.

• Add image metadef property delete command to delete a metadef property inside a specific namespace.

• Add image metadef property list command to list the metadata definitions properties inside a specific namespace.

• Add image metadef property set command to update a metadef property inside a specific namespace.

• Add image metadef property show command to show details about a metadef property inside a specific namespace.

• Migrated following volume backends commands to SDK.

  • Capability Show

  • Pool List

• The volume type create, volume type set, volume type list commands now accept four new options - --multiattach, --cacheable, --replicated, and --availability-zone - which are short cuts for setting or filtering on the relevant properties on the volume type.

• The volume type list command now accepts a --property <key>=<value> option, allowing users to filter volume types by their extra spec properties.

Upgrade Notes

• The --detailed option of the block storage volume manageable list and block storage snapshot manageable list commands has been deprecated in favour of a --long option. These commands will no longer default to detailed output by default.

Bug Fixes

• Migrated block storage resource filters list and block storage resource filters show commands to SDK.

6.3.0

New Features

• An --auto-approve option has been added to the project cleanup command. This allows the interactive confirmation of resource deletion to be skipped.

• Add the --flavor-id option to the router create command.

• Added image metadef resource type list command. This is equivalent to the +md-namespace-resource-type-list command in glanceclient.

• Add image import info command, allowing users to know available import methods, and –store option to image delete, allowing users to delete image from particular store.

• Enable management of Neutron port hints: port create --hint HINT, set port --hint HINT and ``unset port --hint. Port hints allow passing backend specific hints to Neutron mainly to tune backend performance. The first hint controls Open vSwitch Tx steering.

• Add image stores info command, allowing users to know available backends.

• Add --no-property option in volume qos set.

• The volume type set command now supports --public and --private options.

• The openstack keypair create command will now generate keypairs on the client side in ssh-ed25519 format. The Compute service no longer supports server-side key generation starting with --os-compute-api-version 2.92 while the use of ssh-ed25519 is necessary as support for ssh-rsa has been disabled by default starting in OpenSSH 8.8, which prevents its use in guests using this version of OpenSSH in the default configuration. ssh-ed25519 support is widespread and is supported by OpenSSH 6.5 or later and Dropbear 2020.79 or later.

• Migrated the following backup commands to SDK:

  • Create Backup

  • Show Backup

  • List Backup

  • Restore Backup

  • Delete Backup

• The server event list and server event show commands have been migrated to SDK.

• Migrate server reboot command from novaclient to SDK.

• The server restore command has been migrated to SDK.

• The server shelve and server unshelve commands have been migrated to SDK.

• Migrate server start and server stop commands from novaclient to sdk.

• The volume revert command has been migrated to SDK.

• The volume summary command has been migrated to SDK.

• A new option --skip-resource has been added to the project cleanup command. This allows to exclude certain resources from project cleanups, e. g. --skip-resource "block_storage.backup" to keep Cinder backups.

• openstack server rebuild command now fails early if the server is not in a state supported for rebuild - either ACTIVE, ERROR or SHUTOFF. See OpenStack Compute API reference for server rebuild action.

• The server lock and server unlock commands now use SDK.

Upgrade Notes

• The project purge command has been removed. This has been superseded by the project cleanup command, was not tested, and has not been functional for some time hence its removal without a deprecation period. The replacement is project cleanup, which is more powerful and more flexible.

Bug Fixes

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

• openstack server rebuild --wait now properly works for servers in SHUTOFF state without hanging. [Story 2010751]

6.2.0

New Features

• Add port ranges support to the floating ip port forwarding commands.

• The host list and host show commands have been migrated to SDK.

• Switch the server volume list and server volume update command from novaclient to SDK.

• Finish switching server migration to the OpenStackSDK

Upgrade Notes

• The --consistency-group-source and --consistency-group-snapshot options for the consistency group create command have been renamed to --source and --snapshot, respectively. Aliases are provided for the older variants.

• The server volume update command has been renamed to server volume set to better match other commands in OSC. An alias is provided for backwards compatibility.

Deprecation Notes

• The <volume-group-type> and <volume-type> [<volume-type>...] positional arguments for the volume group create command have been deprecated in favour of option arguments. For example:

  openstack volume group create \
    --volume-group-type <volume-group-type>
    --volume-type <volume-type> [--volume-type <volume-type> ...]
  

6.1.0

New Features

• Added --backup option to the volume create command.

• Add baremetal agent type to --agent-type option for network agent list command.

• Added block storage volume manageable list and block storage snapshot manageable list commands that allow operators to list the volumes and snapshots on a particular host or cluster for management under OpenStack.

• Added --source-group and --group-snapshot options to the volume group create command to allow creating group from a source group or a group snapshot.

• Adds openstack image metadef namespace list. The output is equivalent to glance md-namespace-list.

• Add image task show command to show a task for the image service.

• Add image task list command to list tasks for the image service.

• Add missing --trustee, --trustee-domain, --trustor, --trustor-domain options to trust list command, to allow filtering trusts by trustee and trustor.

• Add --authuser option to trust list command, to allow displaying only trusts related to current authenticated user

• Add a new argument --target-project to the network rbac list command to filter for a specific target project.

• The server rebuild commands now accept two optional --reimage-boot-volume and --no-reimage-boot-volume``option. Passing these parameter will allow/disallow a user to rebuild a volume backed server. This is available from Compute microversion ``2.93 and onwards.

• Added block storage log level list and block storage log level set commands that allows operators to list and set log levels for cinder services.

• Added volume revert command that reverts the volume to the given snapshot.

• Added volume summary command to show the total size, total count and metadata of volumes.

• Added block storage cleanup command that allows cleanup of resources (volumes and snapshots) by services in other nodes in a cluster in an Active-Active deployments.

• Support of two commands was added in volume v3: “volume backend capability show” and “volume backend pool list”. These commands are present in v2 volume, but still absent in v3.

• The server create command now accepts two new options, --no-network and --auto-network. These are aliases for --nic none and --nic auto, respectively.

• Add --host and --no-availability-zone options to the server unshelve command to enable administrators to specify a destination host or unset the availability zone during a server unshelve, respectively. Both options require the server to be shelved offload and --os-compute-api-version 2.91 or greater.

• The quota list command can now provide detailed quotas for the volume service, e.g.:

  $ openstack quota list --detail --volume
  

• identity provider create and identity provider set commands now accept the --authorization-ttl <VALUE> argument, with <VALUE> being a non-negative integer.

  See note in Keystone documentations for more details on the meaning of this option.

• Add image import command, allowing users to take advantage of the interoperable image import functionality first introduced in Glance 16.0.0 (Queens).

• Add openstack image metadef namespace create command to create metadef namespace for the image service.

• Add openstack image metadef namespace delete command to delete image metadef namespace.

• Add openstack image metadef namespace set command to update metadef namespace for the image service.

• Add openstack image metadef namespace show command to show metadef namespace for the image service.

• Added a new command, image stage, that will allow users to upload data for an image to staging.

• Add new commands router ndp proxy create, router ndp proxy set, router ndp proxy show, router ndp proxy list and router ndp proxy delete to support Neutron NDP proxy CRUD operations.

• Add new options --enable-ndp-proxy and --disable-ndp-proxy to command router create and router set to support Neutron NDP proxy feature.

• Added two new filter flags to openstack network qos rule type list: --all-supported, to return any QoS rule type supported by at least one loaded driver; --all-rules, to return all QoS rule types supported by the current version of Neutron server, regardless of the loaded drivers.

• Add --no-force option to the openstack quota set command (only for compute and network commands). When specified, the compute and network quota engine will check the resource usage before setting the new quota limit. This is the default behavior of the compute quota engine and will become the default for the network quota engine in a future release.

• The server list command now uses the OpenStack SDK instead of the Python nova bindings.

• The <name> argument for the volume create command is now optional.

• Added a new command, quota delete, that will allow admins delete quotas set for projects. Supported by the compute, volume, and network services.

• The quota show command now allows you to show quotas for a specific service using the --compute, --volume, or --network options.

• The quota show command now supports a --usage option. When provided, this will result in the command returning usage information for each quota. This replaces the quota list --detail command which is now deprecated for removal.

• The server list needs to query the image service API to retrieve image names as part of the response. This command will now retrieve only the images that are relevant, i.e. those used by the server included in the output. This should result in signficantly faster responses when using a deployment with a large number of public images.

• Switch hypervisor to the OpenStackSDK

• Switch hypervisor operations to consume OpenStackSDK

• The server migration * commands now use the OpenStackSDK instead of novaclient.

• The server show command now uses the OpenStack SDK instead of the Python nova bindings. The command prints data fields both by their novaclient names used in previous releases as well as the names used in the SDK.

Deprecation Notes

• The --class options of the quota show and quota set commands are now deprecated. Quota classes were never fully implemented and the compute and volume services only support a single default quota class while the network service does not support quota classes at all. The default quotas can be changed on a deployment-wide basis via configuration and can be inspected using the openstack quota show --default command. Quotas can still be set on a project-specific basis using the quota set command.

• The openstack quota set command currently defaults to --force behavior for network quotas. This behavior is now deprecated and a future release will switch to --no-force behavior. Users should explicitly specify one of these options to prevent a potentially breaking change in behavior.

• The --detail option for the quota list command has been deprecated for removal. When used without the --detail option, the quota list command returned quota information for multiple projects yet when used with this option it only returned (detailed) quota information for a single project. This detailed quota information is now available via the quota show --usage command.

• The --project option for the quota list command has been deprecated for removal. Use the quota show command instead.

Bug Fixes

• The server create command will no longer insist on an --image, --image-property, --volume or --snapshot argument when a volume is provided with a boot index of 0 via the --block-device option.

• The flavor list command will no longer attempt to fetch extra specs unless they are actually required (by using the --long) option. This should significantly improve performance on clouds with a large number of flavors. [Story 2010343]