Newton Series Release Notes¶
3.2.1-4¶
Bug Fixes¶
Fixed a
__init__() got an unexpected keyword argument 'project_name'error in various networking commands whenhelpor--helpwas used. [Bug 1650026]
3.2.1¶
Security Issues¶
Mask passwords when
--debugor-vvoptions are used. [Bug 1630822]
Bug Fixes¶
Skip password prompt when running commands that do not require auth and user auth values are present except for password. [Bug 1619274]
Fix problem with
--os-auth-type token_endpointthat caused exceptions when recent os-client-config version 1.23.0 or newer is installed. [Bug 1642301]
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 unsetto 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 setcommand. [Bug 1602223]
Add new commands
volume backup create/delete/list/show/restore. It is used to replace the old commandsbackup create/delete/list/show/restore. [Blueprint backup-snapshot-renamed-for-volume-resource]
Add
network agent delete,network agent list,network agent showandnetwork agent setcommands. [Blueprint implement-network-agents]
Support bulk deletion and error handling for
aggregate delete,flavor delete,keypair deleteandservice deletecommands. [Blueprint multi-argument-compute]
Support bulk deletion for
subnet pool delete,subnet delete,floating ip delete,security group deleteandsecurity group rule delete. [Blueprint multi-argument-network]
Update
--binding-profileoption on theport createandport setcommands to support JSON input for more advanced binding profile data. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client]
Add
--enable-port-securityand--disable-port-securityoptions on thenetwork createandnetwork setcommands. This supports setting the default port security for ports created on a network. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client]
Add
genevechoice to thenetwork createcommand--provider-network-typeoption. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client]
Add
--device-owneroption to theport listcommand to enable listing ports based on device owner. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client]
Add
network rbac list,network rbac show,network rbac create,network rbac deleteandnetwork rbac setcommands. [Blueprint neutron-client-rbac]
Add
--network-segmentoption to thesubnet createcommand. This is a beta command option and subject to change. Use global option--os-beta-commandto enable this option. [Blueprint routed-networks]
Add support for showing flavor access list by using
flavor showcommand. [Bug 1575461]
Add
--purgeoption tovolume deletecommand (Volume v2 only) in order to removing any snapshots along with volume automatically when user delete the volume. [Bug 1589332]
Add options
--upand--downfor compute v2compute service setcommand to support force up/down compute service. [Bug 1589348]
Support bulk deletion for
ec2 credentials delete,endpoint delete,service deletein 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_providerandservice. [Bug 1592906]
Support bulk deletion for
volume type delete. [Bug 1592906]
Add
--forceoption tobackup createcommand to allow users to back up an in-use volume. [Bug 1596443]
Add
--propertyoption toflavor createcommand. [Bug 1596798]
Add
--forceoption tovolume qos deletecommand to allow users to delete in-use QoS specification(s). [Bug 1596821]
Add
--snapshotoption tobackup createcommand. [Bug 1597184]
Add
--forceoption tobackup deletecommand to allow delete in state other than error or available. [Bug 1597188]
Add
--propertyoption tosnapshot createcommand. [Bug 1597192]
Add
--publicand--privateoptions tovolume type listcommand. [Bug 1597198]
Add
--incrementaloption tobackup createcommand to allow users to create incremental backups. [Bug 1600196]
Add
--projectand--project-domainoptions tovolume type createcommand. [Bug 1602169]
Support to get server
rdp,serial,mkstype console url. [Bug 1605088]
Add
--limitand--markeroptions tosnapshot listcommand. [Bug 1605475]
Deprecate
role listarguments in favor ofrole assignmentcommand. [Bug 1605774]
Add support for domain specific roles in
roleand``role assignment`` commands. [Bug 1606105]
Make
subnet listcommand supports listing up subnets with dhcp enabled/disabled by adding--dhcpand--no-dhcpoptions to the command. [Bug 1610883]
Add “Checksum” column to output of “image list –long” [Bug 1602073]
Add
--projectand--project-domainoptions to theflavor createcommand. 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 listto list up all floating ip pools. This command is used to replace the old commandip 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 commandsip 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 commandsip 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 commandsip 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 unsetto clear the information of allocation-pools, host-routes or DNS servers from the subnet. [ Blueprint network-property-unset]
Add a new command
router unsetto clear the information of routes from the router. [ Blueprint network-property-unset]
Add a new command
subnet pool unsetto clear the information of pool-prefixes from the subnet pools. [ Blueprint network-property-unset]
Upgrade Notes¶
All
setandunsetcommands now return normally when nothing specified to modify. This will become the default behavior of OSCsetandunsetcommands. [Bug 1588588]
Migrate command
compute agent setarguments to be optional.
With the change to use keystoneauth plugins the OpenStackClient-specific
osc_passwordauthentication 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
--stateoption forvolume setcommand 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 showoruser 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
ArgumentTypeErrorif the input arguments do not match the typekey=valuewhen 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 listcommand and make this command work properly without--ip-versionoption. [Bug 1592761]
Fixed service name lookup in Identity commands to properly handle multiple matches. [Bug 1597296]
2.6.0¶
New Features¶
Add
server backup createcommand
Add
network segment listandnetwork segment showcommands. These are beta commands and subject to change. Use global option--os-beta-commandto enable these commands. [Blueprint routed-networks]
Add
volume transfer request listcommand [Bug 1554886]
Add
--projectoption toflavor setcommand to set project access to a flavor [Bug 1575461]
Add
--projectoption toflavor unsetcommand to remove project access to a flavor [Bug 1575461]
Add
image unsetcommand [Bug 1582968]
Add
ip availability listandip availability showcommands [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-ip-capacity]
Add
--stateoption toserver setcommand to set the server to active or error state. [Blueprint server-reset-state]
Upgrade Notes¶
address scope deletecommand now accepts multiple address scopes in a single command
compute agent deletecommand now supports deleting multiple agents in a single command
An exception is not raised by command
service setwhen nothing specified. Instead, the service is not enabled by default. And if--disable-resionis specified but not--disable, an exception will be raised.
Bug Fixes¶
Fix the
--enableoption on all commands by changing the--enable-beta-commandsglobal option to--os-beta-command. There are no upgrade impacts for the global option rename since the old name isn’t used. [Bug 1588384]
2.5.0¶
New Features¶
Add network support for
quota setcommand. Options added includes--networks --subnets --subnetpools --ports --routers --rbac-policies--vips --members --health-monitors. Options--floating-ips --secgroup-rules --secgroupsnow support both network and compute API. [Bug 1489441]
Add
--icmp-typeand--icmp-codeoptions to thesecurity group rule createcommand for Network v2 only. These options can be used to set ICMP type and code for ICMP IP protocols. [Bug 1519512]
The following Network v2 IP protocols are supported by the
security group rule createcommand--protocoloption,ah,dccp,egp,esp,gre,igmp,ipv6-encap,ipv6-frag,ipv6-icmp,ipv6-nonxt,ipv6-opts,ipv6-route,ospf,pgm,rsvp,sctp,udplite,vrrpand integer representations [0-255]. [Bug 1519512]
The
security group rule listcommand supports displaying the ICMP type and code for security group rules with the ICMP IP protocols. [Bug 1519512]
Add
server group create,server group delete,server group list,server group showcommands. [Bug 1542171] [Blueprint nova-server-group-support]
Add
--shareand--defaultoptions tosubnet pool createand--defaultoption tosubnet pool set[Bug 1544586] [Bug 1544591]
Add
--transparent-vlanand--no-transparent-vlanoptions tonetwork createandnetwork setcommands to add/remove VLAN transparency attributes from networks. This option is available in Network V2 only. [Bug 1545537]
Adds
volume service listcommand. [Bug 1550999]
Support X.latest format for OS_COMPUTE_API_VERSION in order to talk with the latest nova microversion API, that is very helpful shortcut usage to use new nova side features. [Bug 1561838]
Add
address scope create,address scope delete,address scope list,address scope setandaddress scope showcommands. [Bug 1566269]
Add the
--ip-versionoption to thesubnet listcommand. This will output subnets based on IP version filter. [Bug 1581179]
Upgrade Notes¶
Changed the
security group rule createcommand--protooption to--protocol. Using the--protooption is still supported, but is no longer documented and may be deprecated in a future release. [Bug 1519512]
Bug Fixes¶
Support a new
--stateoption forsnapshot setcommand that changes the state of a snapshot. [Bug 1535239]
--pool-prefixoption made required forsubnet pool create[Bug 1536479]
Command
network deletewill delete as many networks as possible, log and report failures in the end. [Bug 1556719] [Bug 1537856]
Fixed the
--routeoption on therouter setcommand which did not properly format the new routes to set resulting in aBad Requesterror. In addition, therouter create,router listandrouter showcommand output for routes was fixed to improve readability and to align with the--routeoption on therouter setcommand. [Bug 1564460]
Added
--no-routeto therouter setcommand. Deprecated--clear-routes. [Bug 1565034]
Fixed
network create,network showandnetwork listcommands to correctly display the router type in therouter:externalandRouter Typecolumns. [Bug 1572228]
The
quota showcommand<project/class>argument is now optional. If not specified, the user’s current project is used. This allows non-admin users to show quotas for their current project. [Bug 1572733]
Fixed
flavor show/delete/set/unsetcommand to properly find a private flavor by flavor name. [Bug 1575478]
Fixed
flavor set/unsetcommand to properly find a flavor to be set/unset by flavor id. [Bug 1575624]
2.4.0¶
New Features¶
Add
--disable-reasonoption to theservice setcommand
Add
port create,port listandport setcommands [Bug 1519909]
Add
server restorecommand
The
security group create,security group setandsecurity group showcommands now uses Network v2 when enabled which results in a more detailed output for network security group rules. [Bug 1519511]
Add
--projectand--project-domainoptions to thesecurity group createcommand for Network v2. [Bug 1519511]
Add
--ingress,--egress,--ethertype,--projectand--project-domainoptions to thesecurity group rule createcommand for Network v2 only. These options enableegressandIPv6security group rules along with setting the project. [Bug 1519512]
The
security group rule listcommand now uses Network v2 when enabled which results inegresssecurity group rules being displayed. The--longoption was also added for Network v2 to display direction and ethertype information. In addition, security group rules for all projects will be displayed when thegroupargument is not specified (admin only). This is done by default when using Network v2, but requires the new--all-projectsoption when using Compute v2. [Bug 1519512]
The
security group rule createcommand now supports a security group name for the--src-groupoption. [Bug 1540656]
Add
subnet createcommand. [Bug 1542364]
Add provider network options
--provider-network-type,--provider-physical-networkand--provider-segmentto thenetwork createandnetwork setcommands. These options are available for NetworkV2 only. [Bug 1545537]
Add external network options
--external|--internaland--externalsuboptions--default|--no-defaultto thenetwork createandnetwork setcommands. These options are available for Network version 2 only. [Bug 1545537]
Add
--image-propertyoption tovolume setandvolume unsetcommandsImage properties are copied when a volume is created from an image. The properties are immutable on the image itself but may be updated or removed from the volume created from that image.
Add
--projectand--project-domainoptions tovolume type setandvolume type unsetcommandsUse the
--projectoption to restrict a volume type to a specific project. Volume types are public by default, restricted volume types should be made private with the--privateoption to thevolume createcommand.
Add
host setcommand [Bug 1556929]
Add
aggregate unsetcommand [Bug 1559866]
Add global options
os-certand--os-keyto support client certificate/key. Environment variablesOS_CERTandOS_KEY, as well as thecertandkeyvalues in clouds.yaml may also be used [Bug 1565112]
Add
router add portcommand [Bug 1546849]
Add
router remove portcommand [Bug 1546849]
Add
router add subnetcommand [Bug 1546849]
Add
router remove subnetcommand [Bug 1546849]
Add
subnet setcommand. [Bug 1542363]
Upgrade Notes¶
The
ip floating createcommand now uses Network v2 when enabled [Bug 1519502]
The
security group rule createcommand now uses Network v2 when enabled which results in a more detailed output for network security group rules that matches thesecurity group rule showcommand. [Bug 1519512]
Deprecate global option
--profilein favor of--os-profile.--profileinterferes with existing command options with the same name. Unfortunately it appeared in a release so we must follow the deprecation process and wait one year (April 2017) before removing it.[Bug 1571812]
Bug Fixes¶
The
security group createcommand now uses Network v2 when enabled which allows the security group description to be created with an empty value. In addition, thetenant_idfield changed toproject_idto match thesecurity group showcommand output. [Bug 1519511]
The
security group rule listcommand no longer ignores thegroupargument when it is set to an empty value. [Bug 1519512]
Fixed
openstack command listto display properly [Bug 1545609]
Fixed SSL/TLS verification for Network v2 commands. The commands were ignoring the
--insecureand--os-cacertoptions and theOS_CACERTenvironment variable which caused them to fail withAn SSL error occurred.when authenticating using SSL/TLS. [Bug 1560157]
Fixed
subnet pool listcommand to properly disply the list of subnet pool prefixes in thePrefixescolumn. This fix is consistent with thesubnet pool createandsubnet pool showcommand output. [Bug 1569480]
Make
--nameoptional involume snapshot createandvolume backup createcommands.