Current Release Notes

6.2.0-38

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 --no-property option in volume qos set.

• 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.

• 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.

• 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.

Bug Fixes

• 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.

• 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 --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]

6.0.0

New Features

• Add block storage cluster create, block storage cluster delete, block storage cluster list and block storage cluster show commands to create, delete, list, and show block storage service clusters, respectively.

• The volume argument of the volume backup restore command is now optional and can refer to the name of a new volume that should be created rather than a name or ID of an existing volume (which would be overwritten). If not provided, cinder will generate a new volume with a unique name. To restore a backup to an existing volume, you must now specify the --force option (volume v2, v3 only). [Bug 1597189]

• The image list now accepts multiple --tag options, allowing you to filter images on more than one tag.

• Add support for QoS minimum packet rate rule to following commands: network qos rule create, network qos rule delete, network qos rule list, network qos rule show and network qos rule set

• Add --force options to the openstack quota set command for network service commands. Neutron quota engine now accepts “force” flag to set a new resource quota limit, regardless of the current resource usage.

• The server list command will now display Host Status when the --long option is specified and the compute API microversion is 2.16 or greater.

• The server migration abort, server migration force complete and server migration show commands will now accept a server migration UUID in addition to an ID.

Bug Fixes

• Fixed create image from volume command. If user wants to pass visibility and protected fields, they need to specify volume microversion 3.1 or greater by passing os-volume-api-version 3.1 with the command.

• The volume attachment create command will now display information for successfully created volume attachments. Previously an empty table was returned.

5.8.0

New Features

• Add local ip create, local ip delete, local ip list, local ip set, local ip show, local ip association create, local ip association delete and local ip association list commands to support Neutron Local IP CRUD operations. [bug 1930200]

• Add possibility to unbind Neutron’s port from the host by unsetting its host_id.

• Support for the remote-managed VNIC type has been added and can now be passed to the --vnic-type option when used in conjunction with the port create and port set commands.

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

• Add --subnet-pool option to subnet list to filter by subnets by subnet pool.

• Switch the add fixed IP command from novaclient to SDK.

• Migrate openstack server image create from novaclient to sdk.

• Migrate server add network/port from novaclient to openstacksdk.

• Migrate openstack server add volume to using sdk.

• Migrate server pause and server unpause commands from novaclient to sdk.

• Migrate server suspend and server resume commands from novaclient to sdk.

• Switch the compute service commands from novaclient to SDK.

• 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.

• It is now possible to add an external gateway to a router immediately on creation. Previously it could only be done by modifying the router after it had been created. This includes the options to en- or disable SNAT and to specify a fixed-ip on the external network.

• Added the ability to pass arguments through to the ssh command When using openstack server ssh. This allows the user to use any ssh option without needing to add that option to the openstack client. Existing openstackclient options that mirror SSH options are now deprecated.

• Added --security-group option to the os port list command. This option is appendable and multiple security group IDs can be provided.

• Switch server remove volume/port to using sdk.

• Switch command server remove volume to using sdk.

Deprecation Notes

• 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.

• openstack server ssh options that mirror ssh options are now deprecated (--login, -l, --port, --identity, --option, -o, -vz). The ssh equivalent of each deprecated option should be used instead. For example openstack server ssh instance -- -l user -i key

5.7.0

New Features

• The server create, server set and server rebuild commands now accept an optional --hostname HOSTNAME option. This can be used to configure the hostname stored in the metadata service and/or config drive. Utilities such as cloud-init can then consume this information to set the hostname within the guest OS.

• Added --trusted-image-cert option for server create. It is available only when directly booting server from image (not from volume, not from snapshot and not via image converted to volume first). This option is supported for Compute API version >=2.63

• Added support for microversion 2.89. This microversion removes the id field while adding the attachment_id and bdm_uuid fields to the responses of GET /servers/{server_id}/os-volume_attachments and GET /servers/{server_id}/os-volume_attachments/{volume_id} with these changes reflected in novaclient under the openstack server volume list command.

• Migrate openstack server backup from novaclient to sdk.

• The server add volume command will now return details of the created volume attachment upon successful attachment.

Bug Fixes

• Filtering servers by tags (server list --tag, server list --not-tag) now works correctly. [Bug 1946816]

5.6.0

New Features

• Add new commands network l3 conntrack helper create, network l3 conntrack helper set, network l3 conntrack helper show, network l3 conntrack helper set and network l3 conntrack helper delete to support Neutron L3 conntrack helper CRUD operations.

• Add --no-incremental, --property and --availability-zone options to volume backup create command, allowing users to request a non-incremental backup, set a metadata property on the created backup, and set an availability zone on the created backup, respectively.

• Add --property and --no-property options to the volume backup set command to set a metadata property or remove all metadata properties from an existing backup.

• Add new volume backup unset command to allow unsetting of properties from an existing volume backup.

• Add volume attachment create, volume attachment delete, volume attachment list, volume attachment complete, volume attachment set and volume attachment show commands to create, delete, list, complete, update and show volume attachments, respectively.

• Add volume group create, volume group delete, volume group list, volume group failover, volume group set and volume attachment show commands to create, delete, list, failover, update and show volume groups, respectively.

• Add volume group snapshot create, volume group snapshot delete, volume group snapshot list and volume group snapshot show commands to create, delete, list, and show volume group snapshots, respectively.

• Add volume group type create, volume group type delete, volume group type list, volume group type set/unset and volume group type show commands to create, delete, list, update, and show volume group types, respectively.

• Add volume message list, volume message get and volume message delete commands, to list, get and delete volume failure messages, respectively.

• The volume transfer request create command now accepts the --snapshots / --no-snapshots option to configure whether to create a transfer request for a volume without snapshots or not.

• Add column Forced Down to the output of compute service list --long. Only available starting with --os-compute-api-version 2.11.

• Add mutually exclusive options --hidden and --unhidden to image set command to hide or unhide an image (is_hidden attribute).

• Add option --hidden to image list command to list hidden images.

• The port create --vnic-type option now accepts a vdpa value.

Bug Fixes

• The --name and --description options of the volume backup set command will now verify the version requested on the client side. Previously this would fail on the server side.

5.5.0

New Features

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

• Add --project and --project-domain``options to ``image list command to filter by owner.

• It is now possible to list the keypairs for all users in a project using the --project parameter. This is an admin-only action by default and requires 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 requires Compute API microversion 2.10 or later.

• Add --limit and --marker options to hypervisor list command, to configure pagination of results.

• Add --limit and --marker options to keypair list command, to configure pagination of results.

• Add a number of additional options to the server create command:

  • --snapshot

  • --ephemeral

  • --swap

  • --block-device

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

• Add --limit and --offset options to server group list command, to configure pagination of results.

• Add --limit, --marker, --change-since and --changes-before options to server group list command, to configure pagination of results and filter results by last modification, respectively.

• Add --property option to server image create command, allowing users to record arbitrary key/value metadata to meta_data.json on the metadata server.

• Add a number of additional options to the server list command:

  • --availability-zone

  • --key-name

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

  • --progress

  • --vm-state

  • --task-state

  • --power-state

• Add a number of additional options to the server rebuild command:

  • --name

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

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

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

• Add --no-password option to server set command, allowing users to clear the admin password from the metadata service. Note that this does not actually change the server password.

• Add support for project cleanup based on the OpenStackSDK with create/update time filters. In the long run this will replace openstack project purge command.

• Add server evacuate command. This command will recreate an instance from scratch on a new host and is intended to be used when the original host fails.

• Add server migration show commands. This can be used to show detailed information about an ongoing server migration.

• The --nic option of the server create command now supports an optional tag=<tag> key-value pair. This can be used to set a tag for the interface in server metadata, which can be useful to maintain persistent references to interfaces during various operations.

• Add server volume list command, to list the volumes attached to an instance.

• Add server volume update command, to update the volumes attached to an instance.

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

• Add support --wait option for server shelve.

• Add --tag option to server add fixed ip command when adding a fixed IP to server. Only available starting with --os-compute-api-version 2.49.

• Add --tag option to server add network command when add network to server. Only available starting with --os-compute-api-version 2.49.

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

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

• Add --id and --enabled option to identity provider list command.

• Add --name and --domain option to domain list command.

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

• The server migrate command will now automatically determine whether to use block or shared migration during a live migration operation. This requires Compute API microversion 2.25 or greater.

• Add server migration list command. This command allows users to list the status of ongoing server migrations.

• Add --remote-address-group option to security group rule create command for using an address group as the source/destination in security group rules. Also add field remote_address_group_id to the output of security group rule show and add column Remote Address Group to the output of security group rule list. [Blueprint address-groups-in-sg-rules]

• Add address group create, address group delete, address group list, address group set, address group show and address group unset commands to support Neutron address group CRUD operations. [Blueprint address-groups-in-sg-rules]

• Add --password option to server create command, allowing users to set the admin password when creating a new instance.

• Add server migration abort command to abort ongoing live migrations.

• Add server migration force complete command to force complete ongoing live migrations.

• The openstack flavor list command now accepts two additional options, --min-disk and --min-ram, to filter flavor by minimum disk and minimum RAM, respectively.

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

• Add --user option to the keypair create, keypair delete, and keypair show commands. Only available starting with --os-compute-api-version 2.10.

• Add device profile to port create command.

• Add address_group as a valid --type value for the network rbac create and network rbac list commands.

• Add --tag option to server create command to add tags when creating a server. Only available starting with --os-compute-api-version 2.52.

• Add --tag option to server set command to add a tag to an existing server. Only available starting with --os-compute-api-version 2.26.

• Add --tag options to server unset command to remove a tag from an existing server. Only available starting with --os-compute-api-version 2.26.

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

• Add support for --rule option for server group create.

• Add --c project_id | user_id | created_at to openstack server list command to get these columns as an output.

• The server delete, server start and server stop commands now support the --all-projects option. This allows you to perform the specified action on a server in another project using the server name. This is an admin-only action by default.

• Add support for openstack server show --topology flag, which will include 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

• The openstack server list --status parameter will now validate the requested status.

• The --key-unset option of the server rebuild command has been replaced by --no-key-name. An alias is provided.

• The server set --root-password option has been deprecated in favour of a non-interactive --password option.

• The server create command will now error out if the --file option is specified alongside --os-compute-api-version of 2.57 or greater. This reflects the removal of this feature from the compute service in this microversion.

• The deprecated --live option of the server migrate command has been removed. This was problematic as it required a host argument and would result in a forced live migration to a host, bypassing the scheduler. It has been replaced by a --live-migration option and optional --host option.

• The server migrate confirm and server migrate revert commands, introduced in OSC 5.0, have been deprecated in favour of server migration confirm and server migration revert respectively. The deprecated commands will be removed in a future major version.

• A warning will now be emitted when using the --disk-overcommit or --no-disk-overcommit flags of the server migrate command on Compute API microversion 2.25 or greater. This feature is only supported before this microversion and previously the flag was silently ignored on newer microversions. This warning will become an error in a future release.

Deprecation Notes

• The --block-device-mapping option of the server create command has 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 the security group list command. This is no longer needed to display all columns.

• The --config-drive option on the openstack server create command has been deprecated in favour of the --use-config-drive and --no-config-drive arguments. The --config-drive option expected either a string or bool-like argument, but the nova API has only supported boolean 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. Fixes https://storyboard.openstack.org/#!/story/2007672

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

• The addresses and flavor fields of the server show command will now be correctly rendered as a list of objects and an object, respectively.

• The networks and properties fields of the server list command will now be rendered as objects. In addition, the power_state field will now be humanized and rendered as a string value when using the table formatter.

• The usage list and usage show commands will now display the name of the project being queried rather than the ID when using the table formatter. In addition, the server_usages, total_memory_mb_usage, total_vcpus_usage and total_local_gb_usage values will only be humanized when using the table formatter.

• The policies (or policy, on newer microversions) and members fields of the server group list and server group show commands will now be rendered correctly as lists.

• The cpu_info field of the hypervisor show output is now correctly decoded and output as an object.

• Fixes default behaviour of openstack image create in allowing images with the same name. In version 5.2.0 this changed to not allow duplicates by default.

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

• The openstack server group create command will now validate the policy value requested with --policy, restricting it to the valid values allowed by given microversions.

• Add missing openstack subnet unset --gateway <subnet-id>.

Other Notes

• Remove deprecated neutron-lbaas results from quota show command.

5.4.0

New Features

• Add NUMA affinity policy to port create, port set and port unset commands.

• Support for image search via properties of image. Currently “openstack server create –image-property” only takes image property. Now it can also search image via properties (user defined) too. Story https://storyboard.openstack.org/#!/story/2007860.

Bug Fixes

• You can now remove role assignments from keystone that reference non-existent users or groups.

  [Bug 2006635]

• The openstack server show -f json command was not outputting json for security groups, volumes and properties properly.

5.3.1

Bug Fixes

• Fixes an issue with python 3.8 and entrypoint loading where the new builtin importlib entrypoint support had a different attribute api than expected.

5.3.0

New Features

• Add a new option –description to floating ip port forwarding create and floating ip port forwarding set commands.

• Added --import flag to openstack image create to allow the user to force use of the image import codepath.

• Added the below mentioned parameters to the user create and set commands.

  • –ignore-lockout-failure-attempts

  • –no-ignore-lockout-failure-attempts

  • –ignore-password-expiry

  • –no-ignore-password-expiry

  • –ignore-change-password-upon-first-use

  • –no-ignore-change-password-upon-first-use

  • –enable-lock-password

  • –disable-lock-password

  • –enable-multi-factor-auth

  • –disable-multi-factor-auth

  • –multi-factor-auth-rule

  This will now allow users to set user options via CLI. <https://docs.openstack.org/keystone/latest/admin/resource-options.html#user-options>

• Added the below mentioned parameters to the role, project and domain commands.

  • –immutable

  • –no-immutable

  This will allow user to set “immutable” resource option.

• Add --force options to the openstack quota set command. The compute service allows us to to force set a quota, setting a quota value that is less than the amount of the resource currently consumed. Expose this feature by way of a --force boolean parameter.

• Add address_scope as a valid --type value for the network rbac create and network rbac list commands.

• Add subnetpool as a valid --type value for the network rbac create and network rbac list commands.

• Add new commands router add route and router remove route to support new Neutron extension: extraroute-atomic (see Neutron RFE).

• Add --stateful and --stateless option to the security group create and security group set commands to support stateful and stateless security groups.

Deprecation Notes

• The use of router set --route to add extra routes next to already existing extra routes is deprecated in favor of router add route --route, because router set --route if used from multiple clients concurrently may lead to lost updates.

Bug Fixes

• [Story 2005246] The is_domain property safely handles type checking.

• While uploading a signed image, a private key to sign that image must be specified. The CLI client asks for the password of that private key. Due to wrong encoding handling while using Python 3, the password is not accepted, whether it is correct or not.

• Makes volume backup record commands available in Volume API v3. Task 40279

5.2.0

New Features

• Complete switch from glanceclient to the SDK for image service.

• Image service for v2 is switched from using glanceclient to OpenStackSDK.

5.1.0

New Features

• Now user can add the description when user create’s the role using OSC openstack role create command. User can add the description by adding –description <Description> to OSC openstack role create command.

• Add --dns-publish-fixed-ip and --no-dns-publish-fixed-ip options to create subnet and set subnet commands to control the publishing of fixed IPs in DNS when the subnet_dns_publish_fixed_ip Neutron extension is enabled. [Bug 1784879]

5.0.0

New Features

• Add --parent option to project list command to filter projects by the specified parent project.

• Add server migrate confirm and server migrate revert commands. These are aliases of the server resize confirm and server resize revert commands, respectively.

• Add --disable-delete-on-termination and --enable-delete-on-termination options to the server add volume command to indicate when to delete the attached volume when the server is deleted. Note that it requires --os-compute-api-version 2.79 or greater. [Blueprint support-specifying-az-when-restore-shelved-server https://blueprints.launchpad.net/nova/+spec/support-delete-on-termination-in-server-attach-volume]

• [blueprint whitelist-extension-for-app-creds] Added support for creating access rules as an attribute of application credentials as well as for listing, showing, and deleting access rules.

Upgrade Notes

• Python 2.7 support has been dropped. The last release of python-openstackclient to support Python 2.7 is OpenStack Train. The minimum version of Python now supported by python-openstackclient is Python 3.6.

Bug Fixes

• Fixes the “No server with a name or ID of ‘id’ exists” error when running server list --deleted --marker. The fix removes using a name for the marker when both --deleted and --marker are used. In this scenario an ID must be supplied for the marker. [Story 2006761]

4.0.0

New Features

• Add floating IP Port Forwarding commands: floating ip port forwarding create, floating ip port forwarding delete, floating ip port forwarding list, floating ip port forwarding set and floating ip port forwarding show.

• Add --host and --hypervisor-hostname options to server create command. [Blueprint add-host-and-hypervisor-hostname-flag-to-create-server]

• Add --host option to server migrate command (cold migration) to specify the target host of the migration. Requires --os-compute-api-version 2.56 or greater to target a specific host for the (cold) migration. [Story 2003325]

• Add server resize confirm and server resize revert commands. These replace the now deprecated --confirm and --revert options to the server resize commands, respectively.

• Add --extra-dhcp-options parameter to the port create command. The neutronclient port-create command can accept extra DHCP options, add it to the openstackclient in order to be consistent.

• Add --ethertype option to security group rule list command. Valid values are ipv4 and ipv6.

• Add --reason option to the server lock command to specify a reason when locking a server. Requires –os-compute-api-version 2.73 or greater.

• Add --locked option to the server list command to list only locked servers. Requires –os-compute-api-version 2.73 or greater.

• Add --unlocked option to the server list command list only unlocked servers. Requires –os-compute-api-version 2.73 or greater. [Blueprint add-locked-reason]

• Add --availability-zone option to server unshelve command to enable users to specify an availability zone during unshelve of a shelved offloaded server. Note that it requires --os-compute-api-version 2.77 or greater. [Blueprint support-specifying-az-when-restore-shelved-server]

• Add --boot-from-volume option to the server create command to create a volume-backed server from the specified image with the specified size when used in conjunction with the --image or --image-property options. [Story 2006302]

• The server create --block-device-mapping option now supports an image type in addition to volume and snapshot. When specifying an image block device the compute service will create a volume from the image of the specified size and attach it to the server. [Story 2006302]

Upgrade Notes

• Security group rule listings now have the Ethertype field displayed by default to more easily differentiate between IPv4 and IPv6 rules. In addition, the IP Range field of a security group will be changed to 0.0.0.0/0 for IPv4 and ::/0 for IPv6 if no value is returned for the address, based on the Ethertype field of the rule. For further information see [Bug 1735575]

• Commands that assumed the default value of --protocol to be tcp now must include --protocol tcp explicitly in Network commands.

• Remove deprecated ip fixed add|remove commands. Use server add|remove fixed ip commands instead.

• Remove deprecated ip floating add|remove commands. Use server add|remove floating ip commands instead.

• Remove deprecated role list options --project and --user. Use role assignment list options --project and --user instead.

• Remove deprecated user role list command. Use role assignment list options --project and --user instead.

• Remove deprecated service create option --type. The type is supplied as a positional argument in The service create --name <service-name> type command.

• Remove image create|set option --owner. Use --project option instead.

• Remove deprecated port create|set options --device-id and --host-id. Use --device and --host options instead.

• Remove deprecated router set option --clear-routes. Use --no-route option instead.

• Remove deprecated security group rule create options --src-ip and --src-group. Use --remote-ip and --remote-group options instead.

• Remove deprecated backup commands. Use volume backup commands instead.

• Remove deprecated snapshot commands. Use volume snapshot commands instead.

• Remove deprecated volume create options --project, --user and --multi-attach.

• Change volume transfer request accept to use new required option --auth-key rather than a second positional argument.

• Volume commands now default to Volume API 3. On older clouds that do not support Volume 3.x --os-volume-api-version 2 or the adition of volume_api_version: '2' in clouds.yaml will be required.

Deprecation Notes

• Deprecate the --confirm and --revert options for the server resize command. They have been replaced with the server resize confirm and server resize revert` commands, respectively.

Bug Fixes

• Change the default value of --protocol option to any in security group rule create command when using the Neutron v2 API. [Bug 1716789]

• The compute service set command now properly handles --os-compute-api-version 2.53 and greater. [Story 2005349]

• Compute API v2.40+ returns all matching entities rather than being limited to the API server configured maximum (CONF.api.max_limit). [Story 2005099]

Other Notes

• The configuration show command no longer requires authentication. This is useful in debugging cloud configurations, particularly auth configurations.

3.19.0

New Features

• Add --changes-before option to the server list command. This requires Compute API version ‘2.66’ or later. [:lpbug: 1827844]

• Add security_group as a valid --type value for the network rbac create and network rbac list commands.

• Add --description option to server create, server rebuild, server set and server unset commands. [Bug 2002005]

Deprecation Notes

• The --live option on the openstack server migrate command has been deprecated and is being replaced with two new options:

  • --live-migration: This will signal that the migration is a live migration.

  • --host: This can be used to request a target host for the live migration but requires --os-compute-api-version 2.30 or greater so the requested host can be validated by the scheduler.

  The --live option is problematic in that it requires a host and prior to compute API version 2.30, specifying a host during live migration will bypass validation by the scheduler which could result in failures to actually migrate the server to the specified host or over-subscribe the host.

  The --live and --host options are mutually exclusive. Furthermore, if both the --live and --live-migration options are used the --live-migration option takes priority.

Bug Fixes

• Bug 1411190 has been fixed by providing a --live-migration and --host option to the openstack server migrate command.

• Fix RuntimeError in project show command running under Python 3. [Bug 1740232]

• Re-open stdout in binary mode before writing object data in object save --file - command. [Bug 1775482]

• Fix endpoint group delete command to properly delete endpoint groups. [Story 2005521]

• The --limit option of the image list command was previously ignored. [Bug 2004314]

3.18.0

New Features

• Add --member-status option to image list command.

• From microversion 2.69 the results of openstack server list and openstack server show may contain missing information in their outputs when there are partial infrastructure failure periods in the deployment. See Handling Down Cells for more information on the missing keys/info.

• Add network segment range create, network segment range delete, network segment range list, network segment range show and network segment range set commands. [Blueprint network-segment-range-management]

• Add --attached and --detached options to volume set command to set the volume status in the database. This is the functional equivalent to cinder reset-state --attach-status. [bug 1745699

• Add --dns-domain and --dns-name options to the floating ip create commands. These options set the DNS domain and name for the floating IP.

  Check backend available extension and return an error message if it is missing (instead of a Bad Request HTTP 400). [Bug 1547736]

• Add --long option to the floating ip list command. This adds DNS Name and DNS Domain columns to the floating IP list. [Bug 1547736]

• The image list command now properly filters images on multiple --property options. [Bug 2004290]

• Add support for list detailed quota usage for project. This can be done by passing --detail parameter to quota list command. [Bug 1716043]

• Add --name-lookup-one-by-one option to the server list command that is (mutually exclusive with -n | --no-name-lookup). When provided, the names of images and flavors will be resolved one by one only for those images and flavors that are needed to display the obtained list of servers instead of fetching all the images and flavors. Depending on amount of images in your deployment this can speed up the execution of this command.

• When given --image or --flavor argument, the server list command now resolves only single image or flavor instead of fetching all the images or flavors for name lookup purposes.

• Add dns-domain support for network commands. The new parameter --dns-domain is added to the network create and network set commands. This parameter sets the domain name for the network. Check backend available extension and return an error message if it is missing (instead of a Bad Request HTTP 400).

• Add options --sign-key-path and --sign-cert-id to the image create command. Tthe image must be present on disk, therefore the file option is required:

  image create --file <filename> --sign-key-path <key-path> --sign-cert-id <secret-id>.

  A prompt for a password ensures, that the private key can be protected too. [Bug 2002128]

• Add support for attaching and removing qos policy to router gateway IPs.

  Add --qos-policy and --no-qos-policy options to the router set command.

  Add --qos-policy option to the router unset command.

• Add --property option to the server rebuild command, to provide the ability to specify properties of the rebuilt instance. [Story 2003979]

• Add --key-name option to server rebuild command to set keypair of the server. Note that it requires –os-compute-api-version 2.54 or later.

• Add --key-unset option to server rebuild command to unset keypair. Note that it requires –os-compute-api-version 2.54 or later.

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

• Add openstack volume backend capability show <host> command that provides a list of all capabilities that can be configured for the requested backend. The required <host> parameter takes the form host@backend-name.

• Add openstack volume backend pool list command that provides a list of all backend storage pools. The optional --long parameter includes some basic configuration and stats for each pool.

Upgrade Notes

• The volume migrate --unlock argument did not actually do anything and has now been removed.

Deprecation Notes

• The --project and --user options for the volume create command have been deprecated. They are deprecated because Cinder’s volume create API ignores the corresponding API inputs.

Bug Fixes

• Fix volume create by removing two broken options. The --project and --user options were intended to specify an alternate project and/or user for the volume, but the Volume service’s API does not support this behavior. This caused the volume to be created, but without the expected project/user values. However, an alternate project and/or user may be specified using identity overrides (e.g. –os-username, –os-project-id).

• The openstack server add floating ip command has been fixed to handle servers with multiple ports attached. Previously, the command was using the first port in the port list when attempting to associate the floating ip. This could fail if the server had multiple ports and the first port in the list was not attached to an external gateway. Another way it could fail is if the --fixed-ip-address option was passed and the first port did not have the specified fixed IP address attached to it. Now, the openstack server add floating ip command will find the port attached to the specified --fixed-ip-address, if provided, else it will try multiple ports until one is found attached to an external gateway. If a suitable port is not found in the port list, an error will be returned.

3.16.0

New Features

• Add image member list command to list all members of an image.

• Add --tag option to image list command to filter by tag.

• Add --image-property option to server create command. This parameter will filter a image which properties that are matching.

• Add an ip-substring key to the --fixed-ip option of the port list command. This allows filtering ports by a substring match of an IP address. [Bug 1718605]

• Add registered limit commands for managing registered limits in Keystone. Registered limits define limits of resources for projects to assume by default. [bp unified-limits]

• Add limit commands for managing project-specific limits in keystone. Limits define limits of resources for projects to consume once a limit has been registered. [bp unified-limits]

• Add --tag and --no-tag options to security group create and security group set commands. [Bug 1750983]

• Add --tags, --any-tags, --not-tags and --not-any-tags options to security group list command. [Bug 1750983]

• Add --tag and --all-tag options to security group unset command. [Bug 1750983]

• Add --description option to flavor set command to update the description of the flavor. Only available starting with --os-compute-api-version 2.55.

• Add --description option to flavor create command to set the description of the flavor. Only available starting with --os-compute-api-version 2.55.

• Add support for system-scope to role commands. This includes the ability to generate system-scoped tokens using system_scope: all in cloud.yaml or OS_SYSTEM_SCOPE=all in an environment variable. Support is also included for managing role assignments on the system using --system when adding and removing roles. [bp system-scope]

• Add --network-segment option to subnet set command. This enables the possiblity to set the segment_id of a subnet on update.

• A new command, openstack versions show was added, which will provide a list of all versions of all services in the cloud. It includes relevant metadata, such as min/max microversion, endpoint, status and region.

Bug Fixes

• Add --community option to image list command. [Bug 2001925]

• The server list --all command now resolves non-public flavor names, too, so that the Flavor column will be properly populated. [Bug 1742453]

• Add --tag support to floating ip create|list|set|unset commands. [Bug 1750985]

• The server show command will now properly show the server’s flavor information when using --os-compute-api-version 2.47 or higher. [Bug 1751104]

Other Notes

• Remove deprecated ip floating and ip floating pool commands.

3.15.0

New Features

• Adds support for creating, reading, and deleting application credentials via the appication credential command. With application credentials, a user can grant their applications limited access to their cloud resources. Once created, users can authenticate with an application credential by using the v3applicationcredential auth type. [blueprint application-credentials]

• Add --tag option to project create command, --tag, --clear-tags, and --remove-tag options to project set command. Add --tags, --tags-any, --not-tags, and --not-tags-any options to project list command to filter list results by different projects based on their tags. [blueprint project-tags]

• Add --dns-domain option to port create and port set commands. Requires the dns_domain for ports extension to be enabled. See the Neutron DNS integration documentation for information how to use this. [Bug 1714878]

• Add endpoint group commands: endpoint group add project, endpoint group create, endpoint group delete, endpoint group list, endpoint group remove project, endpoint group set and endpoint group show. [Blueprint keystone-endpoint-filter]

• Add --mtu option to network create and network set commands, allowing CLI users to set the MTU for Neutron networks.

3.14.0

New Features

• Add --device-id option to the port list command.

• Add support for attaching and removing qos policy to floating IPs.

  Add option --qos-policy to the floating ip create and floating ip set commands to add qos policy to a floating IP.

  Add option --no-qos-policy to the floating ip set and option --qos-policy to the floating ip unset command to remove the qos policy from a floating IP.

Bug Fixes

• ‘NoneType’ object is not iterable when Glance cannot find image data in its backend. [Bug 1741223]

3.13.0

New Features

• Support for creating, deleting, and listing implied roles has been added. This allows users to create an inference rule between two roles. The first, called the prior role is the role explicitly assigned to an individual. The second, called the implied role, is one that the user is assgined implicitly. Additionally, these rules can be chained, such that an implied role from the first inference rule can be the implied role in the second. Thus one explicitly assigned role can lead to multiple implied roles. implied role create <role> --implied-role <implied-role> creates an association between prior and implied roles. implied role delete <role> --implied-role <implied-role> removes an association between prior and implied roles. implied role list Lists all implied roles that currently exist.

• Add network qos rule type show command.

• Add server add network command. This command will create a neutron port from the specified neutron network and attach the port to the specified instance.

• Add server remove network command. This command will remove all network ports from the specified network and instance.

• Add --use-prefix-delegation option to the subnet create command to specify ‘Prefix Delegation’ as a subnetpool when creating subnets. [Bug 1513894]

• Add router interfaces info (as field interfaces_info) to router show command. The information of router interface include port’s ID, IP address, the subnet ID it belongs. [Bug 1675489]

• Add any as a --protocol option to security group rule create command. [Bug 1517134]

• Add endpoint add project, endpoint remove project and endpoint list commands to manage endpoint filters in identity v3.

Bug Fixes

• Add --image and --password options to the server rescue command. [Bug 1703278]

• Fix occurrences of the network agent delete command failing with newer releases of python-openstacksdk. [Bug 1711301]

• It is now possible to create a security rule without specifying protocol (using --protocol any), which skips sending the protocol to the API server entirely. Previously TCP was forced as default protocol when none was specified.

• Fix the project purge command to correctly delete only images owned by the specified project ID when run by an administrative user. [Bug 1717130]

• Add --no-fixed-ip option to port create command. [Bug 1717829]

• Fix an issue with endpoint list working slow because it is issuing one GET request to /v3/services/<id> Keystone API for each endpoint. In case of HTTPS keystone endpoint and multiple regions it can take significant amount of time. [Bug 1719413]

• Accept 0 as a valid value in the image set --min-disk and --min-ram options. .. _bug 1719499: https://bugs.launchpad.net/python-openstackclient/+bug/1719499

• Add target-all-projects option in rbac create command. [Bug 1728525]

• Remove the type value limit in credentials when do create, reset or list. Now ‘totp’ method is supported in keystone project and we could create credentials with ‘totp’ type. [Bug 1731848]

• Fix the operation of the --changes-since option to the server list command. [Bug 1732216]

• Remove the client-side check for valid --policy values in the server group create command. Specify --os-compute-api-version 2.15 or higher for the soft-affinity or soft-anti-affinity policy. [Bug 1732938]

• openstack subnet create failed with a NoneType exception when there were no tags. [Bug 1735836]

• Add support to set --icmp-type and --icmp-code to 0 in the security group rule command. [Bug 1703704]

3.12.0

New Features

• Add --default and --no-default options to network qos policy create and network qos policy set comamnds. [Bug 1639220]

• The virtio-forwarder VNIC type has been added as another option for setting the --vnic-type property on the port set and port 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 and network agent remove router commands for adding/removing routers to network l3 agents. [Blueprint network-l3-commands]

• Add --router option to network agent list to filter by router, and --agent option to router list command to filter by agent. [Blueprint network-l3-commands]

• Added support for tags to the following resources: network, subnet, port, router and subnet pool. [Blueprint 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 to network qos rule create and network qos rule set commands. This adds directionality to Network QoS bandwidth-limit rule type. [Bug 1614121]

• Add --human-readable option to image show to display image size in human readable format (such as K, M, G, T,..) [Bug 1640086]

• Add --default-quota option to subnet pool create and subnet pool set commands. [Bug 1667294]

• Add --data-plane-status option to port set and port unset commands. [Bug 1684989]

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

  [Bug 1698390]

• Add --name and --status options to image list command to filter images based on name and status respectively. [Bug 1698742]

• Add --user and --type option to credential 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 to server 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 to Name in volume list output. Current volume list --name command uses display_name as search_opts to send to cinder API, and show the result table with Display Name as column title. Replace all Display Name by Name to be consistent with other list commands.

  Support a mapping for volume list -c Display Name (Volume v1 and v2) and volume create/show -c display_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 the server 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 the server 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 in extension 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 the project show, user show and user 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 the image create and image 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 from network set, because updating vlan-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 and network flavor profile set [Blueprint neutron-client-flavors]

• Add --share, --no-share, --project, --project-domain options to qos policy list command. [Blueprint network-commands-options]

• Add quota list command with --compute, --volume and --network options. [Blueprint quota-list]

• Add server add port and server remove port commands which enable to add/remove ports to/from a server [Bug 1678137]

• Add --no-ha option to the router create command [Bug 1675514]

• Add --fixed-ip-address option to the server add floating ip command [Bug 1624524]

• Add --fixed-ip-address option to the server 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 and network list --agent for adding/removing network to dhcp agent. [Blueprint network-dhcp-adv-commands]

• Add support to add/remove multi users by group add/remove user command. [Blueprint support-multi-add-remove]

• Add --private-key option for keypair 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 to project list by sorting items in client side By default project list will be sorted by name. [Bug 1596818]

• Add --qos-policy option to port create, port set and port unset commands. [Bug 1612136]

• Add --network and --port options to server 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 the project list command to allow admin users to list their own projects. [Bug 1627555]

• Add server event list and server 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 and floating ip unset commands. [Bug 1560297]

• Add network flavor add profile and network flavor remove profile commands. [Blueprint neutron-client-flavors]

Deprecation Notes

• volume transfer request accept has been changed to move the auth-key positional argument to a required option --auth-key. This leaves the transfer request ID as the only positional argument, 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 have ID followed by Name then the remaining columns.

• Now the positional parameter <snapshot-name> of volume snapshot create command is no longer optional, it should be always present. [Bug 1659894]

• security group list command now can display project IDs in the Project column of the command output. [Bug 1659967]

• Allow users to create centralized (distributed=False) routers using the --centralized option in router 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 to port 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 network-auto-allocated-topology]

• Add support to clear/overwrite all flavor properties using --no-property option with flavor set command. [Blueprint allow-overwrite-set-options]

• Add volume host failover command. [Blueprint cinder-command-support]

• Add --fixed-ip option to the port list command. [Bug 1634799]

• Add --encryption-provider, --encryption-cipher, --encryption-key-size and --encryption-control-location options to volume type set and volume type create commands. Add --encryption-type option to volume type unset, volume type list and volume type show commands. [Bug 1651117]

• Add --group option to the command 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 is 3.0.

• Add network flavor create, network flavor delete, network flavor list, Add network flavor show and network flavor set command [Blueprint neutron-client-flavors]

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

Bug Fixes

• Fix --parents and --children options in project show command. [Bug 1499657]

• Fixed the port set and port 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 and none 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 in network create command to be recognized when --external is not present. [Bug 1665231]

• Fix the Ethertype column output of security group rule list command. [Bug 1667699]

3.8.1

Bug Fixes

• The network create command was ignoring the --project option and creating networks owned by the current authenticated user’s project. This was a regression introduced in OSC 3.8.0. [Bug 1659878]

• The address scope list command failed with ‘HttpException: Bad Request’ when the --share or --no-share options were used. [Bug 1659993]

3.8.0

New Features

• Add meter rules commands for network meter rule create, network meter rule delete, network meter rule list, and network meter rule show. [Blueprint neutron-client-metering]

• Add --allowed-address option to port create, port set and port unset commands. Also add --no-allowed-address option to port create and port set commands. [Bug 1612136]

• Add --deleted and --changes-since options to server list command. [Bug 1647242]

• Add --project and --project-domain filtering options to port list command. [Bug 1648087]

• Add --domain options to the user set command. Allows specification of domain context when changing users. [Bug 1658147]

• Add --no-property option in volume snapshot set. [Blueprint allow-overwrite-set-options]

• Add --project and --project-domain option to volume snapshot list command, in order to filter list result by different project.

Bug Fixes

• Allow --block-device-mapping option to work correctly with --volume option in server create command. After Bug 1383338 --block-device-mapping was ignored if --volume was present. Block device mappings are now appended to the mapping created by the --volume option if it is present. The device name of the boot volume specificed in the --volume option is no longer assumed to be ‘vda’ but now uses the hypervisor’s boot index to obtain the device name. This maintains the status quo for QEMU/KVM hypervisors but XEN, parallels and others virt types that have device naming is different from vd* should now also work correctly. [Bug 1497845] [Bug 1647406]

• Fixed a __init__() got an unexpected keyword argument 'project_name' error in various networking commands when help or --help was used. [Bug 1650026]

• Work around a bug in OpenStackSDK 0.9.11 and 0.9.12 that causes quota set --network to fail. [Bug 1655445]

• Fixed a volume qos create display mistake in argument of specs. [Bug 1656767]

• Correctly handle non-admin in create trust command when looking up role names. [Bug 1658582]

3.7.0

New Features

• Added auto and none as values for --nic to the``server create`` command. Specifying none will not attach a network to the server. Specifying auto will automatically attach a network. Note, v2.37 (or newer) of the Compute API is required for these options. [Bug 1650342]

• Add support for Network QoS rule commands: network qos rule create, network qos rule delete, network qos rule list, network qos rule show and network qos rule set [Bug 1609472]

• Add support for Network QoS rule type commands: network qos rule type list, [Bug 1612194]

• Add --router and --no-router options to osc router set command to modify routes in a router instance. [ Blueprint allow-overwrite-set-options]

• Add support for network metering commands: network meter create, network meter delete, network meter show, network meter list [Blueprint neutron-client-metering]

• Add consistency group add volume and consistency group remove volume commands in volume v2. [Bug 1642238]

• Add filters --agent-type and --host to network agent list command [Bug 1641868]

• Add --type, --action, --long options to network rbac list command [Bug 1648307]

• Add support to update image membership with the --accept, --reject and --pending options of the image set command.

Bug Fixes

• Fix an endpoint version problem with Image endpoints that contained the substring ‘v2’. [Bug 1652827]

• Fix --project option for flavor create command when the ID for the new flavor is auto generated. [Bug 1654221]

• Fixed a 'Quota' object is not iterable error in the quota show command that appeared with the initial release of openstacksdk v0.9.11 and v0.9.12. [Bug 1655537]

• Fix floating ip delete and floating ip show to accept IP addresses in addition to IDs to select floating IPs to delete or show. [Bug 1656402

• Work around a bug in OpenStackSDK 0.9.11 and 0.9.12 that causes quota show --default to fail. [Bug 1656572]

• Fix a bug of unable to filter volume list by --project and --user options in the openstack volume list.

• Makes openstack object save much faster when saving an object to disk. [Bug 1654645]

3.6.0

New Features

• Add --default option to volume type list command, in order to show which volume type the volume sets as it’s default. [Blueprint cinder-command-support]

• Add --bootable, --non-bootable, --read-only and --read-write options to volume create command. [Blueprint cinder-command-support]

• Add --name, --ip-version, --project, --project-domain, --share, --no-share options to the address scope list command. [Bug 1636046]

• Add ploop as a valid disk format choice for image create and image set commands. [Bug 1650342]

• Add support for setting the gateway information in a router, by introducing the new option --external-gateway in router set command and clearing the gateway information in a router by introducing --external-gateway option in router unset command. [ Blueprint neutron-client-advanced-router]

3.5.0

New Features

• Add --no-dns-nameserver option to subnet set command. [Blueprint allow-overwrite-set-options]

• Add network service provider list command.

• Add --enable-port-security and --disable-port-security options to port set and port create commands. [Blueprint network-commands-options]

• Add --type and --retype-policy options to volume set command. [Blueprint cinder-command-support]

• Add volume host set command, it allows a user to enable or disable a volume host. [Blueprint cinder-command-support]

• Add --force option to volume snapshot delete command to allow delete in state other than error or available. [Bug 1597195]

• Add --dns-name option to os port create and os port set commands. [Bug 1612136]

• Add --project and --project-domain options to the router list, floating ip create and security group list commands. [Bug 1613231] [Bug 1613629] [Bug 1610909]

• Add consistency group create command in volume v2. [Bug 1613964]

• Add consistency group delete command in volume v2. [Bug 1613964]

• Add consistency group show command in volume v2. [Bug 1613964]

• Add consistency group set command in volume v2. [Bug 1613964]

• Add --long, --status, --project, --project-domain, and --router options to floating ip list command. [Bug 1614379]

• Add --port, --fixed-ip-address, --network, options to floating ip list command [Bug 1614379]

• Add --remote-source option to volume snapshot create command to support creating volume snapshot from an existing remote volume snapshot in volume v2. [Bug 1618676]

• The image list command will now sort by name in ascending order by default. --sort option will have the default value of name:asc. [Bug 1639231]

• Add consistency group snapshot create, consistency group snapshot delete, consistency group snapshot list and consistency group snapshot show commands in volume v2. [Bug 1642238]

• Add Is Public column to volume type list. [Bug 1643861]

• Add --name, --status and --volume options to volume snapshot list command [Bug 1645252]

• Add QoS support for Network commands. The new parameter qos-policy is added to network create and network set commands. This parameter is the name or the ID of the network QoS policy to attach to this network. [Bug 1627069]

• Add new commands volume snapshot create/delete/list/show/set/unset. They are used to replace the old commands snapshot create/delete/list/show/set/unset. [Blueprint backup-snapshot-renamed-for-volume-resource]

Deprecation Notes

• Deprecate commands snapshot create/delete/list/show/set/unset. [Blueprint backup-snapshot-renamed-for-volume-resource]

Bug Fixes

• Skip password prompt when running commands that do not require auth and user auth values are present except for password. [Bug 1619274] Fixed in release 3.3.0

• Fix problem with --os-auth-type token_endpoint that caused exceptions when recent os-client-config version 1.23.0 or newer is installed. [Bug 1642301] Fixed in release 3.4.1

• Changed the default version of OS_IMAGE_API_VERSION to 2. Image v1 has been deprecated for more than six months and other projects, such as shade and os-client-config are using Image v2 by default as well. [Bug 1642772]

3.4.1

Bug Fixes

• Fix TypeError: __init__() got an unexpected keyword argument 'project_domain_id' error with non-password authentication types. [Bug 1642301]

3.4.0

New Features

• Add support to update high-availability property of a router by adding --ha and --no-ha option to router set CLI. [Bug 1631492]

• Add support for Network QoS policies commands: network qos policy create, network qos policy delete, network qos policy list, network qos policy show and network qos policy set [Bug 1609037]

• Add --all-projects option to the volume backup list command to list volume backups across all projects.

• Add --read-only and --read-write options to volume set command. [Blueprint cinder-command-support]

• Add --description option to security group rule create command. [Blueprint network-commands-options]

• Add --description option to port set and port create commands. [Blueprint neutron-client-descriptions]

• openstack floating ip now provides Floating Network and Project to identify to which network and project the floating-ip belongs to. [Bug 1566090]

• Add --security-group and --no-security-group options to port create, port set and port unset commands. [Bug 1612136]

• Add --ingress, --egress and --protocol options to security group rule list command. [Bug 1613533]

• Add a new column status and --long option to the result of the os port list command. [Bug 1613995] [Bug 1614321]

• Add support to allow filtering ports via --mac-address option to the port list command. [Bug 1634333]

• Add --provider-network-type, --provider-physical-network, and --provider-segment options to the network list command. [Bug 1635580]

• Add --long option and more columns to the hypervisor list command. [Bug 1637074]

• Add --name, --enable, --disable options to router list command. [Bug 1637945]

• Add --name, --status, --volume, --marker and --limit options to volume backup list command [Bug 1639712]

• rbac_object parameter in network rbac create command now can be a QoS policy name.

• Add volume migrate command. [Blueprint cinder-command-support]

Upgrade Notes

• Rename the --src-group and --src-ip options in the security group rule create command to --remote-group and --remote-ip. The --src-group and --src-ip options are deprecated but still supported, and will be removed in a future release. [Bug 1637365]

Bug Fixes

• Fix the --block-migration and --shared-migration options for server migrate to send the correct values to the Compute API. [Bug 1518059]:

• A warning message will be shown when an empty password is used for user create and user set operations. [Bug 1607959]

• Fix router unset --route to correctly removed routes. [Bug 1631471]

• Fix --no-allocation-pool option for subnet set command to send the correct value to the Network API. [Bug 1518059]:

• Cliff 2.3.0: The shell formatter would emit invalid shell variable names for field names that contain colons (’:’) and dashes (’-‘), these are now replaced by underscores (’_’). [Bug 1616323]

3.3.0

New Features

• Ports can now be listed as per the networks they are connected to by using the --network option with the port list CLI. [ Blueprint network-commands-options]

• Allow --no-fixed-ip and --no-binding-profile options to port set command to be specified when --fixed-ip and --binding-profile are present. This allows the list of fixed IPs and binding profiles to be cleared and replaced with new values in a single command. [Blueprint allow-overwrite-set-options]

• Add --no-allocation-pool and --no-host-route options to subnet set command that clears the respective values in the specified subnet. This allows new values to replace the entire list of existing values in a single command for allocation pools and host routes. [Blueprint allow-overwrite-set-options]

• Add volume transfer request create, volume transfer request delete, volume transfer request show and volume transfer request accept commands in volume v1 and v2. [Blueprint cinder-command-support]

• Add --description option to network create and network set commands. [Blueprint network-commands-options]

• Add --description option to floating ip create command. [Blueprint neutron-client-descriptions]

• Add --description option to router set and router create commands. [Blueprint network-commands-options]

• Add network segment create, network segment delete and network segment set commands. In addition, the network segment list and network segment show commands are no longer beta commands and the --network-segment option on the subnet create command is no longer a beta command option. [Blueprint routed-networks]

• Add --no-property option to aggregate set command. This allows the property list to be cleared and replaced with new values in a single command. [Blueprint support-no-property-in-aggregate]

• Supported to fetch network project default quota with command quota show --default. [Bug 1204956]

• Add --internal, --name, --project and --project-domain, --enable and --disable, --share and --no share, --status options to the network list command. [Bug 1578819]

• Add --name option to command object create for uploading a file and renaming it. [Bug 1607972]

• Support to update per_volume_gigabytes, backup_gigabytes and backups quota in quota set command. [Bug 1609767]

• Add --ha option to router create command. [Bug 1610161]

• Add --project, --project-domain, --network, --gateway, --name and --subnet-range options to the subnet list command. [Bug 1610883]

• Add --limit option to volume list command in volume v1, add --limit and --marker options to volume list command in volume v2. [Bug 1612484]

• Add volume backup set commands in volume v2. [Bug 1613261]

• Add volume service set commands in volume v1 and v2. [Bug 1613597]

• Add --share, --no-share, --project, --project-domain, --default, --no-default, --name and --address-scope options to the subnet pool list command. [Bug 1613926]

• Add consistency group list command in volume v2. [Bug 1613964]

• Support listing the specified server’s ports by new option --server of port list command. [Bug 1614385]

• Adds --description option to subnet create and subnet set commands. [Bug 1614458]

• Adds --description option to subnet pool create and subnet pool set commands. [Bug 1614823]

• Add --source-replicated, --consistency-group, --hint and --multi-attach options to volume create command in volume v2. Make --size optional when --snapshot, --source or source-replicated options are present. [Bug 1627913]

• Add --service-type option to the subnet create, subnet set, subnet unset, and subnet list commands. [ Blueprint service-subnets]

Security Issues

• Mask passwords when --debug or -vv options are used. [Bug 1630822]

Bug Fixes

• Add --bootable and --non-bootable options to os volume set command to mark volume as bootable or non-bootable. [Bug 1535704]

• Update novaclient DEFAULT_API_VERSION from 2.0 to 2.1 [Bug 1588171]

• Fix the --class option in quota set and quota show commands to not perform a project lookup in Identity. [Bug 1609233]

• Do not show os-volume-type-access:is_public property which is the same as is_public property of volume type object. [Bug 1620922]

• Fix --long option in router list command for deployments without the router_availability_zone extension is not enabled. [Bug 1622565]

• Fix missing _username attribute error in server ssh command. [Bug 1624085]

3.2.0

Bug Fixes

• Fix prompting for password issue introduced in release 3.0.0 [Bug 1617384]

3.0.0

New Features

• Add a new command port unset to clear the information of fixed-ip and binding-profile from the port. [ Blueprint network-property-unset]

• Added support of –server-groups –server-group-members options to quota set command. [Bug 1602223]

• Add new commands volume backup create/delete/list/show/restore. It is used to replace the old commands backup create/delete/list/show/restore. [Blueprint backup-snapshot-renamed-for-volume-resource]

• Add network agent delete, network agent list, network agent show and network agent set commands. [Blueprint implement-network-agents]

• Support bulk deletion and error handling for aggregate delete, flavor delete, keypair delete and service delete commands. [Blueprint multi-argument-compute]

• Support bulk deletion for subnet pool delete, subnet delete, floating ip delete, security group delete and security group rule delete. [Blueprint multi-argument-network]

• Update --binding-profile option on the port create and port set commands to support JSON input for more advanced binding profile data. [Blueprint neutron-client]

• Add --enable-port-security and --disable-port-security options on the network create and network set commands. This supports setting the default port security for ports created on a network. [Blueprint neutron-client]

• Add geneve choice to the network create command --provider-network-type option. [Blueprint neutron-client]

• Add --device-owner option to the port list command to enable listing ports based on device owner. [Blueprint neutron-client]

• Add network rbac list, network rbac show, network rbac create, network rbac delete and network rbac set commands. [Blueprint neutron-client-rbac]

• Add --network-segment option to the subnet create command. This is a beta command option and subject to change. Use global option --os-beta-command to enable this option. [Blueprint routed-networks]

• Add support for showing flavor access list by using flavor show command. [Bug 1575461]

• Add --purge option to volume delete command (Volume v2 only) in order to removing any snapshots along with volume automatically when user delete the volume. [Bug 1589332]

• Add options --up and --down for compute v2 compute service set command to support force up/down compute service. [Bug 1589348]

• Support bulk deletion for ec2 credentials delete, endpoint delete, service delete in identity V2.0 . [Bug 1592906]

• Support bulk deletion for identity v3 commands: consumer, credential, domain, ec2creds, endpoint, federation_protocol, identity_provider, mapping, policy, region, service_provider and service. [Bug 1592906]

• Support bulk deletion for volume type delete. [Bug 1592906]

• Add --force option to backup create command to allow users to back up an in-use volume. [Bug 1596443]

• Add --property option to flavor create command. [Bug 1596798]

• Add --force option to volume qos delete command to allow users to delete in-use QoS specification(s). [Bug 1596821]

• Add --snapshot option to backup create command. [Bug 1597184]

• Add --force option to backup delete command to allow delete in state other than error or available. [Bug 1597188]

• Add --property option to snapshot create command. [Bug 1597192]

• Add --public and --private options to volume type list command. [Bug 1597198]

• Add --incremental option to backup create command to allow users to create incremental backups. [Bug 1600196]

• Add “Checksum” column to output of “image list –long” [Bug 1602073]

• Add --project and --project-domain options to volume type create command. [Bug 1602169]

• Support to get server rdp, serial, mks type console url. [Bug 1605088]

• Add --limit and --marker options to snapshot list command. [Bug 1605475]

• Deprecate role list arguments in favor of role assignment command. [Bug 1605774]

• Add support for domain specific roles in role and``role assignment`` commands. [Bug 1606105]

• Make subnet list command supports listing up subnets with dhcp enabled/disabled by adding --dhcp and --no-dhcp options to the command. [Bug 1610883]

• Add --project and --project-domain options to the flavor create command. We can use these options to add the flavor access to a given project when we create the flavor.

• Add new command floating ip pool list to list up all floating ip pools. This command is used to replace the old command ip floating pool list. [Blueprint rework-ip-commands https://blueprints.launchpad.net/python-openstackclient/+spec/rework-ip-commands]

• Add new commands server add/remove floating ip. They are used to replace the old commands ip floating add/remove. [Blueprint rework-ip-commands https://blueprints.launchpad.net/python-openstackclient/+spec/rework-ip-commands]

• Add new commands server add/remove fixed ip. They are used to replace the old commands ip fixed add/remove. [Blueprint rework-ip-commands https://blueprints.launchpad.net/python-openstackclient/+spec/rework-ip-commands]

• Add new commands floating ip create/delete/list/show. It is used to replace the old commands ip floating create/delete/list/show. [Blueprint rework-ip-commands https://blueprints.launchpad.net/python-openstackclient/+spec/rework-ip-commands]

• Show project access details for private volume type.

  An user can list projects which have access to a specific private volume type by using volume type show <volume-type>

  [Bug 1554891]

• Add a new command subnet unset to clear the information of allocation-pools, host-routes or DNS servers from the subnet. [ Blueprint network-property-unset]

• Add a new command router unset to clear the information of routes from the router. [ Blueprint network-property-unset]

• Add a new command subnet pool unset to clear the information of pool-prefixes from the subnet pools. [ Blueprint network-property-unset]

Upgrade Notes

• All set and unset commands now return normally when nothing specified to modify. This will become the default behavior of OSC set and unset commands. [Bug 1588588]

• Migrate command compute agent set arguments to be optional.

• With the change to use keystoneauth plugins the OpenStackClient-specific osc_password authentication plugin has been removed. The visible difference should only be in the behaviour with poorly configured clouds with old default Keystone values for admin_endpoint and public_endpoint as seen in the version details returned in a GET to the root (‘/’) route.

Deprecation Notes

• Deprecate commands backup create/delete/list/show/restore. [Blueprint backup-snapshot-renamed-for-volume-resource]

• Deprecate command ip floating pool list. [Blueprint rework-ip-commands https://blueprints.launchpad.net/python-openstackclient/+spec/rework-ip-commands]

• Deprecate commands ip floating add/remove. [Blueprint rework-ip-commands https://blueprints.launchpad.net/python-openstackclient/+spec/rework-ip-commands]

• Deprecate commands ip fixed add/remove. [Blueprint rework-ip-commands https://blueprints.launchpad.net/python-openstackclient/+spec/rework-ip-commands]

• Deprecate commands ip floating create/delete/list/show. [Blueprint rework-ip-commands https://blueprints.launchpad.net/python-openstackclient/+spec/rework-ip-commands]

Bug Fixes

• Support a new --state option for volume set command that changes the state of a volume. [Bug 1535213]

• Keystone V3 user password set is a self-service operation. It should not required a scoped token as it is not considered a scoped operation. [Bug 1543222]

• When performing domain show, project show or user show, peek into the user token to determine the ID or the resource (if supplied with only a name). This should make finding information about the user and their project easier for non-admin users. [Bug 1561599]

• Fix setting defaults for some scope parameters, that were putting invalid scope parameters for some auth plugins. [Bug 1582774]

• Raise ArgumentTypeError if the input arguments do not match the type key=value when we set properties. [Bug 1589935]

• Scope options are now validated after authentication occurs, and only if the user does not have a default project scope. [Bug 1592062]

• Fix for network OS_ENDPOINT_TYPE/–os-interface. Previously these were being ignored for network commands which resulted in the public endpoint always being used. [Bug 1592368]

• Add default IP version in ip availability list command and make this command work properly without --ip-version option. [Bug 1592761]

• Fixed service name lookup in Identity commands to properly handle multiple matches. [Bug 1597296]