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 whenhelp
or--help
was used. [Bug 1650026]
3.2.1¶
Security Issues¶
Mask passwords when
--debug
or-vv
options 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_endpoint
that 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 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 commandsbackup create/delete/list/show/restore
. [Blueprint backup-snapshot-renamed-for-volume-resource]
Add
network agent delete
,network agent list
,network agent show
andnetwork agent set
commands. [Blueprint implement-network-agents]
Support bulk deletion and error handling for
aggregate delete
,flavor delete
,keypair delete
andservice delete
commands. [Blueprint multi-argument-compute]
Support bulk deletion for
subnet pool delete
,subnet delete
,floating ip delete
,security group delete
andsecurity group rule delete
. [Blueprint multi-argument-network]
Update
--binding-profile
option on theport create
andport set
commands to support JSON input for more advanced binding profile data. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client]
Add
--enable-port-security
and--disable-port-security
options on thenetwork create
andnetwork set
commands. This supports setting the default port security for ports created on a network. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client]
Add
geneve
choice to thenetwork create
command--provider-network-type
option. [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-client]
Add
--device-owner
option to theport list
command 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 delete
andnetwork rbac set
commands. [Blueprint neutron-client-rbac]
Add
--network-segment
option to thesubnet 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 tovolume 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 v2compute 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
andservice
. [Bug 1592906]
Support bulk deletion for
volume type delete
. [Bug 1592906]
Add
--force
option tobackup create
command to allow users to back up an in-use volume. [Bug 1596443]
Add
--property
option toflavor create
command. [Bug 1596798]
Add
--force
option tovolume qos delete
command to allow users to delete in-use QoS specification(s). [Bug 1596821]
Add
--snapshot
option tobackup create
command. [Bug 1597184]
Add
--force
option tobackup delete
command to allow delete in state other than error or available. [Bug 1597188]
Add
--property
option tosnapshot create
command. [Bug 1597192]
Add
--public
and--private
options tovolume type list
command. [Bug 1597198]
Add
--incremental
option tobackup create
command to allow users to create incremental backups. [Bug 1600196]
Add
--project
and--project-domain
options tovolume type create
command. [Bug 1602169]
Support to get server
rdp
,serial
,mks
type console url. [Bug 1605088]
Add
--limit
and--marker
options tosnapshot list
command. [Bug 1605475]
Deprecate
role list
arguments in favor ofrole 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 “Checksum” column to output of “image list –long” [Bug 1602073]
Add
--project
and--project-domain
options to theflavor 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 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 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
andunset
commands now return normally when nothing specified to modify. This will become the default behavior of OSCset
andunset
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 forvolume 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
oruser 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 typekey=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]
2.6.0¶
New Features¶
Add
server backup create
command
Add
network segment list
andnetwork segment show
commands. These are beta commands and subject to change. Use global option--os-beta-command
to enable these commands. [Blueprint routed-networks]
Add
volume transfer request list
command [Bug 1554886]
Add
--project
option toflavor set
command to set project access to a flavor [Bug 1575461]
Add
--project
option toflavor unset
command to remove project access to a flavor [Bug 1575461]
Add
image unset
command [Bug 1582968]
Add
ip availability list
andip availability show
commands [Blueprint https://blueprints.launchpad.net/python-openstackclient/+spec/neutron-ip-capacity]
Add
--state
option toserver set
command to set the server to active or error state. [Blueprint server-reset-state]
Upgrade Notes¶
address scope delete
command now accepts multiple address scopes in a single command
compute agent delete
command now supports deleting multiple agents in a single command
An exception is not raised by command
service set
when nothing specified. Instead, the service is not enabled by default. And if--disable-resion
is specified but not--disable
, an exception will be raised.
Bug Fixes¶
Fix the
--enable
option on all commands by changing the--enable-beta-commands
global 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 set
command. Options added includes--networks --subnets --subnetpools --ports --routers --rbac-policies
--vips --members --health-monitors
. Options--floating-ips --secgroup-rules --secgroups
now support both network and compute API. [Bug 1489441]
Add
--icmp-type
and--icmp-code
options to thesecurity group rule create
command 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 create
command--protocol
option,ah
,dccp
,egp
,esp
,gre
,igmp
,ipv6-encap
,ipv6-frag
,ipv6-icmp
,ipv6-nonxt
,ipv6-opts
,ipv6-route
,ospf
,pgm
,rsvp
,sctp
,udplite
,vrrp
and integer representations [0-255]. [Bug 1519512]
The
security group rule list
command 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 show
commands. [Bug 1542171] [Blueprint nova-server-group-support]
Add
--share
and--default
options tosubnet pool create
and--default
option tosubnet pool set
[Bug 1544586] [Bug 1544591]
Add
--transparent-vlan
and--no-transparent-vlan
options tonetwork create
andnetwork set
commands to add/remove VLAN transparency attributes from networks. This option is available in Network V2 only. [Bug 1545537]
Adds
volume service list
command. [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 set
andaddress scope show
commands. [Bug 1566269]
Add the
--ip-version
option to thesubnet list
command. This will output subnets based on IP version filter. [Bug 1581179]
Upgrade Notes¶
Changed the
security group rule create
command--proto
option to--protocol
. Using the--proto
option is still supported, but is no longer documented and may be deprecated in a future release. [Bug 1519512]
Bug Fixes¶
Support a new
--state
option forsnapshot set
command that changes the state of a snapshot. [Bug 1535239]
--pool-prefix
option made required forsubnet pool create
[Bug 1536479]
Command
network delete
will delete as many networks as possible, log and report failures in the end. [Bug 1556719] [Bug 1537856]
Fixed the
--route
option on therouter set
command which did not properly format the new routes to set resulting in aBad Request
error. In addition, therouter create
,router list
androuter show
command output for routes was fixed to improve readability and to align with the--route
option on therouter set
command. [Bug 1564460]
Added
--no-route
to therouter set
command. Deprecated--clear-routes
. [Bug 1565034]
Fixed
network create
,network show
andnetwork list
commands to correctly display the router type in therouter:external
andRouter Type
columns. [Bug 1572228]
The
quota show
command<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/unset
command to properly find a private flavor by flavor name. [Bug 1575478]
Fixed
flavor set/unset
command to properly find a flavor to be set/unset by flavor id. [Bug 1575624]
2.4.0¶
New Features¶
Add
--disable-reason
option to theservice set
command
Add
port create
,port list
andport set
commands [Bug 1519909]
Add
server restore
command
The
security group create
,security group set
andsecurity group show
commands now uses Network v2 when enabled which results in a more detailed output for network security group rules. [Bug 1519511]
Add
--project
and--project-domain
options to thesecurity group create
command for Network v2. [Bug 1519511]
Add
--ingress
,--egress
,--ethertype
,--project
and--project-domain
options to thesecurity group rule create
command for Network v2 only. These options enableegress
andIPv6
security group rules along with setting the project. [Bug 1519512]
The
security group rule list
command now uses Network v2 when enabled which results inegress
security group rules being displayed. The--long
option was also added for Network v2 to display direction and ethertype information. In addition, security group rules for all projects will be displayed when thegroup
argument is not specified (admin only). This is done by default when using Network v2, but requires the new--all-projects
option when using Compute v2. [Bug 1519512]
The
security group rule create
command now supports a security group name for the--src-group
option. [Bug 1540656]
Add
subnet create
command. [Bug 1542364]
Add provider network options
--provider-network-type
,--provider-physical-network
and--provider-segment
to thenetwork create
andnetwork set
commands. These options are available for NetworkV2 only. [Bug 1545537]
Add external network options
--external|--internal
and--external
suboptions--default|--no-default
to thenetwork create
andnetwork set
commands. These options are available for Network version 2 only. [Bug 1545537]
Add
--image-property
option tovolume set
andvolume unset
commandsImage 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
--project
and--project-domain
options tovolume type set
andvolume type unset
commandsUse the
--project
option to restrict a volume type to a specific project. Volume types are public by default, restricted volume types should be made private with the--private
option to thevolume create
command.
Add
host set
command [Bug 1556929]
Add
aggregate unset
command [Bug 1559866]
Add global options
os-cert
and--os-key
to support client certificate/key. Environment variablesOS_CERT
andOS_KEY
, as well as thecert
andkey
values in clouds.yaml may also be used [Bug 1565112]
Add
router add port
command [Bug 1546849]
Add
router remove port
command [Bug 1546849]
Add
router add subnet
command [Bug 1546849]
Add
router remove subnet
command [Bug 1546849]
Add
subnet set
command. [Bug 1542363]
Upgrade Notes¶
The
ip floating create
command now uses Network v2 when enabled [Bug 1519502]
The
security group rule create
command now uses Network v2 when enabled which results in a more detailed output for network security group rules that matches thesecurity group rule show
command. [Bug 1519512]
Deprecate global option
--profile
in favor of--os-profile
.--profile
interferes 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 create
command now uses Network v2 when enabled which allows the security group description to be created with an empty value. In addition, thetenant_id
field changed toproject_id
to match thesecurity group show
command output. [Bug 1519511]
The
security group rule list
command no longer ignores thegroup
argument when it is set to an empty value. [Bug 1519512]
Fixed
openstack command list
to display properly [Bug 1545609]
Fixed SSL/TLS verification for Network v2 commands. The commands were ignoring the
--insecure
and--os-cacert
options and theOS_CACERT
environment variable which caused them to fail withAn SSL error occurred.
when authenticating using SSL/TLS. [Bug 1560157]
Fixed
subnet pool list
command to properly disply the list of subnet pool prefixes in thePrefixes
column. This fix is consistent with thesubnet pool create
andsubnet pool show
command output. [Bug 1569480]
Make
--name
optional involume snapshot create
andvolume backup create
commands.