././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9781103 python_openstackclient-8.1.1.dev14/0000775000175100017510000000000015033046512016341 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/.coveragerc0000664000175100017510000000015315033046464020467 0ustar00mylesmyles[run] branch = True source = openstackclient omit = openstackclient/tests/* [report] ignore_errors = True ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/.git-blame-ignore-revs0000664000175100017510000000160615033046464022452 0ustar00mylesmyles# You can configure git to automatically use this file with the following config: # git config --global blame.ignoreRevsFile .git-blame-ignore-revs c5b772db76c071e493a81105c7d8c0def08b2264 # trivial: Prepare for pyupgrade pre-commit hook ed0314ac76ae58a6621077feb742efd5c14c3a62 # Blacken everything else ac64fdb93c32972575a4523ccb23d0279ef584f5 # Blacken openstackclient.api a3778109d0051a25901569e7bafe54915ab25f82 # Blacken openstack.common 53476e1f73d8af172207ac7089fb85fc0221859f # Blacken openstackclient.image c51e4ef1bc350905a04690eb019d53e68fe3d633 # Blacken openstackclient.object af6ea07703ed1c12b86995b97a9618bfa70721ee # Blacken openstackclient.identity 1face4f48b07fbc51824980e989687adaf453f0e # Blacken openstackclient.network 1ca77acc9118b433c14e03bf9fd28f2b1639c430 # Blacken openstackclient.volume 4bbf3bd3846cb3d85e243199910de82df25d35e0 # Blacken openstackclient.compute ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/.mailmap0000664000175100017510000000014315033046464017766 0ustar00mylesmyles ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/.pre-commit-config.yaml0000664000175100017510000000214415033046464022631 0ustar00mylesmyles--- repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v5.0.0 hooks: - id: trailing-whitespace - id: mixed-line-ending args: ['--fix', 'lf'] exclude: '.*\.(svg)$' - id: check-byte-order-marker - id: check-executables-have-shebangs - id: check-merge-conflict - id: debug-statements - id: check-yaml files: .*\.(yaml|yml)$ args: ['--unsafe'] - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.11.8 hooks: - id: ruff args: ['--fix', '--unsafe-fixes'] - id: ruff-format - repo: https://opendev.org/openstack/hacking rev: 7.0.0 hooks: - id: hacking additional_dependencies: [] exclude: '^(doc|releasenotes)/.*$' - repo: https://github.com/pre-commit/mirrors-mypy rev: v1.15.0 hooks: - id: mypy additional_dependencies: - types-requests # keep this in-sync with '[mypy] exclude' in 'setup.cfg' exclude: | (?x)( doc/.* | examples/.* | releasenotes/.* ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/.stestr.conf0000664000175100017510000000014515033046464020620 0ustar00mylesmyles[DEFAULT] test_path=${OS_TEST_PATH:-./openstackclient/tests/unit} top_dir=./ group_regex=([^\.]+\.)+ ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/.zuul.yaml0000664000175100017510000001320015033046464020304 0ustar00mylesmyles--- - job: name: osc-tox-unit-tips parent: openstack-tox description: | Run unit tests for OpenStackClient with master branch of important libs. Takes advantage of the base tox job's install-siblings feature. irrelevant-files: &common-irrelevant-files - ^.*\.rst$ - ^doc/.*$ - ^releasenotes/.*$ - ^\.pre-commit-config\.yaml$ required-projects: - openstack/cliff - openstack/keystoneauth - openstack/openstacksdk - openstack/osc-lib - openstack/python-openstackclient vars: # Set work dir to openstackclient so that if it's triggered by one of the # other repos the tests will run in the same place zuul_work_dir: src/opendev.org/openstack/python-openstackclient - job: name: osc-tox-py310-tips parent: openstack-tox-py310 description: | Run unit tests for OpenStackClient with master branch of important libs. Takes advantage of the base tox job's install-siblings feature. # The job only tests the latest and shouldn't be run on the stable branches branches: ^master$ required-projects: - openstack/cliff - openstack/keystoneauth - openstack/openstacksdk - openstack/osc-lib - openstack/python-openstackclient vars: # Set work dir to openstackclient so that if it's triggered by one of the # other repos the tests will run in the same place zuul_work_dir: src/opendev.org/openstack/python-openstackclient - job: name: osc-tox-py313-tips parent: openstack-tox-py313 description: | Run unit tests for OpenStackClient with master branch of important libs. Takes advantage of the base tox job's install-siblings feature. # The job only tests the latest and shouldn't be run on the stable branches branches: ^master$ required-projects: - openstack/cliff - openstack/keystoneauth - openstack/openstacksdk - openstack/osc-lib - openstack/python-openstackclient vars: # Set work dir to openstackclient so that if it's triggered by one of the # other repos the tests will run in the same place zuul_work_dir: src/opendev.org/openstack/python-openstackclient - job: name: osc-functional-devstack parent: devstack-tox-functional description: | Run functional tests for OpenStackClient. timeout: 7800 irrelevant-files: - ^.*\.rst$ - ^doc/.*$ - ^releasenotes/.*$ required-projects: - openstack/python-openstackclient vars: devstack_localrc: LIBS_FROM_GIT: python-openstackclient # NOTE(dtroyer): Functional tests need a bit more volume headroom VOLUME_BACKING_FILE_SIZE: 20G Q_AGENT: openvswitch Q_ML2_TENANT_NETWORK_TYPE: vxlan Q_ML2_PLUGIN_MECHANISM_DRIVERS: openvswitch devstack_plugins: # NOTE(amotoki): Some neutron features are enabled by devstack plugin neutron: https://opendev.org/openstack/neutron devstack_services: s-account: true s-container: true s-object: true s-proxy: true # Disable OVN services br-ex-tcpdump: false br-int-flows: false ovn-controller: false ovn-northd: false ovs-vswitchd: false ovsdb-server: false q-ovn-metadata-agent: false # Neutron services q-agt: true q-dhcp: true q-l3: true q-meta: true neutron-network-segment-range: true neutron-segments: true q-metering: true q-qos: true neutron-tag-ports-during-bulk-creation: true neutron-conntrack-helper: true neutron-ndp-proxy: true q-trunk: true osc_environment: PYTHONUNBUFFERED: 'true' OS_CLOUD: devstack-admin tox_envlist: functional zuul_work_dir: src/opendev.org/openstack/python-openstackclient - job: name: osc-functional-devstack-tips parent: osc-functional-devstack description: | Run functional tests for OpenStackClient with master branch of important libs. Takes advantage of the base tox job's install-siblings feature. timeout: 7800 required-projects: - openstack/cliff - openstack/keystoneauth - openstack/openstacksdk - openstack/osc-lib - openstack/python-openstackclient vars: devstack_localrc: LIBS_FROM_GIT: python-openstackclient,openstacksdk,osc-lib,cliff tox_envlist: functional tox_install_siblings: true - job: name: osc-build-image parent: opendev-build-docker-image description: Build Docker images. allowed-projects: openstack/python-openstackclient requires: - python-builder-3.11-bookworm-container-image - python-base-3.11-bookworm-container-image provides: osc-container-image vars: docker_images: - context: . tags: [] - project-template: name: osc-tox-unit-tips check: jobs: - osc-tox-py310-tips - osc-tox-py313-tips gate: jobs: - osc-tox-py310-tips - osc-tox-py313-tips - project: templates: - openstackclient-plugin-jobs - osc-tox-unit-tips - openstack-cover-jobs - openstack-python3-jobs - publish-openstack-docs-pti - check-requirements - release-notes-jobs-python3 check: jobs: - osc-build-image: voting: false - osc-functional-devstack - osc-functional-devstack-tips: # The functional-tips job only tests the latest and shouldn't be run # on the stable branches branches: ^master$ gate: jobs: - osc-functional-devstack ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928117.0 python_openstackclient-8.1.1.dev14/AUTHORS0000664000175100017510000005301215033046465017421 0ustar00mylesmyles0weng Aaron Rosen Abhishek Chanda Abhishek Raut Adam Harwell Adam Spiers Adriano Fialho Akihiro Motoki Akihiro Motoki Alan Bishop Alessandro Pilotti Alessio Ababilov Alessio Ababilov Alex Gaynor Alex Holden Alex Katz Alex Schultz Alexander Gräb Alexander Ignatov Alfredo Moralejo Allain Legacy Alvaro Lopez Garcia Amey Bhide Andreas Florath Andreas Jaeger Andreas Jaeger Andrey Kurilin Andrey Larionov Anh Tran Anindita Das Anita Kuno Ankur Gupta Anne Gentle Anton Frolov Antonia Gaete Aradhana Singh Areg Grigoryan Ariel-Berkowicz Artem Goncharov Artem Goncharov ArtofBugs Artom Lifshitz Asha Saravanamohan Ashish Singh Atsushi SAKAI Badhmapriya Boopalan Ben Andrews Bence Romsics Bence Romsics Benoît Knecht Bernard Cafarelli Bharat Kunwar Bhuvan Arumugam Bin Zhou Boris Bobrov Boris Pavlovic Brad Behle Bram Verschueren Brandon Palm Brian Haley Brian Haley Brian Haley Brian Rosmaita Brian Rosmaita Brianna Poulos Cao Xuan Hoang Carl Baldwin Carlos Goncalves Carlos Konstanski Cedric Brandily Chaemin-Lim Chaozhe.Chen Chen Chen Hanxiao Chengen Du Choe, Cheng-Dae Chris Johnson Christian Berendt Christian Rohmann Christian Schneemann Chuck Short Clark Boylan Colleen Murphy Colleen Murphy Colleen Murphy Colleen Murphy Colleen Murphy Corey Bryant Cyril Roelandt Cyril Roelandt Dag Stenstad Daisuke Fujita Daniel Bengtsson Daniel Gonzalez Daniel Speichert Daniel Speichert Daniel Strong Daniel Wilson Dao Cong Tien Davanum Srinivas Dave Chen David Caro David Moreau Simard David Moreau Simard David Rabel David Rosales Dean Troyer Dina Belova Dirk Mueller Diwei Zhu Dmitrii Shcherbakov Dmitriy Chubinidze Dmitriy Rabotyagov Dmitriy Rabotyagov Dmitry Tantsur Dolph Mathews Dongcan Ye Doug Goldstein Doug Hellmann Doug Hellmann Doug Wiegley Dougal Matthews Douglas Mendizábal Douglas Viroel Dr. Jens Harbott Einst Crazy Elena Ezhova Elod Illes Emilien Macchi Eric Brown Eric Fried Fan Zhang Fang Zhen Fei Long Wang Felix Yan Fernando Royo Flavio Percoco Florent Flament Florian Streibelt Frode Nordahl Gabriel Ramirez Gage Hugo Gary Kotton Georgina Shippey Ghanshyam Mann Ghe Rivero Gilles Dubreuil Glenn Van de Water Guang Yee Guang Yee Guojian Shao Guoqiang Ding Gábor Antal Ha Van Tu Hang Yang Hangdong Zhang Harald Jensas Harry Rybacki Harsh Mutha He Jie Xu Henry Nash Hidekazu Nakamura Hideki Saito Hieu LE Hironori Shiina Hong Hui Xiao Hongbin Lu Hongbin Lu Honza Pokorny Huan Xiong Huang Cheng Huanxuan Ao Huda Irshad Hugh Saunders Ian Wienand Igor Malinovskiy Igor_Bolotin Igor_Bolotin Ilya Persky Ilya Popov Imtiaz Chowdhury Inessa Vasilevskaya Iswarya_Vakati Ivan Anfimov Ivan Kolodyazhny JAE YONG LEE JIHOJU JP Parkin Jackie Yuan Jadon Naas Jake Yip Jake Yip James Black James Denton James E. Blair James E. Blair Jamie Lennox Jan Gutter Jan Hartkopf Jan Ueberacker Jas Jaspreet Singh Rawel Javier Pena Jean-Philippe Evrard Jens Harbott (frickler) Jens Harbott Jens Rosenboom Jeremy Houser Jeremy Liu Jeremy Stanley Jerry George Jieon Lee JieonLee Jim Rollenhagen Jimmy McCrory JingLiu Jipyo Hong Jirayut Nimsaeng Jiri Podivin Joe Gordon Joe Wigglesworth Joel Capitao Johannes Kulik John Dennis John Keenleyside Jordan Pittier Jose Castro Leon Josephine Seifert Josh Kearney Joshua Harlow Juan Antonio Osorio Robles Jude Cross Jude Job Julie Pichon Julien Danjou Justin A Wilson KATO Tomoyuki Kailun Qin KeithMnemonic Kelvin Lui Ken Thomas Kendall Nelson Kenneth Chu Kevin_Zheng Khomesh Thakre Kristi Nikolla Kyrylo Romanenko LEE JAE YONG LIU Yulong Lajos Katona Lance Bragstad Lee Yarwood Lewis Denny Lin Yang Lingxian Kong LiuNanke Lorin Hochstein Lu lei Léo GEORGEL M V P Nitesh Maari Tamm Madhu Mohan Nelemane Major Hayden Maksim Malchuk Manjeet Singh Bhatia Manuel Silveyra Marc Abramowitz Marco Fargetta Marcos Fermin Lobo Marek Aufart Marek Denis Mark Vanderwiel Martin Chlumsky Martin Schuppert Masayoshi Mizuma Masayuki Igawa Matt Fischer Matt Joyce Matt Riedemann Matt Riedemann Matthew Treinish Matthieu Huin Michael Gugino Michael Johnson Michael McCune Michael Still Miguel Lavalle Miguel Lavalle Mike Fedosin Mikhail Feoktistov Min Min Ren Mohammed Al-Dokimi Mohammed Naser Mohan Muppidi Monty Taylor Mouad Benchchaoui Mridula Joshi Myeongchul Chae Nakul Dahiwade Nam Nguyen Hoai Natal Ngétal Nate Johnston Nathan Kinder Navid Pustchi Nguyen Phuong An Nguyen Van Duc NiallBunting NiallBunting Nicolas Belouin Nicolas Simonds Nikita Gerasimov Nir Magnezi Noam Angel Nobuto Murata Noorul Islam K M Nurmatov Mamatisa Oleksii Chuprykov Ondřej Nový OpenStack Release Bot Paul Belanger Paul Bourke Pavlo Shchelokovskyy Pedro Martins Pedro Navarro Pete Zaitcev Petr Blaho Pierre Hanselmann Pierre Prinetti Pierre Riteau Przemyslaw Szczerbik Qiu Yu Radoslaw Smigielski Radosław Piliszek Radu Mateescu Rafael Weingärtner Rajasi Kulkarni Rajat Dhasmana Rajesh Tailor Ramaraja Ramaraja Ramachandran Reedip Reedip René Ribaud Richard Theis Rikimaru Honjo Ritvik Vinodkumar Robert Francis Robin Cernin Rodolfo Alonso Hernandez Rodolfo Alonso Hernandez Rodrigo Duarte Rodrigo Duarte Sousa Rodrigo Duarte Sousa Roger Luethi Roxana Gherle Ruby Loo Rudolf Vriend Rui Chen Rui Yuan Dou Rushi Agrawal Ryan Selden SaiKiran Sam Morrison SamYaple Sami MAKKI Samuel Pilla Samuel de Medeiros Queiroz Samuel de Medeiros Queiroz Sascha Peilicke Sascha Peilicke Sean Dague Sean McGinnis Sean Mooney Sean Perry Sean Perry Shane Wang Shashank Kumar Shankar Sheel Rana Shogo Saito ShogoAdachi Shu Yingya Simon Merrick Sindhu Devale Sirushti Murugesan Slawek Kaplonski Snow Kim SongmingYan Stephen Finucane Stephen Finucane Stephen Finucane Stephen Finucane Steve Martinelli Steve Martinelli Steven Hardy Stuart McLaren Surya Seetharaman Sven Wegener Swapnil Kulkarni (coolsvap) Sylvain Bauza Sławek Kapłoński Takashi Kajinami Takashi Kajinami Takashi Natsume Tang Chen Tang Chen Telles Nobrega Terry Howe Terry Howe TerryHowe Thobias Salazar Trevisan Thomas Goirand Thrivikram Mudunuri Tim Bishop Tim Burke Tobias Urdin Tom Cocozzello Tom Jose Kalapura Tom Stappaerts Tony Breeds Tovin Seven Travis Tripp Trevor McCasland Tuan Do Anh Tytus Kurek Ukesh Kumar Vasudevan Valery Tschopp Vasyl Saienko Victor Silva Vijendra Soni Vincent Legoll Violet Kurtz Violet Kurtz Vishakha Agarwal Vladimir Eremin Vladimir Kozhukalov Vu Cong Tuan Wenran Xiao Wenzhi Yu Witold Bedyk Xi Yang Xiaoyang Zhang YAMAMOTO Takashi Yan Xing'an Yang Hongyang Yang JianFeng Yang Youseok Yejia Xu Yi Zhao Yongli He YoonSoo LIM Yoonsoo Lim Yosef Salmalian Youngjun YuehuiLei Yunpeng Li Zane Bitter ZhaoBo Zhaokun Fu Zhenguo Niu ZhongShengping Zhou Zhihong adrian-turjak asarfaty blue55 caoyuan chengkunye chenxing chenying choidoa-git cw0306-lee daizhiyong devMuscle djp dongwenshuai elajkat gecong1973 gengchc2 gtema guang-yee guangpei.liu guiyanxing gvrangan hackertron heesom heha henriquetruta hongp hoosa huangshan huangtianhua jay jeckxie ji-xuepeng jiahui.qiang jiangpch jiaxi jichenjc jqjiang.1@gmail.com judy-yu kafka licanwei lihaijing likui lin-hua-cheng lingyongxu liujunpeng liusheng liuyamin liyifeng <307419146@qq.com> liyingjun lrqrun lsmman lvjiawei lvxianguo maaoyu matbu mb711d melanie witt melissaml mpicea nidhimittalhada niuke npraveen35 ohjiwoo okozachenko pedh pedro pengyuesheng phil-hopkins-a qinchunhua qingszhao qtang rabi reedip rladntjr4 root ryanKor sharat.sharma shizhihui songminglong songwenping sonu.kumar sujin01 suneethravi sunjia sunyajing tanlin tengqm tianhui timothy-symanczyk ting wang ting.wang venkata anil venkatamahesh waf wanghong wangxiyuan wangzihao whoami-rajat wingwj wu.chunyang wu.chunyang wu.shiming wuyuting xfrnk2 xiexs yaeeee yang wang yangweiwei yangxi yanpuqing ycx yfzhao youngho choi <0505zxc@gmail.com> yushangbin zeze zhang.lei zhang.xiuhua zhangbailin zhangboye zhanghongtao zhangoic zheng yin zhengsenyan zhiyong.dai zhiyuan_cai zhouhenglc zhouqi zhu.boxiang zhufl zhurong Édouard Thuleau ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/CONTRIBUTING.rst0000664000175100017510000000153415033046464021013 0ustar00mylesmylesThe source repository for this project can be found at: https://opendev.org/openstack/python-openstackclient Pull requests submitted through GitHub are not monitored. To start contributing to OpenStack, follow the steps in the contribution guide to set up and use Gerrit: https://docs.openstack.org/contributors/code-and-documentation/quick-start.html Bugs should be filed on Launchpad: https://bugs.launchpad.net/python-openstackclient Developers should also join the discussion on the mailing list, at: https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/ or join the IRC channel on #openstack-sdks on OFTC (irc.oftc.net) For more specific information about contributing to this repository, see the openstacksdk contributor guide: https://docs.openstack.org/openstacksdk/latest/contributor/index.html ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928117.0 python_openstackclient-8.1.1.dev14/ChangeLog0000664000175100017510000046367215033046465020144 0ustar00mylesmylesCHANGES ======= * Add metadata as a filter condition when listing volumes * Remove duplicate Python version declarations * Migrate setup configuration to pyproject.toml * Replace deprecated datetime.utcfromtimestamp * Fix openstack image import --method web-download --uri 'invalid value' * Security-groups: Temporarily ignore is\_shared * identity: Remove unnecessary helper * bug fix volume group show command 8.1.0 ----- * evacuate: respect original SHUTOFF state in --wait completion * Fix missing 'options' field in 'user show' command * Identity: Migrate 'group' commands to SDK * tests: Simplify mocking in image tests * identity: Normalise output of application credentials commands * network: Allow multiple FIP filter opts * volume: Migrate 'volume delete' to SDK * volume: Temporarily ignore new volume columns * volume: Split v2, v3 create, delete commands * volume: Migrate 'snapshot show', 'snapshot list' to SDK * volume: Migrate 'snapshot set', 'snapshot unset' to SDK * volume: Migrate 'snapshot create' to SDK * volume: Migrate 'snapshot delete' to SDK * volume: Add v3-specific volume snapshot module * tests: Use SDK mocks for SDK-based commands * volume: Migrate 'backup set', 'backup unset' to SDK * volume: Migrate 'service \*' to SDK * volume: Add v3-specific volume service module * volume: Migrate 'block storage log level \*' to SDK * Add a column to all\_projects tag of server list cmd * Fix incorrect warning with --password-prompt option * compute: Fix key used for NIC fixed IP field * identity: Add missing user argument * identity: Fix listing of applications credentials by user * Bump Python version used for linters to 3.10 * Drop support for Python 3.9 * Add support for spice-direct console types * Update README * Add labels to Dockerfile * Update the docker image to python3.12 * zuul: Remove osc-upload-image, osc-promote-image jobs * tests: Stop returning FakeResource in compute tests * tests: Remove sdk prefix * tests: Remove dead code * tests: Remove use of legacy resource helpers * Require confirmation to reset server state * Fix 'openstack keypair list --project ' * Don't warn about unsupported version with SDK-based commands * Workaround for failing tests on openstacksdk change * Add support for showing scheduler\_hints in server details * Refactor network fakes to sdk properties PART6 * Refactor network fakes to sdk properties PART 5 * volume: Make better use of argparse * image: Migrate 'create image' volume calls to SDK 8.0.0 ----- * tests: Rename 'compute\_sdk\_client' -> 'compute\_client' * compute: Migrate to 'compute' client alias * Remove use of formatter function * Imported Translations from Zanata * Remove use of formatter function * Prepare for osc-lib changes * pre-commit: Enable mypy * typing: Indicate another tuple to be extended * docs: Remove irrelevant TODO * volume: Remove Cinder v1 support * docs: Migrate remaining block storage commands to autocommand * Remove contributor specs * Permit use of tuple API\_VERSIONS * identity: Migrate 'endpoint' commands to SDK * typing: Resolve incompatible operand issues * typing: Correct type for missing attributes * typing: Remove use of optional imports * typing: Use consistent types * typing: Add types for empty dicts, tuples * typing: Indicate tuples to be extended * pre-commit: Bump versions * Fix neutron typos and formatting * Return the \`\`port\`\` column headers expected in the list command * Add filters to search for enabled/disabled users and projects * [Neutron] Add "qos-policy" parameter to router creation command * Fix networking quota usage show * Replace description-content-type by its underscore name * Specifying project-domain for project * zuul: Make image job non-voting * Remove tags from README * Prepare for ruff bump * Update master for stable/2025.1 * Add libpcre3-dev in bindep.txt for pcre.h * Fix image import --disallow-failure flag * identity: Fix 'trust' commands to work with SDK * Fix missing space in help messages 7.4.0 ----- * Fix credential creation * Add four new network agent types to the list command filter 7.3.1 ----- * [Neutron] Fix the "port show" command for trunk details * [Neutron] Support \`\`uplink-status-propagation-updatable\`\` extension * handle 'router create --flavor' option * [Neutron] "uplink-status-propagation" enabled by default 7.3.0 ----- * Add "qinq-vlan" and "no-qinq-vlan" params to the "network create" cmd * Temporary ignore "is\_vlan\_qinq" column in the output * Identity: Deprecate \`--region None\` in limits/registered limits * Update README for use python3 * Get "security\_groups" when port list * Show final image state after image create * Identity: Migrate 'role' commands to SDK * Add the trunk subports information to the port list command * Fix: Volume backup restore output * identity: Migrate 'trust' commands to SDK * tests: Stop setting attributes on class * Adopt sdk\_fakes for compute.test\_server\_volume * Adopt sdk\_fakes for compute.test\_server\_group * Adopt sdk\_fakes for compute.test\_hypervisor * Adopt sdk\_fakes for compute.test\_usage * Adopt sdk\_fakes for compute.test\_service * Adopt sdk\_fakes for compute.test\_keypair * Adopt sdk\_fakes for compute.test\_console * Adopt sdk\_fakes for compute.aggregate * identity: Migrate 'service provider' commands to SDK * quota: Catch correct exception type for Compute quotas * tests: Add functional test for adding, removing SGs * compute: Workaround bug #2089821 * Fix: extend in-use volumes check * network: Make better use of argparse * compute: Add server create --no-security-group option * Remove ceilometer service overrides * identity: Migrate 'domain' commands to SDK * identity: Migrate \`region\` commands to SDK * reno: Update master for unmaintained/2023.1 * identity: Migrate 'credential' commands to SDK * Replace deprecated datetime.utcnow() * requirements: Remove unused test deps * Skip tips jobs on pre-commit config update * common: Use correct argument for volume limits * Add "trusted" attribute to the "port" * Fix ignored --user-domain in role assignment list * Show Created At column for volume backups in v3 * remove project from network flavor profile 7.2.1 ----- * clientmanager: Check for 'block-storage' service type * Fix volume backup show by name 7.2.0 ----- * Always resolve domain id * identity: in \`service set\` command, don't pass the enable option when it is None * evacuate SDK actually uses admin\_pass param * identity: Don't pass unset options when creating user * Add status filtering options to port list * identity: Migrate 'access rule' commands to SDK * tests: Add functional test for access rules * evacuate: Fix password parameter name for SDK * Handle NotFoundException when listing floating IPs * pre-commit: Migrate pyupgrade to ruff * pre-commit: Migrate bandit to ruff * Removed the emit\_duplicated\_warning() funtion * compute: Fix --host in server list for new openstacksdk * Update master for stable/2024.2 7.1.0 ----- * pre-commit: Migrate from black to ruff format * trivial: Remove unnecessary trailing comma * pre-commit: Migrate from flake8 to ruff * pre-commit: Bump versions * identity: Use previous naming for 'service show' fields * identity: Use previous naming for 'application credential show' fields * compute: Make 'hypervisor show' a bit faster * compute: Add 'uuid' column to aggregate list * compute: Only pass admin\_password on rebuild if set * quota: Allow 'quota set' to function without volume service 7.0.0 ----- * Bump requests minimal version * Respect --skip-resource when deleting * Add callback on plugin load failure * Drop support for Python 3.8 * Add Python 3.12 classifier * tests: Remove aliasing from extensions test * Remove TestServer base class * Remove python-novaclient * compute: Allow adding, removing multiple SGs * quota: Migrate 'quota \*' to SDK * quota: Split up 'quota list' command * quota: Default network quotas to not force * quota: Add 'quota set --default' option * quota: Remove deprecated quota options * quota: Move nova-network-related quota * tests: Remove references to novaclient methods * network: Replace use of in-tree API client * compute: Migrate 'server create' to SDK * identity: Migrate 'application credential' commands to SDK * identity: Migrate 'service' commands to SDK * compute: Prevent use of conflicting v\*-fixed-ip for 'server create --nic' * compute: Migrate 'server evacuate' to SDK * compute: Migrate remaining server actions to SDK * compute: Migrate 'server rebuild' to SDK * compute: Avoid third API call during 'server show' * compute: Always use SDK client to display server * compute: Migrate 'server set', 'server unset' commands * compute: Migrate 'server migrate' to SDK * compute: Migrate 'server add/remove security group' to SDK * common: Migrate 'limits show' to SDK * volume: Migrate 'volume list' to compute SDK * volume: Migrate 'volume attachment \*' to SDK * tests: Migrate to 'set\_xxx\_api\_version' helpers * tests: Add ability to configure fake server API version * volume: Add v3-specific volume transfer module * volume: add v3-specific volume type module * volume: Add v3-specific volume module * volume: Add v3-specific volume backup module * docs: Remove references to novaclient * compute: Migrate remaining tests to SDK objects * compute: Migrate 'host set' to SDK * compute: Migrate 'agent \*' to SDK * network: Migrate 'port list' to compute SDK * compute: Migrate tests for ShowServer to SDK objects * Fix: incremental volume backup * docs: Fix indentation * compute: Remove unnecessary try-except * Followup: Reduce LOC in volume v3 service * Add cluster to volume service list * Add tests for 'default security group rule create' * Add volume snapshot unmanage support * Add DeleteVolumeSnapshot class to v3 * Identity: Migrate 'role assignment' commands to SDK * tox: Add testenv descriptions * Add support for volume unmanage * Remove admin only text from 'port create' help text * Drop direct dependency on simplejson * Show Created At column for volume backups * Remove clients of retired projects * Add DeleteVolume class to v3 * Add support for managing volumes * Add CreateVolume class to v3 * Fix tests on Python 3.12 * identity: Make better use of argparse * Router flavor\_id can be a name * pre-commit: Add pyupgrade hook * reno: Update master for unmaintained/zed * tests: Fix trivial sorting issue * trivial: Prepare for pyupgrade pre-commit hook * tox: Remove bandit skips, run via pre-commit * tox: Add functional-pyNN jobs * pre-commit: Bump versions * Improve output of 'server migrate --wait' * Add image metadef resource type association commands 'create', 'list', 'delete' * tests: Remove use of unnecessary fake argparse Namespace * tests: Use consistent shortcut to fake identity client * Identity: Properly list users in a group in 'user list' commands * volume: Deprecate '--retype-policy' in favor of '--migration-policy' * Tox: Fix install commands for unit-tips and functional-tips * identity: Migrate 'user' commands to SDK * tests: Add identity v2, v3 FakeClientMixin * Update master for stable/2024.1 * image cache clear: fix value of default target * refectoring: remove duplicate declaration * Fix typo in the list of Glanceclient/OSC commands * refectory: remove unreachable code 6.6.0 ----- * reno: Update master for unmaintained/xena * reno: Update master for unmaintained/wallaby * reno: Update master for unmaintained/victoria * Add router default route BFD/ECMP options * Add support for managing external gateways * router: Use plural form for storage of \`\`--fixed\_ip\`\` argument * Parse external-gateway argument in separate helper * Add NUMA affinity policy options "socket" * Bug Fix, Default SG Rule Custom SG * Adds CLI support for \`\`glance md-object-property-show\`\` * Do not sort subnet dns\_nameservers field * Adds CLI support for \`\`glance md-object-update\`\` * trivial: Don't ignore missing resources * reno: Update master for unmaintained/yoga * trivial: Fix typo 6.5.0 ----- * doc: magnumclient provides a OSC plugin * image: Trivial fixes * Introduce \`schema\_version\` in the federated attribute mapping API * Add "hardware\_offload\_type" attribute to "port" * Add support for showing requested az in output * pre-commit: Bump linter versions * doc: Add manilaclient as a OSC plugin * Revert "Temporarily drop aodhclient from doc build" * doc: Drop tripleoclient * doc: Remove RSD subcommand * doc: Remove Searchlight subcommands * Explicitly specify namespace fields for output * Update python classifier in setup.cfg * Correct error message for "create server --wait" * Fix --use-prefix-delegation subnet create argument * Adding CLI command for \`\`glance member-get\`\` * trivial: Place positional opts last * network: Clarify purpose of default sg rules * Doc: Fix volume snapshot commands * Fix availability zone list command * volume list: Don't call nova if no volume is attached 6.4.0 ----- * Fix clearing of dns\_domain and description on a network by setting to empty strings * tests: Handle missing extensions in network tests * tests: Check for DHCP agents first in DHCP test * [codespell] fix typos in doc,tests and help messages * Adds command \`\`image metadef object delete\`\` * test: Ignore 'OS\_' environment variables * parseactions: Use ArgumentError, not ArgumentTypeError * Remove unnecessary file * Use CommandError, not SystemExit, to exit * compute: Address bug in shelve offload logic * tests: Remove unused flag * tests: Enable logging fixture * tests: Remove prints * tests: Handle missing extensions in network tests * tests: Fix API extension check * tests: Centralise check for networking service * Adds command \`\`image metadef object list\`\` * image: Fix the default description of image visibility * Adds command \`\`image metadef object show\`\` * Add pagination helpers * compute: Add 'server create --server-group' option * Adds command \`\`image metadef object create\`\` * Update the docker image to python3.11 * Update from storyboard to launchpad pt. 2 * volume: Support same\_host, different\_host hint as list * Migrate resource filter commands to SDK * Removed start, end time format. Before fix, openstack usage list command resulted 'str' object has no attribute 'isoformat' error * trivial: Make better use of argparse * volume: Add alias for volume type AZs * volume: Add aliases for common volume type props * volume: Allow filtering volume types by properties * Switch back to Launchpad * Add support for default security group rule CRUDs * Add "image metadef property set" command * Add "image metadef property delete" command * Add "image metadef property create" command * Add "image metadef property show" command * Add "image metadef property list" command * Migrate volume backend commands to SDK * image: Add support for cache commands * tests: Add compute v2 FakeClientMixin * tests: Use consistent shortcut to fake compute client * tests: Add volume v1, v2, v3 FakeClientMixin * tests: Use consistent shortcut to fake volume client * tests: Use central SDK client fake * Update branch regexes for tips jobs * Add is\_incremental to ListVolumeBackup * Update master for stable/2023.2 * tests: Explicitly specify port fields for output * Remove use of oslo.utils * volume: Deprecate '--detailed' options 6.3.0 ----- * Propocol release versions properly * Fix ReleaseNotes build * tests: Add image v1, v2 FakeClientMixin * tests: Use consistent shortcut to fake image client * tests: Remove FakeImagev1Client, FakeImagev2Client * tests: Add network v2 FakeClientMixin * tests: Use consistent shortcut to fake network client * tests: Remove FakeNetworkV2Client * Remove project purge image commands * Migrate 'extension list' to SDK * Migrate 'availability zone list' to SDK * Fix "server create"command with --boot-from-volume * volume: Migrate 'volume group snapshot' commands to SDK * tox: Bump min\_version to 4.3.0 * Add --skip-resource option to project cleanup * Add the flavor-id option to router create * Migrate backup commands to SDK * Check the default role list before adding a new one * Adding image stores info command * Adding \`\`image delete --store\`\` and \`\`image import info\`\` commands * Add a warning for resizing servers booted from volumes * Update the underlying python containers to "3.10-bookworm" * docs: Add examples of common auth methods * doc: Split image command documentation * Add image metadef resource type command 'list' * Migrate 'volume summary' command to SDK * tests: Use a new project for quota tests * Allow multiple \`--remove-tag\` in \`project set\` * Fix "access rule" commands to only use ID * tox: Disable E501 * Neutron port hints * trivial: Remove duplicate definitions * Dropping the use of 'addFixedIp' server action * compute: Fix formatting of 'server show' * docs: Migrate volume commands to autoprogram-cliff * volume: Add 'volume qos set --no-property' option * volume: Make better use of argparse * volume: Add 'volume type set --private/--public' * compute: Fix bug with start/stop server * Allow server rebuild --wait for SHUTOFF servers * tests: Use SDK objects where expected * tests: Remove unnecessary nesting of compute resources * tests: Reorder compute fakes * Migrate 'volume revert' command to SDK * pre-commit: Enable black * Ignore black changes * Blacken everything else * Blacken openstackclient.api * Blacken openstack.common * Blacken openstackclient.image * Blacken openstackclient.object * Blacken openstackclient.identity * Blacken openstackclient.network * Blacken openstackclient.volume * Blacken openstackclient.compute * Use pre-commit for 'pep8' tox target, bump versions * Address pre-commit issues * compute: Generate SSH keypairs ourselves * Migrate 'server event \*' commands to SDK * Fix pep issue in the network service provider * Adding \`\`image import\`\` command * Silence warnings from openstacksdk * compute: Migrate 'reboot server' to SDK * Add an updated tips job running on py310 * Show Network QoS rules one per line * "hypervisor list --matching" showed the wrong result * Docs: Update glance command mapping * Fix --security-group for port list * Update master for stable/2023.1 6.2.0 ----- * Add missing documentation for state options for "image set" * zuul: Merge osc-functional-devstack-base into only child * Wait for volume being available to set bootable or readonly * doc: Update nova command mapping * Deprecate positional args for 'volume group create' 6.1.0 ----- * Add options to create volume group from source * Add block storage manageable list commands * Add block storage cleanup command * Add block storage log level {list, set} commands * Add volume revert command * Add auto-approve option to project cleanup * volume: Remove duplication from 'consistency group create' opts * Move network trunk commands from python-neutronclient * Add volume summary command * tests: Use fake SDK Migration object * Excluding test code from coverage reports * Drop default from ask\_user\_yesno question * Fix tox v4 compatibility * Add plugin doc page for cyborg * Update 'host list' and 'host show' command to use sdk * Remove unused helpers for legacy novaclient * Switch server shelve, unshelve to SDK * compute: Switch server restore to SDK * Remove unnecessary 'self.methods' * Switch server start, server stop to SDK * Switch server lock, unlock to sdk * compute: 'server volume update' -> 'server volume set' * Switch server volume update to sdk * Switch list server volume to sdk * Switch server dump create to using sdk * Finish switching server migration to sdk * Fix server list error with --long and -c options * Create a functional test case for hypervisor list and show * Fix functional-tips job * Migrate hypervisor stats commands to SDK * Fix really long help strings * Fix parameter handling in server add fixed ip cmd * Use the SDK for server show * Add qos rule type filtering * Add image metadef namespace command * Updating the glanceclient reference doc * docs: Fix typos * compute: Allow users to manually specify bootable volumes * tests: Add test for multiple blocks devices * image: Fail if we can't find an image * image: Rename import * image: Add support for additional image import methods * Revert "Don't look up project by id if given id" * Use the SDK in server migration list * docs: Document how we manage API versions * docs: Describe common actions found in OSC * Use the compute SDK in server list * tests: Convert network tests to use 'parse\_output' * tests: Convert compute tests to use 'parse\_output' * tests: Convert identity tests to use 'parse\_output' * tests: Convert volume tests to use 'parse\_output' * tests: Convert image tests to use 'parse\_output' * Adding volume backend commands to volume v3 * docs: Typo fix * docs: Small cleanup of human interface guide * Add test for creating volume from source * Change --size helptext to include backup * Add option to create volume from backup * Docstring fix for CreateVolumeAttachment class * Moved hypervisor to the SDK * image: Add 'image import' command * image: Add 'image stage' command * image: Simplify handling of data provided via stdin * image: Ignore '--progress' if providing image data from stdin * Add baremetal agent type list filtering * tests: Convert more functional tests to use 'parse\_output' * tests: Move json decoding to base test class * compute: Add missing microversion check for networks * compute: Fix '--network none/auto' handling * zuul: Remove nova-network tests * Add note about microversion 2.87 in server rescue help * compute: Add '--no-network', '--auto-network' flags * Improve \`server dump create\` helptext * Added "openstack image metadefs namespace list" command * Use the compute SDK in usage commands * quota: Deprecate "force" behavior for network quotas * quota: Fix issues with delete quota command * tests: Remove unnecessary nesting of volume resources * tests: Remove duplicate FakeImagev1Client * tests: Move fake clients to top of file * quota: Trivial style fixups * quota: Deprecate 'quota show --class', 'quota set --class' arguments * quota: Allow showing project-specific quotas * quota: Add 'quota show --usage' option * quota: Simplify logic used to list, show quotas * Fix server evacuate command * Speed up standard flavor list command * quota: Add support for detailed volume quotas * quota: Add 'quota delete' command * doc: Update cinder command mapping * Improve help text for network create --external * Switch to 2023.1 Python3 unit tests and generic template name * Update master for stable/zed * Fix wrong assertion methods * image: Add 'image task list' command * image: Add 'image task show' commands * Run swift in -tips job * Replace assertItemsEqual with assertCountEqual * Adding missing command mapping in docs * volume: Volume names are optional * compute: Add support for microversion 2.93 * compute: Require image when rebuilding a volume-backed server * Add address-scope to NDP proxy tests * network: Add tenant project filter for RBAC list * Add router ndp proxy commands * Fix missing closing brackets in metavar * Remove invalid note from requirements files * Bump python-novaclient version * Microversion 2.91: Support specifying destination host to unshelve * remove unicode prefix from code 6.0.0 ----- * Fix documents for replaced configuration name * Migrate server\_groups to the new API * config: Also mask non-prefix config * Update the Nova CLI Mapping Guide * Add authorization\_ttl for identity providers * Add port ranges on floating ip portforwardings cli * docs: Add missing command mappings * Drop support for Python 3.6, 3.7 * pre-commit: Allow unsafe YAML * Add support for CRUD operations for QoS minimum packet rate rule * image: Split image creation depending on service * image: Make better use of argparse * Fix: create image from volume command * image: Trivial style changes * Skip test\_quota\_network\_set\_with\_force func test * Don't show tenant\_id in network objects * Allow users to list all images * Migrate osc-tox-py3N-tips to Python 3.8 * Add 'Host Status' to 'server list --long' with >= v2.16 * volume: Correct output of 'volume attachment create' * Allow to filter multiple tags for image list * Stop testing lower-constraints * volume: Add 'block storage resource filter list' command * volume: Add 'block storage cluster \*' commands * Refactor network fakes to sdk properties PART 4 * Stop using private \_is\_uuid\_like method * Add more filter option of columns for server list -c COLUMN * compute: Only retrieve necessary images * Add trustor and trustee filtering to trusts list * Allow "--force" flag in quota network commands * Refactor network fakes to sdk properties PART 3 * compute: Add 'Security Groups' for 'server list' * Refactor network fakes to sdk properties PART 2 * Refactor network fakes to sdk properties PART 1 * Refactor "volume backup restore" command * compute: Move server migrations commands to their own file * compute: Allow retrieval of migration by UUID * volume: fix backup list of deleted volume * Add Python3 zed unit tests * Update master for stable/yoga * Fix metavars and typos in local\_ip 5.8.0 ----- * Add support for setting extra DHCP options on existing ports * volume list: don't fail when there's no compute service * Fix 'server event list|show' for deleted servers * docs: Document additional 'server migration' commands * Add support for 'remote-managed' vnic type * Don't fail on extlinks warnings for reno build * Support Neutron Local IP CRUD * Get rid of tenant\_id in the network commands * Switch compute service list, delete and set to sdk * Skip original\_name from flavor info * Fix volume set functional test * Add location to fake network objects * Hide location columns for network objects * compute: Pass through args to ssh * compute: Fix weird option definition for 'server ssh' * compute: Return information about fixed IP * Switch add fixed IP to SDK * tests: Improve logging for executed commands * Allow setting gateway when creating a router * Fix RemoveServerVolume * Add network update quota "limit\_check" parameter * Add --security-group to port list * compute: Show flavor in 'server list' with API >= 2.47 * compute: Reorder building of columns for 'server list' * Switch server suspend and server resume to SDK * Switch server pause and server unpause to SDK * Switch openstack server remove port/network to using sdk * Allow unset port's host\_id * Switch command server remove volume to sdk * Add functional test for server add/remove volume * Temporarily drop aodhclient from doc build * Switch command server add volume to sdk * Add missing command mapping in nova * image: Sanity check the 'SetImage' command * tests: Update fake image client in tests * image: Remove FakeImage test helper * image: Remove dead test helper methods * Switch server image create to SDK * Switch openstack server add port/network to using sdk 5.7.0 ----- * compute: Return details of attached volumes * compute: Use correct command class for 'show migration' * compute: Don't warn if disk overcommit params unset * Switch server backup to sdk * Fix typos * Remove remnants of 'six' * Remove 'get\_osc\_show\_columns\_for\_sdk\_resource' duplicates * tox: Ignore virtualenvs for pep8 environment * compute: Fix filtering servers by tags * Update the Nova CLI docoder document * Update the Nova CLI decoder document * Remove non-working code after method return * Add --trusted-image-cert option for server create * Fix that the path of functional test * Add Python3 yoga unit tests * Update master for stable/xena * Replace assertItemsEqual with assertCountEqual * compute: Add support for microversion 2.89 * compute: Add support for microversion 2.90 5.6.0 ----- * [community goal] Update contributor documentation * Fix typo error in listing server's column name * Show "Forced Down" compute service status with --long * Correct REST API response fields for /os-migrations API * volume: Add missing 'volume list --offset' parameter * Fix TestListMigrationV223 test class MIGRATION\_COLUMNS * tests: Handle removal of block-storage v2 API * volume: Add 'volume transfer request create --(no-)snapshots' option * Moving IRC network reference to OFTC * cinder: Remove redundant command * Correct the tox option for skipping sdist generation * compute: Better help text for 'openstack server set --state' * compute: Note that '--password' is deployment-specific * volume: Add more missing 'volume backup \*' options * volume: Add 'volume group snapshot \*' commands * L3 conntrack helper: Use singular name consistently * Add support for Neutron's L3 conntrack helper resource * volume: Add 'volume group type \*' commands * volume: Add 'volume group \*' commands * tests: Rename 'FakeType' -> 'FakeVolumeType' * volume: Add missing 'volume backup \*' options * volume: Add 'volume message \*' commands * volume: Add 'volume attachment \*' commands * volume: Allow more versions * docs: Update neutronclient comparison doc * docs: Update glanceclient comparison doc * docs: Update novaclient comparison doc * docs: Update cinderclient comparison doc * Include hosts in aggregate list --long * Changed minversion in tox to 3.18.0 * compute: Fix typo * setup.cfg: Replace dashes with underscores * Make functional Neutron tests running fine on ML2/OVN environments * Allow to send extra attributes in Neutron related commands * compute: Update 'server resize --revert', '--confirm' help * Add check for cinderclient.v2 support * Set ML2/OVS backend explicitly in the devstack jobs * Fix the functional-tips tox environment * openstack image create: honor protection/visibility flags * Replace assertItemsEqual with assertCountEqual * requirements: Drop os-testr * hacking: Remove references to encoding * Implements hide image * Add Python3 xena unit tests * Update master for stable/wallaby * Hides prefix\_length column in subnet show output * network: Make 'network qos rule create --type' option required * volume: Re-add accidentally deleted test * network: Add support for vnic-type vdpa 5.5.0 ----- * Add --subnet-pool to subnet list * Update the file paths mentioned in README.rst * Add pre-commit * compute: Remove 'file://' prefix from '--block-device' * Update volume create documentation * network: Add missing subnet unset --gateway * compute: Add support for loading BDMs from files * compute: Add functional tests for --block-device * Add --name to port list * Add 'address\_group' type support to rbac commands * project cleanup * compute: Remove deprecated 'server migrate --live' option * compute: Deprecate 'server create --file' * compute: Stop silently ignore --(no-)disk-overcommit * compute: Auto-configure shared/block live migration * compute: Add 'server create --block-device' option * compute: Remove references to optional extensions * compute: Add missing 'server create' options * compute: Improve 'server create --block-device-mapping' option parsing * compute: Rename 'server migrate (confirm|revert)' * compute: Add 'server migration show' command * Rename FakeServerMigration to FakeMigration * compute: Add support for 'server boot --nic ...,tag=' * compute: Improve 'server create --nic' option parsing * compute: Shuffle options for 'server create' * compute: Add missing options for 'server event list' * compute: Add missing options for 'server group list' * compute: Add 'server \* --all-projects' option * Add device profile to \`\`port\`\` * compute: Improve 'server migration list' options * compute: Add '--force' option to 'server delete' * compute: Add missing options for 'hypervisor list' * Support remote-address-group in SG rules * compute: Add 'server volume update' command * network: Address nits for I3c313fc9329837dde67815901528a34dca98ebcc * Add reno for change Ic3c555226a220efd9b0f27edffccf6c4c95c2747 * Remove retired Karbor support * Add 'server unshelve --wait' option * Add 'server shelve --offload', 'server shelve --wait' options * compute: Add 'server volume list' command * compute: Add missing options for 'server image create' * tests: Remove unused fake method * compute: Add missing options for 'keypair list' * compute: Add missing options for 'server set' * compute: Add missing options for 'server list' * trivial: Use plural for appended parameters * compute: Add 'server show --topology' option * compute: Add 'server group create --rule' option * compute: Fix 'hypervisor show -f yaml' output * compute: Fix 'server group \* -f yaml' output * compute: Fix 'usage \* -f yaml' output * compute: Fix 'server \* -f yaml' output * Add support '--progress' option for 'image create' * Support Neutron Address Group CRUD * image: Unset properties rather than setting to None * Add project field in image list subcommand * trivial: Cleanup docs for 'server list' * compute: Add missing options for 'server rebuild' * Add 'flavor list --min-disk', '--min-ram' options * Make use of comparable 'FormattableColumn' subclasses * Remove retired Searchlight support * Update lower-constraints * Fix lower-constraints job * Add support for token caching * trivial: Cleanup docs for 'server rebuild' * Add documentation about login with federation * Switch compute aggregate functions to SDK * Switch compute flavors from novaclient/direct to SDK * Let autoprogram-cliff know who's running * Add NODE and HOST parameters in "server create" help text * Add option to filter instances by AZ * stop image downloads to memory * Add "fields" parameter to ListPort query * trivial: Document removal of support for agents * tests: Remove 'agent' functional tests * Allow to resize in-use volumes * Resolve issues with 'server migration list' * Switch 'openstack keypair' ops to use SDK * functional: Remove test for 'quota set --force' * Remove unnecessary test * Remove references to Python 2.7 * Add a few selectable fields to the "openstack server list" output * Add 'openstack server evacuate' command * Fix formatting of the flavor properties * Compute: Add user id support for keypair * trivial: Rework 'CreateServer' function * update lower-constraints.txt * Replace deprecated UPPER\_CONSTRAINTS\_FILE variable * Switch console url show operations to SDK * Remove references to setuptools * Remove the unused coding style modules * Add support for 'keypairs list --project' parameter * Add support for 'keypairs list --user' parameter * Compute: Add tags support for server * Validate 'server group create --policy' option * Add 'openstack server migration list --type' option * Cleanup of 'server migration list' command * Add 'server migration force complete' command * Add 'server migration abort' command * compute: Add --password option for openstack server create * Remove oslo.utils * zuul: Stop testing against Tempest * Add an error message when server bind floating IP * Compute: Add tag support for server add fixed ip * Compute: Add tag support for server add network * Compute: Add 'keypair create --type' parameter * Compute: Add tag support for server add port * Compute: Add tag support for server add volume * Remove usage of six * Switch openstack console log show operation to use OpenStackSDK * Fix: port attribute name propagate\_uplink\_status * Restore behavior of image create with same name * Add Python3 wallaby unit tests * Update master for stable/victoria 5.4.0 ----- * Add server migration list CLI * Remove install unnecessary packages * Remove None valued network quota entries * bump py37 to py38 in tox.ini * Output correct json for security groups in 'openstack server show' * Remove install unnecessary packages * Fix gate due to switch to focal * Fix --image-property option in 'create server' * Update developing.rst * Support tagging Neutron ports on creation * Add source\_ip\_prefix and destination\_ip\_prefix to metering label rules * Show words indicating booted from volume for server image * Add API check for server\_groups.create * Add API check for server\_groups.list * Bypass user and group verification in RemoveRole * Add NUMA affinity policy parameter to "port" * Add id and enabled param in ListIdentityProvider parser * Delete the testcases that arent needed anymore * Fix reverted osc-lib interface change * Add 'openstack server create --use-config-drive' * Add name and enabled param in ListDomain parser 5.3.1 ----- * Fix compatibility issue in 5.3 * Add system role assignment tests for users and groups 5.3.0 ----- * Fix uploading an signed image does not work if private signing key is encrypted * Add a command to trigger entrypoint cache creation * switch to stevedore for entry points * Make volume backup record commands available in v3 * Remove enabling of glance v1 API * Expose flag for forcing use of import for images * Remove translation sections from setup.cfg * port: add --host to list command * Don't display Munch objects in the output * Revert "Format location columns in network commands" * Allow openstack flavor set to update flavor description using name * image: autogenerate docs * identity: autogenerate docs * Remove os-client-config references * Add cliff to libs-from-git for devstack functional tips * Add OpenStack Client for Manila docs * Remove congress * Replace assertItemsEqual with assertCountEqual * Client should parse string to boolean for value 'is\_domain' * Add py38 package metadata * Switch to newer openstackdocstheme and reno versions * Make container list --all work * Cleanup: remove a useless reference to "object" * Resolve PEP8 * Correct image lookup during server rebuild * Add Python3 victoria unit tests * Update master for stable/ussuri * Remove Babel from requirements * Add '--force; parameter to 'openstack quota set' * Add 'subnetpool' type support to rbac commands * Add resource option immutable * Revert "Disallow setting default on internal network" * Use unittest.mock instead of third party mock * Add description field to portforwarding NAT rules * Support for stateless security groups * Cleanup Python 2.7 support * Add command: router add/remove route --route * Adding options to user cli * Be explicit about python version in image * Add libc6-dev to bindep * Add 'address\_scope' type support to network rbac commands 5.2.0 ----- 5.1.0 ----- * Don't look up project by id if given id * Complete switch from glanceclient to SDK for image service * Honor endpoint override from config for volume * Switch image to use SDK * Remove trailing newline from dockerhub secret * Fix network segment range "\_get\_ranges" function * Change dockerhub password * Bump lower constraint of MarkupSafe * Update image building jobs * Allow setting floating IP description * Stop configuring install\_command in tox and stop use pip * Build utility image for using osc * Allow os quota list query to filter by project * Add "fields" parameter to ListSecurityGroup query * Update http links in docs * Disallow setting default on internal network * Change 'Volume' to 'Block Storage' * Always display direction for security group rules * Add bindep file * Add storage policy option to create container command * Add qos\_network\_policy\_id to network port tests 5.0.0 ----- * Complete "Drop python2 support" goal * Use 'KeyValueAppendAction' from osc-lib * Stop silently ignoring invalid 'server create --hint' options * Remove mention of meetings from docs * Incorrect title for service provider * Fix copypaste errors in access rule command * Add support for app cred access rules * Switch to using osc\_lib.utils.tags * Add unit tests and release note for dns\_publish\_fixed\_ip * Raise flake8-import-order version to latest * Raise hacking to more recent 2.0.0 * Replace six.iteritems() with .items() * Show correct name for resource with quota set to zero * Bump tox minversion * Fix openstack server list --deleted --marker option * Fix faulthy state argument choice * Stop testing python 2 in tox and zuul * Fix router create/show if extraroute not supported * Provide stderr in exception when check\_parser fails * Microversion 2.79: Add delete\_on\_termination to volume-attach API * Create Volume v3 functional tests * Refactor AggregateTests * Deflate .htaccess * Add redirect testing * compute: autogenerate docs * openstack.cli: autogenerate docs * common: autogenerate docs * Update a stale doc reference to use :neutron-doc: * neutron: autogenerate docs * versions: Fix 'versions show' help message * Remove redundant OpenStackShell.prepare\_to\_run\_command * Use SDK to get compute API extensions * Fix functional tests for py3 * Use autoprogram-cliff for remaining plugin docs * Doc: launchpad => storyboard * Link to (some) plugin doc pages * Add plugin doc page for watcher * Produce complete content for plugin docs * Split plugin docs per project * Remove plugin projects from test-requirements.txt * Add placement to known plugins * Fix plugin autodoc generation * Update master for stable/train * Fix osc-lib interface change: catch osc-lib Forbidden 4.0.0 ----- * Add dns\_publish\_fixed\_ip attribute to subnets * Update release table for Train and 4.0.0 * More aggregate functional race chasing * Add 'openstack server migrate (confirm|revert)' commands * Add doc and relnote for review 639652 * Default to Cinder v3 API * Clean up app initialization and config * Follow-up: fix the invalid releasenote link * Microversion 2.77: Support Specifying AZ to unshelve * Add parent project filter for listing projects * Bump lower constraint of python-zunclient * Remove races in floating ip functional tests * Bump min osc-lib to 1.14.0 * Format location columns in network commands * Add floating IP Port Forwarding commands * Bump hacking version * Remove token\_endpoint auth type * Format aggregate command fields and de-race functional tests * Add CLI argument tests before making changes * Fix functional.base.TestCase.openstack() to optionally omit --os-auth-type * Document 2.53 behavior for compute service list/delete * Add openstack server create --boot-from-volume option * Fix description for --block-device-mapping * Support type=image with --block-device-mapping option * Fix compute service set handling for 2.53+ * Add 'openstack server resize (confirm|revert)' commands * Make configuration show not require auth * Fix typo: "to and endpoint" * Fix module paths for volumev3 volume backup commands * openstack port create support --extra-dhcp-option * Mention compute service set --up|--down requires 2.11 or greater * Update api-ref location * Add host and hypervisor\_hostname to create servers * Support IPv6 addresses better * Add Python 3 Train unit tests * docs: clarify compute service --service option * Update the constraints url * Add Python 3 Train unit tests * Fix BFV server list handling with --name-lookup-one-by-one * Use cliff formattable columns in volume v2 commands * Use cliff formattable columns in volume v1 commands * Use cliff formattable columns in object storage commands * Use cliff formattable columns in image commands * Use cliff formattable columns in identity commands * Microversion 2.73: Support adding the reason behind a server lock * Allow "server migrate" (not live) to take "--host" option * Add server add/remove volume description for microversion 2.20 * Add server event command documentation for compute API 2.21 3.19.0 ------ * Add changes-before attribute to server list * Deprecate openstack server migrate --host option * Remove deprecated volume commands and args * Batch up minor cleanups for release * Remove deprecated network options * Remove deprecated image commands * Remove deprecated identity commands and args * Remove deprecated compute commands * Serialize more aggregate functional tests * Compute: Add description support for server * Remove code migrated to osc-lib long ago * Aggregate functional test tweak * Update sphinx requirement * Rename review.openstack.org to review.opendev.org * Stop leaving temp files after unit test runs * Use cliff formattable columns in network commands * Blacklist Bandit 1.6.0 due to directory exclusion bug * Fix bug in endpoint group deletion * document the --timing option * Change default security group protocol to 'any' * Fix link to new opendev repo * Document that server dump create requires 2.17 * Dropping the py35 testing * Followup opendev cleanup and test jobs * OpenDev Migration Patch * Fix docs bug link to go to storyboard rather than launchpad * Tweak network segment range fiunction tests * Before writing object data to stdout, re-open it in binary mode * Volume backup functional test tweak * Ignore case in security group rule --ethertype * Update master for stable/stein * Fix: incorrect check when no shared/private input * Fix service discovery in functional tests * Fix: set invalid None project\_id on range creation 3.18.0 ------ * Mention compute API 2.50 in openstack quota show --class * Add network segment range command object * API microversion 2.69: Handles Down Cells * Add 'security\_group' type support to network rbac commands * Paginate over usage list to return all usages * Add --attached / --detached parameter to volume set * Fix: Restore output 'VolumeBackupsRestore' object is not iterable * Typo fix * Disabling c-backup service for osc-functional-devstack-tips job * Add possibility to filter images using member\_status * Add support for get details of Quota * Fix help message of image add project * Fix help message of image add project * add python 3.7 unit test job * Remove str() when setting network objects names * Add py36 env * This fix removes an erroneous underscore found within the function named test\_snapshot\_delete within test\_snapshot.py found in both volume v1 and v2 of python-openstackclient * More state handling in volume transfer requests functional tests * Fix --limit option in image list sub-command * fix multiple server delete produce multiple new lines * Add floating IP filter to floating IP list command * Use os-cloud instead of OS env vars for functional tests * Add osc repo to the base job definition * Remove testr.conf as it's been replaced by stestr * More volume functional test fixes * Supports router gateway IP QoS * Support enable/disable uplink status propagation * Change openstack-dev to openstack-discuss * Add Python 3.6 classifier to setup.cfg * Use devstack functional base job * Replace assertEqual(True/False, expr) with assertTrue/assertFalse * Fix i18n issue * Add volume backup import/export commands * Modify the help message for 'registered limit set' * Updated the take\_actions for unified limits 3.17.0 ------ * Add project param in LimitList parser * image/v2: support multiple property filters * Handle multiple ports in AddFloatingIP * Add --name-lookup-one-by-one option to server list * trivial: modify spelling error of project * Remove invalid 'unlock-volume' migration arg * Update the Neutron CLI decoder document * Update release note version reference table * Make use of keystoneauth service-type filtering for versions * Improve document 'openstack complete' * Address issues from volume backend commands * Handle not having cinderclient.v1 available * Add volume backend pool list command * Add volume backend capability show command * Allow endpoint filtering on both project and project-domain * Add --key-name and --key-unset option for server rebuild API * Add --property option to 'server rebuild' command * Remove python-ceilometerclient * trivial: remove commented-out code * Add monascaclient to \`not plugins\` list * Fix some spaces in help messages * fix tox python3 overrides * Update the URL in doc * Fix help message for subnetpool default-quota value * Now we can add description for role creation in OSC * Replace port 35357 with 5000 for "auth\_url" * Fix 'project purge' deleting wrong project's servers and volumes * Add metavar for name parameter in subnet create * osc-included image signing (using openstacksdk) * Use templates for cover and lower-constraints * Partially Revert "Add command to unset information from Subnet-pools" * add lib-forward-testing-python3 test job * add python 3.6 unit test job * switch documentation job to new PTI * import zuul job settings from project-config * Deprecate volume create --project and --user options * Fix inconsistency (nit) * Detailed help message for QoS max-burst-kbps value * Fix broken gate jobs * Add DNS support to floating IP commands * Fix missing trailing spaces in network help messages * Update reno for stable/rocky 3.16.0 ------ * Release note cleanup for 3.16.0 release * Support --community in openstack image list * Don't sent disk\_over\_commit if nova api > 2.24 * Fix error with image show when image name is None * Add command to show all service versions * Implement support for project limits * Implement support for registered limits * Pass volume snapshot size to volume create * compute: host: expand kwargs in host\_set() call * Fix lower-constraints.txt * Replace pbr autodoc with sphinxcontrib-apidoc * Skip calls to glance and nova when got no servers * Slow down and retry aggregate create/delete to lessen race * Retry floating IP tests * Support filtering port with IP address substring * Fix docs from I0dc80bee3ba6ff4ec8cc3fc113b6de7807e0bf2a * Add ability to filter image list by tag * Add release note link in README * Change bug url to a correct one * Adding api\_version to FakeApp * Fix the \`role implies list\` command * Fix volume type functional tests * Delete the LB object quotas set command in openstackclient * Compute: Add description support for flavor * compute: limit the service's force down command above 2.10 * Fix subnet host\_routes error * Do not require port argument when updating floating IP * Network: Add tag support for security group * Fix RuntimeError when showing project which has extra properties * Mention 2.51 in help for openstack server event show * Fix server show for microversion 2.47 * Optimize \_prep\_server\_detail to avoid redundant find\_resource * Use Server.to\_dict() rather than Server.\_info * Add note about version 2.5 when listing servers using --ip6 * Update role document to include system parameter * Fix urls in README.rst * Allow setting network-segment on subnet update * Add system role functionality * Fix lower-constraints.txt * Make max\_burst\_kbps option as optional for bw limit QoS rule * Don't display router's is\_ha and is\_distributed attributes always * Add cliff project link * Update the content about Import Format * Update command test for volume.v3 * Prevent "server migrate --wait" from hanging * Format port\_details field of Floating IP * Add dns-domain support to Network object * Trivial: Update pypi url to new url * Fix functional job failed * Network: Add tag support for floating ip * Clean up W503 and E402 pep8 errors * Add bgp commands to neutron decoder * Add help for nova interface-list to decoder * Remove deprecated ip floating commands * Fix limits show command without Nova and Cinder 3.15.0 ------ * Updated from global requirements * Add --image-property parameter in 'server create' * add lower-constraints job * Rename python-openstacksdk to openstacksdk * Add support to list image members * Display private flavors in server list * Default --nic to 'auto' if creating a server with >= 2.37 * Fix additional output encoding issues * Correct application credential usage doc * Fix crashing "console log show" * Fix typo in 'floating ip associate' command and doc * neutron: add --mtu for create/set network * Make Profile fallback go bye-bye * Remove duplicated network attributes * Re-implement novaclient bits removed in 10.0 * Updated from global requirements * Update links in README * Imported Translations from Zanata * Cleanup error messages on failure * Update help text for encryption provider * Add support for endpoint group commands * Add support for "--dns-domain" argument * Add project tags functionality * Make osc-functional-devstack-tips actually use tips * Zuul: Remove project name * Add CRUD support for application credentials * Use find\_ip from openstacksdk * Updated from global requirements * Fix tox -e venv -- reno new * Update reno for stable/queens 3.14.0 ------ * Updated from global requirements * Fix use of new openstacksdk connection * Rework Network client config for new SDK Connection * Replace assert with condition * Updated from global requirements * Corrected spelling mistake * Updated from global requirements * Fix indentation in authentication.rst * Partially Revert "Update new documentation PTI jobs" * Use Zuul v3 fetch-subunit-output * Updated from global requirements * Updated from global requirements * Add floating IP qos\_policy actions * Updated from global requirements * Check that Glance returns image data before processing it * Allow ports filtering with device\_id * Update new documentation PTI jobs * flavor: clarify --swap description * Switch to use stestr directly * Fix func tests: Ensure to pass OS\_CLOUD envvar * Updated from global requirements 3.13.0 ------ * Send 'changes-since' instead of 'changes\_since' query parameter * Fix SDK Connection creation alternative to Profile * Make functional-tips job voting * Remove -U from pip install * openstack subnet create fails when tags is None * Avoid tox\_install.sh for constraints support * Make py27 and py35 versions and template of unit-tips jobs * Add cliff and keystoneauth to tips jobs * Remove a bunch of things we promised to remove in 2H 2017 * Release note cleanup * Set correct designate endpoint in docs * Make osc-tox-unit-tips work on other repos * Allow port list to shown undefined attributes * Updated from global requirements * Fix file mode on network-topology.rst * Add support for endpoing filter commands * Remove hard-coded policy choices for creating a server group * Fix credentials in create, update and list * Remove setting of version/release from releasenotes * Prepare for os-clinet-config to go away * Add logic to handle old and new sdk constructor * Updated from global requirements * Network: Add interfaces info in router show * Updated from global requirements * Show detailed message of neutron exception * Add RemoveNetwork command to server * Replace %r with %s on printing string variable * Updated from global requirements * Neutron agent delete: remove the wrong argument * Display Network QoS rule type details * Network: Add supports rbac target-all-projects * Updated from global requirements * Rehome test units lib * Zuul: add file extension to playbook path * Add python-rsdclient into plugin list * Add server rescue unit tests * Zuul job updates * Add missing parameters on openstack server rescue * Added AddNetwork command to server * Convert 'server' commands to use autoprogram * Native DevStack jobs * Add wrapper around ostestr * Accept 0 for --min-disk and --min-ram * Move more jobs in-repo * Attempt to de-race qos policy * Allow creating security rules without protocol * Move base functional test job in-repo * Switch to $USER in post\_test\_hooks * Avoid default mutable values in arguments * Be robust on import plugin module * auto-generate docs for v3 identity resources * Updated from global requirements * Support creating unaddress neutron port * Optimize getting endpoint list * Support icmp-type and icmp-code to be set as zero * Fix 'project purge' deletes ALL images problem * Update the documentation link for doc migration * Updated from global requirements * Add "volume service list --host" functional test case * Add functional test cases for "volume qos associate/disassociate" * Unroll the network qos policy functional tests * Add python-zunclient plugin * Attempt to work around chronically failing server issues with aggregates and qos * Fix subunit collection in functional tests with ostestr>=1.0.0 * Updates for stestr * Updated from global requirements * Updated from global requirements * Correct import of keystoneauth1 session * Skip Volume v1 functional tests if v1 not present * Fix output for subnet show * Useless line of code in shell.py * Updated from global requirements * Updated from global requirements * Update image cli doc and fix some typos * Updated from global requirements * Convert remaining network functional tests to JSON * Convert network qos functional tests to JSON * Convert network security group functional tests to JSON * Fix "openstack image unset" command's help message typo * flake8-import-order: Ensure to place project imports last * Implied Roles * Updated from global requirements * auto-generate object docs * Revert "Disable karborclient until a fixed version is released" * Use flake8-import-order plugin * Allow PD as Subnetpool during Subnet creations * Imported Translations from Zanata * Convert network segment functional tests to JSON * Update release/stable branch table in docs * Update reno for stable/pike * Add .htaccess for docs migration * Add new commands for karbor osc plugin * Updated from global requirements * Replace guildelines with guidelines * Updated from global requirements * Updated from global requirements * Updated from global requirements * network functest: Remove condition for segment test * Use instance variables for subnet tests * Skip object-store functional tests when Swift is not available 3.12.0 ------ * Add optional parameter "user\_id" and "type" to list credentials * network tag UT: avoid using mix-in test class * wrong values in openstack quota show command * Update the documentation link for doc migration * Network tag support * Updated from global requirements * Release note cleanup for 3.12.0 * Updated from global requirements * Updated from global requirements * Add domain parameter to Identity Provider * Start using 'cliff.sphinxext' * Updated from global requirements * Clean up the changes of os.environ in functional tests * Minor followup to network agent docs * Fix dynamic names in network functional tests * Disable karborclient until a fixed version is released * Add support for virtio-forwarder VNIC type * Fix 'domain' filter not work well in some commands * Fix column names for server list --no-name-lookup * Updated from global requirements * image-list should support filters 'name','status' * Add 'data\_plane\_status' option to Port classes * Fix unit test failures related to new os-client-config and osc-lib * Network L3 Router Commands for OSC * Add server list -n and --no-name-lookup arguments * Use openstackdocstheme in release note * Add the other commands for karbor osc plugin * Allow objects to be streamed to stdout * Add new parameter "is\_default" to Network QoS policy * Fix man page build * Add missing barbican commands * Added 'openstack image set --visibility' * Add python-octaviaclient plugin * Remove inaccurate mapping of 'host-meta' in csv * Updated from global requirements * Updated from global requirements * switch to openstackdocstheme * Use identity auth v3 the README examples * Updated from global requirements * update the docs URLs in the readme * move auto-generated api docs into contributor tree * reorganize existing documentation according to the new standard layout * Enable some off-by-default checks * Now OSC server create check keys in --nic * When creating a trust, send role\_ids instead or role\_names * Add direction field to QoS bandwidth limit * Show neutron tags in OSC network show * Add support for Karbor Plugin * Add project purge command to osc * Don't show hint about vlan transparent in network set * Add default-quota to subnet pool commands * Updated from global requirements * Fix Mapping Guide Error * Updated from global requirements * volume functest: ensure snapshots deleted when volume delete * Updated from global requirements * Updated from global requirements * Updated from global requirements * Updated from global requirements * Trivial fix typos * Replace "Display Name" by "Name" in volume list * JSON-ify image functional tests * Use \_get\_token\_resource in role assignment list * Updated from global requirements * Create server with security group ID and name * Refactor Extension show and list command * Updated from global requirements * Convert image functional tests into JSON format * Convert volume functional tests into JSON format * Make block-device-mapping more stable and clear * Correct the "extra spec" command openstack * Updated from global requirements * Ignore more exceptions in quota list * Rework floating ip functional tests 3.11.0 ------ * Do not always init compute\_client when doint port list * Skip floating ip attach functional test on nova-net * Updated from global requirements 3.10.0 ------ * Funcional tests: quota list * Nova-net functional tests: aggregates * Functional tests: Identity v2 and DevStack * Updated from global requirements * Fix volume qos spec list * Nova net functional tests round 3 * Nova net functional tests round 2 * Nova net functional tests round 1 * Fix Nova-net netowrk commands * Fix quota functional tests for nova-net * Fix server create with nova-net * Updated from global requirements * Functional test for subnet\_pool * Fix NoneType error for volume snapshot create command * Improve no-auth path * Remove ipdb installation in tox debug section * Make test\_server.py more elegant and simple * Fix network list functional test * Explicitly set 'builders' option * Low-level Compute v2 API: floating ip pool * Low-level Compute v2 API: network * Split network tests * Updated from global requirements * Low-level Compute v2 API: floating ip * Low-level Compute v2 API: security group rules * Low-level Compute v2 API: security group * Add document about renaming OS\_ENDPOINT\_TYPE to OS\_INTERFACE * Split floating IP tests * Update to tox.ini * Add --network and --port to server create * Updated from global requirements * Split security group tests * Allow override of distributed router flag * Clean up password prompt work-arounds * "floating ip set/unset port" for OSC * Add "qos-policy" option to "port create" & "port set" * Structure FindFloatingIP() to work without ip\_cache * Enable to specify which fixed-ip to add to a vm * Correct flavor associate/disassociate commands in Mapping Guide * Help/docs cleanups: marker, limit, ip-address metavars * Release notes cleanup for 3.10.0 release * Enable to add/remove port to/from a server * Introduce neutron flavor associate, disassociate to OSC * Add help commands withouth auth in functional * Fix block-device-mapping when volume\_size is empty * Enable to create legacy router * Trivial Fix * Updated from global requirements * Use Sphinx 1.5 warning-is-error * doc: Correct Sphinx warnings * doc: Remove local fork of apidoc * Change noauth strategy for plugin loading * Fix volume transfers request commands * Doc: Fix link in network flavors * OSC Extension Show * Remove log translations * Fix Trivial Changes in [1] * Support to add/remove multi users for "group add/remove user" * Simplify logic around option lists in port set * Enable to specify which vm fixed-ip to publish * Introduce Neutron DHCP agent commands to OSC * docs: Don't include ChangeLog * OSC Network Flavor Profile * Make MAC address of port updatable * Non-Admin can't list own projects * Updated from global requirements * Narrow expected responses for CheckUserInGroup * Add extra filtering options to qos policy list * Adds missing flavor information in the server list long command * Functional test for ip\_availability * OSC Quota List * Fix reference in network flavor create command reference * Refactor ServerTests and ServerEventTests functional test classes * Fix "security group list" command to display project ID properly * Trivial Fix * Jsonify meter and meter rule functional tests * Revert "Fix port command for SDK >0.9.10" * Fix handling the use\_default\_subnet\_pool attribute * Add sort support to project list * Add the bgp agent type to network agent command * Remove py34 tox env and pypi classifier * command list: Move network meter appropriately * Add server event list and show commands 3.9.0 ----- * Updated from global requirements * Cleanup release notes for 3.9.0 release * Trivial Fix * add neutron CLI to decoder * Normalize the gnocchiclient docs entry * Add "--private-key" option for "keypair create" * Trivial Fix * Updated from global requirements * Jsonify network flavor functional tests * Nit: Trivial doc formatting fix for network flavor * Use \*\_as\_ids instead \*\_as\_list * Add a validation about options for server migrate command * Updated from global requirements * Update doc/source/command-objects/image.rst * Port set/unset SecGroup Bug Fix * Fix output of ListSecurityGroupRule * openstack image create : --file and --volume exclude each other * Fix can not set is\_default in network * Support --no-property in "volume set" command * Revert unit tests for quota commands * Support list commands by group name keyword * Auto allocated topology for OSC * minor tweaks to mapping table * add keystone and glance -> osc mapping * Fix "endpoint list" help message * Show openstacksdk version info in "module list" * OSC Network Flavor * Fix properties format for volume qos in volume v1 * Rework port functional tests on json output format * add volume->osc mapping * add swift and nova to osc mapping * Add Cinder v3 client support for volumes * TODO cleanup: osc-lib * Remove text about OSC as a plugin requirement * Remove unused logging import * Remove remaining uses of SDK Proxy.session * Finish converting server functional tests to JSON format * Remove quota set workaround for SDK <0.9.13 * Fix image selection in server function tests * Fix "server create" command failed when --nic auto or none * Use public and unified method get\_console\_url() * Handle log message interpolation by the logger in compute/ * Handle log message interpolation by the logger in network/ * Handle log message interpolation by the logger in identity/ * Updated from global requirements * Overwrite/Clear Flavor property * Refactor volume functional test in volume v1 * Updated from global requirements * Updated from global requirements * Modify error handling for role and group commands * Fix --parents and --children options in project show * Add --fixed-ip option to the port list command * Fix wrong behavior of parsing plugin service name * Fix "module list --all" failed * NIT: replace os with openstack in command example * mention the final ocata osc version in releasenotes * SDK refactor: Set "is\_admin\_state\_up" for network agent * TODO cleanup: OSC\_Config * Add mitaka release notes to master * Update reno for stable/ocata 3.8.1 ----- * Add relnotes for the two recent bug fixes * Fix network create --project * Fix address scope list --share 3.8.0 ----- * Fix sphinx errors * Updated from global requirements * Cleanup for 3.8.0 release * Switch server create to block\_device\_mapping\_v2 * Support "--no-property" option in volume snapshot set * Adds domain specification for SetUser * Add options to "server list" command * Fix Identity functional tests to not require OS\_AUTH\_URL * change assert\_show\_fields to not fail on new fields * Add server\_boot\_from\_volume() test * Fix 'mapping set' return value * Add server test for image and flavor lookups * Updated from global requirements * Use image client for images instead of compute * Update container format choices * Handle 403 error on creating trust * SDK refactor: Prepare security group commands * Add meter rule to OSC * Update devref about "--no-property" * Fix OSC networking commands help errors * Functional tests debug support * Switch to use cleanup method in functional test * Fix functional test for creating subnet * Functional test for router * Functional test for subnet * Functional test for volume qos * Remove the fixed set of choices for network\_type * Add plugin adoption for trove * Error in the return of command server show, create * Error in the return of command 'volume qos create' * Functional test for volume snapshot * Update functional test for aggregate * Updated from global requirements 3.7.0 ----- * Release 3.7.0 cleanup * Fix quota set command error for SDK > 0.9.10 * SDK refactor: Prepare network agent commands * Updated from global requirements * unskip port test * Use git+file urls instead of directories * Fix quota show --default command * Fix network functional tests for sdk 0.9.12 * Fix floating IP delete and show by IP * Add "encryption-\*" options in volume type commands * Fix subnet creating failure in functional test * fix functional tests for network agents * Fix security group rule list for NEtwork v2 * Install from /opt/stack/new instead of git.o.o * Fix quota show output * unskip network qos rule type functional test * Fix image member unit tests occasional failures * Fix flavor create help re swap size units * Fix Network QoS rule CLI attrs parsing * Add unit test for multi volume types delete * add support for running tests with master dependencies * To display image size in human friendly format * Updated from global requirements * Add support for Network QoS rule commands * Make 'object save' fast again * Fix Octavia gate breakage caused by \_get\_columns() * functional test for volume * Fix port command for SDK >0.9.10 * Fix filter error in os volume list * Add --project and --project-domain option to "volume snapshot list" * add domain id to expected IdP fields, unskip tests * skip tests related to SDK 0912 and keystone IdP change * Functional tests - flavor * Add options to allow filtering on agent list * Fix network service provider functional test * Fix "ip availability show" command * Updated from global requirements * Fix creating a private flavor with ID auto * Functional tests - port * Add support for Glance 'update image members' feature * Fixes image api URL endpoint for certain scenario * Remove unneeded methods from OS\_Config class * Error handling for delete commands in identity * Update the description format * Add ":option:\` \`" in the help message * OSC Network Meter * Beef up floating IP functional tests * Beef up address scope functional tests * Beef up network functional tests * update server migrate '--wait' description * Revert "WIP: Skip broken functional tests..." * Updated from global requirements * Fix a spelling error * Fix typo in release notes * Add unit tests for usage commands in compute v2 * Test-requirements.txt: Bump Hacking to 0.12 * Updated from global requirements * WIP: Skip broken functional tests.. * To support '--project' and '--project-domain' options * Add support for QoS rule type commands * Update earliest-version number format in release notes * Should support 'auto' and 'none' as network parameter when boot instances * Fix all missing "os to openstack" transformation * Add '--type'and other options to network rbac list 3.6.0 ----- * Fix the missing os in command in example * Add 'allowed address pairs' option to 'port create/set/unset' * change os in command example to openstack(3) * change os in command example to openstack(2) * change os in command example to openstack * Add support for clearing router gateway * Introduce overwrite functionality in \`\`osc router set\`\` * Add one test for "backup set" command * Add doc for Searchlight client * Tivial:update the description format in volume\_snapshot.py * Add filtering options to the address scope list command * Add support for setting router gateway * Add ploop to supported disk formats * SDK refactor: Prepare network commands * Updated from global requirements * [TrivialFix] Fix typo error 3.5.0 ----- * SDK Refactor: Prepare port commands * 3.5.0 release note cleanup * Updated from global requirements * Add two consistency group commands * SDK Refactor: Prepare router commands * Add "--remote-source" option to "volume snapshot create" command * update plugins documentation * Add extra filtering options to floating ip list * Correct missspellings of secret * Add '--force' option to 'volume snapshot delete' command * Modified API calls in os usage * Trivial: update volume-qos.rst * Add "consistency-group-snapshot" option to consistency group create * Add "consistency group set" command * Add --default option to "volume type list" * Add some options to "volume create" command * Revert "Remove marker and loop from "image list" command" * Remove auth\_with\_unscoped\_saml decorator * SDK Refactor: Prepare ip availability commands * Adjust the code sequence in consistency\_group.py * Avoid duplicated project\_id when show network resources * Add "dns-name" option to "os port create" and "os port set" * Add "consistency group show" command * Add "consistency group delete" command * Updated from global requirements * Updated from global requirements * Correct reraising of exception * Add '--project' and '--project-domain' options to os cmds * Add functional test for volume service * Add network service provider list to OSC * Add \`--enable/disable-port-security\` option to \`port set\` and \`port create\` * Add unit tests for server create in computev2 * Trivial:modify one parameter * Refactor availability zone functional test * Add QoS support to Network object * Introduce overwrite functionality in \`\`osc subnet set\`\` * Functional test for configuration * Functional test for aggregate * Refactor module functional test * Add choices for option '--policy' * Fix description errors in volume fakes * DevRef fix for network qos policy * Add options to "volume snapshot list" command * Show team and repo badges on README * Functional test for agent * Add "volume host set" command * Updated from global requirements * Functional test for server group * clean up image choices and help text * Add "--type" and "--retype-policy" options to "volume set" command * TrivialFix in helpMessage for readability * Updated from global requirements * Add "Is Public" column in volume type list * Remove outdated comments in volume unit test * Fill the missing colon * Add "volume host failover" command * Sort list images by name by default * SDK Refactor: Prepare security group rule commands * SDK Refactor: Prepare network rbac commands * SDK Refactor: Prepare network qos policy commands * SDK Refactor: Prepare subnet commands * Add commands for "consistency group snapshot" 3.4.1 ----- * Add relnote for release 3.4.1 * Use project\_domain\_id only in password auth * Using v2 as the default version of Glance * Add "consistency group create" command 3.4.0 ----- * translate all command help strings * Updated from global requirements * 3.4.0 release note cleanup * Do proper deprecation for security group rule create * Outdated test data clean up in volume * TrivialFix: Insert blank space for readability * Updated from global requirements * Updated from global requirements * Add '--network' and other options to floating ip list * Show disk format vhdx in help * network.common.NetworkAndComputeShowOne: catch HttpException * Updated from global requirements * Add 'description' option * Add 'all-projects' option to 'volume backup list' * Add options to "volume backup list" command * Updated from global requirements * Not appropriate name sg rule attribute * SDK refactor: Prepare floating ip commands * Refactor "snapshot" commands * Updated from global requirements * Add filtering options --name,--enable,--disable to router list * Support --provider-\* options in the network list command * Add --long option and more columns to the hypervisor list command * Adds information about private key generation for instance access * Updated coverage configuration file * Avoid duplicated project\_id when show network * Updated from global requirements * update openstackclient page url * update volume and zone commands * Improve a network testcase * Use FakeImage class to replace duplicated image info in volume test * Updated from global requirements * Correct help string of the subnet pool list options * Allow input the QoS policy name in network rbac create command * Updated from global requirements * Add option to allow filtering by mac-address on port list * Updated from global requirements * Warning for empty password set for user create/set * Reset allocation pools to [] instead of '' * Rename variable to avoid shadowing of built-in name * Add "--read-only" and "--read-write" options in "volume set" * Add "volume migrate" command * Add description field port create & port set * Add support make a router HA * Add necessary info to Floating IP list * properly format error messages for volume resizing * Updated from global requirements * Update the doc for Zaqar v2 * Updated from global requirements * Add direction and protocol options to os security group rule list cmd * Updated from global requirements * Add a new column and a new option the 'os port list' cmd * Add security groups options to "port create/set/unset" * Fix --shared/block-migration options in server migrate command * Add network support for Network QoS policies * Fix router unset --route option * Redefine set/unset command devref * Refactor image v1 unit tests with FakeImage class 3.3.0 ----- * More 3.3.0 release notes * Improve output of supported API versions * Enable release notes translation * Updated from global requirements * Mask passwords in debug logs for auth\_config\_hook * SDK Refactor: Prepare subnet pool commands * SDK Refactor: Prepare network segment commands * SDK Refactor: Prepare address scope commands * Updated from global requirements * Refactor qos spec unit test in volume v1 * Add --ha option to os router create command * Updated from global requirements * Document \`openstack complete\` help and usage * Add example in the doc when using Identity v3 * Updated from global requirements * Update default nova api version to 2.1 * Remove beta label for network segment resource * Add and modify options for "volume create" command * Implement "consistency group list" command * Updated from global requirements * fix doc information in the limit.rst * Replace 'MagicMock' with 'Mock' * Add translation markers for object commands * Add option "--name" to command "openstack object create" * Add default limit for container/object * Add command option parameter in console-url.rst * Updated from global requirements * Add warning message for --state option of set command in volume * Align '=' for developing.rst and newton.rst * Updated from global requirements * remove square backet to required parameter * Remove reference to CLI Ref in osc doc * Add option markup in osc doc * Fix typo in osc doc * Add functional test for snapshot in volume v1 * Support "--no" option in aggregate set * Updated from global requirements * Add --description to Neutron commands * Add unit tests for backup commands in volume v1 * Use assertGreater replace assertTrue * Fix unset commands to pass normally when nothing specified * Add square bracket to option parameter * Updated from global requirements * Implement "volume transfer request show/accept" command * Align '=' for image.rst * Add "volume backup set" command in volume v2 * Add filtering options to os network list command * Updated from global requirements * Fix "volume unset" command pass normally when nothing specified * Use correct router add/remove interface methods * Refactor volume unit test with FakeVolume class in volume v1 * replace metavar "volume-id" with "volume" to avoid ambiguity * Overwrite/Clear support for subnets * Introduce overwrite functionality in \`\`osc port set\`\` * Remove unnecessary setUp * Add 'description' option to os subnet (pool) create/set cmd * Add --description to Create/Set Network * Clean up docs and notes for 3.3.0 release * Provide support to list ports by network * Add filtering options to os subnet pool list command * Add filtering options to os subnet list command * Fix quota-update issue in LBaaS * Fix Quota Support for HMs * Correct login name deduction in SshServer * router list if availability\_zone ext not enabled * Support mark volume as bootable in volume set * Doc, help and message updates for port unset * Replace 'MagicMock' with 'Mock' * Support listing specified server's ports * Fix openstack quota set/show --class not work * Support fetching network project default quota * Add functional tests for unset multiple volume type props * Set quota "per\_volume\_gigabytes", "backup\_gigabytes" and "backups" * Unit tests of quota command refactor * Trivial: Rename ListTransferRequests to ListTransferRequest * Display hypervisor information without uptime * Fix regular expression for uptime in hypervisor show * Add unit test for volume type in volume v1 * Implement "volume transfer request delete" command * Implement "volume transfer request create" command * Error handling of multi REST API calls for "snapshot set" command * Add "--limit" and "--marker" options to "volume list" command * Support error handling for delete commands in volume v1 * Multi REST API calls error handling of "volume unset" command * remove the old post\_test\_hook * remove duplicate unit test * unwedge the gate * Add network segment create, delete and set support * move all functional tests to tests module * move unit tests to new "unit" test module * Defer auth prompting until it is actually needed * standardize release note page ordering * Do not show "os-volume-type-access:is\_public" property of volume type * better functional test collection * format token expires time to prevent json loading datetime data * Update reno for stable/newton * Use assertIn(A, B) instead of assertTrue(A in B ) * Updated from global requirements * Rearrange integration tests * Updated from global requirements 3.2.0 ----- * Updated from global requirements * Add importing file to import warnings * Provide fallback prompt function for current osc-lib * Fix auth prompt brokenness * Updated from global requirements * Cleanup after install 3.1.0 ----- * Fix six typos * Updated from global requirements * Clean imports in code * Updated from global requirements * Restore default auth-type for token/endpoint * Updated from global requirements * [docs] fix incorrect rst markups * Clean up FakeClient classes in volume fakes 3.0.1 ----- * Work around a version clash issue with os-client-config * Fix post and periodic jobs 3.0.0 ----- * Updated from global requirements * Add Subnet service-types to subnets * Integ test cleanup * Fix up last-minute imports to use osc-lib * document locale and language support tips * Add shell integration test * Gate-unbreaking combo review * Add "volume service set" command * update requirements and test requirements * Fix errors in volume set/unset image properties unit tests * Rename backup commands in volume v1 and v2 * Add support for domain specific roles * Fix OSC identity v3 functional tests * Implement "network agent set" command * Add '--dhcp' and '--no-dhcp' options to os subnet list cmd * Add --ip-version filtering option to subnet.rst * Support multi REST API calls error handling for "volume set" command * Updated from global requirements * osc-lib: shell * Implement network agents functionality * Show "target\_project\_id" attribute properly for network rbac object * Add unit tests for group commands in identity v3 * Updated from global requirements * Updated from global requirements * Remove an outdated directory in tox.ini * Add support of setting volume's state * Implement "network rbac set" command * Add a document for required options * Refactor identity v3 unit tests with fake class * Updated from global requirements * OS\_DEFAULT\_DOMAIN must be an ID * Updated from global requirements * Document network trunk commands * Update the description of project in releasenotes * Updated from global requirements * Pass security group id to novaclient while adding security group to server * Implement network rbac create and delete commands * Allow setting quotas for server groups and server group members * Add support for deleting volumes with associated snapshots * arguments are not locale decoded into Unicode * Use identity fake classes instead of old unit tests data * Remove temporary code in ClientManager * Use assertEqual() instead of assertDictEqual() * Add options to "volume type list" command * Add "--marker" and "--limit" options to "snapshot list" * Unit test of credential in identityv3 * Add assignment list to v2 identity and deprecate alternate listing * Rework clientmanager * Clarification of option name rules * Remove execute permission on a few files * Fix error for find\_service() in identity * Standardize import format * Remove discover from test-requirements * Add Support for showing flavor access list * Support to get server rdp/serial/mks type console url * Updated from global requirements * Set identity v3 client in networkv2 fake * Show project access for volume type * Transfer "ip floating CRUD" to "floating ip CRUD" * Updated from global requirements * Exchange the check order for the dhcp and no-dhcp * Support bulk deletion for delete commands in identityv3 * Updated from global requirements * Unskip the tests affected by warlock 1.3.0 * Follow upper constraints for all tox targets * Add create\_one\_image\_member() in FakeImage class and update test * Update doc for credential in indentityv3 * Updated from global requirements * Allow format selection in get\_opts * Change to plural form of object in multi delete error message in networkv2 * Support error handling for delete commands in volumev2 * Make set/unset commands pass normally when nothing specified in identityv3 * Temp work around for missing select\_auth\_plugin() * Add "--project" option to "volume type create" command * Change the wrong import order * Modify some help and error messages in ec2creds identityv2 * image list: Add Checksum column * Add Python3.5 to setup.cfg tox.ini * Add "--incremental" option to "backup create" command in volume v2 * Pass security group id to novaclient * Make the doc build reproducible * Modify compute agent set command * Use FakeProject and FakeDomain classes in unit tests of networkv2 * Add missing "Volume version 2 only" message in backup.rst * Remove useless dest of option in volume v1&v2 * Updated from global requirements * remove unused LOG * Updated from global requirements * Remove FakeService.get\_services * Add notes, modify notes in fakes docstring * Add network-topolopy support * Unskip tests caused by bug 1599333 * Added a note on how to test changes * Correct reraising of exception * modify notes in the FakeHypervisorStats docstring * fix one spelling mistake and two help messages * "server list": "Image Name", "Image ID" columns * Add '--force' option to 'backup delete' command in volumev2 * Add "--property" option to "snapshot create" command in volumev2 * fix some spelling mistakes in doc/ * skip failing tests due to bug 1599333 is fixed * Deduplicate get\_opts methods * Add python-neutronclient to OSC plugins * fix a few spelling mistakes * Remove useless dest of option in "snapshot create" command * Add missing '(name only)' message for keypair in computev2 * Refactor unit tests for project and domain with fake classes in identityv3 * Transfer "ip fixed add/remove" to "server add/remove fixed ip" * Transfer "ip floating add/remove" to "server add/remove floating ip" * Transfer "ip floating pool list" to "floating ip pool list" * Updated from global requirements * Add command to unset information from ports * Add "--snapshot" option to "backup create" command in volumev2 * update plugin documentation * osc-lib: api.auth * Add command to unset information from Subnet-pools * Fix doc issue for "compute agent list" command * Add port security option to network commands * Add "--property" option to "flavor create" command * Add command to unset information from Subnets * Add "--force" option to "volume qos delete" command * Support bulk deletion for delete commands in computev2 * Update Fakes.py and unit tests for commands in identity V2.0 * Modify few words and change output format for command "ip floating list" * skip image tag tests * Change "ID only" to "name or ID" for backup commands * Add command to unset information from Routers * Add "--force" option to "backup create" command in volumev2 * Make set/unset command in volume pass normally when nothing specified * Modify some unusual help messages in computev2 * Implement rbac list and show command * Add unit tests for "host list" and "host show" commands * Fix several flake8 code style issues in compute tests * Make code more compact for get\_list\_opts function * Remove code forgotten in cb28fb55884a9be7cd70c37343181116cf000a42 * Support multi-delete for commands in identity V2 * Fix the problem of router delete * Updated from global requirements * Improve server functional tests * Standardize logger usage of catalog in identity * Use resource id when name given for identity show * Fix typo in openstackclient/network/v2 * Remove OSCGenericPassword plugin * Refactor unit test of "compute service list" command * Add FakeObject classes to fakes.py, update unit tests in identity V2 * Fix errors for "host set" command * Fix token/endpoint auth plugin * Updated from global requirements * Add "--project" option to the "flavor create" command * Fix a missing i18n support in security\_group\_rule.py * Make set/unset commands in compute/image/common return normally when nothing specified * Improve masking of secrets in configuration show * Refactor setting defaults for some scope parameters * Refactor check\_valid\_auth\_options function * Make the print info support i18n * Support bulk deletion for "flavor/aggregate delete" * Add "--device-owner" option to "port list" * use env vars to specify OS\_IDENTITY\_API\_VERSION * Support JSON data for port binding profile * support multi-delete for volume-type * Standardize logger usage * Use osc\_lib in server\_image.py * Error handling of "router delete" command * Do not prompt for scope options with default scoped tokens * Updated from global requirements * Modify help msg and docs in identity * Make set/unset command in identity and image pass normally when nothing specified * move release note to correct directory * Fix console url show command broken in microversion case * Support bulk deletion for delete commands in networkv2 * Add "--password-prompt" to user.rst * Modify doc issues about property option of aggregate * Add functional test for "aggregate unset" command * Add doc for logger usage * Fix help msg of identity endpoint * Finish osc-lib transition for command.py * Fix volume functional tests * Setup deprecate msg for command.py * Add default IP version and fix help messages for "ip availability list" * Support bulk deletion for commands that exist in both network and compute * Standardize logger usage in volume * Remove blank line in release notes * Add release note for network endpoint type bugfix * Fix missing i18n supports in api/ and shell.py * Fix foundation copyrights * Ensure endpoint type is used for network commands * Support compute service force down/up * Fix errors in \`\`set/unset flavor\`\` unit tests * Fix i18n problems for common files in identity * osc-lib: timing * osc-lib: command * osc-lib: parseractions * osc-lib: logs * osc-lib: utils * osc-lib: exceptions * Add "--network-segment" option to "subnet create" * Fix errors in flavor unit tests * Fix image delete multiple arguments error * Trivial: Fix coding style in examples in doc * Add geneve provider network type * Use osc-lib and set up deprecation warnings * Updated from global requirements * Moving authentication from keystoneclient to keystoneauth * Updated from global requirements * Fix network * Remove duplicate file logger formatter setting * Make set/unset commands in network return normally when nothing specified * Clean up fakes.py in volumev2 * Fix compute service set command * Modify unit tests of compute agent delete * Error handling for KeyValueAction class * Set up 3.x release notes 2.6.0 ----- * Release note cleanups for 2.6.0 * Fix i18n supports in commom * Add Tox prerequisites and installation * Update unit test test\_extension with fake class * Support error handling for "port delete" command * Fix i18n support problems in identity * Add functional tests for IP availability * Fix release note links to (now) external docs * Fix errors for "volume type unset" command * fix keypair help msg * Add newline to strings in stdout/stderr.write() * modify server group * fix image unset * Add server set/unset unit test cases * Updated from global requirements * Add support for volume transfer request list * Refactor SetService --enable/disable option * Make set/unset commands in volume return normally when nothing specified * Imported Translations from Zanata * Add network availability for osc * Move server image create command to its own resource file * Modify the style of translated messages * Check port name in set port tests * Fix wrong test in flavor unit tests * Fix some missing i18n support problems in compute * Updated from global requirements * Support multiple argument for compute agent delete command * Update v2 endpoint show help * Fix --enable options on commands * Add support for removing flavor-access * Trivial: Remove duplicated line in man page * Updated from global requirements * Modify lowercase to uppercase * Updated from global requirements * Trivial: Fix i18n support in network/common.py * Fix unit test for volume commands in volumev2 * include old release notes in reno * add unit test for compute agent command * Add FakeQos class and update unit test for qos\_specs in VolumeV2 * Updated from global requirements * Fix i18n support in cinder * Add support for setting flavor-access * Support to set server state * Add "image unset" command * Fix output and error log in server.py * Support deleting multi address scopes in networkv2 * Fix functest "test\_server\_metadata()" in test\_sever.py * Fix help message for "server group delete" command * Add network segment command object * [compute] Add server backup function * i18n support for leftover exception messages in volume * Do not require an scope when setting a password * fix endpoint show help 2.5.0 ----- * keystone: fix catalog output when region is unset * Release notes cleanup * Refactor service unit tests * Search by user defined ID for service providers * Updated from global requirements * Fix i18n support for help and error messages in compute * Search by user defined ID for identity providers * i18n support for help and error messages in cinder * Add FakeType class and update volumetype test in VolumeV2 * Add some functional tests for commands in VolumeV2 * Updated from global requirements * Add FakeSnapshot class and update snapshot test in VolumeV2 * Add functional tests for server group in ComputeV2 * Fix image tests to use warlock resources * Avoid TypeError on message object additions * Add network support for "quota set" * Fix i18n support for help and log.warning in image * Updated from global requirements * Refactor TestVolumeShow with FakeVolume * Add FakeBackup class and updata backup unittest in volumeV2 * Add ip version filter to subnet list * Added CONTRIBUTING.rst file * Add VLAN Transparent option to \`\`osc network\`\` * Fix i18n support for help and error msg in network * Refactor TestRemoveProjectImage with FakeImage class * Added --no-route to the router set command * Updated from global requirements * Changed the nomenclature of credentials command * Additional network protocol support * Refactor TestImageList with FakeImage class * Refactor TestAddProjectToImage with FakeImage class * remove #noqa from i18n imports * Pep8 environment to run on delta code only * Refactor TestVolumeList with FakeVolume * Fix functional test for floatingip add/remove in ComputeV2 * Implement "address scope set" command * Implement "address scope show" command * Implement "address scope list" command * Implement "address scope delete" command * Implement "address scope create" command * Add unit tests for "server show" command * Updated from global requirements * Use find\_resource() instead of get() in \_prep\_server\_detail() * Ignore domain related config when using with keystone v2 * Fix functional test failures * Map server power state num to meanful string * Updated from global requirements * Trivial: Remove unuseful comments for assertRaise() checking * Remove unnecessary type conversions in network unit tests * Ignore domain related config when using with keystone v2 * Fix network router type display * bump timeout to prevent gate failures * Added "name" parameter to the help message * Add a unit test for "flavor create" command * Add describe of overwrite options behavior into devref * remove assert in favor an if/else * Spec to Implement IP Availability * Make "flavor show" command to show a private flavor properly * Documentation updates * Replace tempest-lib with tempest.lib * add a bandit environment to tox * Fix error in flavor set/unset command * Add functional tests for commands of floating ip * Fixes BadRequest when no --pool-prefix given * Support for volume service list * Doc: Add network resource descriptions * Devref: Command Beta * Support quota show for current project * Fix server group document issue * Add commands of clustering service to doc * Add new share and default parms to subnet pool cmds * Updated from global requirements * Fixed subnet command host route output * Trivial: Fix an omited i18n issue * Update tests for server * Add "server group show" command * Add "server group list" command * Add "server group delete" command * Add "server group create" command * Support X.latest format for OS\_COMPUTE\_API\_VERSION * Fix mutable default arguments in tests 2.4.0 ----- * Rename --profile to --os-profile * Updated from global requirements * Update keypair tests * Fix client certificate/key support for Network v2 commands * Imported Translations from Zanata * Deduplicate CLI output parser code in test.py * Add provider network options to osc network set * Clean up for next release * Add options to security group rule list * Fix router set --route option * Initialize neutron client with region name * Updated from global requirements * Remove methods argument from vloume/v2/fakes.py * State i18() changes and help messages improved * Add support for removing volume-type-access * Fix wrong attribute name and add functional test for --snapshot * Remove methods argument from FakeHypervisorStats * Propagate AttributeErrors when lazily loading plugins * Add external network options to osc network set * Trivial: Fix incorrect comment text * Enhance exception handling for "network delete" command * Append existing information during port set * Use CommandFailed exception from tempest\_lib * Updated from global requirements * Fix prefixes output for subnet pool list * Doc: Unify repeatable option comments * Remove fake methods code from compute network * Add Testing Ref in README.rst * Add project options to security group rule create * Add network options to security group rule create * Add support for setting volume-type-access * Move keys() methods in each resource class to FakeResource * Add --address-scope option "subnet pool create/set" * Fix pep8 fail that crept in * use correct manager for volume snapshots * Fix SSL/TLS verification for network commands * Doc: Fix network command documentation issues * Append existing information during subnet set * TrivialFix: Rename provider segment option * Updated from global requirements * Updated from global requirements * Clean up release notes since 2.2.0 release * TrivialFix: Fix help messages for port set * Add option to clear information from ports * Make snapshot and backup name optional * Prefer assertEqual/assertIn over assertOutput/assertInOutput * Correct addCleanup use in functests * Support client certificate/key * Add provider network options to osc network create * Add external network options to osc network create * Fix typos in docstrings and comments * Improve tmpfile cleanup in functests * Remove unused method cleanup\_tmpfile * Use fixtures and addCleanup instead of tearDown * Log hint when --enable present with --disable-reason * Trivial: Rename FakehypervisorStats to FakeHypervisorStats * Add name option to 'port set' * rxtx factor should be a float * Don't mask authorization errors * Add default value to pool-prefix in Subnet-pool * Devref: Options with Multiple Values * Doc: Add missing command objects * Add --project to "subnet pool create" * Follow Boolean Option rule * Add fixed keypair create functional test * Fix subnet pool prefix length option * Wrong param type in compute-service.rst * Remove unused method 'from\_response' * Aggregate object should be "grouping of compute hosts" * Docs cleanup: volume command help * Docs cleanup: volume type * Docs cleanup: sort subnet commands * Refactor security group rule list to use SDK * Added functional tests for 'service provider' v3 commands * Add unit tests for compute v2 aggregate * Add "aggregate unset" to osc * Subnet: Add "subnet set" command using SDK * [Floating IP] Neutron support for "ip floating create" command * Support security group name for --src-group * Refactor security group rule create to use SDK * Trivial: Fix typo in common/limits.py * Fix "server unset" document issue * Use assert\_called\_once\_with() instead of assert\_called\_with() * Add Subnet add/remove support to router * Remove superfluous variable assignment statements * Style fix for one line docstring according to flake8 * Add "router remove port" to osc * Add "router add port" to osc * Updated from global requirements * Image API v2: make volume\_type optional * Improve error for token issue command without auth * Devref: Document OSC interfaces available to plugins * Fix keypair create --public-key * Functional tests for openstackclient help messages * Trivial-Fix : Add a ' to the choices documentation * update docs with status of plugins * Fix options in port create/set * Updated from global requirements * Add option to allow filtering by router on port list * Add support for deleting Image-property * Add support for setting Image-property * Sort commands in docs * Doc: Fix documentation errors for command object * Support "--long" option in ListService * Use assertItemsEqual() instead of assertListEqual() * Trivial: Add release note for "subnet pool create" command * Fix dict.keys() compatibility for python 3 * Add doc describing how to handle API errors * Add project options to security group create * Add incompatibility info for "ip floating list" command * Enhance list extension unit test * Trivial: Reorder classes in identity v3 in alphabetical order * Update reno for stable/mitaka * Add "os subnet create" command using SDK * Refactor security group create to use SDK * Refactor security group show to use SDK * Add subnet pool functional tests * Fixed command list * Trivial: Use 'SSH' rather than 'Ssh' * [Identity] Check return value is None in identity v3 unit tests * Add --reason for disable service * Remove FakeFlavorResource class * Add support of setting snapshot state * Add port functional tests * Add 'port set' command * [Subnet pool] Add 'subnet pool create' command support * [Subnet pool] Add 'subnet pool set' command support * Trivial: Fix incorrect comments in compute fakes.py * remove py26 workaround in osc * [Identity] Check return value is None in identity v3 unit tests * Add port list command * Trivial: Remove useless return * Use \_get\_columns() to obtain columns in network.py * Add release note for security group set refactor * Test take\_action() instead of run() in unit tests * Updated from global requirements * Add 'port create' command * Add subnet functional tests * Updated from global requirements * Updated from global requirements * " openstack server image create " doesn't print proper info 2.2.0 ----- * Fix test\_aggregate functional test * [Volume] Check return value is None in volume unit tests * Fix incorrect unit test for router * Refactor security group set to use SDK * Updated from global requirements * Trivial: Reorder unit tests in alphabetical order in volume tests * [Image] Check return value is None in image unit tests * Support "network create" command in nova network * Add test cases to test some commands with '--wait' and fix bug * Devref: Options with Choices * Clean up unnecessary import of urlparse module * Trivial: Update image\_list v2 docs * Fix regression in interactive client mode * Fix 'code-block' tag format issues * TrivialOrder: Rearrange Class Names * add a checklist for creating a new plugin * Trivial: Reorder flavor op order in flavor.py * Subnet: Add "subnet delete" command using SDK * fix: Exception message includes unnecessary class args * Refactor security group list to use SDK * take\_action() method from command.Command shouldn't return * Trivial: Reorder unit tests in test\_type.py * Fix return value of "image set" command * [Compute] Check return value is None in compute unit tests * Router: Add --route and --clear-routes options to "router set" command * Add MultiKeyValueAction to custom parser action * Make SetAggregate inherit from cliff.Command * Make SetAgent inherit from cliff.Command * Make SetSecurityGroup inherit from cliff.Command * Make SetFlavor and UnsetFlavor inherit from cliff.Command * Add missing command/configuration object * Updated from global requirements * [compute] Add set host command * Add shell --profile option to trigger osprofiler from CLI * update heat object and command doc * Add some test cases for "server list" command * Floating IP: Neutron support for "ip floating show" command * Improve tox to show coverage report on same window * Py3 replace dict.iteritems with six.iteritems * Updated from global requirements * Defaults are ignored with flake8 * Fixed a bunch of spacing * Add "security group rule show" command * Fix wrong return value in TestDeleteFloatingIPNetwork * Use update\_parser\_common() in ShowNetwork * [compute] Support restore server * [compute] Add unit test for keypair * Use instanceof instead of type * Add "os subnet show" command using SDK * Initialize \_keys in \_\_init\_\_() in FakeFlavorResource * Add unit tests for 'hypervisor stats' command * Clean redundant argument to dict.get * Add functional tests for "volume" commands v2 * Add functional tests for "image" command v2 * Updated from global requirements * Add unit test for "flavor show" command * Refactor: Set "project\_id" for FakeXXX in a consistent style * Fix Mutable default argument * gitignore .idea * Trivial: Rename subnet\_pool.rst to subnet-pool.rst * Replace string format arguments with function parameters * Support unscoped token request * Use assertIsNone() instead of assertEqual(None, xxx) * Don't use Mock.called\_once\_with that does not exist * Floating IP: Fix "ip floating list" in neutron network * Subnet Pool: Add "subnet pool show" command * Subnet Pool: Add "subnet pool list" command * Remove unused test-requirments * Subnet Pool: Add "subnet pool delete" command * Support "network show" command in nova network * Support "network list" command in nova network * Add release note for "network delete" command for nova network * Define FakeFloatingIP class in tests/compute for nova network commands * Add release note for "ip floating delete/list" commands for neutron network * Fix 'openstack --help' fails if clouds.yaml cannot be read * Rename parameter "identifier" to "network" in network commands * Use assertRaises() to check if an exception is raised * Support "network delete" command in nova network * Floating IP: Neutron support for "ip floating list" command * Floating IP: Neutron support for "ip floating delete" command * Updated from global requirements * Add quota functional tests * Add NetworkAndCompute Lister and ShowOne classes * Fix identity test\_role functional tests * Trivial: Fix a typo in test\_network.py * Updated from global requirements * Refactor network AZ exception handling * Refactor security group rule delete to use SDK * Identity: Fix DisplayCommandBase comments for cliff ShowOne subclass tests * Identity: Fix DisplayCommandBase comments for cliff Lister subclass tests * Identity: Fix DisplayCommandBase comments for cliff Command subclass tests * Trivial: Fix "abstractmethod" to "abstract method" * Fix DisplayCommandBase comments for cliff ShowOne subclass tests * Add "token revoke" for identity v3 * Fix DisplayCommandBase comments for cliff Lister subclass tests * Fix DisplayCommandBase comments for cliff Command subclass tests * Updated from global requirements * Add release note for custom logging feature * Add release note for recursive delete * Add unit tests for "hypervisor show" command * Compute: Fix DisplayCommandBase comments for cliff ShowOne subclass tests * Compute: Fix DisplayCommandBase comments for cliff Lister subclass tests * Compute: Fix DisplayCommandBase comments for cliff Command subclass tests * Remove identity\_client.projects definition in TestSecurityGroup * Define security\_group\_rules mock in FakeComputev2Client * Move security\_groups mock definition to FakeComputev2Client * Fix formatting in release 2.0.0 notes * Fix some release note formatting * Add recursive object delete for containers * Refactor security group functional tests * Add functional tests for snapshots * Add support for triggering an crash dump * Add unit tests for "hypervisor list" command * Allow custom log levels for other loggers 2.1.0 ----- * Use assert\_not\_called() in common tests * Minor typo in help text * Fix a spell typos * Add --marker option to "image list" command * Add limit option to "image list" command * Remove marker and loop from "image list" command * Trivial: Reorder test class in test\_volume.py into alphabetical order * Fix wrong type of volume attachments in FakeVolume * Refactor TestVolumeCreate to use FakeVolume * Refactor security group delete to use SDK * Add "os port show" command * Support listing network availability zones * Trivial: Fix wrong comment in test\_image.py * Network: Abstract get\_body() out to be a private helper * Drop log\_method decorator * Updated from global requirements * Consume openstackclient.common.command in subnet/port * Fix showing network quotas for a project * Add missing release notes * log take\_action parameters in a single place * Revert "Skip identity v2 functional tests" * Skip identity v2 functional tests * Add availability zone support for router commands * Update translation setup * Add availability zone support for network commands * Allow wait\_for\_delete to work for all clients * Updated from global requirements * Return names in list role assignments * Remove the Tuskar client * Use correct terminology for subnets * Updated from global requirements * Add releasenote for 'subnet list' command support * Add router functional tests * Subnet List * Updated from global requirements * Refactor abstract columns and datalist out in image and object test cases * Updated from global requirements * Add python-searchlightclient to list of adopters * Refactor abstract columns and datalist out in compute test cases * log\_method: get logger from decorated method if unspecified * Set up logger of each command by metaclass * Refactor: Abstract columns and datalist out in volume test cases * Add support to delete the ports * Initialize activation status * Imported Translations from Zanata * Updated from global requirements * Doc: Network is supported for extension object * Change --owner to --project in image commands * Support listing volume availability zones * Refactor "os availability zone list" * Changed the abstract columns and datalists from test cases of common and Identity * Updated from global requirements * Support non-interactive user password update * Use assertTrue/False instead of assertEqual(T/F) * Replace assertEqual(\*, None) with assertIsNone in tests * Updated from global requirements * Further improve output for "os security group show" * Delete the unused LOG configure code * Refactor network endpoint enablement checking * Implementation for project unset cmd for python-openstackclient * Enabling domain lookup for project set v3 command * Docstring should say 'default' if option is default * Trivial: Remove useless string\_to\_bool() * Refactor: Initialize parser in setUp() in TestNonNegativeAction * Refactor: Initialize parser in setUp() in TestKeyValueAction * Replace assertEqual(None, \*) with assertIsNone(\*) * Functional tests for security group rule * Improve output for "os security group show" * Add all regions to cloud configuration * Updated from global requirements * Add owner validation for "openstack image create/set" * TestServerGeneral: Add test for \_prep\_server\_detail() * TestServerGeneral: Add test for \_format\_servers\_list\_networks() * Trivial: Remove useless return from files in image and volume * Trivial: Remove useless return from files in network * Add support to list all security group rules * Replace assertEqual(None, \*) with assertIsNone in tests * Trivial: Remove useless return from files in compute * Add image re/deactivate commands * Router: Add "router show" command using SDK * Router: Add "router set" command using SDK * Refactor TestImageCreate with FakeImage class * Updated from global requirements * Router: Add "router delete" command using SDK * Network: Improve no option test for "network create" * Router: Add "router create" command using SDK * Remote security group name not displayed for rule * when fetching object store properties use lower() * Doc: Add optional command specs process * Removes MANIFEST.in as it is not needed explicitely by PBR * Updated from global requirements * Deprecated tox -downloadcache option removed * Router: Add "router list" command using SDK * Router: Add class FakeRouter to test "router xxx" command * Trivial: Improve unclear comments in test\_server.py * Make --image parameter optional in "server rebuild" * Trivial: Fix parameter name typo in network.rst * Trivial: Do not use plural format in command parameter in "network delete" * Map some of the SDK field names * TestServerGeneral: Add test for \_format\_servers\_list\_power\_state() * Remove python-neutronclient requirement * Fix poorly named test mocks * Remove old code after sdk integration * SDK integration extensions and server create networks * Add unit test for TestServerList to test --long option * Add multi deletion testcase for "openstack image delete" * Refactor TestImageDelete with FakeImage * Remove unuseful test data in test\_netwrok.py * Migrate network client to SDK * Migrate "network show" command to use SDK * Migrate "network set" command to use SDK * Migrate "network delete" command to use SDK * Migrate "network create" command to use SDK * Fix "sevice show" cannot catch NoUniqueMatch Exception * The format\_exc method does not take an exception * Migrate "network list" command to new version using SDK * Trivial: Coding style fix in test\_flavor.py * Use FakeVolume in server test cases * Use FakeImage in server test cases * Add source security group support to create rule * SDK integration: Add a temporary method to create network client using sdk * Introduce class FakeNetwork to fake one or more networks * Use formatter in server.py for "server list" tests * Updated from global requirements * Trivial: Import network.common as network\_common in server.py * Refactor network test: Remove unusful test code * Refactor TestShowNetwork: Use TestNetwork in TestShowNetwork * Refactor TestSetNetwork: Use TestNetwork in TestSetNetwork * Refactor TestListNetwork: Use TestNetwork in TestListNetwork * Refactor TestDeleteNetwork: Use TestNetwork in TestDeleteNetwork * Refactor TestCreateNetwork: Setup identity client in setUp() in TestCreateNetworkIdentityV2 * Refactor TestCreateNetwork: Setup identity client in setUp() in TestCreateNetworkIdentityV3 * Refactor TestCreateNetwork: Setup cmd in setUp() in TestCreateNetworkIdentityV2 * Refactor TestCreateNetwork: Setup cmd in setUp() in TestCreateNetworkIdentityV3 * Refactor TestCreateNetwork: Split TestCreateNetwork into two classes for identity v2 and v3 * Refactor network test: Introduce TestNetworkv2 and TestNetwork to improve unit test of network * Trivial: Remove unuseful doc of "network list" command * Trivial: Improve doc for "server create" command * Updated from global requirements * Fix exception when doing volume set operation 2.0.0 ----- * Trivial: Reorder doc of "server shelve" command to keep alphabetic order * Convert 2.0 release notes to reno format * Add reno for release notes management * Add multi deletion testcase for openstack volume delete * Add class TestServerList to provide basic unit test for "server list" command * Enable setup\_servers\_mock() to take attributes param * Introduce FakeImage class * Switch to ksa Session * Add release notes for 2.0.0 * Support "server list" searching by both image name and ID * Support "server list" searching by both flavor name and ID * autodocument commands from plugins using stevedore.sphinxext * Remove list output from "compute service set" * Add --limit option to "server list" command * Add --marker option to "server list" command * Updated from global requirements * Add a changelog to see all changes into tagged releases * Integrating mistralclient with openstackclient * Add testcases for compute.v2.service * Consistency of the --all argument for snapshots * Introduce FakeVolume class * Add unit testcases for "openstack flavor delete" * Add project name/ID validation for "openstack quota show" * Add status column for "openstack image list" * Change the home-page value in setup.cfg * Remove old fake flavor data * Use FakeFlavor in TestServerCreate * User FakeFlavor in TestServerResize * Use FakeFlavor in TestFlavorUnset * Use FakeFlavor in TestFlavorSet * Use FakeFlavor in TestFlavorList * Introduce class FakeFlavor to fake one or more flavors * Refactor: Move FakeFlavorResource to compute\_fakes.py * Refactor: Abstract datalist out in TestFlavorList to avoid redundant code * Refactor: Abstract columns out in TestFlavorList to avoid redundant code * Add "openstack server unshelve" into OSC * Fix a bug of "openstack volume delete" * Use Block Storage instead of Volume * Add unit tests for "server stop" command * Add unit tests for "server start" command * Add unit tests for "server resume" command * Add unit tests for "server suspend" command * Add unit tests for "server unlock" command * Add unit tests for "server lock" command * Add unit tests for "server unpause" command * Abstract a helper function for server.xxx() tests * Add multiple servers test case to TestServerDelete * Use setup\_servers\_mock() in the base class in TestServerDelete * Move setup\_servers\_mock() to class TestServer * Trivial: Fix typo in find() in network * Trivial: Fix a typo * Change 'Object Store' to 'Object Storage' * Use is\_public to set access of volume type * Refactor: Order of security group class names * Move FakeServer to tests.common.v2.compute.fakes * Trivial: Add missing doc for parameter in wait\_for\_delete() * Add functional tests for network crud * Remove py26 support * Doc: Update and add IP address * Doc: Add security group and security group rule * Enable "openstack server resume" command to take multiple servers * Enable "openstack server suspend" command to take multiple servers * Add "openstack server shelve" into OSC * Trivial: Fix wrong doc for wait\_for\_status() * Updated from global requirements * Remove the old fake server data * Use class FakeServer in TestServerResize * Use class FakeServer in TestServerImageCreate * Use class FakeServer in TestServerDelete * Use class FakeServer in TestServerCreate * Add command wrapper doc * Trivial: Remove doc for non-existing param in format\_dict() * Unable to set some compute quotas * Add --volume to Image \`create\` * Have configuration tests support OCC * Add unit tests for "server pause" command * Introduce random server faking mechanism * Enable FakeResource to fake methods * Allow error status to be specified * Remove deprecated 'project usage list' command * Remove LICENSE APPENDIX 1.9.0 ----- * Add release notes for 1.9.0 * Improve "server list" command to have the same output as "nova list" * Enable "openstack server unlock" command to take multiple servers * Enable "openstack server lock" command to take multiple servers * Enable "openstack server unpause" command to take multiple servers * Add capability to update description of an IdP * validate non-ascii values for swift properties * Trivial: Fix wrong param name in comment * Split the vol\_id from a dev mapping * better format remote IDs for identity providers * Trivial: Fix wrong param name in comment * Trivial cleanup: Use plural format for "server delete" doc * Set default network api to 2.0 instead of 2 * Fix the bug of "openstack console log show" * Enable "openstack server pause" command to take multiple servers * Change method to get the user\_id * Use fake server name instead of id when testing "server\_name" param * Fix a bug about "openstack server list --user" * Add --owner to \`image create\` * Trivial: Fix wrong comment of \_format\_servers\_list\_networks() * Add "server stop" command to osc * Add "server start" command to osc * Allow int version numbers in the clouds.yaml * Import the module not the class * Add project-name/-id validation for the OSC "openstack quota set" * Imported Translations from Zanata * Fix the bug of "openstack usage show" * Rename context.py to logs.py * Allow debug to be set in configuration file * Updated from global requirements * Trivial clean up: Add doc for "osc server lock/unlock" * Trivial clean up: do not use plural form in command arguments * Fix issue when displaying image\_member * Add Command Options guideline doc * remove url from v3 regions * Support pagination params for flavor list 1.8.0 ----- * Add release notes for 1.8.0 * Updated from global requirements * Follow-on for volume list - add tests, clean help * Add compute service delete * Add filtering by project/user for 'openstack volume list' * Updated from global requirements * Move session and fixtures to keystoneauth1 * Remove cliff-tablib from requirements.txt * Updated from global requirements * Updated from global requirements * Mask the sensitive values in debug log * Fix functional tests for Python 3.4 * Fix up object-store show commands * Change Identity API default version to 3 * Add a table showing all the openstack plugin objects * unwedge the gate * Fix a typo in commands.rst * Fix typos in authentication.rst * Updated from global requirements * Add test for role list --inherited * Fix non-ascii issue with object commands * Add ID column to compute service list * image set should not show the resource * Add tags to \`image set\` * Clean up Image v2 image set command * Evaluate --inherited in role list * Set object store arg order in docs * Update the plugin docs * add set/unset support for objects in object store * add support for set/unset of container properties * Updated from global requirements * Rename swift account commands * Add one parenthesis * cleanup account ids from container commands * Add support for showing account details * Add support for updating swift account properties * Add tests for find\_resource() * Imported Translations from Zanata * Mark arguments for 'credential' commands as required * attempt to find resource by listing * Additional exception handling for find\_resource * Add shields.io version/downloads links/badges into README.rst * docs: pip install -e needs an argument * Glance \`image set\` Resolve Fracturing 1.7.0 ----- * Add release notes for 1.7.0 * Use format\_list instead of format\_dict when listing images * Format an images properties and tags * Add image create support for image v2 * Change ignore-errors to ignore\_errors * Imported Translations from Zanata * Remove backticks from help in role commands * Move option logging back to start if initialize\_app() * Set default auth plugin back to 'password' * Updated from global requirements * Image fix bug with --volume * set image api to 1 for functional tests * Updated from global requirements * Use \`discover\_extensions\` for novaclient * Imported Translations from Transifex * Use novaclient.client.Client for initialization Nova client * Add filtering by user for 'openstack server list' * Add support for listing servers of other projects * Support listing users by group name * Fix compute API version snafu * Properly handle port arguments for ICMP * Use a common decorator to log 'take\_action' activation * Fix 'auhentication' spelling error/mistake * Volume v2 list does not show server name * Ignore flavor and image find errors on server show * Create log configuration class * default OS\_VOLUME\_API\_VERSION to v2 * Automate flavors, networks, and image get * unwedge the osc gate * additional functional tests for identity providers * Adds documentation on weekly meeting * Update the plugin docs for designate * Added note to install openstackclient * Override the debug default and help text * Running 'limits show' returns nothing * Optimize log formatting * Extract log level from configuration file * Move options to log level out of shell.py * Move set warnings filters to logging module * Updated from global requirements * Updated from global requirements * Updated from global requirements * Add tests for volume quota set 1.6.0 ----- * Use correct domain to find project * Updated from global requirements * Skip functional test: test\_server\_up * Updated from global requirements * Remove non-existing hacking deviations from doc * Update plugin documentation * Set up every time record log in file * Add release notes for 1.6.0 * Add developer documentation * Add --inherited to the role docs * Rename command docs to remove underscores * Inherited info/option when listing role assignment * Alphabetize setup.cfg * Add set feature to volume type v2 * Add list feature to volume v2 * Fixes inherited role assignments CRUD calls * Fix quota show when there is no project id * Add functional test for volume type create --property * Imported Translations from Transifex * Updated from global requirements * Added a new function test for volume type set * Introduce functional test for Identity Provider * Add domain scoping in 'role assignment list' * Removed unnecessary assignment of function result Joined lines together * New test for configuration show --mask * add new test for configuration show unmask * Minor Documentation changes for code samples * Set OS\_VOLUME\_API\_VERSION before running functional tests * Added test for \`volume type show\` * Add functional tests for volume type list * New test for configuration show * Imported Translations from Transifex * Updated from global requirements * Fix quota set failed problem * Add support for volume v2 commands * Add configuration show command * Imported Translations from Transifex * Add plugin interface version * Fix --os-auth-plugin in auth\_with\_unscoped\_saml * add doc for floatingip * Updated from global requirements * Fix yet more documentation warnings * Make trustee/trustor/project searchable by ID * Add create and list for volume type v2 * add image member commands for image API * Fix the way auth\_type default value is overriden * Format volume type properties when showing * Rename type.py to volume\_type.py * Removes trailing blank in trust show * Add volume type show for volume v1 * --property should be required in \`os unset\` commands * More minor docs fixes * Minor identity documentation change * Add functional tests server reboot * Add functional tests server IP attach and detach * Add details to the documentation * Making --property as required when openstack flavor unset * Do not set default versions in parsed args * Add functional tests for servers that require wait * Updated from global requirements * enhance tests for user v3 * Remove unnecessary test extension mock * Remove requirements.txt from tox.ini * add functional tests for identity v3 * Add functional tests for volume qos * Support multiple volume qos delete * add functional tests for identity v2 * add --project-domain option for user v3 * only return endpoints that have url * Fix the way we call find\_resource when only using ID * Fix image save with API v2 * Rename endpoint type to interface * Updated from global requirements * temporarily skip help tests * Drop py33 support for Liberty * Fix interactive password prompt * Updated from global requirements * Fix wrong mock method call * add functional tests for identity v2 * Fixes modules index generated by Sphinx * Imported Translations from Transifex * Fix address parsing for server ssh command * openstack catalog list always returns publicURL for internalURL and adminURL * Remove the --dhcp option to network list * Remove testing of cliff command line options * add functional tests for identity v3 * Add --os-endpoint-type cli optional argument * Show which aggregate a hypervisor is member of * Move update code from image create command * Fix examples with cacert * Updated from global requirements * Add support for volume API v2 QoS commands * Add tests for 'list' and 'show' for volume qos v1 * Alphabetize tests for v1 qos\_specs * Add docs for QoS specs * No need for get\_parser on QoS list * Alphabetize QoS specs * Add support for volume API v1 QoS commands * fix confused domain argument for network create v2 * fix typo in network.rst * Updated from global requirements * Updated from global requirements * Add support to inherited project role grant calls * Updated from global requirements * fix typo for server create in server.rst * Fix typo in user.rst * Update 1.4.0 release notes * Refactor option handling for user|group|project domain scoping * Updated from global requirements 1.5.0 ----- * Add release notes for 1.5.0 * reference corect ec2 helper function * Add functional tests for image set * Updated from global requirements 1.4.0 ----- * Improve the hint message * Fix the typo in \`openstackclient/shell.py\` * Add functional tests for volume set size * Add functional tests for server CRUD * Add functional tests for flavor metadata * Add flavor functional test * Add oidc plugin for listing federation projects * Skip trying to set project\_domain\_id if not using password * Updated from global requirements * Updated from global requirements * Add functional tests for security group CRUD * Enables retrieval of project's parents and subtree * Imported Translations from Transifex * Include links to developer workflow documentation * Enable specifying domain for group and role commands * Not use the deprecated argument * Add support for volume backup v2 command * Create 1.4.0 release notes * Updated from global requirements * Add support for volume snapshot v2 command * Allow --insecure to override --os-cacert * Clean up ec2 credentials help text * Add functional tests for volume set and unset * Add domain support for ec2creds in v3 identity * Add EC2 support for identity v3 API * Imported Translations from Transifex * Add a reference to the IRC channels * Change Credentials header to Blob from data * Get rid of oslo\_i18n deprecation notice * Fix security group list command * Rework shell tests * Add image functional tests * Add volume functional tests * Ignore cover directory from git * Set tenant options on parsed namespace * Add support for volume v2 API * add domain scope arguments to v3 role add in doc * project create is missing --parent in doc * add --domain argument to v3 project set * Add --wait to server delete * Use ostestr for test runs * Add cli tests for --verify and friends * Small tweaks to osc plugin docs * Fix shell tests 1.3.0 ----- * Create 1.3.0 release notes * Add support for v2 image set command * Adds python-tuskarclient to list of plugins * Remove oslo serialization requirement * Remove oslo incubator config * Add missing properties to image set command * Add some comments about current plugin support * Remove checks for None dates in keypair functional tests * Fix client error while rescuing an instance * Add support for keypair functional tests * Fix insecure/verify options * Use format options for functional tests * Fix functional test gate * Updated from global requirements * Enable specifing domains in "role add" * Send the correct user-agent to Keystone * Updated from global requirements * Security group rule delete broken * Updated from global requirements * Imported Translations from Transifex * Don't create empty quota set requests * Updated from global requirements * Add os-client-config cli tests * minor syntax error in tox.ini * Add image show tests * Minor fix to openstack image show command 1.2.0 ----- * Create 1.2.0 release notes * Fix tiny typo in comment message * Minor logging/debug cleanups * Redo 1.1.0 release notes * Remove unique class names because they are scoped * Raise exception if no session is created * Reduce parameters to base class execute * Functional tests run in many environments * Remove references to venv * Add a doc that dictates backwards incompatible changes * Remove run\_tests.sh * Security group rule create fails * Fix security group create description bug * Adds support for container selection for backup * Create 1.1.0 release notes 1.1.0 ----- * Handle the pagination for image list * Refactor utility to find identity resources * Imported Translations from Transifex * remove unnecessary conditionals * Update the docs for new nic options * Begin documenting --os-cloud * Add --os-cloud support * Imported Translations from Transifex * Re-organize functional tests * Role operations should not require list object permission * Print warning on authentication error * Fix skipped image create attribute location attr * Uncap library requirements for liberty * Defer client imports * Better help for --nic in create server * Add support to specify volume quotas per volume type * Add docs for service provider CRUD * Federation Service Providers CRUD operations * Add warning message if unknown version supplied * Fix session timing * Add support for showing limits of a specific project * Suppress warnings user can't fix * Use glanceclient's inbuilt images find * Updated from global requirements * Imported Translations from Transifex * Add support to remote\_id * Add parent field to project creation * Add project and domain params to network create * Add a doc about authenticating against v3 * Add the ability to set and unset flavor properties * Use cliff deferred help instead of homemade one * Base TokenEndpoint plugin on keystoneclient's 1.0.3 ----- * Create 1.0.3 release notes * Move OSC auth plugins so they can be found * Add identity v3 catalog show * Update README * Imported Translations from Transifex * Add identity v3 catalog list * Fix catalog list when region name is absent * Add ability for diplaying hypervisor statistics * Add 'uptime' in 'hypervisor show' * Raise AttributeError for unknown attributes * Add hypervisor docs * Don't hack the image url * Fix embarrassing typo in man page * Updated from global requirements * Fix identity v2 catalog list * Fix help messages * Handle novaclient >2.20.0 * Fix auth-required for help command * change oslo namespace to avoid warning * Updated from global requirements * Revert "Skip functional tests until they are fixed" * Rename --verify for server resize to avoid conflict * Fix error msg in sort\_items * Skip functional tests until they are fixed * Restrict groups and users from changing domains * Do not allow user to change domain of a project * Implement trust in identity v3 api * Imported Translations from Transifex * Change volume create --snapshot-id to --snapshot * Check volume status before extending size * Adding default user\_domain\_id parameter only when using password auth * Add sort support to image list * tenant\_id to project\_id in server show * Added capabilities/options to 'openstack flavor list' command to match capabilities already provided by 'nova flavor-list': * Improving the help of the lock command * Updated from global requirements * Change test order to avoid incompatibliity * Add network support to quota show * Add filter to image list * Add the ability to extend volumes in \`osc volume set\` * fix the wrong order of assertEqual args * Add 'find by name' to --nic for creating server * Remove ignore portion of tox.ini * fix object list command naming * Begin low-level API for Network v2 * Command docs: network * Add region name for identity and volume clients * Begin low-level API for Image v1 and v2 1.0.2 ----- * Fix doc building errors * Create 1.0.2 release notes * Imported Translations from Transifex * Add missing oslo-config to requirements * Update service clist commands for v2 and v3 * Default user domain id and project domain id * Add helpful messages when authN'ing with password * Add version url config workaround * Use session for neutron client * Imported Translations from Transifex * Deprecate project usage list command * Copy wiki content to index page * Copy HIG from wiki * Tweaks to the catalog doc and show command * Fine tune some of the helps commands * Command doc: policy * Updated from global requirements * Upgrade hacking to 0.10 * Command docs: add service * fix some small issues in catalog show * Rework role list v2 for --user and --project * Add versioning to the docs that missed it * Updated from global requirements * Command doc: access token * Request token authorize * Command doc: snapshot * Fix up snapshot command * Command doc: image * Request token creation docs + tweaks * Command doc: consumer * Allow user list to filter by project * Command doc: federation protocol * Command doc: identity provider * Command doc: mapping * Command doc: backup * Fixup backup list output * Command docs: volume * Update the command list * Command doc: volume type * tweak the server command docs * Check if service.name available before access * Command docs: group * Add endpoint v3 docs * Command docs: ec2 credentials * Rename column to \`default project id\` for long listing v3 user * Add missing content for token commands * Add docs for usage show/list * Command docs: flavor * Command docs: domain * Command docs: region * Add docs for listing availability zones * Bunch of formatting tweaks to server-image docs * type should be required for v2.0 service create * Command object docs: container, object * Catch exception when getting quota * Rename \`os project usage list\` to \`os usage list\` * Add usage show command * Fix a few issues with 'usage list' * Compute calls ignore region selection * add doc for group command * add doc for role assignment command * add doc for domain command * Allow service description to be set for KS V3 * Revert some docs changes from multi-delete * add multi-delete support for identity * add multi-delete support for compute/image/net/volume * Properly format 'attached to' column list when listing volumes * Don't import form keystoneclient.openstack.common * list availability zones for compute * Updated from global requirements * Tweaks after the fact 1.0.1 ----- * Release 1.0.1 * Followup for ec2 credentials command fix * Fix ec2 credentials commands for new auth * Workflow documentation is now in infra-manual 1.0.0 ----- * Command object docs: catalog, credentials, endpoint, region, token * Safely pop project parent id * Add documentation of interactive mode * 1.0.0 release notes * Command object docs: server, server image * Add the ability to list projects based on a user * Add support for domains when deleting identity v3 resources * Command object docs: project, role, user * Updated from global requirements * Command object docs: aggregate, console \*, keypair * Begin copying wiki command list here * Enhance the theming for modules page * Fix volume create --image * add keystone v3 region object * Updated from global requirements * Add --or-show support for v3 identity resources * Add authentication description doc * Add environment variable in the os-auth-type help * Liberalize version matching a bit * Add more session/api examples * Add an API example base and functional test base * Look harder to find DevStack * Add arg to 'server image create' tests * Add additional support for --or-show * Remove links from oauth consumers * Remove links from federation related commands in identity v3 * cleanup files that are created for swift functional tests * Tests work fine with random PYTHONHASHSEED * Updated from global requirements * Swap remaining assertEqual arguments * Add --or-show option to user create * Add cliff-tablib to requirements * Use fixtures from keystoneclient for static data * Unscoped federated user-specific commands * Fix server create for boot-from-volume * Adjust some logging levels * Change --os-auth-plugin to --os-auth-type * Beef up object-store tests * Include support for using oslo debugger in tests * Clean up shell authentication * Fix token issue after auth changeup * only generate one clientmanager instance in interactive mode * Remove ClientManager.\_service\_catalog * Remove now-unnecessary client creation hacks * use jsonutils in oslo.serialization instead of keystoneclient * Close files on server create, add tests * Close files on image create * Move plugin stuff to clientmanager * Update use of open() in object API * Put pbr and six first in requirements list * Add plugin to support token-endpoint auth * Remove 'links' section from several v3 Identity objects * Fix issue token for v3 * Updated from global requirements * Fix operation on clouds with availability-zones * Allow --domain to be used for identity commands without lookup * Add translation markers for user v2 actions * Add domain parameters to user show for Identity V3 * Mark identity v2 resources for translation * Support for keystone auth plugins * Add 'command list' command * CRUD operations for federated protocols * Update for cliff commandmanager >=1.6.1 * Update compute server messages for translation * Implement CRUD operations for Mapping objects * Fix issues with object related commands * Update gitignore * Add some code-blocks to the docs * Place the command to generate docs on one line * Remove duplicate env function in shell.py * Pass in domain and project as positional args, not kwargs * Create a whole slew of functional tests for identity * Add functional tests to osc * Move object-store commands to low-level API * Add low-level API base class * Test top-to-bottom: object-store containers * Updated from global requirements * utils.find\_resource does not catch right exception * Remove unused reference to keyring * v3 credential set always needs --user option * Use oslo.utils * Change help text for image save command * Fixing typo and improving docstring of find\_domain * Updated from global requirements * Acknowlege git.o.o as OpenStack's git server * Add service catalog commands * Return current user/project for user/project show commands * Add support for 'file' format objects * Add preliminary save container support * Add preliminary support for downloading objects * Stop using intersphinx * Updated from global requirements 0.4.1 ----- * Update docs and release notes for 0.4.1 release * Use Keystone client session.Session * Add action 'user password set' for identiy v3 * Unordered dicts and lists causes variable results * Leverage openstack.common.importutils for import\_class * Multiple args for object and container commands * Sync with oslo-incubator and add importutils * assertEquals order wrong * Work toward Python 3.4 support and testing * Make Identity client load like the others * Fix server add security group * Fix security group list for non-admin * Change app.restapi to app.client\_manager.session * Add i18n module to openstackclient * Create message variables for exceptions * Add oslo.i18n as a dependency * Updated from global requirements * Network use enable/disable vs admin state up/down * add service/interface/region filter for endpoint v3 * add tests for identity v3 endpoint * add tests for identity v3 domain * a mistake in tests/identity/v3/test\_role.py * Add commands for object upload and delete * test\_find\_resource fails if run alone * Use oslosphinx to generate documentation * user create v2.0 depends on tenantId in response * Updated from global requirements * v3 endpoint set shouldn't always need service option * Add container create and delete support * Cleanup README.rst * fix typo in identity/v3/endpoint.py * Add network extension list * More make\_client() logging cleanup * Change V2 image tests to actually run V2 image code * Add more columns to image list output * Normalize more help strings * Fix PEP8 E302 errors * Fix IDP commands * Update help text for some network commands * Change object API\_NAME to 'object\_store' * Add Python 3 support * Fix server resize * Add basic timing support * Clean up make\_client() logging * Domain administrator cannot do project operations * Replaced some UTF-8 characters with ASCII characters * Python 3: do not compare a list to a zip object * Allow network find to use alternate name * Move network stuff to v2 instead of v2\_0 * Catch SystemExit for parse args * Add support to list volume extensions * Python 3: remove a useless code to safe\_encode() * Add support to list compute extensions * Remove keyring support from openstackclient * trust authentication * Python 3: do not use \_\_builtin\_\_ * Updated from global requirements * Remove backslash usage from a few tests * Sort/clean setup.cfg * Rename token classes to match command * Fix PEP8 E126 and E202 errors * Fix PEP8 E265 errors * Fix PEP8 H405 errors * Fixed typos in the identity client * Network CRUD * Updated from global requirements * sync oslo bits 0.4.0 ----- * Update docs and release notes for 0.4.0 * Updated from global requirements * Complete Identity v3 list command filters * Change the token verb to issue/revoke * Update docs template * Add a docs job to tox.ini * Fix find\_resource for keystone and cinder * Image create and set command updates and tests * Refactor oauth1 code for updates * Updated from global requirements * Clean up logging levels * Ignore most of the new hacking 0.9.2 rules * Refactor role list subcommand for identity v3 api * Add support for extension list * Add role assignments list support to identity v3 * Add token delete command for identity v2 * Fixed several typos throughout the codebase * replace string format arguments with function parameters * Add tests for identity endpoints * Change volume create --volume-type to --type * Fix server image create * Display all server log when --lines option is None * Fix help message for \`ip floating delete\` * volume type create should display properties * Skip auth in cinderclient * Updated from global requirements * Implement CRUD operations for Identity Providers * Updated from global requirements * move read\_blob\_file\_contents to utils * Pass arguments to v3 keystoneclient by kwarg * Fix the project option to user list so it filters * Make endpoint commands more consistent * Correct display of project/tenant id on display of credentials * Produce a useful error message for NoUniqueMatch * identity v3 allow project list filtering by domain * Updated from global requirements * Fix 'keypair show' command output * add interface and url to endpoint list * Fixed spelling error, compatability to compatibility * Fixed Spelling errors - compatability to compatibility * Fixed spelling errors - occurance to occurence * Make bash comple command best effort to authorize * Add ability to set key value pairs in projects * Updated from global requirements * Add --volume option to image create command * Update release notes for 0.3.1 * In anticipation of network agents, rename compute 0.3.1 ----- * Use cacert values when creating identity client * Updated from global requirements * Fix volume commands with multiple regions * Add ability to prompt for passwords for user create and set * Fix some help strings * Fix format errors in nova security group rule list * Update oslo incubator bits * Python 3: the content of a FakeResponse must be bytes * Rename Openstack to OpenStack * FakeResponse: use a default status code * Python 3: fix a syntax error * Use six.iteritems() rather than dict.iteritems() * Remove tox locale overrides * Glance client no longer isa http client * Fix misspellings in python openstackclient * Add token create subcommand for identity v3 api * Updated from global requirements * Fix keyring issue where there were name space problems * Remove remaining print statements * Remove copyright from empty files * Add token create subcommand for identity v2 api * Sync with global requirements * Fix errant underscores * Add support for specifying custom domains * Fix image set properties error * Displaying curl commands for nova and cinder calls * Closes-Bug: #1262322 Make links clickable * Closes-Bug: #1262321 Remove the unimplemented post\_process method call 0.3.0 ----- * Release notes for 0.3.0 release * Remove mox3 requirement * Updated from global requirements * Update docs for plugins and release notes * Add missing requests and six requirements * Add module list command * Update OSC's CommandManager subclass * Bring RESTApi closer to ithe imminent keystoneclient.Session * Add return Closes-Bug: 1246356 * Restore Object API name 'object-store' * Expand support for command extensions * Fix typo * Support building wheels (PEP-427) * Add server image create command * Complete basic test infrastructure * change execute to run * Update URL for global hacking doc and fix typos * Remove httpretty from test requirements * Updated from global requirements * Do lookups for user, project in volume create * Adjust to non-deprecated names in Keyring 1.6.+ * Updated from global requirements * Sync oslo-incubator for py33 fixes * Add options to support TLS certificate verification * Updated from global requirements * Add object-store show commands 0.2.2 ----- * Update release notes for 0.2.2 * Sort entrypoints in setup.cfg * Fix security group entrypoints * Delay authentication to handle commands that do not require it * Identity v3 tests * Prepare for Identity v3 tests * Add to clientmanager tests * Add Identity v2 role and service tests * Refactor fake data for projects and users * Update tox.ini for new tox 1.6 config * Update requirements.txt and test-requirements.txt * Object API commands using our REST API layer * Create a new base REST API interface * Re-order oauth commands and sync with keystoneclient * Add Identity v2 user tests * Add Identity v2 project tests * Updated from global requirements 0.2.1 ----- * Add release notes in docs * Sync with global requirements 0.2.0 ----- * Change version reporting to use pbr * Modify run\_tests.sh to just run tox 0.2.rc1 ------- * Prep for 0.2 release (0.2.rc1) 0.2.alpha1 ---------- * Remove 'oauth authorization show' function from identity v3 * Remove tenant round 3 - other commands * Remove tenant round 2 - Identity API * Remove tenant round 1 - global options * Add server ssh command * Begin Python 3 compatability * Add security group commands * Add server resize command * Add server migrate command * Add server commands: (un)lock, (un)rescue, (un)set, add/remove volume * Add usage command for compute api * Add server diagnose for compute api * Fix --password in server rebuild * Change volume manager to volume type, unset property for type * Clean up properties (metadata) formatting * Add password field to set user * Add aggregate commands * Complete Image v1 * Add quota commands * Add list and delete authorizations for oauth commands * Add --catalog to service show * Update openstack-common.conf format * Add show limits command * Remove api = apiName calls from each method * Add authenticate method to oauth code * Sync install\_venv\_common from oslo * Update documentation with info about setup.cfg * Add EC2 credentials CRUD * Finish up v3 role commands * Add methods for user and group interactions * Move tests into project package * Remove python3 incompatible exception syntax * Add OAuth support for Identity V3 * Fix py26 tests: assertDictEqual * Remove explicit distribute depend * Add volume backup commands * python3: Introduce py33 to tox.ini * Rename requires files to standard names * Fix identity v2.0 entry point * Tweak volume commands and add k=v argparse action * Add domain and description to user for v3 identity * Migrate to pbr * Migrate to flake8 * Fix flake8 errors in anticipation of flake8 patch * Rename all instances of 'metadata' to 'property' * Switch to noun-verb command forms * Add console commands * Adds image \`create\` and \`delete\` functionality * Add fixed-ip and floating-ip commands * Add compute keypair commands * metadata is one word * Add policy to identity v3 * Add metadata support for volume * Make entry point strings readable * Add extra-specs support for volume-type * Add endpoint v3 functionality * Add service v3 support for identity * Add functionality for add-role commands * Add a simple extension hook * Removed unused imports * Add role v3 support to identity in openstack client * Added compute hypervisor support * Add optional arguments to volume list command * Turn down requests logging level * Add force-delete option for volumes * Add snapshot support for v1 volume * add domain, credential to identity v3 api * Add volume support for openstack client * Add compute hosts support * Clean up args and help strings in server commands * Change create flavor to use default arguments * Add metadata support for volume type * Added compute service support * Add quota v1 support for volume * Added compute flavor support * Remove underscore * Added compute agent support * Correct the version mapping to image service * Add volume test cases and structure * Add Cinder API V1 Support * Multiple API version support * Update .coveragerc * Sync latest openstack-common * Upgraded to PEP8 1.3.3 to stay aligned with Nova, etc * Copy cfg and iniparser from oslo-incubator * Clean up test\_shell so that the tests are captured though the test framework * Remove old/unsupported options from run\_tests help message * Use install\_venv\_common.py from oslo * Updated README to reflect latest changes * Ensure that image and identity clients are constructed properly * First pass at adding compute unit tests * v3 identity - group and project api * Fix test runner run\_tests.sh is broken * Use the cliff framework's ShowOne as intended for \`show image\` * Sync latest openstack-common updates * Standardize on a copyright header and ensure all files have them * Remove incorrect 'raise' * Migrate from nose to testr * Clean up test environment and remove unused imports * Updated gitignore and manifest * Adds Glance API v2 support * Move from unittest2 to testtools * Increment minimum required keystoneclient version number * bug 1091029 * Remove upper bounds on openstack dependencies * Fixes setup compatibility issue on Windows * Add OpenStack trove classifier for PyPI * Add cliff prereqs * Update compute client bits * Fix PEP8 issues * Document the use of keyring * Add nosehtmloutput as a test dependency * Keyring support for openstackclient * Secure password prompt (docs) * Use PyPI for client libs * If no password in env or command line, try prompting * Add read\_versioninfo method * Fixed a typo in the rst docs * Add post-tag versioning * Update Contributing blurb in the docs * Create tests for shell interface * Refactor cliff.Command.run() * Fix pep8 issues * Move docs to doc * minor fixes * removing print call in roles get\_data * Documented python setup.py develop * Fix 'set user' command * Add role CRUD commands * Add endpoint CRUD commands * Added :: to readme.rst to format correctly * Clean up tenant and server * Added conf.py so Sphinx docs will build * Document how to install the client * Moved test related packages to test-requires * Update service commands * Add user CRUD commands * Updating Readme Document * correcting ordering of imports * fix authentication setup in interactive mode and improve error handling so tracebacks are not printed twice * Revise command boolean flags * Move get\_client\_class() to common.utils * Add tenant CRUD commands * Add API versioning support * look at the command the user is going to run before trying to authenticate them * Add copyright notices and update dates * Add tenant commands, work on service * More identity client config * Remove printt * Add Identity to ClientManager * Fix "help" command and implement "list server" and "show server" * Adding HACKING doc to project * Change binary name to 'openstack' * Auto generate AUTHORS for python-openstackclient * Adding name to Authors and updating a bad URL. More to get my gerrit workflow up * Shell init & logging 0.1 --- * Reset project version to 0.1 * Add openstack-common and test infrastructure * Cleanup auth client path * Add 'list service' command and common modules * Add token auth to shell and README * Begin to add Keystone auth * Change to argparse to match cliff 0.2 * Clean up command output * Use cliff * Set up common utils * Add openstackclient bits * First commit ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/Dockerfile0000664000175100017510000000257515033046464020352 0ustar00mylesmyles# Copyright (c) 2020 Red Hat, Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # implied. # See the License for the specific language governing permissions and # limitations under the License. FROM docker.io/opendevorg/python-builder:3.12-bookworm AS builder COPY . /tmp/src RUN assemble FROM docker.io/opendevorg/python-base:3.12-bookworm LABEL org.opencontainers.image.title="python-openstackclient" LABEL org.opencontainers.image.description="Client for OpenStack services." LABEL org.opencontainers.image.licenses="Apache License 2.0" LABEL org.opencontainers.image.url="https://www.openstack.org/" LABEL org.opencontainers.image.documentation="https://docs.openstack.org/python-openstackclient/latest/" LABEL org.opencontainers.image.source="https://opendev.org/openstack/python-openstackclient" COPY --from=builder /output/ /output RUN /output/install-from-bindep # Trigger entrypoint loading to trigger stevedore entrypoint caching RUN openstack --help >/dev/null 2>&1 CMD ["/usr/local/bin/openstack"] ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/HACKING.rst0000664000175100017510000000240715033046464020150 0ustar00mylesmylesOpenStack Style Commandments ============================ - Step 1: Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/ - Step 2: Read on General ------- - thou shalt not violate causality in our time cone, or else Docstrings ---------- Docstrings should ONLY use triple-double-quotes (``"""``) Single-line docstrings should NEVER have extraneous whitespace between enclosing triple-double-quotes. Deviation! Sentence fragments do not have punctuation. Specifically in the command classes the one line docstring is also the help string for that command and those do not have periods. """A one line docstring looks like this""" Calling Methods --------------- Deviation! When breaking up method calls due to the 79 char line length limit, use the alternate 4 space indent. With the first argument on the succeeding line all arguments will then be vertically aligned. Use the same convention used with other data structure literals and terminate the method call with the last argument line ending with a comma and the closing paren on its own line indented to the starting line level. :: unnecessarily_long_function_name( 'string one', 'string two', kwarg1=constants.ACTIVE, kwarg2=['a', 'b', 'c'], ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/LICENSE0000664000175100017510000002363715033046464017367 0ustar00mylesmyles Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9781103 python_openstackclient-8.1.1.dev14/PKG-INFO0000644000175100017510000002351715033046512017444 0ustar00mylesmylesMetadata-Version: 2.2 Name: python-openstackclient Version: 8.1.1.dev14 Summary: OpenStack Command-line Client Author-email: OpenStack License: Apache-2.0 Project-URL: Homepage, https://docs.openstack.org/python-openstackclient/ Project-URL: Repository, https://opendev.org/openstack/python-openstackclient/ Classifier: Environment :: OpenStack Classifier: Intended Audience :: Information Technology Classifier: Intended Audience :: System Administrators Classifier: License :: OSI Approved :: Apache Software License Classifier: Operating System :: POSIX :: Linux Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: 3.12 Classifier: Programming Language :: Python :: 3.13 Requires-Python: >=3.10 Description-Content-Type: text/x-rst License-File: LICENSE Requires-Dist: pbr!=2.1.0,>=2.0.0 Requires-Dist: cryptography>=2.7 Requires-Dist: cliff>=4.8.0 Requires-Dist: iso8601>=0.1.11 Requires-Dist: openstacksdk>=4.5.0 Requires-Dist: osc-lib>=2.3.0 Requires-Dist: oslo.i18n>=3.15.3 Requires-Dist: python-keystoneclient>=3.22.0 Requires-Dist: python-cinderclient>=3.3.0 Requires-Dist: requests>=2.27.0 Requires-Dist: stevedore>=2.0.1 Dynamic: requires-dist =============== OpenStackClient =============== .. image:: https://img.shields.io/pypi/v/python-openstackclient.svg :target: https://pypi.org/project/python-openstackclient/ :alt: Latest Version OpenStackClient (OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Network, Object Store and Block Storage APIs together in a single shell with a uniform command structure. Support for additional service APIs is provided via plugins. The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack. Getting Started =============== OpenStack Client can be installed from PyPI using pip: .. code-block:: shell python3 -m pip install python-openstackclient You can use ``--help`` or the ``help`` command to get a list of global options and supported commands: .. code-block:: shell openstack --help openstack help You can also get help for a specific command: .. code-block:: shell openstack server create --help openstack help server create You can add support for additional services by installing their clients. For example, to add support for the DNS service (designate): .. code-block:: shell python3 -m pip install python3-designateclient A ``Dockerfile`` is provided for your convenience in the repository. You can use this to build your own container images: .. code-block:: shell git clone https://opendev.org/openstack/python-openstackclient cd python-openstackclient podman build . -t example.com/myuser/openstackclient For more information the available options and commands, refer to the `Users Guide`__. .. __: https://docs.openstack.org/python-openstackclient/latest/cli/index.html Configuration ============= OpenStack Client must be configured with authentication information in order to communicate with a given OpenStack cloud. This configuration can be achieved via a ``clouds.yaml`` file, a set of environment variables (often shared via an ``openrc`` file), a set of command-line options, or a combination of all three. Your cloud provider or deployment tooling will typically provide either a ``clouds.yaml`` file or ``openrc`` file for you. If using a ``clouds.yaml`` file, OpenStack Client expects to find it in one of the following locations: * If set, the path indicated by the ``OS_CLIENT_CONFIG_FILE`` environment variable * ``.`` (the current directory) * ``$HOME/.config/openstack`` * ``/etc/openstack`` The options you should set will depend on the configuration of your cloud and the authentication mechanism(s) supported. For example, consider a cloud that supports username/password authentication. Configuration for this cloud using a ``clouds.yaml`` file would look like so: .. code-block:: yaml clouds: my-cloud: auth: auth_url: '' project_name: '' project_domain_name: '' username: '' user_domain_name: '' password: '' # (optional) region_name: '' The corresponding environment variables would look very similar: .. code-block:: shell export OS_AUTH_URL= export OS_REGION_NAME= export OS_PROJECT_NAME= export OS_PROJECT_DOMAIN_NAME= export OS_USERNAME= export OS_USER_DOMAIN_NAME= export OS_PASSWORD= # (optional) Likewise, the corresponding command-line options would look very similar: :: openstack --os-auth-url --os-region --os-project-name --os-project-domain-name --os-username --os-user-domain-name [--os-password ] .. note:: If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely. Some clouds use federated authentication. If this is the case, your configuration will be slightly more involved. For example, to configure username/password authentication for a federated user using a ``clouds.yaml`` file: .. code-block:: yaml clouds: my-cloud: auth: auth_url: '' project_name: '' project_domain_name: '' username: '' user_domain_name: '' password: '' identity_provider: '' client_id: '' client_secret: '' openid_scope: '' protocol: '' access_token_type: '' discovery_endpoint: '' auth_type: 'v3oidcpassword' region_name: '' The corresponding environment variables would look very similar: .. code-block:: shell export OS_PROJECT_NAME= export OS_PROJECT_DOMAIN_NAME= export OS_AUTH_URL= export OS_IDENTITY_API_VERSION=3 export OS_AUTH_TYPE=v3oidcpassword export OS_USERNAME= export OS_PASSWORD= export OS_IDENTITY_PROVIDER= export OS_CLIENT_ID= export OS_CLIENT_SECRET= export OS_OPENID_SCOPE= export OS_PROTOCOL= export OS_ACCESS_TOKEN_TYPE= export OS_DISCOVERY_ENDPOINT= Likewise, the corresponding command-line options would look very similar: .. code-block:: shell --os-project-name --os-project-domain-name --os-auth-url --os-identity-api-version 3 --os-auth-plugin openid --os-auth-type v3oidcpassword --os-username --os-password --os-identity-provider --os-client-id --os-client-secret --os-openid-scope --os-protocol --os-access-token-type --os-discovery-endpoint For more information on configuring authentication, including an overview of the many authentication mechanisms supported, refer to the `Authentication guide`__. For more information on configuration in general, refer to the `Configuration guide`__. .. __: https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html. .. __: https://docs.openstack.org/python-openstackclient/latest/configuration/index.html Contributing ============ You can clone the repository from opendev.org:: git clone https://opendev.org/openstack/python-openstackclient cd python-openstackclient OpenStack Client uses the same contributor process as other OpenStack projects. For information on this process, including help on setting up you Gerrit account and an overview of the CI process, refer to the `OpenStack Contributors Guide`__. For more information on contributing to OpenStack Client itself, including guidance on how to design new commands and how to report bugs, refer to the `Contributors Guide`__. .. __: https://docs.openstack.org/python-openstackclient/latest/contributor/index.html .. __: https://docs.opendev.org/opendev/infra-manual/latest/developers.html Links ----- * `Issue Tracker `_ * `Code Review `_ * `Documentation `_ * `PyPi `_ * `Mailing list `_ * `Release Notes `_ * `IRC (#openstack-sdks on OFTC (irc.oftc.net)) `_ ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/README.rst0000664000175100017510000002075015033046464020042 0ustar00mylesmyles=============== OpenStackClient =============== .. image:: https://img.shields.io/pypi/v/python-openstackclient.svg :target: https://pypi.org/project/python-openstackclient/ :alt: Latest Version OpenStackClient (OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Network, Object Store and Block Storage APIs together in a single shell with a uniform command structure. Support for additional service APIs is provided via plugins. The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack. Getting Started =============== OpenStack Client can be installed from PyPI using pip: .. code-block:: shell python3 -m pip install python-openstackclient You can use ``--help`` or the ``help`` command to get a list of global options and supported commands: .. code-block:: shell openstack --help openstack help You can also get help for a specific command: .. code-block:: shell openstack server create --help openstack help server create You can add support for additional services by installing their clients. For example, to add support for the DNS service (designate): .. code-block:: shell python3 -m pip install python3-designateclient A ``Dockerfile`` is provided for your convenience in the repository. You can use this to build your own container images: .. code-block:: shell git clone https://opendev.org/openstack/python-openstackclient cd python-openstackclient podman build . -t example.com/myuser/openstackclient For more information the available options and commands, refer to the `Users Guide`__. .. __: https://docs.openstack.org/python-openstackclient/latest/cli/index.html Configuration ============= OpenStack Client must be configured with authentication information in order to communicate with a given OpenStack cloud. This configuration can be achieved via a ``clouds.yaml`` file, a set of environment variables (often shared via an ``openrc`` file), a set of command-line options, or a combination of all three. Your cloud provider or deployment tooling will typically provide either a ``clouds.yaml`` file or ``openrc`` file for you. If using a ``clouds.yaml`` file, OpenStack Client expects to find it in one of the following locations: * If set, the path indicated by the ``OS_CLIENT_CONFIG_FILE`` environment variable * ``.`` (the current directory) * ``$HOME/.config/openstack`` * ``/etc/openstack`` The options you should set will depend on the configuration of your cloud and the authentication mechanism(s) supported. For example, consider a cloud that supports username/password authentication. Configuration for this cloud using a ``clouds.yaml`` file would look like so: .. code-block:: yaml clouds: my-cloud: auth: auth_url: '' project_name: '' project_domain_name: '' username: '' user_domain_name: '' password: '' # (optional) region_name: '' The corresponding environment variables would look very similar: .. code-block:: shell export OS_AUTH_URL= export OS_REGION_NAME= export OS_PROJECT_NAME= export OS_PROJECT_DOMAIN_NAME= export OS_USERNAME= export OS_USER_DOMAIN_NAME= export OS_PASSWORD= # (optional) Likewise, the corresponding command-line options would look very similar: :: openstack --os-auth-url --os-region --os-project-name --os-project-domain-name --os-username --os-user-domain-name [--os-password ] .. note:: If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely. Some clouds use federated authentication. If this is the case, your configuration will be slightly more involved. For example, to configure username/password authentication for a federated user using a ``clouds.yaml`` file: .. code-block:: yaml clouds: my-cloud: auth: auth_url: '' project_name: '' project_domain_name: '' username: '' user_domain_name: '' password: '' identity_provider: '' client_id: '' client_secret: '' openid_scope: '' protocol: '' access_token_type: '' discovery_endpoint: '' auth_type: 'v3oidcpassword' region_name: '' The corresponding environment variables would look very similar: .. code-block:: shell export OS_PROJECT_NAME= export OS_PROJECT_DOMAIN_NAME= export OS_AUTH_URL= export OS_IDENTITY_API_VERSION=3 export OS_AUTH_TYPE=v3oidcpassword export OS_USERNAME= export OS_PASSWORD= export OS_IDENTITY_PROVIDER= export OS_CLIENT_ID= export OS_CLIENT_SECRET= export OS_OPENID_SCOPE= export OS_PROTOCOL= export OS_ACCESS_TOKEN_TYPE= export OS_DISCOVERY_ENDPOINT= Likewise, the corresponding command-line options would look very similar: .. code-block:: shell --os-project-name --os-project-domain-name --os-auth-url --os-identity-api-version 3 --os-auth-plugin openid --os-auth-type v3oidcpassword --os-username --os-password --os-identity-provider --os-client-id --os-client-secret --os-openid-scope --os-protocol --os-access-token-type --os-discovery-endpoint For more information on configuring authentication, including an overview of the many authentication mechanisms supported, refer to the `Authentication guide`__. For more information on configuration in general, refer to the `Configuration guide`__. .. __: https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html. .. __: https://docs.openstack.org/python-openstackclient/latest/configuration/index.html Contributing ============ You can clone the repository from opendev.org:: git clone https://opendev.org/openstack/python-openstackclient cd python-openstackclient OpenStack Client uses the same contributor process as other OpenStack projects. For information on this process, including help on setting up you Gerrit account and an overview of the CI process, refer to the `OpenStack Contributors Guide`__. For more information on contributing to OpenStack Client itself, including guidance on how to design new commands and how to report bugs, refer to the `Contributors Guide`__. .. __: https://docs.openstack.org/python-openstackclient/latest/contributor/index.html .. __: https://docs.opendev.org/opendev/infra-manual/latest/developers.html Links ----- * `Issue Tracker `_ * `Code Review `_ * `Documentation `_ * `PyPi `_ * `Mailing list `_ * `Release Notes `_ * `IRC (#openstack-sdks on OFTC (irc.oftc.net)) `_ ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928137.0 python_openstackclient-8.1.1.dev14/RELEASENOTES.rst0000664000175100017510000103673515033046511021002 0ustar00mylesmyles====================== python-openstackclient ====================== .. _python-openstackclient_8.1.0-9: 8.1.0-9 ======= .. _python-openstackclient_8.1.0-9_New Features: New Features ------------ .. releasenotes/notes/add-volume-list-property-option-62008dc24762663b.yaml @ b'572eeb6d38f92669580b34d0d0a2b217fc999179' - Add ``--property`` option to ``volume list`` command to filter volumes. .. _python-openstackclient_8.1.0: 8.1.0 ===== .. _python-openstackclient_8.1.0_New Features: New Features ------------ .. releasenotes/notes/add-user-project-enabled-filters-9f2090cdcc97b667.yaml @ b'34831172598d20e211147a8c3758d2b3383ea256' - Add filters to search for enabled and disabled users and projects. .. releasenotes/notes/compute-add-validate-console-auth-token-1eda2bd62060ccfa.yaml @ b'5d730f374b63bbc2121a025638b7abe79f156f53' - Add support for the new ``spice-direct`` console type, as well as the exposing the ability for admins to lookup console connection information via the new ``console connection show`` command. .. releasenotes/notes/fip-filter-opts-a847f8743fef467f.yaml @ b'01c1b1e36fd712cc6d3367ca23525e7e0b3e9f4d' - The ``--network``, ``--port``, and ``--router`` options of the ``floating ip list`` command can now be specified multiple times. .. _python-openstackclient_8.1.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/confirm-reset-state-24497c8b24990aa7.yaml @ b'25cd1178b31a3d5582ab4ad77518fb63a856fd88' - The ``openstack server set`` command has been extended with a new parameter ``--auto-approve`` and the existing ``--state`` parameter has been modified to require confirmation before resetting the state. .. releasenotes/notes/drop-python-39-fc95c2d17a862e3e.yaml @ b'ce2a253d5ac8603c61f4e868e2126354e1cfe4db' - Support for Python 3.9 has been dropped. .. releasenotes/notes/migrate-domain-to-sdk-da6ec38221e79a37.yaml @ b'4bdd51cbea41e08f4c78bf071ac4f76d18f42b41' - The following commands have been migrated to SDK: - ``domain create`` - ``domain delete`` - ``domain list`` - ``domain set`` - ``domain show`` .. releasenotes/notes/migrate-group-to-sdk-59beef31a7c40bbb.yaml @ b'a2be1b014e020e9effb1a72e45781e47236b9606' - Migrate ``group`` commands from keystoneclient to SDK. .. _python-openstackclient_8.0.0: 8.0.0 ===== .. _python-openstackclient_8.0.0_New Features: New Features ------------ .. releasenotes/notes/network-ovn-agents-bdfced3a6d25e7d2.yaml @ b'762a3b10d13716e2bc4cef121d5b70ced6958d42' - Added four new network agent types to the list method filter: ``ovn-controller``, ``ovn-controller-gateway``, ``ovn-metadata`` and ``ovn-agent``. .. releasenotes/notes/router-create-with-qos-policy-b94967a35351cddd.yaml @ b'07515cd1602841851d72dac30c7b12affee27bbe' - The router creation command now has the parameter ``--qos-policy``, that allows to set a QoS policy for the provided external gateways (one or many). It is mandatory to define an external gateway if the QoS policy is set. .. _python-openstackclient_8.0.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/migrate-endpoint-to-sdk-8ca5a34794b6bd7e.yaml @ b'7750fc1cf45a32563225092ec442c96c38ee6769' - The following commands have been migrated to SDK: - ``endpoint create`` - ``endpoint delete`` - ``endpoint list`` - ``endpoint show`` - ``endpoint set`` .. releasenotes/notes/remove-volume-v1-commands-bfa14e9cae54929f.yaml @ b'e6be9a3edf0904762cb6816a04b8d3d146a1f639' - Support for the Block Storage (Cinder) v1 API has been officially removed as it had been broken for some time. If you haven't noticed then you likely don't need to do anything. However, in the unlikely event that your cloud is using the Block Storage v1 API - or incorrectly advertises the Block Storage v1 API - consider overriding the API version to use v2 as this behaves very similarly. It may also be necessary to set an endpoint override for the Block Storage API if your clouds service catalog is not configured correctly. For example: .. code-block:: yaml example: regions: - name: regionOne values: block_storage_endpoint_override: 'https://blockstorage.api.cloud.example/' volume_api_version: 2 If using a public cloud provider, there may also be a profile already published that sets these. These are listed in the `Vendor Support`__ doc. For example: .. code-block:: yaml example: profile: rackspace Alternatively, consider use versions of OSC < 3.19 and python-cinderclient < 5.0 (both Stein), since these were the last versions to fully support Cinder v1. .. __: https://docs.openstack.org/openstacksdk/latest/user/config/vendor-support.html .. _python-openstackclient_2.3.1: 2.3.1 ===== .. _python-openstackclient_2.3.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1560157-bce572f58b43efa1.yaml @ b'53a79c33f88cea83fb2a90408dd3f5e8dd48a2f5' - Fixed SSL/TLS verification for Network v2 commands. The commands were ignoring the ``--insecure`` and ``--os-cacert`` options and the ``OS_CACERT`` environment variable which caused them to fail with ``An SSL error occurred.`` when authenticating using SSL/TLS. [Bug `1560157 `_] .. _python-openstackclient_2.2.0: 2.2.0 ===== .. _python-openstackclient_2.2.0_New Features: New Features ------------ .. releasenotes/notes/add-osprofiler-support-adf5286daf220914.yaml @ b'16f00833a70893979ccdf7ffb7f6e1e7653cdc24' - OSprofiler support was added. To initiate OpenStack request tracing ``--profile `` option needs to be added to the CLI command. This key needs to present one of the secret keys defined in the OpenStack projects configuration files (if there is a wish to generate cross-project trace, the chosen key needs to be presented in all these configuration files). By default all OpenStack projects, that support OSprofiler, are using ``SECRET_KEY`` HMAC key. To use tracing functionality OSprofiler (and its storage backend) needs to be installed in the environment. If so, you will be able to trigger profiling via `openstack --profile SECRET_KEY ` command. At the end of output there will be message with , and to plot human-readable HTML chart the following command should be used - ``osprofiler trace show --html --out result.html``. .. releasenotes/notes/allow-custom-logging-12d55f8ed859ff8e.yaml @ b'cdb7637b76027f74db9b24026a0757084a83195d' - Allow custom logging of components [Bug `1484660 `_] .. releasenotes/notes/bug-1519502-f72236598d14d350.yaml @ b'f0960f0fef263298e56d7e81acf50597073becc7' - Command ``ip floating delete`` is now available for neutron network. [Bug `1519502 `_] .. releasenotes/notes/bug-1519502-f72236598d14d350.yaml @ b'f0960f0fef263298e56d7e81acf50597073becc7' - Command ``ip floating list`` is now available for neutron network. [Bug `1519502 `_] .. releasenotes/notes/bug-1519502-f72236598d14d350.yaml @ b'f0960f0fef263298e56d7e81acf50597073becc7' - Add command ``ip floating show`` for neutron and nova network. [Bug `1519502 `_] .. releasenotes/notes/bug-1519512-48624c5a32432a47.yaml @ b'dccde70c57baf9266a795a54198238515d7fdda6' - Add support for ``security group rule show`` command. [Bug `1519512 `_] .. releasenotes/notes/bug-1538372-ef3a30298357f972.yaml @ b'6b3583ab06459dad8c2aa1b762538516047b8b41' - Add support for the `server dump create` command [Bug `1538372 `_] .. releasenotes/notes/bug-1542359-181d28db21a2358a.yaml @ b'112d7b0e0966599aa940de4c0598cea759780785' - Add ``subnet show`` command. [Bug `1542359 `_] .. releasenotes/notes/bug-1542362-ddad607f6d3025f0.yaml @ b'88c92bf71ae026b90b07411772c66b718a7d59e1' - Add ``subnet delete`` command to openstack-client. [Bug `1542362 `_] .. releasenotes/notes/bug-1543226-7d885ecaa3715415.yaml @ b'686a26973809eaba3deb9aed63daddba3bb0521e' - Add ``token revoke`` command for Identity v3 [Bug `1543226 `_] .. releasenotes/notes/bug-1543672-bad2fc4c6c8f3125.yaml @ b'359dfa1a06683354ace568c78706e3d0a6372c14' - Command ``network delete`` is now available for nova network. [Bug `1543672 `_] .. releasenotes/notes/bug-1543672-bad2fc4c6c8f3125.yaml @ b'359dfa1a06683354ace568c78706e3d0a6372c14' - Command ``network list`` is now available for nova network. [Bug `1543672 `_] .. releasenotes/notes/bug-1543672-bad2fc4c6c8f3125.yaml @ b'359dfa1a06683354ace568c78706e3d0a6372c14' - Command ``network show`` is now available for nova network. [Bug `1543672 `_] .. releasenotes/notes/bug-1543672-bad2fc4c6c8f3125.yaml @ b'359dfa1a06683354ace568c78706e3d0a6372c14' - Command ``network create`` is now available for nova network. [Bug `1543672 `_] .. releasenotes/notes/bug-1544587-ec3ca453c1340b4e.yaml @ b'79fd6d3f2075ecdfdac8c856be135b3fd1260eb5' - Add support for ``subnet pool delete`` command. [Bug `1544587 `_] .. releasenotes/notes/bug-1544589-b9f669ef71aa5e57.yaml @ b'a04012c3d50c3623c699f57d0dd320783b92e1cb' - Add support for ``subnet pool list`` command. [Bug `1544589 `_] .. releasenotes/notes/bug-1544590-8cf42954e28c2f42.yaml @ b'3c8bb165137ee1f17d99c270896b37fb9d00f07c' - Add support for ``subnet pool show`` command. [Bug `1544590 `_] .. releasenotes/notes/list_role_assignment_names-0db89f50259d4be2.yaml @ b'3a48989eb02187f384cfbf7bb7cd55502741fc68' - [`bug 1479569 `_] Add an optional ``--names`` argument to the `role assignment list`` command. This will output names instead of IDs for users, groups, roles, projects, and domains. .. releasenotes/notes/recursive-container-delete-983361aa9c35ffed.yaml @ b'828f63f903ee71a9f63ebaab3638fe441768a35a' - Add support for recursive container delete. [Bug `1542718 `_] .. _python-openstackclient_2.2.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1519511-74bab0e0d32db043.yaml @ b'842882f3cbfca6df9a42bc49b0deefdb84509a8e' - Ignore the ``security group list`` command ``--all-projects`` option for Network v2 since security groups will be displayed for all projects by default (admin only). [Bug `1519511 `_] .. releasenotes/notes/bug-1543214-959aee7830db2b0d.yaml @ b'41e1bd0be64e15a5e0c12b45bdf3dcde5fabf244' - The ``token issue`` can now return an unscoped token. If a `project` or `domain` target scope are not specified, an unscoped token will be returned. [Bug `1543214 `_] .. releasenotes/notes/bug-1546065-41d09ffbd8606513.yaml @ b'ba826fa04fd5f16658da0319f34e26f14d7716d2' - Command ``flavor set/unset`` now outputs nothing. [Bug `1546065 `_] .. releasenotes/notes/bug-1546065-41d09ffbd8606513.yaml @ b'ba826fa04fd5f16658da0319f34e26f14d7716d2' - Command ``security group set`` now outputs nothing. [Bug `1546065 `_] .. releasenotes/notes/bug-1546065-41d09ffbd8606513.yaml @ b'ba826fa04fd5f16658da0319f34e26f14d7716d2' - Command ``compute agent set`` now outputs nothing. [Bug `1546065 `_] .. releasenotes/notes/bug-1546065-41d09ffbd8606513.yaml @ b'ba826fa04fd5f16658da0319f34e26f14d7716d2' - Command ``aggregate set`` now outputs nothing. [Bug `1546065 `_] .. _python-openstackclient_2.1.0: 2.1.0 ===== .. _python-openstackclient_2.1.0_New Features: New Features ------------ .. releasenotes/notes/add-port-delete-command-4789d3881b186cfc.yaml @ b'3168e2297d0b48c240b22fb6d8c1b7d05def1e6b' - Add support for the ``port delete`` command. [Bug `1519909 `_] .. releasenotes/notes/add-port-show-command-de0a599017189a21.yaml @ b'981621e9845934c109c5e4abd9b2ab6828744346' - Add support for the ``port show`` command. [Bug `1519909 `_] .. releasenotes/notes/add-subnet-list-command-970f4b397469bdc6.yaml @ b'299c5710c518d9502a23f5240360047baa81ac8d' - Add support for the ``subnet list`` command. [Bug `1523258 `_] .. releasenotes/notes/bug-1486597-857e20262c038514.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Add ``project unset`` command for Identity v2 [Bug `1486597 `_] .. releasenotes/notes/bug-1516661-757ef629f899cca3.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Add ``image set --activate|--deactivate`` options (Image v2 only) [Bug `1516661 `_] .. releasenotes/notes/bug-1517134-9efecb257910989c.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Add ``--project-domain`` option to ``image create`` and ``image set`` commands (Image v2 only) [Bug `1517134 `_] .. releasenotes/notes/bug-1519503-978a68a54819dbbc.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Add ``router`` commands ``create``, ``delete``, ``list``, ``set``, ``show`` [Bug `1519503 `_] .. releasenotes/notes/bug-1522969-63abf273c6e71a07.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Add ``--src-group`` option to ``security group rule create`` to include a 'remote' security group rule. [Bug `1522969 `_] .. releasenotes/notes/bug-1532945-1a5485b8d0ebddb8.yaml @ b'99f6795189b188b8c560507b7f8101b1cd820392' - Add volume support to ``os availability zone list`` [Bug `1532945 `_] * New ``--compute`` option to only list compute availability zones. * New ``--volume`` option to only list volume availability zones. .. releasenotes/notes/bug-1534202-1ba78f0bb744961f.yaml @ b'99f6795189b188b8c560507b7f8101b1cd820392' - Add network support to ``os availability zone list`` [Bug `1534202 `_] * New ``--network`` option to only list network availability zones. .. releasenotes/notes/bug-1540988-17841cfd5accf7f5.yaml @ b'499369329c493f9734248393ff19a82b5e224078' - Add ``--limit`` option to ``image list`` to limit the number of images in output. [Bug `1540988 `_] .. releasenotes/notes/bug-1540988-17841cfd5accf7f5.yaml @ b'499369329c493f9734248393ff19a82b5e224078' - Add ``--marker`` option to ``image list`` to handle paginate requests. [Bug `1540988 `_] .. _python-openstackclient_2.1.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1519512-d20f44aca1f9e9b9.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Make ``security group rule list`` group argument optional to list all security groups [Bug `1519512 `_] .. releasenotes/notes/bug-1520003-505af921c8afffc9.yaml @ b'99f6795189b188b8c560507b7f8101b1cd820392' - Add remote security group to ``os security group rule list`` [Bug `1520003 `_] .. releasenotes/notes/bug-1521492-89b972c6362940a5.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Change ``server list --flavor`` to now accept flavor ID or name [Bug `1521492 `_] .. releasenotes/notes/bug-1521492-8cde2601591a8c78.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Change ``server list --image`` to now accept image ID or name [Bug `1521492 `_] .. releasenotes/notes/bug-1524456-9967fac653c91cb2.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Change the ``project set --domain`` option to use the argument as a lookup for locating projects in non-default domains. [Bug `1524456 `_] .. releasenotes/notes/bug-1525805-122e6ce0c3cd4945.yaml @ b'cd4998ef41d7bed8cfb3ae849f522e07162913f5' - Fix case sensitivity when showing object-store properties. [Bug `1525805 `_] .. releasenotes/notes/bug-1531360-0f5c62d18088e5b5.yaml @ b'5cbecc130ef2aacd5d9bd265b814e6f8140374f9' - Support non-interactive user password update [Bug `1531360 `_] .. _python-openstackclient_2.1.0_Other Notes: Other Notes ----------- .. releasenotes/notes/bug-1527833-42cde11d28b09ac3.yaml @ b'99f6795189b188b8c560507b7f8101b1cd820392' - Change the ``--owner`` option to ``--project`` in ``image create`` and ``image set`` commands. ``--owner`` is deprecated and no longer documented but is still accepted; a warning message will be shown if it is used. [Bug `1527833 `_] .. _python-openstackclient_2.0.0: 2.0.0 ===== .. _python-openstackclient_2.0.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/no-project-usage-list-e88eb49aa2e96cf7.yaml @ b'552eded9ad102bfafee734b2a7a4c9aa8d806ce6' - Removed the deprecated command ``project usage list`` in favor of ``usage list`` .. _python-openstackclient_2.0.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1475831-3caafd724d4ed644.yaml @ b'e604a726b2608941dc2b60cf4f071e7777ba2b17' - Some compute quotas were not being set [Bug `1475831 `_] .. releasenotes/notes/bug-1517386-1c0aad8e3203b02b.yaml @ b'e604a726b2608941dc2b60cf4f071e7777ba2b17' - Add `--all` for `snapshot list` [Bug `1517386 `_] .. releasenotes/notes/bug-1519181-932c1ff07ef16666.yaml @ b'552eded9ad102bfafee734b2a7a4c9aa8d806ce6' - Add Status column to default ``image list`` output (v1 and v2) [Bug `1519181 `_] .. releasenotes/notes/bug-1520115-0367e1c8917dc912.yaml @ b'552eded9ad102bfafee734b2a7a4c9aa8d806ce6' - Fix ``--public|--private`` options for ``volume type create`` command to correctly pass privacy argument to client library [Bug `1520115 `_] .. releasenotes/notes/bug-1520541-44d45e4693089c03.yaml @ b'552eded9ad102bfafee734b2a7a4c9aa8d806ce6' - Fix ``volume delete`` command to delete all specified volumes rather than only the last volume [Bug `1520541 `_] .. _python-openstackclient_2.0.0_Other Notes: Other Notes ----------- .. releasenotes/notes/add-ksa-7f0795157d93a898.yaml @ b'e604a726b2608941dc2b60cf4f071e7777ba2b17' - Add dependency on keystoneauth1 module to perform authentication in place of python-keystoneclient. .. releasenotes/notes/bug-1519510-3cde4643b33ebb7a.yaml @ b'e604a726b2608941dc2b60cf4f071e7777ba2b17' - Drop Python 2.6 support [Bug `1519510 `_] .. releasenotes/notes/server-changes-3962541b6ebdbbd8.yaml @ b'552eded9ad102bfafee734b2a7a4c9aa8d806ce6' - Changes to ``server`` resource commands: * Added ``--limit`` and ``--marker`` to ``server list`` * Added ``server shelve`` * Added ``server unshelve`` * ``server resume`` now takes multiple server arguments * ``server suspend`` now takes multiple server arguments .. _python-openstackclient_3.2.1-4: 3.2.1-4 ======= .. _python-openstackclient_3.2.1-4_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1650026-0ce6a77e69d24424.yaml @ b'e79eca55aae02206bd10e663b1540078424d9734' - Fixed a ``__init__() got an unexpected keyword argument 'project_name'`` error in various networking commands when ``help`` or ``--help`` was used. [Bug `1650026 `_] .. _python-openstackclient_3.2.1: 3.2.1 ===== .. _python-openstackclient_3.2.1_Security Issues: Security Issues --------------- .. releasenotes/notes/bug-1630822-mask-password-on-debug-20dcdf1c54e84fa1.yaml @ b'48e6d8a361ae828c6f3c12f1f3284d7e71cf5338' - Mask passwords when ``--debug`` or ``-vv`` options are used. [Bug `1630822 `_] .. _python-openstackclient_3.2.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1619274-e78afd7c12ea2c3d.yaml @ b'48e6d8a361ae828c6f3c12f1f3284d7e71cf5338' - 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* .. releasenotes/notes/bug-1642301-ad04424c80e8fe50.yaml @ b'48e6d8a361ae828c6f3c12f1f3284d7e71cf5338' - 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* .. _python-openstackclient_3.2.0: 3.2.0 ===== .. _python-openstackclient_3.2.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1617384-55c88207115e2a5b.yaml @ b'84c83fc3aeebf8201a301f1864c3b8a1572111f1' - Fix prompting for password issue introduced in release 3.0.0 [Bug `1617384 `_] .. _python-openstackclient_3.0.0: 3.0.0 ===== .. _python-openstackclient_3.0.0_New Features: New Features ------------ .. releasenotes/notes/add-port-unset-command-8bdaf1fa9c593374.yaml @ b'230d38fb4ca0235706a9cd7617628b84413075b7' - Add a new command ``port unset`` to clear the information of fixed-ip and binding-profile from the port. [ Blueprint `network-property-unset `_] .. releasenotes/notes/add-server-group-quotas-b67fcba98619f0c9.yaml @ b'b50c2b6a8847219ec6d3916f429dec77cf2ba180' - Added support of --server-groups --server-group-members options to ``quota set`` command. [Bug `1602223 `_] .. releasenotes/notes/bp-backup-snapshot-renamed-for-volume-resource-2d2d13ea8489a61f.yaml @ b'39c5eb9e3fe89bf177e513e447f22b62f5e4785c' - 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 `_] .. releasenotes/notes/bp-implement-network-agents-5eba48796318f094.yaml @ b'722be75f9cffec7242d893cac20d40c570af32d6' - Add ``network agent delete``, ``network agent list``, ``network agent show`` and ``network agent set`` commands. [Blueprint `implement-network-agents `_] .. releasenotes/notes/bp-multi-argument-compute-0bc4522f6edca355.yaml @ b'af7ab03693a5708102cf6746563da289e4c1e3b7' - Support bulk deletion and error handling for ``aggregate delete``, ``flavor delete``, ``keypair delete`` and ``service delete`` commands. [Blueprint `multi-argument-compute `_] .. releasenotes/notes/bp-multi-argument-network-e43e192ac95db94d.yaml @ b'041ea4978b94149d5037b5afc7743db939b75331' - Support bulk deletion for ``subnet pool delete``, ``subnet delete``, ``floating ip delete``, ``security group delete`` and ``security group rule delete``. [Blueprint `multi-argument-network `_] .. releasenotes/notes/bp-neutron-client-a0552f8ca909b665.yaml @ b'412b29b972e4a6877472147f5b713214ace2ca12' - Update ``--binding-profile`` option on the ``port create`` and ``port set`` commands to support JSON input for more advanced binding profile data. [Blueprint :oscbp:`neutron-client`] .. releasenotes/notes/bp-neutron-client-a0552f8ca909b665.yaml @ b'412b29b972e4a6877472147f5b713214ace2ca12' - 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 :oscbp:`neutron-client`] .. releasenotes/notes/bp-neutron-client-a0552f8ca909b665.yaml @ b'412b29b972e4a6877472147f5b713214ace2ca12' - Add ``geneve`` choice to the ``network create`` command ``--provider-network-type`` option. [Blueprint :oscbp:`neutron-client`] .. releasenotes/notes/bp-neutron-client-a0552f8ca909b665.yaml @ b'412b29b972e4a6877472147f5b713214ace2ca12' - Add ``--device-owner`` option to the ``port list`` command to enable listing ports based on device owner. [Blueprint :oscbp:`neutron-client`] .. releasenotes/notes/bp-neutron-client-rbac-bbd7b545b50d2bdf.yaml @ b'fac321458166cccffc0eb1d13a986a01c9e6d33e' - Add ``network rbac list``, ``network rbac show``, ``network rbac create``, ``network rbac delete`` and ``network rbac set`` commands. [Blueprint `neutron-client-rbac `_] .. releasenotes/notes/bp-routed-networks-86a24f34d86fca53.yaml @ b'6a6b192ddeb80b516778b1d6e3d34f4261dca85d' - 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 `_] .. releasenotes/notes/bug-1575461-3fed33e53795684a.yaml @ b'b0c317ebdd5e5f2626ce2fbd495149336fe5df7e' - Add support for showing flavor access list by using ``flavor show`` command. [Bug `1575461 `_] .. releasenotes/notes/bug-1589332-2941f5286df7e5d4.yaml @ b'954c28dfa21be76b0522af051d71fb9470877a1a' - 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 `_] .. releasenotes/notes/bug-1589348-4a612a4efc7ed0e5.yaml @ b'eccd943acc9526311fcfc318280b4be51c42a566' - Add options ``--up`` and ``--down`` for compute v2 ``compute service set`` command to support force up/down compute service. [Bug `1589348 `_] .. releasenotes/notes/bug-1592906-a5604ec5abe77507.yaml @ b'6df09fd377f872388d4f855b001a6578ae6fba46' - Support bulk deletion for ``ec2 credentials delete``, ``endpoint delete``, ``service delete`` in identity V2.0 . [Bug `1592906 `_] .. releasenotes/notes/bug-1592906-ad67ce8736f3cd48.yaml @ b'60639d76a742852e18f9e2889c480be95596c268' - 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 `_] .. releasenotes/notes/bug-1592906-e69b37377278d9c2.yaml @ b'4e62e1e2e18cb93ba0f88bff8727182b1002de4b' - Support bulk deletion for ``volume type delete``. [Bug `1592906 `_] .. releasenotes/notes/bug-1596443-9e2af267e91d1643.yaml @ b'fc719f998ce5f826d42f49aecf4f437e6d07857a' - Add ``--force`` option to ``backup create`` command to allow users to back up an in-use volume. [Bug `1596443 `_] .. releasenotes/notes/bug-1596798-b22fd587bdca8b36.yaml @ b'dbed97a24df2fb74e4989fb15c912252f8a8bb07' - Add ``--property`` option to ``flavor create`` command. [Bug `1596798 `_] .. releasenotes/notes/bug-1596821-a07599eb4beb6342.yaml @ b'4e46c04f921c81927ded78f17fd28d5a55ebf9e2' - Add ``--force`` option to ``volume qos delete`` command to allow users to delete in-use QoS specification(s). [Bug `1596821 `_] .. releasenotes/notes/bug-1597184-f4fb687b3d4d99d9.yaml @ b'6364df4cbd33a20ea1c729e0031b1aebd3fcd6df' - Add ``--snapshot`` option to ``backup create`` command. [Bug `1597184 `_] .. releasenotes/notes/bug-1597188-a2ff62b809865365.yaml @ b'f5aef9ac36257cfd9808c0dbdb80c5adc412876b' - Add ``--force`` option to ``backup delete`` command to allow delete in state other than error or available. [Bug `1597188 `_] .. releasenotes/notes/bug-1597192-52801f7520287309.yaml @ b'3222ffc157b6e686249fb2e3d4375c89384bfb97' - Add ``--property`` option to ``snapshot create`` command. [Bug `1597192 `_] .. releasenotes/notes/bug-1597198-e36b55f3fd185a3a.yaml @ b'e31408d2a4c524181c37ef565b021c0b729cbbe3' - Add ``--public`` and ``--private`` options to ``volume type list`` command. [Bug `1597198 `_] .. releasenotes/notes/bug-1600196-6a733dd4e3371df7.yaml @ b'34812655a5b44623a04fc05f1a6c9110f4afbc25' - Add ``--incremental`` option to ``backup create`` command to allow users to create incremental backups. [Bug `1600196 `_] .. releasenotes/notes/bug-1602169-2750c9a6896d2825.yaml @ b'e310682235810759c17278365fcb76fac438f582' - Add ``--project`` and ``--project-domain`` options to ``volume type create`` command. [Bug `1602169 `_] .. releasenotes/notes/bug-1605088-fea9347336764469.yaml @ b'cf20225347766240a2ebb155e6e46b85f84a3ddc' - Support to get server ``rdp``, ``serial``, ``mks`` type console url. [Bug `1605088 `_] .. releasenotes/notes/bug-1605475-84e649fb8c675737.yaml @ b'61b9d9fe2d0c6c99d5e77361111f02a19d169782' - Add ``--limit`` and ``--marker`` options to ``snapshot list`` command. [Bug `1605475 `_] .. releasenotes/notes/bug-1605774-28aec51f6ec4926e.yaml @ b'713d92df4e53f74698a1ff2dfcb7514ff22f023b' - Deprecate ``role list`` arguments in favor of ``role assignment`` command. [Bug `1605774 `_] .. releasenotes/notes/bug-1606105-ca06b230e22ab5c6.yaml @ b'5eb7e626b18b033f97f3cf10f2791529f9d75789' - Add support for domain specific roles in ``role`` and``role assignment`` commands. [Bug `1606105 `_] .. releasenotes/notes/bug-1610883-e6345c32a35cc290.yaml @ b'831546fb9e4150074baecee9470a0b8d681e0f86' - Make ``subnet list`` command supports listing up subnets with dhcp enabled/disabled by adding ``--dhcp`` and ``--no-dhcp`` options to the command. [Bug `1610883 `_] .. releasenotes/notes/bug_1602073-5deb58deeafbc8be.yaml @ b'8bbf30498eb34990cb9bc7c7af418216d47f0421' - Add "Checksum" column to output of "image list --long" [Bug `1602073 `_] .. releasenotes/notes/flavor-create-with-project-19d41bfa93e3c6d0.yaml @ b'014835930d50130a2efca0786920876efc60a8eb' - 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. .. releasenotes/notes/ip-command-rework-8d3fe0858f51e6b8.yaml @ b'0aa2304f38da0696576827fc4d71f2cf7cc13ad6' - 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 ``_] .. releasenotes/notes/ip-command-rework-8d3fe0858f51e6b8.yaml @ b'0aa2304f38da0696576827fc4d71f2cf7cc13ad6' - Add new commands ``server add/remove floating ip``. They are used to replace the old commands ``ip floating add/remove``. [Blueprint rework-ip-commands ``_] .. releasenotes/notes/ip-command-rework-8d3fe0858f51e6b8.yaml @ b'0aa2304f38da0696576827fc4d71f2cf7cc13ad6' - Add new commands ``server add/remove fixed ip``. They are used to replace the old commands ``ip fixed add/remove``. [Blueprint rework-ip-commands ``_] .. releasenotes/notes/ip-command-rework-8d3fe0858f51e6b8.yaml @ b'0aa2304f38da0696576827fc4d71f2cf7cc13ad6' - 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 ``_] .. releasenotes/notes/list_volume_type_access-f7d9aa6159f757ea.yaml @ b'5e8957ef7f4acea1ece06378c050021b64ea3f6f' - 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 `` [Bug `1554891 `_] .. releasenotes/notes/subnet-unset-5b458cdbaf93d766.yaml @ b'45b026d7c8e4675a598192bcf4c88f22005cc1d2' - 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 `_] .. releasenotes/notes/unset-router-7b0cbd9518bb1de6.yaml @ b'ed64788cf1a247ca03174770d43d8c7816cc0ad1' - Add a new command ``router unset`` to clear the information of routes from the router. [ Blueprint `network-property-unset `_] .. releasenotes/notes/unset-subnet-pool-333052dd85b95653.yaml @ b'063c722a110031883e9615064092644de6df8da2' - Add a new command ``subnet pool unset`` to clear the information of pool-prefixes from the subnet pools. [ Blueprint `network-property-unset `_] .. _python-openstackclient_3.0.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/bug-1588588-39927ef06ca35730.yaml @ b'9c62af8a42ebfeb60d88f5ad0af7c1c2fd562853' - 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 `_] .. releasenotes/notes/modify-compute-agent-set-77ff894ef62ebbc7.yaml @ b'25bdf6811c71413921777cad73b6d039444600ff' - Migrate command ``compute agent set`` arguments to be optional. .. releasenotes/notes/remove-osc_password-0767ac78267ef114.yaml @ b'ccbb2dd1e8aaa5d2f34a30763f71125688c8dfac' - 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. .. _python-openstackclient_3.0.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/bp-backup-snapshot-renamed-for-volume-resource-2d2d13ea8489a61f.yaml @ b'39c5eb9e3fe89bf177e513e447f22b62f5e4785c' - Deprecate commands ``backup create/delete/list/show/restore``. [Blueprint `backup-snapshot-renamed-for-volume-resource `_] .. releasenotes/notes/ip-command-rework-8d3fe0858f51e6b8.yaml @ b'0aa2304f38da0696576827fc4d71f2cf7cc13ad6' - Deprecate command ``ip floating pool list``. [Blueprint rework-ip-commands ``_] .. releasenotes/notes/ip-command-rework-8d3fe0858f51e6b8.yaml @ b'0aa2304f38da0696576827fc4d71f2cf7cc13ad6' - Deprecate commands ``ip floating add/remove``. [Blueprint rework-ip-commands ``_] .. releasenotes/notes/ip-command-rework-8d3fe0858f51e6b8.yaml @ b'0aa2304f38da0696576827fc4d71f2cf7cc13ad6' - Deprecate commands ``ip fixed add/remove``. [Blueprint rework-ip-commands ``_] .. releasenotes/notes/ip-command-rework-8d3fe0858f51e6b8.yaml @ b'0aa2304f38da0696576827fc4d71f2cf7cc13ad6' - Deprecate commands ``ip floating create/delete/list/show``. [Blueprint rework-ip-commands ``_] .. _python-openstackclient_3.0.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1535213-c91133586e07d71c.yaml @ b'20ae54045cef136a8d0665aab0d45698e12ed21c' - Support a new ``--state`` option for ``volume set`` command that changes the state of a volume. [Bug `1535213 `_] .. releasenotes/notes/bug-1543222-6f8579344ff5c958.yaml @ b'2740291f491804be5f521770ee773fa62894e8a3' - 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 `_] .. releasenotes/notes/bug-1561599-d5f541f08ae6274a.yaml @ b'337d013c94378a4b3f0e8f90e4f5bd745448658f' - 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 `_] .. releasenotes/notes/bug-1582774-3bba709ef61e33b7.yaml @ b'099a2c38b99dff6a0909c0a3ba2909f1aea58644' - Fix setting defaults for some scope parameters, that were putting invalid scope parameters for some auth plugins. [Bug `1582774 `_] .. releasenotes/notes/bug-1589935-8a56e6a18d836db9.yaml @ b'cf122397733b8795530577b7824aeae305719658' - Raise ``ArgumentTypeError`` if the input arguments do not match the type ``key=value`` when we set properties. [Bug `1589935 `_] .. releasenotes/notes/bug-1592062-e327a31a5ae66809.yaml @ b'fe0c8e955be0331aef9cc6847c9bddc43ce66d92' - Scope options are now validated after authentication occurs, and only if the user does not have a default project scope. [Bug `1592062 `_] .. releasenotes/notes/bug-1592368-a4af69f163a1e208.yaml @ b'b875f63a6f2a7ac381d4bb80b9c032272126ef49' - 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 `_] .. releasenotes/notes/bug-1592761-f45998453d6801f7.yaml @ b'ca5e8e6c8540e457a620cc90d321a08e7417de32' - Add default IP version in ``ip availability list`` command and make this command work properly without ``--ip-version`` option. [Bug `1592761 `_] .. releasenotes/notes/bug-1597296-9735f33eacf5552e.yaml @ b'c45b1d7b230e900d0416a4953607e5d4e1dc9cfd' - Fixed service name lookup in Identity commands to properly handle multiple matches. [Bug `1597296 `_] .. _python-openstackclient_2.6.0: 2.6.0 ===== .. _python-openstackclient_2.6.0_New Features: New Features ------------ .. releasenotes/notes/add-server-backup-e63feaebb6140f83.yaml @ b'd24c255e4302c37b3a4fa4051b263b3d5e0b9b92' - Add ``server backup create`` command .. releasenotes/notes/bp-routed-networks-3eea4978c93aa126.yaml @ b'd24c255e4302c37b3a4fa4051b263b3d5e0b9b92' - Add ``network segment list`` and ``network segment show`` commands. These are beta commands and subject to change. Use global option ``--os-beta-command`` to enable these commands. [Blueprint `routed-networks `_] .. releasenotes/notes/bug-1554886-8e5249a655e7e7b6.yaml @ b'd24c255e4302c37b3a4fa4051b263b3d5e0b9b92' - Add ``volume transfer request list`` command [:lpbug:`1554886`] .. releasenotes/notes/bug-1575461-4d7d90e792132064.yaml @ b'd24c255e4302c37b3a4fa4051b263b3d5e0b9b92' - Add ``--project`` option to ``flavor set`` command to set project access to a flavor [:lpbug:`1575461`] .. releasenotes/notes/bug-1575461-4d7d90e792132064.yaml @ b'd24c255e4302c37b3a4fa4051b263b3d5e0b9b92' - Add ``--project`` option to ``flavor unset`` command to remove project access to a flavor [:lpbug:`1575461`] .. releasenotes/notes/bug-1582968-4d44912a033b242c.yaml @ b'd24c255e4302c37b3a4fa4051b263b3d5e0b9b92' - Add ``image unset`` command [:lpbug:`1582968`] .. releasenotes/notes/ip-availability-ca1cf440f6c70afc.yaml @ b'd24c255e4302c37b3a4fa4051b263b3d5e0b9b92' - Add ``ip availability list`` and ``ip availability show`` commands [Blueprint :oscbp:`neutron-ip-capacity`] .. releasenotes/notes/server-set-state-214b12ec2161de4d.yaml @ b'1a7284f63ad13f41c6ff4295d69f065310242524' - Add ``--state`` option to ``server set`` command to set the server to active or error state. [Blueprint `server-reset-state `_] .. _python-openstackclient_2.6.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/address-scope-delete-multi-31c3af73feb31265.yaml @ b'd24c255e4302c37b3a4fa4051b263b3d5e0b9b92' - ``address scope delete`` command now accepts multiple address scopes in a single command .. releasenotes/notes/compute-agent-deff48988e81b30e.yaml @ b'd24c255e4302c37b3a4fa4051b263b3d5e0b9b92' - ``compute agent delete`` command now supports deleting multiple agents in a single command .. releasenotes/notes/service-set-option-61772a8940ad0778.yaml @ b'ac1d86c34333780e30b9393d155ae84a769ac222' - 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. .. _python-openstackclient_2.6.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1588384-eb6976fcfb90cb4c.yaml @ b'6f2c1734e3d66e261f231711455821321c1fc254' - 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 `_] .. _python-openstackclient_2.5.0: 2.5.0 ===== .. _python-openstackclient_2.5.0_New Features: New Features ------------ .. releasenotes/notes/add-quota-set-for-network-11fcd7b9e08624b5.yaml @ b'b92cf77fb58b4aafcf4b3a1ef6b89fd15166505b' - 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 `_] .. releasenotes/notes/bug-1519512-dbf4368fe10dc495.yaml @ b'fd5fd924d152338204fcf69673fedd31a3904977' - Add ``--icmp-type`` and ``--icmp-code`` options to the ``security 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 `_] .. releasenotes/notes/bug-1519512-dbf4368fe10dc495.yaml @ b'fd5fd924d152338204fcf69673fedd31a3904977' - 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 `_] .. releasenotes/notes/bug-1519512-dbf4368fe10dc495.yaml @ b'fd5fd924d152338204fcf69673fedd31a3904977' - The ``security group rule list`` command supports displaying the ICMP type and code for security group rules with the ICMP IP protocols. [Bug `1519512 `_] .. releasenotes/notes/bug-1542171-fde165df53216726.yaml @ b'99031cf1ed36b3c3b8c09e2c64aaa4b789eb25b9' - Add ``server group create``, ``server group delete``, ``server group list``, ``server group show`` commands. [Bug `1542171 `_] [Blueprint `nova-server-group-support `_] .. releasenotes/notes/bug-1544586-0fe19a567d3e31fc.yaml @ b'48ebc49f201baea443146a8d1c3b6cbde3b2f297' - Add ``--share`` and ``--default`` options to ``subnet pool create`` and ``--default`` option to ``subnet pool set`` [Bug `1544586 `_] [Bug `1544591 `_] .. releasenotes/notes/bug-1545537-4fa72fbfbbe3f31e.yaml @ b'99031cf1ed36b3c3b8c09e2c64aaa4b789eb25b9' - Add ``--transparent-vlan`` and ``--no-transparent-vlan`` options to ``network create`` and ``network set`` commands to add/remove VLAN transparency attributes from networks. This option is available in Network V2 only. [Bug `1545537 `_] .. releasenotes/notes/bug-1550999-5e352a71dfbc828d.yaml @ b'99031cf1ed36b3c3b8c09e2c64aaa4b789eb25b9' - Adds ``volume service list`` command. [Bug `1550999 `_] .. releasenotes/notes/bug-1561838-3a006a8263d7536d.yaml @ b'a5a343a5a86658246cc136a330eee951e32c7b56' - 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 `_] .. releasenotes/notes/bug-1566269-2572bca9157ca107.yaml @ b'99031cf1ed36b3c3b8c09e2c64aaa4b789eb25b9' - Add ``address scope create``, ``address scope delete``, ``address scope list``, ``address scope set`` and ``address scope show`` commands. [Bug `1566269 `_] .. releasenotes/notes/bug-1581179-4d15dc504777f9e7.yaml @ b'668bc028d13b80dfc6ecbef6193678a97e64fdc1' - Add the ``--ip-version`` option to the ``subnet list`` command. This will output subnets based on IP version filter. [`Bug 1581179 `_] .. _python-openstackclient_2.5.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/bug-1519512-dbf4368fe10dc495.yaml @ b'fd5fd924d152338204fcf69673fedd31a3904977' - 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 `_] .. _python-openstackclient_2.5.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1535239-767e6cf1990eda01.yaml @ b'189e4774f88243669ee1b9089d6c39021094c83d' - Support a new ``--state`` option for ``snapshot set`` command that changes the state of a snapshot. [Bug `1535239 `_] .. releasenotes/notes/bug-1536479-d1f03ed2177d06ed.yaml @ b'08759b853a2611144a2d3f0e9216d6801fc23ef2' - ``--pool-prefix`` option made required for ``subnet pool create`` [Bug `1536479 `_] .. releasenotes/notes/bug-1556719-d2dcf61acf87e856.yaml @ b'56f9227063cb86594600ccc80c661101f0f0c2c8' - Command ``network delete`` will delete as many networks as possible, log and report failures in the end. [Bug `1556719 `_] [Bug `1537856 `_] .. releasenotes/notes/bug-1564460-ab7ad35c02392cb4.yaml @ b'a90c824e0407f931b5c45df53103b43aa564de12' - Fixed the ``--route`` option on the ``router set`` command which did not properly format the new routes to set resulting in a ``Bad Request`` error. In addition, the ``router create``, ``router list`` and ``router show`` command output for routes was fixed to improve readability and to align with the ``--route`` option on the ``router set`` command. [Bug `1564460 `_] .. releasenotes/notes/bug-1565034-dd404bfb42d7778d.yaml @ b'bc93ebfe5c0fa4d29b79fa3fd93ec603425997ea' - Added ``--no-route`` to the ``router set`` command. Deprecated ``--clear-routes``. [Bug `1565034 `_] .. releasenotes/notes/bug-1572228-03638a7adec5da8b.yaml @ b'9f3fa5ee3bf87c47f7a38ef78f4022ac46b2f2f6' - Fixed ``network create``, ``network show`` and ``network list`` commands to correctly display the router type in the ``router:external`` and ``Router Type`` columns. [Bug `1572228 `_] .. releasenotes/notes/bug-1572733-874b37a7fa8292d0.yaml @ b'27024d70af4756cb6e4b210b025ed7427541f773' - The ``quota show`` command ```` 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 `_] .. releasenotes/notes/bug-1575478-5a0a923c3a32f96a.yaml @ b'681d6dc2de83ef13b4fb2fb4abe70f3c1ccb0e10' - Fixed ``flavor show/delete/set/unset`` command to properly find a private flavor by flavor name. [Bug `1575478 `_] .. releasenotes/notes/bug-1575624-87957ff60ad661a6.yaml @ b'4524b3605fa4260a2f916421eebfc7a99b320e4b' - Fixed ``flavor set/unset`` command to properly find a flavor to be set/unset by flavor id. [Bug `1575624 `_] .. _python-openstackclient_2.4.0: 2.4.0 ===== .. _python-openstackclient_2.4.0_New Features: New Features ------------ .. releasenotes/notes/add-disable-reason-6e0f28459a09a60d.yaml @ b'ad6727df8800a61a5890995a1e572e6f5b9bab01' - Add ``--disable-reason`` option to the ``service set`` command .. releasenotes/notes/add-port-commands-a3580662721a6312.yaml @ b'baf96411fed22ad97ff219601830be63563ae03a' - Add ``port create``, ``port list`` and ``port set`` commands [Bug `1519909 `_] .. releasenotes/notes/add-restore-server-d8c73e0e83df17dd.yaml @ b'ad6727df8800a61a5890995a1e572e6f5b9bab01' - Add ``server restore`` command .. releasenotes/notes/bug-1519511-65b8901ae6ea2e63.yaml @ b'ad6727df8800a61a5890995a1e572e6f5b9bab01' - The ``security group create``, ``security group set`` and ``security group show`` commands now uses Network v2 when enabled which results in a more detailed output for network security group rules. [Bug `1519511 `_] .. releasenotes/notes/bug-1519511-65d8d21dde31e5e2.yaml @ b'a7c76878da02da406c9ccbcd62cc40def1108faa' - Add ``--project`` and ``--project-domain`` options to the ``security group create`` command for Network v2. [Bug `1519511 `_] .. releasenotes/notes/bug-1519512-48d98f09e44220a3.yaml @ b'a5a9caea2b06a69953f692289866e59f52d78a4c' - Add ``--ingress``, ``--egress``, ``--ethertype``, ``--project`` and ``--project-domain`` options to the ``security group rule create`` command for Network v2 only. These options enable ``egress`` and ``IPv6`` security group rules along with setting the project. [Bug `1519512 `_] .. releasenotes/notes/bug-1519512-65df002102b7fb99.yaml @ b'94c9cd5c66512d52b31dfaa42bc3d1cc7fd81702' - The ``security group rule list`` command now uses Network v2 when enabled which results in ``egress`` 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 the ``group`` 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 `_] .. releasenotes/notes/bug-1540656-f7b7b7e3feef2440.yaml @ b'2109bce85a40da3e3cbebed1cac661611564ccb2' - The ``security group rule create`` command now supports a security group name for the ``--src-group`` option. [Bug `1540656 `_] .. releasenotes/notes/bug-1542364-5d1e93cfd24f0b65.yaml @ b'71b8919054fc7cc7f95006f6d7e2bcee18c955e5' - Add ``subnet create`` command. [Bug `1542364 `_] .. releasenotes/notes/bug-1544586-0e6ca9a09dac0726.yaml @ b'ad6727df8800a61a5890995a1e572e6f5b9bab01' - Add ``subnet pool create`` and ``subnet pool set`` commands. [Bug `1544586 `_] [Bug `1544591 `_] .. releasenotes/notes/bug-1545537-12bbf01d2280dd2f.yaml @ b'aa1495e241e99903bc8704f1981a7e3941803e35' - Add provider network options ``--provider-network-type``, ``--provider-physical-network`` and ``--provider-segment`` to the ``network create`` and ``network set`` commands. These options are available for NetworkV2 only. [Bug `1545537 `_] .. releasenotes/notes/bug-1545537-7a66219d263bb1e5.yaml @ b'67f8b898eb6d48b11b9f0624ac70f65c4311f8e8' - Add external network options ``--external|--internal`` and ``--external`` suboptions ``--default|--no-default`` to the ``network create`` and ``network set`` commands. These options are available for Network version 2 only. [Bug `1545537 `_] .. releasenotes/notes/bug-1554877-7f8479791eab45b7.yaml @ b'baf96411fed22ad97ff219601830be63563ae03a' - Add ``--image-property`` option to ``volume set`` and ``volume unset`` commands Image 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. [Bug `1554877 `_] [Bug `1554879 `_] .. releasenotes/notes/bug-1554889-32ba8d4bfb0f5f3d.yaml @ b'baf96411fed22ad97ff219601830be63563ae03a' - Add ``--project`` and ``--project-domain`` options to ``volume type set`` and ``volume type unset`` commands Use 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 the ``volume create`` command. [Bug `1554889 `_] [Bug `1554890 `_] .. releasenotes/notes/bug-1556929-edd78cded88ecdc9.yaml @ b'baf96411fed22ad97ff219601830be63563ae03a' - Add ``host set`` command [Bug `1556929 `_] .. releasenotes/notes/bug-1559866-733988f5dd5b07bb.yaml @ b'baf96411fed22ad97ff219601830be63563ae03a' - Add ``aggregate unset`` command [Bug `1559866 `_] .. releasenotes/notes/bug-1565112-e0cea9bfbcab954f.yaml @ b'baf96411fed22ad97ff219601830be63563ae03a' - Add global options ``os-cert`` and ``--os-key`` to support client certificate/key. Environment variables ``OS_CERT`` and ``OS_KEY``, as well as the ``cert`` and ``key`` values in clouds.yaml may also be used [Bug `1565112 `_] .. releasenotes/notes/router-port-add-0afe7392c080bcb8.yaml @ b'2e94f2803fca3862589fe2b10c76c2ebc9e17229' - Add ``router add port`` command [Bug `1546849 `_] .. releasenotes/notes/router-remove-port-058078c93819b0f4.yaml @ b'8ecdc57ea680b7e20835bea69a2d18e1460d9406' - Add ``router remove port`` command [Bug `1546849 `_] .. releasenotes/notes/router-subnet-469d095ae0bac884.yaml @ b'9e42daa577b0f15c349c2f4a79b3632ffec97720' - Add ``router add subnet`` command [Bug `1546849 `_] .. releasenotes/notes/router-subnet-469d095ae0bac884.yaml @ b'9e42daa577b0f15c349c2f4a79b3632ffec97720' - Add ``router remove subnet`` command [Bug `1546849 `_] .. releasenotes/notes/subnet-set-bbc26ecc16929302.yaml @ b'2b95e363d325c686db229a9da1d9a3a7677e8294' - Add ``subnet set`` command. [Bug `1542363 `_] .. _python-openstackclient_2.4.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/bug-1519502-d534db6c18adef20.yaml @ b'baf96411fed22ad97ff219601830be63563ae03a' - The ``ip floating create`` command now uses Network v2 when enabled [Bug `1519502 `_] .. releasenotes/notes/bug-1519512-4231ac6014109142.yaml @ b'd90650796217fbb9cdd19297ee6ff59f0e009413' - 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 the ``security group rule show`` command. [Bug `1519512 `_] .. releasenotes/notes/bug-1571812-49cdce4df5f3d481.yaml @ b'530fe42589a2138278f100f791d8c6d3fbed8950' - 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 `_] .. _python-openstackclient_2.4.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1519511-65b8901ae6ea2e63.yaml @ b'ad6727df8800a61a5890995a1e572e6f5b9bab01' - 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, the ``tenant_id`` field changed to ``project_id`` to match the ``security group show`` command output. [Bug `1519511 `_] .. releasenotes/notes/bug-1519512-65df002102b7fb99.yaml @ b'94c9cd5c66512d52b31dfaa42bc3d1cc7fd81702' - The ``security group rule list`` command no longer ignores the ``group`` argument when it is set to an empty value. [Bug `1519512 `_] .. releasenotes/notes/bug-1545609-bdc1efc17214463b.yaml @ b'f0c3b4e69dc56934305442b505d5f5f68579f1f2' - Fixed ``openstack command list`` to display properly [Bug `1545609 `_] .. releasenotes/notes/bug-1560157-bce572f58b43efa1.yaml @ b'b5f10f43eb9fd1a046a3e80db09d8bc8c350c218' - Fixed SSL/TLS verification for Network v2 commands. The commands were ignoring the ``--insecure`` and ``--os-cacert`` options and the ``OS_CACERT`` environment variable which caused them to fail with ``An SSL error occurred.`` when authenticating using SSL/TLS. [Bug `1560157 `_] .. releasenotes/notes/bug-1569480-c52e330548bfbd78.yaml @ b'3a4d53a93bb62f5bd2e21db1727ef74f771075d8' - Fixed ``subnet pool list`` command to properly disply the list of subnet pool prefixes in the ``Prefixes`` column. This fix is consistent with the ``subnet pool create`` and ``subnet pool show`` command output. [Bug `1569480 `_] .. releasenotes/notes/make-snapshot-and-backup-name-optional-01971d33640ef1c8.yaml @ b'311e775c81419c3b28d03e616a0e415a614b9cff' - Make ``--name`` optional in ``volume snapshot create`` and ``volume backup create`` commands. .. _python-openstackclient_3.8.2: 3.8.2 ===== .. _python-openstackclient_3.8.2_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1659967-644a8ee3621c9e81.yaml @ b'253a92ec8f2b7bd5d8f056210dea374f2e2ae184' - ``security group list`` command now can display project IDs in the ``Project`` column of the command output. [Bug `1659967 `_] .. releasenotes/notes/bug-1711301-17754f487973d4c1.yaml @ b'f2120f15d54ba8b23748663c81650e3fd7a6efd1' - Fix occurrences of the ``network agent delete`` command failing with newer releases of python-openstacksdk. [Bug `1711301 `_] .. _python-openstackclient_3.8.1: 3.8.1 ===== .. _python-openstackclient_3.8.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1659878-f6a55b7166d99ca8.yaml @ b'1e3dc48c64304eb378660ceb531aab3d42ac0710' - 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 `_] .. releasenotes/notes/bug-1659993-a5fe43bef587e490.yaml @ b'1e3dc48c64304eb378660ceb531aab3d42ac0710' - The ``address scope list`` command failed with 'HttpException: Bad Request' when the ``--share`` or ``--no-share`` options were used. [Bug `1659993 `_] .. _python-openstackclient_3.8.0: 3.8.0 ===== .. _python-openstackclient_3.8.0_New Features: New Features ------------ .. releasenotes/notes/bp-neutron-client-metering-6f8f9527c2a797fd.yaml @ b'16aeee430308fd1863d2f9892f09e0d928a0e6f1' - Add meter rules commands for ``network meter rule create``, ``network meter rule delete``, ``network meter rule list``, and ``network meter rule show``. [Blueprint :oscbp:`neutron-client-metering`] .. releasenotes/notes/bug-1612136-6111b944569b9351.yaml @ b'8bcfb824c8f2978c9348968d3da1345c45d7b764' - 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 `_] .. releasenotes/notes/bug-1647242-fdc39e564372857b.yaml @ b'c46f9dc501441ef449f41e726ec3cfbbe9f3de9d' - Add ``--deleted`` and ``--changes-since`` options to ``server list`` command. [Bug `1647242 `_] .. releasenotes/notes/bug-1648087-21dfb7250abfdbe9.yaml @ b'780ce07459f8c196dbf289909c390ff88a380e3f' - Add ``--project`` and ``--project-domain`` filtering options to ``port list`` command. [Bug `1648087 `_] .. releasenotes/notes/bug-1658147-9de9ae222f9db9ae.yaml @ b'4cb56269ad30d0bd59f7685040ab0585f38c3b0f' - Add ``--domain`` options to the ``user set`` command. Allows specification of domain context when changing users. [Bug `1658147 `_] .. releasenotes/notes/support-no-property-in-volume-snapshot-0af3fcb31a3cfc2b.yaml @ b'16aeee430308fd1863d2f9892f09e0d928a0e6f1' - Add ``--no-property`` option in ``volume snapshot set``. [Blueprint `allow-overwrite-set-options `_] .. releasenotes/notes/volume_snapshot_list_project-e7dcc07f98d44182.yaml @ b'27e0be051714fe11a3b9b5306f2e0a72d95fe2c3' - Add ``--project`` and ``--project-domain`` option to ``volume snapshot list`` command, in order to filter list result by different project. .. _python-openstackclient_3.8.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1647406-c936581034a1b6e4.yaml @ b'95c8661f86e74c9d5217869a740da11350f1f0eb' - Allow ``--block-device-mapping`` option to work correctly with ``--volume`` option in ``server create`` command. After :lpbug:`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. [:lpbug:`1497845`] [:lpbug:`1647406`] .. releasenotes/notes/bug-1650026-0ce6a77e69d24424.yaml @ b'4d9da2c40ae02086258cfde852b297754d8085fa' - Fixed a ``__init__() got an unexpected keyword argument 'project_name'`` error in various networking commands when ``help`` or ``--help`` was used. [Bug `1650026 `_] .. releasenotes/notes/bug-1655445-96c787e3a51226e0.yaml @ b'0340275fa9b48cda5a5f4015534ca8cbca23b3d2' - Work around a bug in OpenStackSDK 0.9.11 and 0.9.12 that causes ``quota set --network`` to fail. [Bug `1655445 `_] .. releasenotes/notes/bug-1656767-36a3d4b9fac335c9.yaml @ b'f353253122ca39aeb092656cea011a06e70103a4' - Fixed a ``volume qos create`` display mistake in argument of ``specs``. [Bug `1656767 `_] .. releasenotes/notes/bug-1658582-80a76f6b0af0ca12.yaml @ b'5cf77bb672eeb28327cac8bc0a8227c8b7137819' - Correctly handle non-admin in ``create trust`` command when looking up role names. [Bug `1658582 `_] .. _python-openstackclient_3.7.0: 3.7.0 ===== .. _python-openstackclient_3.7.0_New Features: New Features ------------ .. releasenotes/notes/add-auto-and-none-as-nic-parameter-ed23a6e7f99f250d.yaml @ b'ff18e3d0e9307fb505113b467e58bdb62992fb85' - 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 `_] .. releasenotes/notes/add-network-qos-rule-22cc1ddd509941db.yaml @ b'6b114cd98f4a1bc95cb8702db02eeb625be6b3e7' - 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 `_] .. releasenotes/notes/add-network-qos-rule-types-337e464c6e81f29c.yaml @ b'9e1e7e1c9fde2e60b2f95f3bd000c599a9e1c72a' - Add support for Network QoS rule type commands: ``network qos rule type list``, [Bug `1612194 `_] .. releasenotes/notes/add-overwrite-option-to-router-7c50c8031dab6bae.yaml @ b'4d3cfb9142be8884fa74a6a8b324df869e32ba30' - Add ``--router`` and ``--no-router`` options to ``osc router set`` command to modify routes in a router instance. [ Blueprint `allow-overwrite-set-options `_] .. releasenotes/notes/bp-neutron-client-metering-1ee703a48343ece1.yaml @ b'0fb1378c6ca7a5ea717ee651d64603b0246f6737' - Add support for network metering commands: ``network meter create``, ``network meter delete``, ``network meter show``, ``network meter list`` [Blueprint :oscbp:`neutron-client-metering`] .. releasenotes/notes/bug-1613964-b3e8d9d828a3822c.yaml @ b'2f2603d90896d0765e1bb2bb1cfb223fdba75835' - Add ``consistency group add volume`` and ``consistency group remove volume`` commands in volume v2. [Bug `1642238 `_] .. releasenotes/notes/bug-1641868-97c284e33f944c2d.yaml @ b'2e78c11c8d485195b9ae40b9d00cf3a557aebd6d' - Add filters ``--agent-type`` and ``--host`` to ``network agent list`` command [Bug `1641868 `_] .. releasenotes/notes/bug-1648307-a2c6d7698e927449.yaml @ b'af7129cda33dcd4ac784097ddb4f119e145c40d5' - Add ``--type``, ``--action``, ``--long`` options to ``network rbac list`` command [Bug `1648307 `_] .. releasenotes/notes/image-set-to-update-image-membership-68221f226ca3b6e0.yaml @ b'4d3cfb9142be8884fa74a6a8b324df869e32ba30' - Add support to update image membership with the ``--accept``, ``--reject`` and ``--pending`` options of the ``image set command``. .. _python-openstackclient_3.7.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1652827-f59bbd1b64df958d.yaml @ b'4d3cfb9142be8884fa74a6a8b324df869e32ba30' - Fix an endpoint version problem with Image endpoints that contained the substring 'v2'. [Bug `1652827 `_] .. releasenotes/notes/bug-1654221-a564ab75a6afc332.yaml @ b'd8749f9148f2a78f28e91c58e698779735eae4dc' - Fix ``--project`` option for ``flavor create`` command when the ID for the new flavor is auto generated. [Bug `1654221 `_] .. releasenotes/notes/bug-1655537-20b0eb676afa278f.yaml @ b'024bd3bd660490e458456c28674dcd0ad4ee13c8' - 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 `_] .. releasenotes/notes/bug-1656402-88b12760fb2d4ef9.yaml @ b'339af2c20bfe44a772a1e39fc8b769db112b75ce' - 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 `_ .. releasenotes/notes/bug-1656572-b40303ae50a41000.yaml @ b'819526591ee2cdbf7f138a08f9c38b9c804e5d31' - Work around a bug in OpenStackSDK 0.9.11 and 0.9.12 that causes ``quota show --default`` to fail. [Bug `1656572 `_] .. releasenotes/notes/bug-volume-list-with-project-2dc867c5e8346a66.yaml @ b'51ea68ae948da5d69b262827961ca9ae9118edbc' - Fix a bug of unable to filter volume list by ``--project`` and ``--user`` options in the ``openstack volume list``. .. releasenotes/notes/speedup-object-save-6bd59e678a31c3e8.yaml @ b'1cdc1319d6cbfc4087551e5bf0a9875c016eca1c' - Makes ``openstack object save`` much faster when saving an object to disk. [Bug `1654645 `_] .. _python-openstackclient_3.6.0: 3.6.0 ===== .. _python-openstackclient_3.6.0_New Features: New Features ------------ .. releasenotes/notes/bp-cinder-command-support-82dbadef47454c18.yaml @ b'd083ddb12f4b8eb0d72bb4ff60113cd0904d8c1d' - Add ``--default`` option to ``volume type list`` command, in order to show which volume type the volume sets as it's default. [Blueprint :oscbp:`cinder-command-support`] .. releasenotes/notes/bp-cinder-command-support-ff7acc531baae8c3.yaml @ b'7e5a98bca91e0734f3440fdbeb12cd59273cd6a4' - Add ``--bootable``, ``--non-bootable``, ``--read-only`` and ``--read-write`` options to ``volume create`` command. [Blueprint `cinder-command-support `_] .. releasenotes/notes/bug-1636046-98dc0e69a4e44850.yaml @ b'd12aa86f7c4cadb423553d607ae4078f2cb8a962' - Add ``--name``, ``--ip-version``, ``--project``, ``--project-domain``, ``--share``, ``--no-share`` options to the ``address scope list`` command. [Bug `1636046 `_] .. releasenotes/notes/bug-1650342-22cb88ef37a41872.yaml @ b'63377f25fc7dfae151bab2f6e82002a9a1944e93' - Add ``ploop`` as a valid disk format choice for ``image create`` and ``image set`` commands. [Bug `1650342 `_] .. releasenotes/notes/router-gateway-set-01d9c7ffe4461daf.yaml @ b'4a5bf8d2a58fde1d6cbbd2bb27c3eb6fabe59c3a' - 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 `_] .. _python-openstackclient_3.5.0: 3.5.0 ===== .. _python-openstackclient_3.5.0_New Features: New Features ------------ .. releasenotes/notes/add-dns-nameserver-overwrite-option-b866baeae12f9460.yaml @ b'11a762e03c3d53b45888387f3c5472a37d9d9f68' - Add ``--no-dns-nameserver`` option to ``subnet set`` command. [Blueprint `allow-overwrite-set-options `_] .. releasenotes/notes/add-network-service-provider-c161a4a328a8a408.yaml @ b'11a762e03c3d53b45888387f3c5472a37d9d9f68' - Add ``network service provider list`` command. .. releasenotes/notes/add-port-security-enabled-to-port-set-82b801d21d45e715.yaml @ b'11a762e03c3d53b45888387f3c5472a37d9d9f68' - Add ``--enable-port-security`` and ``--disable-port-security`` options to ``port set`` and ``port create`` commands. [Blueprint :oscbp:`network-commands-options`] .. releasenotes/notes/bp-cinder-command-support-413b6d80232f8ece.yaml @ b'4b14f3d0cb26dc89d7b62c70302eefaabc7cf2e3' - Add ``--type`` and ``--retype-policy`` options to ``volume set`` command. [Blueprint `cinder-command-support `_] .. releasenotes/notes/bp-cinder-command-support-7e3ae1fb4cd90407.yaml @ b'71e6d444767a29664821ab190e0736088d8ccfba' - Add ``volume host set`` command, it allows a user to enable or disable a volume host. [Blueprint `cinder-command-support `_] .. releasenotes/notes/bug-1597195-54ff1ecf381899f6.yaml @ b'bbfd8cb46bc7493971173f1cbc774ef4697ddfe4' - Add ``--force`` option to ``volume snapshot delete`` command to allow delete in state other than error or available. [Bug `1597195 `_] .. releasenotes/notes/bug-1612136-63aac6377209db38.yaml @ b'df5f12b135f273e3916e7bf300fa7688a180ea02' - Add ``--dns-name`` option to ``os port create`` and ``os port set`` commands. [Bug `1612136 `_] .. releasenotes/notes/bug-1613231-386b2b1373662052.yaml @ b'ce079d22617f3129bfdf5165b9f124d7cc7dbc2e' - Add ``--project`` and ``--project-domain`` options to the ``router list``, ``floating ip create`` and ``security group list`` commands. [Bug `1613231 `_] [Bug `1613629 `_] [Bug `1610909 `_] .. releasenotes/notes/bug-1613964-837196399be16b3d.yaml @ b'1907220113efe9425a6cc7f52ce87dd4e82233c7' - Add ``consistency group create`` command in volume v2. [Bug `1613964 `_] .. releasenotes/notes/bug-1613964-837196399be16b3d.yaml @ b'1907220113efe9425a6cc7f52ce87dd4e82233c7' - Add ``consistency group delete`` command in volume v2. [Bug `1613964 `_] .. releasenotes/notes/bug-1613964-837196399be16b3d.yaml @ b'1907220113efe9425a6cc7f52ce87dd4e82233c7' - Add ``consistency group show`` command in volume v2. [Bug `1613964 `_] .. releasenotes/notes/bug-1613964-86e0afe0e012a758.yaml @ b'4dc78e4265f60356ea453c7f52fcdaeecec58fcb' - Add ``consistency group set`` command in volume v2. [Bug `1613964 `_] .. releasenotes/notes/bug-1614379-d8e2815804d53cef.yaml @ b'47716d1ad32b7c879f6b5736687be1553f6fbfb6' - Add ``--long``, ``--status``, ``--project``, ``--project-domain``, and ``--router`` options to ``floating ip list`` command. [Bug `1614379 `_] .. releasenotes/notes/bug-1614379-da92ded6d19f5ad5.yaml @ b'839c5f7a84b48cecbc80606e894b7906fa01d66b' - Add ``--port``, ``--fixed-ip-address``, ``--network``, options to ``floating ip list`` command [Bug `1614379 `_] .. releasenotes/notes/bug-1618676-04ff0f335b670567.yaml @ b'7357b24d3a63be612aa32c901e15424ff92beca0' - 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 `_] .. releasenotes/notes/bug-1639231-21823768bd54170a.yaml @ b'a7a0d0c61a6a88e044b781bbc4903cdcfc919e55' - 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 `_] .. releasenotes/notes/bug-1642238-3032c7fe7f0ce29d.yaml @ b'3907137f5824e359bcdcfcdd8ab3d15a83d10bca' - Add ``consistency group snapshot create``, ``consistency group snapshot delete``, ``consistency group snapshot list`` and ``consistency group snapshot show`` commands in volume v2. [Bug `1642238 `_] .. releasenotes/notes/bug-1643861-b17ad5dfcb4304ff.yaml @ b'5e070c36a176edf47ec0832ef90636ee6720def7' - Add ``Is Public`` column to ``volume type list``. [Bug `1643861 `_] .. releasenotes/notes/bug-1645252-219bfd50c8f04846.yaml @ b'6ca4dc3533d009866f82515c34cb3881f993c750' - Add ``--name``, ``--status`` and ``--volume`` options to ``volume snapshot list`` command [Bug `1645252 `_] .. releasenotes/notes/network-add-qos-policy-a25e868e67142f90.yaml @ b'4132392c2fd8337d18296c33f07c4a89b8a58bda' - 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 `_] .. releasenotes/notes/rename-snapshot-commands-e0937f7143a4ef55.yaml @ b'11a762e03c3d53b45888387f3c5472a37d9d9f68' - 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 `_] .. _python-openstackclient_3.5.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/rename-snapshot-commands-e0937f7143a4ef55.yaml @ b'11a762e03c3d53b45888387f3c5472a37d9d9f68' - Deprecate commands ``snapshot create/delete/list/show/set/unset``. [Blueprint `backup-snapshot-renamed-for-volume-resource `_] .. _python-openstackclient_3.5.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1619274-e78afd7c12ea2c3d.yaml @ b'11a762e03c3d53b45888387f3c5472a37d9d9f68' - 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* .. releasenotes/notes/bug-1642301-ad04424c80e8fe50.yaml @ b'11a762e03c3d53b45888387f3c5472a37d9d9f68' - 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* .. releasenotes/notes/bug-1642772-19f53765bef8ee91.yaml @ b'4bce7167338908b082eb8ea946adcd60109e0907' - 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 `_] .. _python-openstackclient_3.4.1: 3.4.1 ===== .. _python-openstackclient_3.4.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1642301-18b08e0cd4b11687.yaml @ b'61cc5464750e03a44536642cdc493cf81ded2366' - Fix ``TypeError: __init__() got an unexpected keyword argument 'project_domain_id'`` error with non-password authentication types. [Bug `1642301 `_] .. _python-openstackclient_3.4.0: 3.4.0 ===== .. _python-openstackclient_3.4.0_New Features: New Features ------------ .. releasenotes/notes/add-ha-to-router-update-6a38a73cc112b2fc.yaml @ b'bae09c3c3fac210f4839a8a51dfb51e2dad69aa7' - Add support to update high-availability property of a router by adding ``--ha`` and ``--no-ha`` option to ``router set`` CLI. [Bug `1631492 `_] .. releasenotes/notes/add-network-qos-policy-b8ad1e408d73c279.yaml @ b'3205dad161c6c7bcaf16f985121217b8cf320af0' - 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 `_] .. releasenotes/notes/backup_list_all-projects_option-4bb23e0b9b075cac.yaml @ b'74360e00f51bd6be275ae5e7e5fc0e1ee765b54f' - Add ``--all-projects`` option to the ``volume backup list`` command to list volume backups across all projects. .. releasenotes/notes/bp-cinder-command-support-3db775ba331e113d.yaml @ b'daffce3a6a31ac59ee10e3cc8fe421320da1704a' - Add ``--read-only`` and ``--read-write`` options to ``volume set`` command. [Blueprint `cinder-command-support `_] .. releasenotes/notes/bp-neutron-client-descriptions-b65dd776f78b5a73.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - Add ``--description`` option to ``security group rule create`` command. [Blueprint :oscbp:`network-commands-options`] .. releasenotes/notes/bp-neutron-client-descriptions-b65dd776f78b5a73.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - Add ``--description`` option to ``port set`` and ``port create`` commands. [Blueprint :oscbp:`neutron-client-descriptions`] .. releasenotes/notes/bug-1566090_64726dc7df5b1572.yaml @ b'8f8a8448a4adc1d250c253738688ff46e6456616' - ``openstack floating ip`` now provides ``Floating Network`` and ``Project`` to identify to which network and project the floating-ip belongs to. [Bug `1566090 `_] .. releasenotes/notes/bug-1612136-051b5f94796e3b51.yaml @ b'66a04abd581e03e5e71a6b755e1b4dce1856ef41' - Add ``--security-group`` and ``--no-security-group`` options to ``port create``, ``port set`` and ``port unset`` commands. [Bug `1612136 `_] .. releasenotes/notes/bug-1613533-93279179c6f70117.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - Add ``--ingress``, ``--egress`` and ``--protocol`` options to ``security group rule list`` command. [Bug `1613533 `_] .. releasenotes/notes/bug-1613995-10bb3895d702c063.yaml @ b'2c1282cecf33162b5483f5cb558f98395945380b' - Add a new column ``status`` and ``--long`` option to the result of the ``os port list`` command. [Bug `1613995 `_] [Bug `1614321 `_] .. releasenotes/notes/bug-1634333-a2b04d33ca39440e.yaml @ b'a1e305641430af48b72c941f87c7ffcc182b3f9a' - Add support to allow filtering ports via ``--mac-address`` option to the ``port list`` command. [Bug `1634333 `_] .. releasenotes/notes/bug-1635580-54e0039b469ad5a6.yaml @ b'960b2658dc6ab1f82b78dbc531386544d302f09e' - Add ``--provider-network-type``, ``--provider-physical-network``, and ``--provider-segment`` options to the ``network list`` command. [Bug `1635580 `_] .. releasenotes/notes/bug-1637074-1b0e409f30f715ca.yaml @ b'8ca1cc637013972491744b8318d30e9256bc4165' - Add ``--long`` option and more columns to the ``hypervisor list`` command. [Bug `1637074 `_] .. releasenotes/notes/bug-1637945-f361c834381d409c.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - Add ``--name``, ``--enable``, ``--disable`` options to ``router list`` command. [Bug `1637945 `_] .. releasenotes/notes/bug-1639712-a7b9d1a35a042049.yaml @ b'e07b0e0919784b48dc47ae9cd8836342b8c13480' - Add ``--name``, ``--status``, ``--volume``, ``--marker`` and ``--limit`` options to ``volume backup list`` command [Bug `1639712 `_] .. releasenotes/notes/fix-network-rbac-create-d1f4de77ad2dd421.yaml @ b'57d5f945402681e5f7d62b9ca99fc229927cc784' - ``rbac_object`` parameter in ``network rbac create`` command now can be a QoS policy name. .. releasenotes/notes/volume-migrate-command-52cf6edd62fe17a7.yaml @ b'd7c8bb88e4a117d8ab6a53c3a7d14cc7a4105eda' - Add ``volume migrate`` command. [Blueprint `cinder-command-support `_] .. _python-openstackclient_3.4.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/bug-1637365-b90cdcc05ffc7d3a.yaml @ b'0ac4370c09567b80cda84d022068642047576e32' - 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 `_] .. _python-openstackclient_3.4.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1518059-e2dbe6e4b2473f10.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - Fix the ``--block-migration`` and ``--shared-migration`` options for ``server migrate`` to send the correct values to the Compute API. [Bug `1518059 `_]: .. releasenotes/notes/bug-1607959-a52aa93e3793f28a.yaml @ b'3770ad08b21b5ad7dd5430e810f1618435b269d5' - A warning message will be shown when an empty password is used for ``user create`` and ``user set`` operations. [Bug `1607959 `_] .. releasenotes/notes/bug-1631471-beb0a1c9b4a932cb.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - Fix ``router unset --route`` to correctly removed routes. [Bug `1631471 `_] .. releasenotes/notes/bug-1634672-7ce577f3adc34eed.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - Fix ``--no-allocation-pool`` option for ``subnet set`` command to send the correct value to the Network API. [Bug `1518059 `_]: .. releasenotes/notes/cliff-2.3.0-7ead18fae9ceea80.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - 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 `_] .. _python-openstackclient_3.3.0: 3.3.0 ===== .. _python-openstackclient_3.3.0_New Features: New Features ------------ .. releasenotes/notes/add-network-list-option-to-ports-9d101344ddeb3e64.yaml @ b'554607eb3dab879da8e172eacb72930e54f0acf4' - 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 `_] .. releasenotes/notes/bp-allow-overwrite-set-options-190a9c6904d53dab.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - 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 `_] .. releasenotes/notes/bp-allow-overwrite-set-options-190a9c6904d53dab.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - 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 `_] .. releasenotes/notes/bp-cinder-command-support-cc8708c4395ce467.yaml @ b'3ef7e29dd01a848ad08ce1b66deb9c5c3b1a4b1e' - 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 `_] .. releasenotes/notes/bp-network-command-options-2-e7b13a6a09f5d21e.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - Add ``--description`` option to ``network create`` and ``network set`` commands. [Blueprint `network-commands-options `_] .. releasenotes/notes/bp-neutron-client-descriptions-a80902b4295843cf.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - Add ``--description`` option to ``floating ip create`` command. [Blueprint :oscbp:`neutron-client-descriptions`] .. releasenotes/notes/bp-neutron-client-descriptions-a80902b4295843cf.yaml @ b'ad5ae83a34e555dabeb2761d3d8f3c7f1dbac2f8' - Add ``--description`` option to ``router set`` and ``router create`` commands. [Blueprint :oscbp:`network-commands-options`] .. releasenotes/notes/bp-routed-networks-3b502faa5cd96807.yaml @ b'256ec66f79f98b41497e8937911604bac7ddeabb' - 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 `_] .. releasenotes/notes/bp-support-no-property-in-aggregate-b74a42e00a65d14a.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - 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 `_] .. releasenotes/notes/bug-1204956-af47c7f34ecc19c3.yaml @ b'6f326acd260d035cb024f0c5e3ef2237277d8b37' - Supported to fetch network project default quota with command ``quota show --default``. [Bug `1204956 `_] .. releasenotes/notes/bug-1578819-d1efccfefb18356d.yaml @ b'9c473f475d2bb7adadc65a7525b93db84f10bef9' - Add ``--internal``, ``--name``, ``--project`` and ``--project-domain``, ``--enable`` and ``--disable``, ``--share`` and ``--no share``, ``--status`` options to the ``network list`` command. [Bug `1578819 `_] .. releasenotes/notes/bug-1607972-a910a9fbdb81da57.yaml @ b'78312ca9afea22f6511f2421dccb0736f394e9c8' - Add ``--name`` option to command ``object create`` for uploading a file and renaming it. [Bug `1607972 `_] .. releasenotes/notes/bug-1609767-0602edc4408c2dc6.yaml @ b'6fba7163e85a436d1fe0660d9932a53d06b1a343' - Support to update ``per_volume_gigabytes``, ``backup_gigabytes`` and ``backups`` quota in ``quota set`` command. [Bug `1609767 `_] .. releasenotes/notes/bug-1610161-7c34c7b735701bd4.yaml @ b'e2fc436d53f53d0993fc0b9dd29f402e6c7f8bc1' - Add ``--ha`` option to ``router create`` command. [Bug `1610161 `_] .. releasenotes/notes/bug-1610883-38929f6fc2eefc9a.yaml @ b'5ec435e706d137afb714cfd5c5ddbd40d8107a9e' - Add ``--project``, ``--project-domain``, ``--network``, ``--gateway``, ``--name`` and ``--subnet-range`` options to the ``subnet list`` command. [Bug `1610883 `_] .. releasenotes/notes/bug-1612484-e8605ad8966a455e.yaml @ b'6986a32e1cd6d0c0bdf973e5d4e4bcb3d1f45235' - Add ``--limit`` option to ``volume list`` command in volume v1, add ``--limit`` and ``--marker`` options to ``volume list`` command in volume v2. [Bug `1612484 `_] .. releasenotes/notes/bug-1613261-290a64080fead6c0.yaml @ b'ddf84429f297b34ce7067250d834ea897e37f37c' - Add ``volume backup set`` commands in volume v2. [Bug `1613261 `_] .. releasenotes/notes/bug-1613597-b1545148b0755e6f.yaml @ b'81431d24a9f94f56c4c39cb12bf846871f6230d8' - Add ``volume service set`` commands in volume v1 and v2. [Bug `1613597 `_] .. releasenotes/notes/bug-1613926-2d0e405831c0b5a9.yaml @ b'5ec435e706d137afb714cfd5c5ddbd40d8107a9e' - Add ``--share``, ``--no-share``, ``--project``, ``--project-domain``, ``--default``, ``--no-default``, ``--name`` and ``--address-scope`` options to the ``subnet pool list`` command. [Bug `1613926 `_] .. releasenotes/notes/bug-1613964-e5760f4825f1e043.yaml @ b'8d63b8b263ca4011761b062331d53d9b53b5031d' - Add ``consistency group list`` command in volume v2. [Bug `1613964 `_] .. releasenotes/notes/bug-1614385-460b5034ba372463.yaml @ b'96a8ed435c7e55633c00dbb1283477ff11cf35f9' - Support listing the specified server's ports by new option ``--server`` of ``port list`` command. [Bug `1614385 `_] .. releasenotes/notes/bug-1614458-c42be5738f447db8.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - Adds ``--description`` option to ``subnet create`` and ``subnet set`` commands. [Bug `1614458 `_] .. releasenotes/notes/bug-1614823-e89080342f25f2c0.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - Adds ``--description`` option to ``subnet pool create`` and ``subnet pool set`` commands. [Bug `1614823 `_] .. releasenotes/notes/bug-1627913-2adf4182977e5926.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - 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 `_] .. releasenotes/notes/subnet-service-type-8d9c414732e474a4.yaml @ b'cf9ad08ab6fd5e6ed5f68208a39b0014b0af5f8a' - Add ``--service-type`` option to the ``subnet create``, ``subnet set``, ``subnet unset``, and ``subnet list`` commands. [ Blueprint `service-subnets `_] .. _python-openstackclient_3.3.0_Security Issues: Security Issues --------------- .. releasenotes/notes/bug-1630822-mask-password-on-debug-20dcdf1c54e84fa1.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - Mask passwords when ``--debug`` or ``-vv`` options are used. [Bug `1630822 `_] .. _python-openstackclient_3.3.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1535704-d6f013bfa22ab668.yaml @ b'6a914d0056e810e1ef37eaf4f01cd5c85217aba6' - Add ``--bootable`` and ``--non-bootable`` options to ``os volume set`` command to mark volume as bootable or non-bootable. [Bug `1535704 `_] .. releasenotes/notes/bug-1588171-61214d0ea482988c.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - Update novaclient ``DEFAULT_API_VERSION`` from 2.0 to 2.1 [Bug `1588171 `_] .. releasenotes/notes/bug-1609233-90b2ddf8d941050e.yaml @ b'762f2f2c34814b8bfc615696918d8cb49b93a1dd' - Fix the ``--class`` option in ``quota set`` and ``quota show`` commands to not perform a project lookup in Identity. [Bug `1609233 `_] .. releasenotes/notes/bug-1620922-7f27942dc00f7108.yaml @ b'5231ade27c8a08e3d7fd5573d4dda6fa47d0ae67' - Do not show ``os-volume-type-access:is_public`` property which is the same as ``is_public`` property of volume type object. [Bug `1620922 `_] .. releasenotes/notes/bug-1622565-2e715aff8b054401.yaml @ b'5ec435e706d137afb714cfd5c5ddbd40d8107a9e' - Fix ``--long`` option in ``router list`` command for deployments without the ``router_availability_zone`` extension is not enabled. [Bug `1622565 `_] .. releasenotes/notes/bug-1624085-7cf296649277f405.yaml @ b'5ec435e706d137afb714cfd5c5ddbd40d8107a9e' - Fix missing ``_username`` attribute error in ``server ssh`` command. [Bug `1624085 `_] .. _python-openstackclient_3.12.1: 3.12.1 ====== .. _python-openstackclient_3.12.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1711301-633255f813c71d2a.yaml @ b'8eced505329a32533b1154700302780ca5af51ef' - Fix occurrences of the ``network agent delete`` command failing with newer releases of python-openstacksdk. [Bug `1711301 `_] .. releasenotes/notes/bug-1717130-029211b60f74b4c4.yaml @ b'b9c5094ede503109955eb90fe0007e343f7bb903' - Fix the ``project purge`` command to correctly delete only images owned by the specified project ID when run by an administrative user. [Bug `1717130 `_] .. releasenotes/notes/bug-1732938-868963acedaa307e.yaml @ b'8eced505329a32533b1154700302780ca5af51ef' - 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 `_] .. _python-openstackclient_3.12.0: 3.12.0 ====== .. _python-openstackclient_3.12.0_New Features: New Features ------------ .. releasenotes/notes/add-is-default-to-network-qos-policy-89b11d4df032a789.yaml @ b'c17819ab58db7ded30644d63575d47ee3c963ada' - Add ``--default`` and ``--no-default`` options to ``network qos policy create`` and ``network qos policy set`` comamnds. [Bug `1639220 `_] .. releasenotes/notes/add-virtio-forwarder-vnic-type-bad939c6a868b9e9.yaml @ b'cf5dfa77e17d273aaebca21a0b44902d587fac04' - 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. .. releasenotes/notes/bp-network-l3-adv-commands-cc1df715a184f1b2.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - Add ``network agent add router`` and ``network agent remove router`` commands for adding/removing routers to network l3 agents. [Blueprint :oscbp:`network-l3-commands`] .. releasenotes/notes/bp-network-l3-adv-commands-cc1df715a184f1b2.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - Add ``--router`` option to ``network agent list`` to filter by router, and ``--agent`` option to ``router list`` command to filter by agent. [Blueprint :oscbp:`network-l3-commands`] .. releasenotes/notes/bp-neutron-client-tag-ff24d13e5c70e052.yaml @ b'57e5840710c3b2b74d31bfd6a0da739e0fc747ed' - Added support for ``tags`` to the following resources: ``network``, ``subnet``, ``port``, ``router`` and ``subnet pool``. [Blueprint :oscbp:`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. .. releasenotes/notes/bug-1584596-5b3109487b451bec.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - Add command ``openstack project purge`` to clean a project's resources. [Bug `1584596 `_] .. releasenotes/notes/bug-1614121-a3c5b6892074d5ae.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - 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 `_] .. releasenotes/notes/bug-1640086-21d7e5f2ce18f53c.yaml @ b'6962cc963e6e17e709524ecf6a395e2d0c8b8370' - Add ``--human-readable`` option to ``image show`` to display image size in human readable format (such as K, M, G, T,..) [Bug `1640086 `_] .. releasenotes/notes/bug-1667294-f92efa49627eb00a.yaml @ b'eb793dc8c6a8bd30e612f19f30808528b10eb344' - Add ``--default-quota`` option to ``subnet pool create`` and ``subnet pool set`` commands. [Bug `1667294 `_] .. releasenotes/notes/bug-1684989-3bda158a822d2f73.yaml @ b'1ae904a4912494b3d0ac87f22aaf958129744548' - Add ``--data-plane-status`` option to ``port set`` and ``port unset`` commands. [Bug `1684989 `_] .. releasenotes/notes/bug-1698390-0df8f0ec4fe354de.yaml @ b'77ff011ced18260242224a7317aba92d53ff1455' - Added the ``--domain`` option to the ``identity provider create`` command to associate an existing domain with an identity provider on its creation. [Bug `1698390 `_] .. releasenotes/notes/bug-1698742-66d9d4e6c7ad274a.yaml @ b'bca8d57eb3963beb74baa5d75e61954c610369d0' - Add ``--name`` and ``--status`` options to ``image list`` command to filter images based on name and status respectively. [Bug `1698742 `_] .. releasenotes/notes/credential_list_user_type-c809e5b8014d6275.yaml @ b'470a1f1acfe261357fc3125b2db3bc6ec10c654e' - Add ``--user`` and ``--type`` option to ``credential list`` command to filter list result by different user or type. .. releasenotes/notes/object-stdout-db76cc500948b0e8.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - Add support for streaming Swift objects to stdout when using the ``object save`` command by specifying ``-`` as a file name: ``--filename -``. .. releasenotes/notes/skip-name-lookups-9f499927173c1eee.yaml @ b'2689984ba71fa0be25d2368277f33f2fb5c41266' - 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. .. _python-openstackclient_3.12.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1657956-977a615f01775288.yaml @ b'6aceca218af7d1d2c708fde48f1a5f2b798bc421' - 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 `_] .. releasenotes/notes/bug-1658189-d2b390ad74c96c79.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - Make the ``role assignment list`` command callable without administrator permissions if restricted to the user's own project with the ``--project`` option. [Bug `1658189 `_] .. releasenotes/notes/bug-1667266-6497727abc2af9a5.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - 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 `_] .. releasenotes/notes/bug-1687814-743ad8418923d5e3.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - 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 `_] .. releasenotes/notes/bug-1689233-c3f98e159c75374e.yaml @ b'acc2d106abfb4fed0ff5d0d0c246d69f9ea1758b' - 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 `_] .. releasenotes/notes/bug-1696111-e2cf9233fa872eb7.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - 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 `_] .. releasenotes/notes/bug-1704097-8ff1ce1444b81b04.yaml @ b'1f2295cf6531b589de4f6d78c5d10f1c31537bb7' - 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 `_] .. releasenotes/notes/image_set_visibility-babf4ff2f687d465.yaml @ b'3468ea1ca429e8b6403ae5f989cfed521d8f5690' - 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. .. releasenotes/notes/remove-unsupported-set-vlan-transparent-eeff412264ae7c09.yaml @ b'2b66c71a7c2798dc1f9149574d54062b9086a01a' - Remove ``--transparent-vlan`` and ``--no-transparent-vlan`` from ``network set``, because updating ``vlan-transparent`` is not supported in Neutron. [Bug `1691776 `_] .. _python-openstackclient_3.11.0: 3.11.0 ====== .. _python-openstackclient_3.11.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1688194-bb008b65267a1169.yaml @ b'c69304e3d365dc2c67fab298eba0b9097d3819da' - Fix issue in ``port list`` command when no Compute endpoint is in the Service Catalog. [Bug `1688194 `_] .. _python-openstackclient_3.10.0: 3.10.0 ====== .. _python-openstackclient_3.10.0_New Features: New Features ------------ .. releasenotes/notes/add-network-flavor-profile-e7cc5b353c3ed9d9.yaml @ b'7ef1e9ea96ef15b63304a6bccaf30f8c269f2b76' - 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 :oscbp:`neutron-client-flavors`] .. releasenotes/notes/add-qos-policy-list-options-9ba1ae731a88e7ac.yaml @ b'9fd3dba11e5fc60023a9c332cfb76b42d38adf05' - Add ``--share``, ``--no-share``, ``--project``, ``--project-domain`` options to ``qos policy list`` command. [Blueprint `network-commands-options `_] .. releasenotes/notes/add-quota-list-command-0d865fac61db2430.yaml @ b'58591d3c37c0265d8775f881271ba4d987e5ffb6' - Add ``quota list`` command with ``--compute``, ``--volume`` and ``--network`` options. [Blueprint `quota-list `_] .. releasenotes/notes/allow-to-add-remove-vm-ports-273593d7cc1982de.yaml @ b'21510ac1a94eeb8de218a0edfe81db5ef0437249' - Add ``server add port`` and ``server remove port`` commands which enable to add/remove ports to/from a server [Bug `1678137 `_] .. releasenotes/notes/allow-to-create-legacy-router-cb4dcb44dde74684.yaml @ b'53ba05325ad5e580e62addb7f4b405b96ad01d80' - Add ``--no-ha`` option to the ``router create`` command [Bug `1675514 `_] .. releasenotes/notes/allow-to-specify-vm-ip-to-publish-85f7207740c0cc8d.yaml @ b'f5527877bb6dab09757b6692460bcc376b7d5ec3' - Add ``--fixed-ip-address`` option to the ``server add floating ip`` command [Bug `1624524 `_] .. releasenotes/notes/allow-to-vm-ip-to-add-7721ba64b863fa77.yaml @ b'7f9814860ad739e25b82898176d26c7b788e8e33' - Add ``--fixed-ip-address`` option to the ``server add fixed ip`` command [Bug `1678140 `_] .. releasenotes/notes/bp-extension-show-6f7e31a27dad0dc9.yaml @ b'9915efdd0abebd91a3f05a242e0e20bbd5d5efa9' - Added ``extension show`` command to display the details of an extension. Currently works only for network extensions. [Blueprint `extension-show `_] .. releasenotes/notes/bp-network-dhcp-adv-commands-e61bf8757f46dc93.yaml @ b'f4fd8f6e31dcc177b56d1e618cdefef728d09157' - 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 :oscbp:`network-dhcp-adv-commands`] .. releasenotes/notes/bp-support-multi-add-remove-9516f72cfacea11a.yaml @ b'ef5a7caf85bd6169701371da67029457abdaf47f' - Add support to add/remove multi users by ``group add/remove user`` command. [Blueprint :oscbp:`support-multi-add-remove`] .. releasenotes/notes/bug-1549410-8df3a4b12fe13ffa.yaml @ b'dee22d8faa0c8a0da1d6ff62c0997c2cc770b759' - 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 `_] .. releasenotes/notes/bug-1596818-d4cd93dd4d38d3d6.yaml @ b'6c1b03bf7354fe39d61bb9cf93d2491bbb5ebb16' - Add ``--sort`` support to ``project list`` by sorting items in client side By default project list will be sorted by name. [Bug `1596818 `_] .. releasenotes/notes/bug-1612136-ec240349a933db12.yaml @ b'5ff2cfd042de7afc4323a3b306ff5be1882fba46' - Add ``--qos-policy`` option to ``port create``, ``port set`` and ``port unset`` commands. [Bug `1612136 `_] .. releasenotes/notes/bug-1612898-bea3b68251d12d81.yaml @ b'8549071363805a9eef815dd2429b6b860db11a2c' - Add ``--network`` and ``--port`` options to ``server create`` command as alternatives to ``--nic`` option. [Bug `1612898 `_] .. releasenotes/notes/bug-1627555-3b47eba215e35b3c.yaml @ b'49f6032b699804b1b0ed56137ab14ba266251157' - 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 `_] .. releasenotes/notes/bug-1642030-166b2b28c8adf22e.yaml @ b'9915efdd0abebd91a3f05a242e0e20bbd5d5efa9' - 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 `_] .. releasenotes/notes/floating-ip-set-unset-port-28e33875937b69cf.yaml @ b'763c8c5670f238920398165e670592e006213f32' - Add ``floating ip set`` and ``floating ip unset`` commands. [:lpbug:`1560297`] .. releasenotes/notes/neutron-client-flavors-81387171f67a3c82.yaml @ b'b51310a4bb5997137a4b6c0cf3517f481e178474' - Add ``network flavor add profile`` and ``network flavor remove profile`` commands. [Blueprint :oscbp:`neutron-client-flavors`] .. _python-openstackclient_3.10.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/bug-1633582-df2bee534c2da7fc.yaml @ b'9915efdd0abebd91a3f05a242e0e20bbd5d5efa9' - ``volume transfer request accept`` has been changed to move the ``auth-key`` positional argument to a requried option ``--auth-key``. This leaves the transfer request ID as the only positional arguemnt, as per the OpenStackClient command format. The old format is still functional, but is deprecated and will be removed in the next major release. .. _python-openstackclient_3.10.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1633582-df2bee534c2da7fc.yaml @ b'9915efdd0abebd91a3f05a242e0e20bbd5d5efa9' - 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 `_] .. releasenotes/notes/bug-1633582-df2bee534c2da7fc.yaml @ b'9915efdd0abebd91a3f05a242e0e20bbd5d5efa9' - Change the output column order in ``volume transfer request list`` to have ``ID`` followed by ``Name`` then the remaining columns. .. releasenotes/notes/bug-1659894-4518b10615498ba9.yaml @ b'1c49a1f01da73b8eed701809de88b408e738dfed' - Now the positional parameter ```` of ``volume snapshot create`` command is no longer optional, it should be always present. [Bug `1659894 `_] .. releasenotes/notes/bug-1659967-644a8ee3621c9e81.yaml @ b'888022f8c0a2911a03fc682fdbe4c68c35a27db7' - ``security group list`` command now can display project IDs in the ``Project`` column of the command output. [Bug `1659967 `_] .. releasenotes/notes/bug-1664255-f82c5c13d92fed2a.yaml @ b'fe59e339ae6dd6a5e9075773fb5c2a0fea9c2e53' - 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 `_] .. releasenotes/notes/bug-1670707-c4799fbed39ef75b.yaml @ b'f1345dc06f91177ced17f102bcdaaa126fe12568' - Add ``--mac-address`` option to ``port set`` command. [Bug `1670707 `_] .. releasenotes/notes/bug-1672634-ef754cb5109dd0f2.yaml @ b'853ea5ab59e5d7845d389e46527038575c3c170c' - Narrow acceptable negative response codes for ``group contains user`` [Bug `1672634 `_] .. releasenotes/notes/bug-1677236-7de9d11c3f0fb5ed.yaml @ b'61cde9c8e85182073b53e3736f8568f2a6d1453c' - Fix creating a server with a block-device-mapping when volume_size is empty. [Bug `1677236 `_] .. _python-openstackclient_3.9.0: 3.9.0 ===== .. _python-openstackclient_3.9.0_New Features: New Features ------------ .. releasenotes/notes/add-network-auto-allocated-topology-481580f48840bfc4.yaml @ b'1169434f42a751ca9ef37fed2fa2fd04fe8b6f8b' - Add support for the ``network auto allocated topology`` command for creating and deleting auto allocated topologies. [Blueprint :oscbp:`network-auto-allocated-topology`] .. releasenotes/notes/add-no-property-f97e4b2f390cec06.yaml @ b'1e739d7aebe53d38038b9f6172eb08916a7dd23c' - Add support to clear/overwrite all flavor properties using ``--no-property`` option with ``flavor set`` command. [Blueprint :oscbp:`allow-overwrite-set-options`] .. releasenotes/notes/add-volume-host-failover-8fc77b24533b7fed.yaml @ b'55195cec46fadd88f6151783b1e17557d5e94940' - Add ``volume host failover`` command. [Blueprint `cinder-command-support `_] .. releasenotes/notes/bug-1634799-1322227c9b0188ca.yaml @ b'e0e46bca093984926de11559e312d1f1fcade108' - Add ``--fixed-ip`` option to the ``port list`` command. [Bug `1634799 `_] .. releasenotes/notes/bug-1651117-a1df37e7ea939ba4.yaml @ b'b2fd8ba869cd4b8e927118f7712d0ed7fb60309f' - 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 `_] .. releasenotes/notes/bug-1666780-c10010e9061689d3.yaml @ b'20429bd5c624399578cb7217e582eb86068114c6' - 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 `_] .. releasenotes/notes/change-098377fd53cce7a0.yaml @ b'4d5f2c3925068fe49748e05a47c5c9c7e7999b3c' - 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``. .. releasenotes/notes/network-flavor-command-support-afe3a9da962a09bf.yaml @ b'3907389785055e4599907dca39ae2c2bc0e78497' - Add ``network flavor create``, ``network flavor delete``, ``network flavor list``, Add ``network flavor show`` and ``network flavor set`` command [Blueprint :oscbp:`neutron-client-flavors`] .. releasenotes/notes/support-no-property-in-volume-811e67ff4a199eb6.yaml @ b'40ec7a9c96f4ce4071e47e5bf0c249aa77b5b2ee' - Add ``--no-property`` option in ``volume set``, this removes all properties from a volume. [Blueprint `allow-overwrite-set-options `_] .. _python-openstackclient_3.9.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1499657-eeb260849febacf3.yaml @ b'20429bd5c624399578cb7217e582eb86068114c6' - Fix ``--parents`` and ``--children`` options in ``project show`` command. [Bug `1499657 `_] .. releasenotes/notes/bug-1656788-2f5bda2205bc0329.yaml @ b'9d946f0f45c83c5677e9dd2688830c45cb6a24af' - Fixed the ``port set`` and ``port unset`` command failures (AttributeError) when ``--security-group`` option is included. [Bug `1656788 `_] .. releasenotes/notes/bug-1658614-f84a8cece6f2ef8c.yaml @ b'e8b6a9f7be7e773396c8fe1021d8798aa0e2a4a9' - 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 `_] .. releasenotes/notes/bug-1661814-1692e68a1d2d9770.yaml @ b'3afd2b7ff25af7e7998e9c8f4adac8a58a079675' - Fix ``module list --all`` command failed, and enhance the related unit tests and funcational tests. [Bug `1661814 `_] .. releasenotes/notes/bug-1663520-d880bfa51ca7b798.yaml @ b'c051c5f090fa6729a005c9d462afd8a75fc1b40f' - 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 `_] .. releasenotes/notes/bug-1665231-3df6d090d137fe4f.yaml @ b'7d93db21e59e8518ed2ca8018cecb69dc3f5b2e4' - Allow ``--default`` and ``--no-default`` options in ``network create`` command to be recognized when ``--external`` is not present. [Bug `1665231 `_] .. releasenotes/notes/bug-1667699-6dad786b128ca8b5.yaml @ b'20429bd5c624399578cb7217e582eb86068114c6' - Fix the ``Ethertype`` column output of ``security group rule list`` command. [Bug `1667699 `_] .. _python-openstackclient_3.14.3-12: 3.14.3-12 ========= .. _python-openstackclient_3.14.3-12_New Features: New Features ------------ .. releasenotes/notes/name-lookup-one-by-one-e0f15f4eab329b19.yaml @ b'defa0f562b8efc8fc917f1b195c998e2d6224260' - 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. .. releasenotes/notes/name-lookup-one-by-one-e0f15f4eab329b19.yaml @ b'defa0f562b8efc8fc917f1b195c998e2d6224260' - 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. .. _python-openstackclient_3.14.3-12_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1751104-compute-api-2.47-4bfa21cfaa13f408.yaml @ b'1c754197b58a28e9d30ae158560bd9921e7a8e9c' - 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 `_] .. releasenotes/notes/bug-1775482-7ed2a9a8765b313e.yaml @ b'3228713ea302a962c11eb96ce34918b94528205e' - Re-open stdout in binary mode before writing object data in ``object save --file -`` command. [Bug `1775482 `_] .. releasenotes/notes/story-2005349-compute-service-set-2.53-3d2db875154e633a.yaml @ b'492a6c400169689182c077df5543f5ec1e481369' - The ``compute service set`` command now properly handles ``--os-compute-api-version`` 2.53 and greater. [Story `2005349 `_] .. _python-openstackclient_3.14.3: 3.14.3 ====== .. _python-openstackclient_3.14.3_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/floating-ip-multi-port-9779e88f590cae23.yaml @ b'010da92ff3711873e40c0f5a1c262010400bf53b' - 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. .. _python-openstackclient_3.14.1: 3.14.1 ====== .. _python-openstackclient_3.14.1_New Features: New Features ------------ .. releasenotes/notes/neutron_mtu-d87e53e2d76f8612.yaml @ b'a3caf7b331709d76fc6aec5222c60688fd6112a9' - Add ``--mtu`` option to ``network create`` and ``network set`` commands, allowing CLI users to set the MTU for Neutron networks. .. _python-openstackclient_3.14.0: 3.14.0 ====== .. _python-openstackclient_3.14.0_New Features: New Features ------------ .. releasenotes/notes/add-device_id-to-port-list-0c658db51ce43c9e.yaml @ b'5fdd0730c88b7a3f65b728c0ea87bb34cbc1d9c4' - Add ``--device-id`` option to the ``port list`` command. .. releasenotes/notes/bp-neutron-floating-ip-rate-limit-8387c040a6fb9acd.yaml @ b'cf91d7a2f46b4a8546169a4836cc64476fce44d8' - 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. .. _python-openstackclient_3.14.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1741223-7a5c5b6e7f232628.yaml @ b'ed1b59848fd2a6b7bed7618ab5ac0db00e8110dc' - 'NoneType' object is not iterable when Glance cannot find image data in its backend. [Bug `1741223 `_] .. _python-openstackclient_3.13.0: 3.13.0 ====== .. _python-openstackclient_3.13.0_New Features: New Features ------------ .. releasenotes/notes/add-implied-role-0cdafb131fbd7453.yaml @ b'8cd3e258c5029a8efedab40019d6cfd3eac379f5' - 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 --implied-role `` creates an association between prior and implied roles. ``implied role delete --implied-role `` removes an association between prior and implied roles. ``implied role list`` Lists all implied roles that currently exist. .. releasenotes/notes/add-network-qos-rule-type-show-57a714a1d428726e.yaml @ b'07f0c7aa55920d65035124c9e8bfe8452356c811' - Add ``network qos rule type show`` command. .. releasenotes/notes/add-server-add-network-98ede8ff6079eb23.yaml @ b'e3ad82164dc5c51b5f3cb75b826bc15a6778b8b0' - 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. .. releasenotes/notes/add-server-remove-network-fb09c53d5b0c0068.yaml @ b'809355894fac72908869739b72d44ead1c183072' - Add ``server remove network`` command. This command will remove all network ports from the specified network and instance. .. releasenotes/notes/bug-1513894-6d2f05db6e1df744.yaml @ b'04ef8a41acbd45ef03253240934fa07ec170d7f4' - Add ``--use-prefix-delegation`` option to the ``subnet create`` command to specify 'Prefix Delegation' as a subnetpool when creating subnets. [Bug `1513894 `_] .. releasenotes/notes/bug-1675489-a1d226f2ee911420.yaml @ b'e7ef9e855677051383446e18e393b1f96158331b' - 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 `_] .. releasenotes/notes/bug-1712242-934bbe2f2378f5bd.yaml @ b'82f45d9bd203aee77914c1f9e300f7dbedf673c8' - Add ``any`` as a ``--protocol`` option to ``security group rule create`` command. [Bug `1517134 `_] .. releasenotes/notes/keystone-endpoint-filter-e930a7b72276fa2c.yaml @ b'12ee1861085144f43e6e535f82ba5d9b5d9a5632' - Add ``endpoint add project``, ``endpoint remove project`` and ``endpoint list`` commands to manage endpoint filters in identity v3. .. _python-openstackclient_3.13.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1703278-5e45a92e43552dec.yaml @ b'fd23ebfbf3080b96f7ef8ba516b64e67a111971d' - Add ``--image`` and ``--password`` options to the ``server rescue`` command. [Bug `1703278 `_] .. releasenotes/notes/bug-1711301-472b577f074edd43.yaml @ b'3a672eae7be0dcf5e2e951ea958d5d157699c341' - Fix occurrences of the ``network agent delete`` command failing with newer releases of python-openstacksdk. [Bug `1711301 `_] .. releasenotes/notes/bug-1712242-934bbe2f2378f5bd.yaml @ b'82f45d9bd203aee77914c1f9e300f7dbedf673c8' - 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. .. releasenotes/notes/bug-1717130-029211b60f74b4c4.yaml @ b'254dbf3294c0f1edc4a2a469f556b3c4b3123a00' - Fix the ``project purge`` command to correctly delete only images owned by the specified project ID when run by an administrative user. [Bug `1717130 `_] .. releasenotes/notes/bug-1717829-c1de1d777d3abaf9.yaml @ b'de23ab8d75fe89c164b3b084c53f01c25b9040ca' - Add ``--no-fixed-ip`` option to ``port create`` command. [Bug `1717829 `_] .. releasenotes/notes/bug-1719413-0401d05c91cc9094.yaml @ b'f6f5ce03c5b8a03180db24a02dda5b30f40b4cee' - Fix an issue with ``endpoint list`` working slow because it is issuing one GET request to /v3/services/ Keystone API for each endpoint. In case of HTTPS keystone endpoint and multiple regions it can take significant amount of time. [Bug `1719413 `_] .. releasenotes/notes/bug-1719499-d67d80b0da0bc30a.yaml @ b'4464109c7754a9287f75ec2af84398700d1450e6' - 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 .. releasenotes/notes/bug-1728525-2c40f0c19adbd0e8.yaml @ b'9ca99b991947c5b932a0c916591cd71568f2ac17' - Add ``target-all-projects`` option in ``rbac create`` command. [Bug `1728525 `_] .. releasenotes/notes/bug-1731848-71d0a5fdb1a34a8b.yaml @ b'0f749cacc2b0a76226a6a7ab7769ecf1475a160b' - 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 `_] .. releasenotes/notes/bug-1732216-b41bfedebff911e1.yaml @ b'116526275d0953fda93c7ff8eacd8631c5af68d5' - Fix the operation of the ``--changes-since`` option to the ``server list`` command. [Bug `1732216 `_] .. releasenotes/notes/bug-1732938-e4d91732ef777f9a.yaml @ b'3a672eae7be0dcf5e2e951ea958d5d157699c341' - 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 `_] .. releasenotes/notes/bug-1735836-9be6d777a6e6410b.yaml @ b'dab49df461d7ca68001632f11dc5bf1229271de9' - ``openstack subnet create`` failed with a NoneType exception when there were no tags. [Bug `1735836 `_] .. releasenotes/notes/support-icmp-type-code-zero-cbef0a36db2b8123.yaml @ b'221b7052abcefa56213a6516cecc6de9c73026d1' - Add support to set ``--icmp-type`` and ``--icmp-code`` to 0 in the ``security group rule`` command. [Bug `1703704 `_] .. _python-openstackclient_3.16.3-4: 3.16.3-4 ======== .. _python-openstackclient_3.16.3-4_New Features: New Features ------------ .. releasenotes/notes/network_dns_integration-5914b2c2be474a41.yaml @ b'e7a8687a2c87a507ce25e042014d6a918e95d035' - 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). .. _python-openstackclient_3.16.3-4_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1775482-7ed2a9a8765b313e.yaml @ b'47f0277208362a3224f8e587bbdd60dd5aebf846' - Re-open stdout in binary mode before writing object data in ``object save --file -`` command. [Bug `1775482 `_] .. _python-openstackclient_3.16.3: 3.16.3 ====== .. _python-openstackclient_3.16.3_New Features: New Features ------------ .. releasenotes/notes/name-lookup-one-by-one-e0f15f4eab329b19.yaml @ b'dda007ba33b5c7d1ae539926b826749727276e3c' - 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. .. releasenotes/notes/name-lookup-one-by-one-e0f15f4eab329b19.yaml @ b'dda007ba33b5c7d1ae539926b826749727276e3c' - 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. .. _python-openstackclient_3.16.3_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2005521-0274fc26bd9b3842.yaml @ b'bb7f49168563414d65b4050e84a8d1d4915206bc' - Fix ``endpoint group delete`` command to properly delete endpoint groups. [Story `2005521 `_] .. releasenotes/notes/story-2005349-compute-service-set-2.53-3d2db875154e633a.yaml @ b'fc5f2978c0f4f1e3360325b00c1f1b99f1e6318f' - The ``compute service set`` command now properly handles ``--os-compute-api-version`` 2.53 and greater. [Story `2005349 `_] .. _python-openstackclient_3.16.2: 3.16.2 ====== .. _python-openstackclient_3.16.2_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/floating-ip-multi-port-9779e88f590cae23.yaml @ b'e09c358e7b35ac938595aad90c5c42dfe402a42a' - 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. .. _python-openstackclient_3.16.0: 3.16.0 ====== .. _python-openstackclient_3.16.0_New Features: New Features ------------ .. releasenotes/notes/add-image-member-list-1630ead5988348c2.yaml @ b'4236d777ffb6f03bb2682142aaa18b48e9a00d96' - Add ``image member list`` command to list all members of an image. .. releasenotes/notes/add-image-tag-filter-support-5cb039416b07caab.yaml @ b'9edbab8c90bb74ba12892d0c77c8e8a99d4868fe' - Add ``--tag`` option to ``image list`` command to filter by tag. .. releasenotes/notes/add-server-create-image-property-ef76af26233b472b.yaml @ b'4236d777ffb6f03bb2682142aaa18b48e9a00d96' - Add ``--image-property`` option to ``server create`` command. This parameter will filter a image which properties that are matching. .. releasenotes/notes/allow-port-list-with-ip-address-substr-14c5805b241e402f.yaml @ b'4a9cb8eea8e47950cb30ecaa7572a23d80d5bfcd' - 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 `_] .. releasenotes/notes/bp-unified-limits-58f166401534a4ff.yaml @ b'4236d777ffb6f03bb2682142aaa18b48e9a00d96' - 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 `_] .. releasenotes/notes/bp-unified-limits-6c5fdb1c26805d86.yaml @ b'4236d777ffb6f03bb2682142aaa18b48e9a00d96' - 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 `_] .. releasenotes/notes/bug-1750983-420945d6c0afb509.yaml @ b'4236d777ffb6f03bb2682142aaa18b48e9a00d96' - Add ``--tag`` and ``--no-tag`` options to ``security group create`` and ``security group set`` commands. [Bug `1750983 `_] .. releasenotes/notes/bug-1750983-420945d6c0afb509.yaml @ b'4236d777ffb6f03bb2682142aaa18b48e9a00d96' - Add ``--tags``, ``--any-tags``, ``--not-tags`` and ``--not-any-tags`` options to ``security group list`` command. [Bug `1750983 `_] .. releasenotes/notes/bug-1750983-420945d6c0afb509.yaml @ b'4236d777ffb6f03bb2682142aaa18b48e9a00d96' - Add ``--tag`` and ``--all-tag`` options to ``security group unset`` command. [Bug `1750983 `_] .. releasenotes/notes/flavor-add-description-b618abd4a7fb6545.yaml @ b'7e8c55fa1bbc5f44b9233602786c22d6019eef22' - Add ``--description`` option to ``flavor set`` command to update the description of the flavor. Only available starting with ``--os-compute-api-version 2.55``. .. releasenotes/notes/flavor-add-description-b618abd4a7fb6545.yaml @ b'7e8c55fa1bbc5f44b9233602786c22d6019eef22' - Add ``--description`` option to ``flavor create`` command to set the description of the flavor. Only available starting with ``--os-compute-api-version 2.55``. .. releasenotes/notes/implement-system-scope-4c3c47996f98deac.yaml @ b'4236d777ffb6f03bb2682142aaa18b48e9a00d96' - 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 `_] .. releasenotes/notes/subnet-set-segment-id-4440e433b170f9f3.yaml @ b'e8c731547d85b1241c7898d2fb77b8d635901dfd' - Add ``--network-segment`` option to ``subnet set`` command. This enables the possiblity to set the ``segment_id`` of a subnet on update. .. releasenotes/notes/versions-show-12a2443624c83048.yaml @ b'9ece632f96844fd78c2f717f2f6d35e61c3b9ef2' - 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. .. _python-openstackclient_3.16.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/add-community-option-to-image-list-ac0651eb2e5d632f.yaml @ b'860639a548a2c07193662cd361432cb5061c2a7f' - Add ``--community`` option to ``image list`` command. [Bug `2001925 `_] .. releasenotes/notes/bug-1742453-ae4be6de90a3ae1d.yaml @ b'c615bcd75e85a2a2231d9944caeffd746e881e5e' - The ``server list --all`` command now resolves non-public flavor names, too, so that the ``Flavor`` column will be properly populated. [Bug `1742453 `_] .. releasenotes/notes/bug-1750985-a5345f715a14825c.yaml @ b'09a0916daeeb9c257d84175a43062d5b4a1d0b1a' - Add ``--tag`` support to ``floating ip create|list|set|unset`` commands. [:lpbug:`1750985`] .. releasenotes/notes/bug-1751104-compute-api-2.47-4bfa21cfaa13f408.yaml @ b'4236d777ffb6f03bb2682142aaa18b48e9a00d96' - 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 `_] .. _python-openstackclient_3.16.0_Other Notes: Other Notes ----------- .. releasenotes/notes/remove-ip-floating-commands-d5363f313e09249a.yaml @ b'ea89065dabf92c2684e55c4b37c7be9b667cfa1e' - Remove deprecated ``ip floating`` and ``ip floating pool`` commands. .. _python-openstackclient_3.15.0: 3.15.0 ====== .. _python-openstackclient_3.15.0_New Features: New Features ------------ .. releasenotes/notes/bp-application-credential-a7031a043efc4a25.yaml @ b'375964f270e125b8887e0ca4ee1cbe15d5eddf04' - 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 `_] .. releasenotes/notes/bp-project-tags-b544aef9672d415b.yaml @ b'd32664150fbc00340f3ff4304c13abf9a191299a' - 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 `_] .. releasenotes/notes/bug-1714878-46806jv2yv13q054.yaml @ b'4a9e84be994575146b30bd40a341d5686174eaad' - 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 `_] .. releasenotes/notes/keystone-endpoint-group-0c55debbb66844f2.yaml @ b'1eae301c4fab30c551ed7542cdaf8735cbbc3822' - 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 `_] .. releasenotes/notes/neutron_mtu-d87e53e2d76f8612.yaml @ b'18563b4132f794cc6612c2897795f96a31b565ae' - Add ``--mtu`` option to ``network create`` and ``network set`` commands, allowing CLI users to set the MTU for Neutron networks. .. _python-openstackclient_3.18.1-3: 3.18.1-3 ======== .. _python-openstackclient_3.18.1-3_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1775482-7ed2a9a8765b313e.yaml @ b'29ec8c8134072b9b3eb6ff89320506bef9ec358a' - Re-open stdout in binary mode before writing object data in ``object save --file -`` command. [Bug `1775482 `_] .. releasenotes/notes/bug-2006761-9041d1b25e845cfb.yaml @ b'3b48ef54c8ad205dd086520cc17e4f96583e88ec' - 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 `_] .. _python-openstackclient_3.18.1: 3.18.1 ====== .. _python-openstackclient_3.18.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2005521-0274fc26bd9b3842.yaml @ b'fd3a94d16be8e7806ff4f3aa7417d8a0d36375fb' - Fix ``endpoint group delete`` command to properly delete endpoint groups. [Story `2005521 `_] .. releasenotes/notes/story-2005349-compute-service-set-2.53-3d2db875154e633a.yaml @ b'100d34c54ecdfedf6fb40a2686e1aae1f54df97e' - The ``compute service set`` command now properly handles ``--os-compute-api-version`` 2.53 and greater. [Story `2005349 `_] .. _python-openstackclient_3.18.0: 3.18.0 ====== .. _python-openstackclient_3.18.0_New Features: New Features ------------ .. releasenotes/notes/add-member-status-filter-2e118b2c93151223.yaml @ b'444a40c656b9f6007364ecd3bcf38964bbcd4556' - Add ``--member-status`` option to ``image list`` command. .. releasenotes/notes/bp-handling-down-cell-ab8af2897f1a8c85.yaml @ b'239b103849b96213dc9cb317006346ce311228e4' - 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. .. _Handling Down Cells: https://developer.openstack.org/api-guide/compute/down_cells.html .. releasenotes/notes/bp-network-segment-range-management-0abf03fe03eea149.yaml @ b'd52920b3878479f7dd549cba1679870b4f00ee33' - 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 `_] .. releasenotes/notes/bug-1745699-afa7318b9dc96696.yaml @ b'e776a4f0260af1d2ae66439e647794395d470578' - 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 `_ .. releasenotes/notes/floatingip_dns_integration-f26c7575694d098d.yaml @ b'ed09f28a9dd1cbc0f8c141a8e38587b7022d4166' - 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 `_] .. releasenotes/notes/floatingip_dns_integration-f26c7575694d098d.yaml @ b'ed09f28a9dd1cbc0f8c141a8e38587b7022d4166' - Add ``--long`` option to the ``floating ip list`` command. This adds ``DNS Name`` and ``DNS Domain`` columns to the floating IP list. [Bug `1547736 `_] .. releasenotes/notes/image-list-filter-multiple-properties-03c51d43131ee3b6.yaml @ b'21e4c87bdeb78ef5c5a251ae9e671efd1b5e3102' - The ``image list`` command now properly filters images on multiple ``--property`` options. [Bug `2004290 `_] .. releasenotes/notes/list-detailed-quota-informations-1755129e1c68a252.yaml @ b'75cba9d1cbdd7b14b0d507af27f896c6c45e713e' - Add support for list detailed ``quota`` usage for project. This can be done by passing ``--detail`` parameter to `quota list` command. [Bug `1716043 `_] .. releasenotes/notes/name-lookup-one-by-one-e0f15f4eab329b19.yaml @ b'e782f49927a6b142a35f85a1a4a759fd2b1ceedf' - 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. .. releasenotes/notes/name-lookup-one-by-one-e0f15f4eab329b19.yaml @ b'e782f49927a6b142a35f85a1a4a759fd2b1ceedf' - 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. .. releasenotes/notes/network_dns_integration-5914b2c2be474a41.yaml @ b'b8754e15e7adc9a04587f67c83febaf49b64f18c' - 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). .. releasenotes/notes/osc-included-image-signing-a7021a4dbdcf6336.yaml @ b'1981eb22500b7c389befc8e91d7ba5cebbe19a88' - 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 --sign-key-path --sign-cert-id ``. A prompt for a password ensures, that the private key can be protected too. [Bug `2002128 `_] .. releasenotes/notes/router-gateway-IP-QoS-c8ba95e180bca05f.yaml @ b'fd23025227a07e879e0b29c67063401b1d392518' - 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. .. releasenotes/notes/server-rebuild-property-e8c6439b04e27c80.yaml @ b'e3dc30fe8c1ae6a13926bf1eae52097e8bb37aab' - Add ``--property`` option to the ``server rebuild`` command, to provide the ability to specify properties of the rebuilt instance. [Story `2003979 `_] .. releasenotes/notes/server-rebuild-with-keypair-name-83c1aa20db136d91.yaml @ b'f82c5b85ce9d6fee62550044fbabe54155e4b367' - 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. .. releasenotes/notes/server-rebuild-with-keypair-name-83c1aa20db136d91.yaml @ b'f82c5b85ce9d6fee62550044fbabe54155e4b367' - Add ``--key-unset`` option to ``server rebuild`` command to unset keypair. Note that it requires --os-compute-api-version 2.54 or later. .. releasenotes/notes/support-uplink_status_propagation-4d37452bcf03e0f8.yaml @ b'c82f4237e59dd61f180b2bfbd3383c6540cd6cef' - Add ``--enable-uplink-status-propagation`` option and ``--disable-uplink-status-propagation`` option to ``port create`` command. .. releasenotes/notes/volume-backend-c5faae0b31556a24.yaml @ b'e0615e8d69152ce0417f873b30050802a2da0da8' - Add ``openstack volume backend capability show `` command that provides a list of all capabilities that can be configured for the requested backend. The required `` parameter takes the form `host@backend-name`. .. releasenotes/notes/volume-backend-c5faae0b31556a24.yaml @ b'e0615e8d69152ce0417f873b30050802a2da0da8' - 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. .. _python-openstackclient_3.18.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/unlock-volume-a6990fc3bf1f5f67.yaml @ b'f00ffebea61f94f2334d1c1578bc23986bbcf58c' - The ``volume migrate --unlock`` argument did not actually do anything and has now been removed. .. _python-openstackclient_3.18.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/bug-1777153-750e6044aa28d5d8.yaml @ b'030fd71390e8e4b8413e916e64076337035f9aa7' - 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. .. _python-openstackclient_3.18.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1777153-750e6044aa28d5d8.yaml @ b'030fd71390e8e4b8413e916e64076337035f9aa7' - 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). .. releasenotes/notes/floating-ip-multi-port-9779e88f590cae23.yaml @ b'013c9a4f3a44cb0b81fc7affe9b933e701cb5dba' - 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. .. _python-openstackclient_4.0.2-9: 4.0.2-9 ======= .. _python-openstackclient_4.0.2-9_New Features: New Features ------------ .. releasenotes/notes/add-missing-server-group-list-opts-d3c3d98b7f7a56a6.yaml @ b'a36ac0596cddabadc2154b9c7600abe2a2064b91' - Add ``--limit`` and ``--offset`` options to ``server group list`` command, to configure pagination of results. .. releasenotes/notes/add-parent-list-option-to-projects-10382a7176993366.yaml @ b'03c28595d172abecf0ae89b38447c67bcedc92b4' - Add ``--parent`` option to ``project list`` command to filter projects by the specified parent project. .. releasenotes/notes/fix-flavor-in-server-list-microversion-2.47-af200e9bb4747e2d.yaml @ b'63e15ff405c46821d64676900edf020973c280de' - 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. .. _python-openstackclient_4.0.2-9_Other Notes: Other Notes ----------- .. releasenotes/notes/remove-nlbaas-quota-8b38e0c91ab113cb.yaml @ b'b948e74b88befca67eab57573444e81f44eb75c9' - Remove deprecated neutron-lbaas results from ``quota show`` command. .. _python-openstackclient_4.0.2: 4.0.2 ===== .. _python-openstackclient_4.0.2_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2006635-3110f7a87a186e62.yaml @ b'2e0a0f15cf50e200925aebd9659d903c79b5b68e' - You can now remove role assignments from keystone that reference non-existent users or groups. [Bug `2006635 `_] .. _python-openstackclient_4.0.1: 4.0.1 ===== .. _python-openstackclient_4.0.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2005246-3fb70206bafc5444.yaml @ b'bff556c7c2e19d6162fb47929b91c155eba2a6ee' - [Story `2005246 `_] The `is_domain` property safely handles type checking. .. releasenotes/notes/bug-2006761-9041d1b25e845cfb.yaml @ b'c42c27aa926e93a2507e686eeaf0c5510a29d245' - 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 `_] .. _python-openstackclient_4.0.0: 4.0.0 ===== .. _python-openstackclient_4.0.0_New Features: New Features ------------ .. releasenotes/notes/add-fip-portforwarding-commands-6e4d8ace698ee308.yaml @ b'f044016e296fd261f61eda69fb2f5ef87de6e0a9' - 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``. .. releasenotes/notes/add-host-and-hypervisor-hostname-flag-to-create-server-cb8b39a9f9311d42.yaml @ b'340f25fa14d42205a4134ce4cba47792764b8542' - Add ``--host`` and ``--hypervisor-hostname`` options to ``server create`` command. [Blueprint `add-host-and-hypervisor-hostname-flag-to-create-server `_] .. releasenotes/notes/add-server-migrate-with-host-4884a71903c5c8a9.yaml @ b'cb0c20b23c564dc6b260492923aef58ee66620d9' - 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 `_] .. releasenotes/notes/add-server-resize-confirm-revert-commands-98854ca98965432a.yaml @ b'7561e062ebd80a28655523320cbe1a49e94ee509' - Add ``server resize confirm`` and ``server resize revert`` commands. These replace the now deprecated ``--confirm`` and ``--revert`` options to the ``server resize`` commands, respectively. .. releasenotes/notes/allow-port-create-with-extra-dhcp-options-c2c40e4002b52e2a.yaml @ b'68809fce5a1073659001a87aee4f9407affd5d0e' - 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. .. releasenotes/notes/better-ipv6-address-suppport-security-group-rules-95272847349982e5.yaml @ b'cb0c20b23c564dc6b260492923aef58ee66620d9' - Add ``--ethertype`` option to ``security group rule list`` command. Valid values are ``ipv4`` and ``ipv6``. .. releasenotes/notes/bp-add-locked-reason-425efd2def1144f1.yaml @ b'187be0ac22be5d2d1c42d45e9299e62cfc3796ae' - 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. .. releasenotes/notes/bp-add-locked-reason-425efd2def1144f1.yaml @ b'187be0ac22be5d2d1c42d45e9299e62cfc3796ae' - Add ``--locked`` option to the ``server list`` command to list only locked servers. Requires ``–os-compute-api-version`` 2.73 or greater. .. releasenotes/notes/bp-add-locked-reason-425efd2def1144f1.yaml @ b'187be0ac22be5d2d1c42d45e9299e62cfc3796ae' - 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 `_] .. releasenotes/notes/bp-support-specifying-az-when-restore-shelved-server-16e864223d51b50a.yaml @ b'dd1ce370424264166be686578bcab0fa41ac973e' - 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 `_] .. releasenotes/notes/story-2006302-add-boot-from-volume-cd411b1ca776bb3c.yaml @ b'b9d63105566c84db11a976846844ad7b3a0b331e' - 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 `_] .. releasenotes/notes/story-2006302-support-bdm-type-image-0becfb63bd4fb969.yaml @ b'6a199bd14152889f18ad95919a4bee9c0c083d5d' - 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 `_] .. _python-openstackclient_4.0.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/better-ipv6-address-suppport-security-group-rules-95272847349982e5.yaml @ b'cb0c20b23c564dc6b260492923aef58ee66620d9' - 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 `_] .. releasenotes/notes/bug-1716789-abfae897b7e61246.yaml @ b'cb0c20b23c564dc6b260492923aef58ee66620d9' - Commands that assumed the default value of ``--protocol`` to be ``tcp`` now must include ``--protocol tcp`` explicitly in Network commands. .. releasenotes/notes/osc4-compute-09246008eff260cb.yaml @ b'b7742b59371b9e0b2e417547eb2cdaa80954b50d' - Remove deprecated ``ip fixed add|remove`` commands. Use ``server add|remove fixed ip`` commands instead. .. releasenotes/notes/osc4-compute-09246008eff260cb.yaml @ b'b7742b59371b9e0b2e417547eb2cdaa80954b50d' - Remove deprecated ``ip floating add|remove`` commands. Use ``server add|remove floating ip`` commands instead. .. releasenotes/notes/osc4-identity-6564257c67d43106.yaml @ b'f9fdc296bc6f2c1f7d6196352b754a7617c4f2d2' - Remove deprecated ``role list`` options ``--project`` and ``--user``. Use ``role assignment list`` options ``--project`` and ``--user`` instead. .. releasenotes/notes/osc4-identity-6564257c67d43106.yaml @ b'f9fdc296bc6f2c1f7d6196352b754a7617c4f2d2' - Remove deprecated ``user role list`` command. Use ``role assignment list`` options ``--project`` and ``--user`` instead. .. releasenotes/notes/osc4-identity-6564257c67d43106.yaml @ b'f9fdc296bc6f2c1f7d6196352b754a7617c4f2d2' - Remove deprecated ``service create`` option ``--type``. The type is supplied as a positional argument in The ``service create --name type`` command. .. releasenotes/notes/osc4-image-e922ee6f8e028648.yaml @ b'67dadda746759d8cf47822e6f426c473e46acc27' - Remove ``image create|set`` option ``--owner``. Use ``--project`` option instead. .. releasenotes/notes/osc4-network-db2aed696d964ca6.yaml @ b'5a0fc68a87d1c9733c1dd5bb6f68b2e518fe2105' - Remove deprecated ``port create|set`` options ``--device-id`` and ``--host-id``. Use ``--device`` and ``--host`` options instead. .. releasenotes/notes/osc4-network-db2aed696d964ca6.yaml @ b'5a0fc68a87d1c9733c1dd5bb6f68b2e518fe2105' - Remove deprecated ``router set`` option ``--clear-routes``. Use ``--no-route`` option instead. .. releasenotes/notes/osc4-network-db2aed696d964ca6.yaml @ b'5a0fc68a87d1c9733c1dd5bb6f68b2e518fe2105' - Remove deprecated ``security group rule create`` options ``--src-ip`` and ``--src-group``. Use ``--remote-ip`` and ``--remote-group`` options instead. .. releasenotes/notes/osc4-volume-470422e5a453310e.yaml @ b'e76e10c0bac9cf87c564a7f0201df189f7cd8b52' - Remove deprecated ``backup`` commands. Use ``volume backup`` commands instead. .. releasenotes/notes/osc4-volume-470422e5a453310e.yaml @ b'e76e10c0bac9cf87c564a7f0201df189f7cd8b52' - Remove deprecated ``snapshot`` commands. Use ``volume snapshot`` commands instead. .. releasenotes/notes/osc4-volume-470422e5a453310e.yaml @ b'e76e10c0bac9cf87c564a7f0201df189f7cd8b52' - Remove deprecated ``volume create`` options ``--project``, ``--user`` and ``--multi-attach``. .. releasenotes/notes/osc4-volume-470422e5a453310e.yaml @ b'e76e10c0bac9cf87c564a7f0201df189f7cd8b52' - Change ``volume transfer request accept`` to use new required option ``--auth-key`` rather than a second positional argument. .. releasenotes/notes/volume-v3-default-0ffa9bebb43b5057.yaml @ b'cb0c20b23c564dc6b260492923aef58ee66620d9' - 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. .. _python-openstackclient_4.0.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/add-server-resize-confirm-revert-commands-98854ca98965432a.yaml @ b'7561e062ebd80a28655523320cbe1a49e94ee509' - 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. .. _python-openstackclient_4.0.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1716789-abfae897b7e61246.yaml @ b'cb0c20b23c564dc6b260492923aef58ee66620d9' - Change the default value of ``--protocol`` option to ``any`` in ``security group rule create`` command when using the Neutron v2 API. [Bug `1716789 `_] .. releasenotes/notes/story-2005349-compute-service-set-2.53-3d2db875154e633a.yaml @ b'4bd53dc1090fda86f6ce25b76a079e250c9206d8' - The ``compute service set`` command now properly handles ``--os-compute-api-version`` 2.53 and greater. [Story `2005349 `_] .. releasenotes/notes/usage-list-all-49ca7a62c50e71d3.yaml @ b'037a800538feb690af0541d4f276dcdf48af3f72' - Compute API v2.40+ returns all matching entities rather than being limited to the API server configured maximum (``CONF.api.max_limit``). [Story `2005099 `_] .. _python-openstackclient_4.0.0_Other Notes: Other Notes ----------- .. releasenotes/notes/config-show-00512dc60882e5c0.yaml @ b'865e182970c9ce42d5be07cd3b81fb5dd1a3e656' - The ``configuration show`` command no longer requires authentication. This is useful in debugging cloud configurations, particularly auth configurations. .. _python-openstackclient_3.19.0: 3.19.0 ====== .. _python-openstackclient_3.19.0_New Features: New Features ------------ .. releasenotes/notes/bug-1827844-8f1de120087c6a22.yaml @ b'ef1fd388154eee11b9e83f80e5004670fdffb6cc' - Add ``--changes-before`` option to the ``server list`` command. This requires Compute API version '2.66' or later. [:lpbug: `1827844`] .. releasenotes/notes/rbac-add-security-group-35370701a06ac906.yaml @ b'be7a75814ca4a503dd384f36166f93f12f6cb8da' - Add ``security_group`` as a valid ``--type`` value for the ``network rbac create`` and ``network rbac list`` commands. .. releasenotes/notes/server-description-ae9618fc09544cac.yaml @ b'c77a9621beaf7748e5ccfecb3ac37fa9602c5bfe' - Add ``--description`` option to ``server create``, ``server rebuild``, ``server set`` and ``server unset`` commands. [Bug `2002005 `_] .. _python-openstackclient_3.19.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/bug-1411190-live-migration-host-655ae6befa6a3de2.yaml @ b'3057989714e5e510e275c454258e0f167ed551d2' - 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. .. _python-openstackclient_3.19.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1411190-live-migration-host-655ae6befa6a3de2.yaml @ b'3057989714e5e510e275c454258e0f167ed551d2' - `Bug 1411190`_ has been fixed by providing a ``--live-migration`` and ``--host`` option to the ``openstack server migrate`` command. .. _Bug 1411190: https://bugs.launchpad.net/python-openstackclient/+bug/1411190 .. releasenotes/notes/bug-1740232-91ad72c2ac165f35.yaml @ b'71f138b172e95515b9d54eee9b3e318df3381791' - Fix RuntimeError in ``project show`` command running under Python 3. [Bug `1740232 `_] .. releasenotes/notes/bug-1775482-7ed2a9a8765b313e.yaml @ b'415b48056d9d021e04ec972029040a89a6b13928' - Re-open stdout in binary mode before writing object data in ``object save --file -`` command. [Bug `1775482 `_] .. releasenotes/notes/bug-2005521-0274fc26bd9b3842.yaml @ b'04e03b2a1fe34046e2148d3c1d17b9053010c8af' - Fix ``endpoint group delete`` command to properly delete endpoint groups. [Story `2005521 `_] .. releasenotes/notes/bug-27882-402ced7ffe930058.yaml @ b'6f1f44d422ed3f384ea6d4d729227277f0988b99' - The ``--limit`` option of the ``image list`` command was previously ignored. [Bug `2004314 `_] .. _python-openstackclient_5.2.2-8: 5.2.2-8 ======= .. _python-openstackclient_5.2.2-8_New Features: New Features ------------ .. releasenotes/notes/add-missing-server-group-list-opts-d3c3d98b7f7a56a6.yaml @ b'f0d21237a2de3d11ca68fee321dd0f8a724e1871' - Add ``--limit`` and ``--offset`` options to ``server group list`` command, to configure pagination of results. .. releasenotes/notes/fix-flavor-in-server-list-microversion-2.47-af200e9bb4747e2d.yaml @ b'0a6babc04ce53a9234521e0549ba11b725d20bf7' - 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. .. releasenotes/notes/stateful-security-group-a21fa8498e866b90.yaml @ b'89b4a689fc9c4b97b647636ef6db96268335954f' - Add ``--stateful`` and ``--stateless`` option to the ``security group create`` and ``security group set`` commands to support stateful and stateless security groups. .. _python-openstackclient_5.2.2-8_Other Notes: Other Notes ----------- .. releasenotes/notes/remove-nlbaas-quota-8b38e0c91ab113cb.yaml @ b'643b69d91480e461ff3546318943517b3226d11a' - Remove deprecated neutron-lbaas results from ``quota show`` command. .. _python-openstackclient_5.2.2: 5.2.2 ===== .. _python-openstackclient_5.2.2_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2006635-3110f7a87a186e62.yaml @ b'b30843cee35e50e516a41a48bcbe00dd2c1639f4' - You can now remove role assignments from keystone that reference non-existent users or groups. [Bug `2006635 `_] .. releasenotes/notes/task-40279-eb0d718ac1959c50.yaml @ b'5b25ea899e023bcd3d7384cca943f9844bcb0b79' - Makes ``volume backup record`` commands available in Volume API v3. `Task 40279 `__ .. _python-openstackclient_5.2.1: 5.2.1 ===== .. _python-openstackclient_5.2.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2005246-3fb70206bafc5444.yaml @ b'19723aee18e2901e9250dd840a61359704baa170' - [Story `2005246 `_] The `is_domain` property safely handles type checking. .. _python-openstackclient_5.2.0: 5.2.0 ===== .. _python-openstackclient_5.2.0_New Features: New Features ------------ .. releasenotes/notes/complete_image_switch-203e0b3105a54674.yaml @ b'768a64aac5bd14f56c142faeec1793aac91947cb' - Complete switch from glanceclient to the SDK for image service. .. releasenotes/notes/use_sdk_for_image-f49d2df38e7d9f81.yaml @ b'60e7c51df4cf061ebbb435a959ad63c7d3a296bf' - Image service for v2 is switched from using glanceclient to OpenStackSDK. .. _python-openstackclient_5.1.0: 5.1.0 ===== .. _python-openstackclient_5.1.0_New Features: New Features ------------ .. releasenotes/notes/add-description-to-role-afe7b6ff668df261.yaml @ b'eb001733fd3c1a98027f7439b84e952f1eb2a406' - 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 ` to OSC ``openstack role create`` command. .. releasenotes/notes/bug-1784879-9b632174d4af853f.yaml @ b'68aa35f35f21476085e25ad2e3da51a1961948e4' - 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 `_] .. _python-openstackclient_5.1.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/disallow-setting-default-on-internal-network-824fdea1a900891c.yaml @ b'962efd949feb461283a9bb4a668fbd310f80ba40' - For ``network create`` the `--default`` option should be only used for external networks. After this release, we enforce this scenario. If a users attempts to create an internal default network or update a network to be internal default, the command will be denied. [Bug `1745658 `_] .. _python-openstackclient_5.0.0: 5.0.0 ===== .. _python-openstackclient_5.0.0_New Features: New Features ------------ .. releasenotes/notes/add-parent-list-option-to-projects-10382a7176993366.yaml @ b'7c1b6a799e0ac6fea511a2cf1e97aebb2f94e0d6' - Add ``--parent`` option to ``project list`` command to filter projects by the specified parent project. .. releasenotes/notes/add-server-migrate-confirm-revert-commands-9d8079c9fddea36d.yaml @ b'609988ebac2c6bbb596aa77b46589274ffbc1e07' - Add ``server migrate confirm`` and ``server migrate revert`` commands. These are aliases of the ``server resize confirm`` and ``server resize revert`` commands, respectively. .. releasenotes/notes/bp-support-specifying-az-when-restore-shelved-server-9179045f04815bbb.yaml @ b'874a726f522dae3a08832f32230e2590a787d45c' - 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 ``_] .. releasenotes/notes/bp-whitelist-extension-for-app-creds-9afd5009b374190b.yaml @ b'70ab3f9dd56a638cdff516ca85baa5ebd64c888b' - [`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. .. _python-openstackclient_5.0.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/drop-py2-421c90fbdf18dbc2.yaml @ b'e6e4b73efa01281002930e0806b765200f38e7c8' - 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. .. _python-openstackclient_5.0.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2006761-9041d1b25e845cfb.yaml @ b'f5384ae16a24cdd54149fa21827d14b8b8983d4f' - 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 `_] .. _python-openstackclient_5.4.0-14: 5.4.0-14 ======== .. _python-openstackclient_5.4.0-14_New Features: New Features ------------ .. releasenotes/notes/add-missing-server-group-list-opts-d3c3d98b7f7a56a6.yaml @ b'768dca5a695d78d8c5c22fca185137d3c5b8c07c' - Add ``--limit`` and ``--offset`` options to ``server group list`` command, to configure pagination of results. .. releasenotes/notes/fix-flavor-in-server-list-microversion-2.47-af200e9bb4747e2d.yaml @ b'fef473390c7bb6874a38b98053e54cf18547b23c' - 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. .. _python-openstackclient_5.4.0-14_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/fix-openstak-image-save-sdk-port-eb160e8ffc92e514.yaml @ b'8dbf141d52c84d0a7311e62d39d229fdc80876fd' - 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 .. releasenotes/notes/fix-openstak-image-save-sdk-port-eb160e8ffc92e514.yaml @ b'8dbf141d52c84d0a7311e62d39d229fdc80876fd' - Restore default behavior of 'openstack image save' to send data to stdout Relates to https://storyboard.openstack.org/#!/story/2007672. .. releasenotes/notes/story-2007727-69b705c561309742.yaml @ b'5a7841d5f04a76f6ab2ad01d6b41e01038ebd2a9' - 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. .. _python-openstackclient_5.4.0-14_Other Notes: Other Notes ----------- .. releasenotes/notes/remove-nlbaas-quota-8b38e0c91ab113cb.yaml @ b'dd06a4c475a1813dc72bf439bfdcb47deec89049' - Remove deprecated neutron-lbaas results from ``quota show`` command. .. _python-openstackclient_5.4.0: 5.4.0 ===== .. _python-openstackclient_5.4.0_New Features: New Features ------------ .. releasenotes/notes/add-port-numa-affinity-policy-4706b0f9485a5d4d.yaml @ b'454b2195649aec1a9eb1fdaa60b64663cb1f7298' - Add NUMA affinity policy to ``port create``, ``port set`` and ``port unset`` commands. .. releasenotes/notes/properties-with-image-property-field.yaml-c51bf37c3106d6ff.yaml @ b'fbd2c00b8999202917671bcdb39298eb39c3ad47' - 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. .. _python-openstackclient_5.4.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2006635-3110f7a87a186e62.yaml @ b'e24673267093de85beee753860cda1fb224ce4bc' - You can now remove role assignments from keystone that reference non-existent users or groups. [Bug `2006635 `_] .. releasenotes/notes/security-grp-json-fix.yaml-2af1f48a48034d64.yaml @ b'bae89b30144fdf40d0fea31e1a595b507e32c4f3' - The ``openstack server show -f json`` command was not outputting json for security groups, volumes and properties properly. .. _python-openstackclient_5.3.1: 5.3.1 ===== .. _python-openstackclient_5.3.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/entrypoint-3.8-0597d159889042f7.yaml @ b'82ebddca006d1dc61855fdd34b0616222039ea58' - Fixes an issue with python 3.8 and entrypoint loading where the new builtin importlib entrypoint support had a different attribute api than expected. .. _python-openstackclient_5.3.0: 5.3.0 ===== .. _python-openstackclient_5.3.0_New Features: New Features ------------ .. releasenotes/notes/add-description-field-in-port-forwarding-c536e077b243d517.yaml @ b'74a7c1d9d6efc545676cec1d9efeb2a86c5bc548' - Add a new option `--description` to ``floating ip port forwarding create`` and ``floating ip port forwarding set`` commands. .. releasenotes/notes/add-image-import-flag-899869dc5a92aea7.yaml @ b'c04ec16cf7ad2dbe7bf8edf5f6e7840c54b0efa3' - Added ``--import`` flag to ``openstack image create`` to allow the user to force use of the image import codepath. .. releasenotes/notes/add_options_to_user_create_and_set-302401520f36d153.yaml @ b'05da145eaee329e299b449ba2d7ea88d1325e432' - 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. .. releasenotes/notes/add_resource_option_immutable-efed6e1ebdc69591.yaml @ b'7f66273d3f2fb6449d7b50d88460ace0cb81bf30' - Added the below mentioned parameters to the role, project and domain commands. * --immutable * --no-immutable This will allow user to set "immutable" resource option. .. releasenotes/notes/force-flag-openstackclient-c172de2717e5cfac.yaml @ b'b328cf74df7f94a20de85b3c0992dcb65e818458' - 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. .. releasenotes/notes/rbac-add-address-scope-7f6409ab70d36306.yaml @ b'f03cb68ad89dcc856fdad1a46fee36b7d68c5ba2' - Add ``address_scope`` as a valid ``--type`` value for the ``network rbac create`` and ``network rbac list`` commands. .. releasenotes/notes/rbac-add-subnetpool-f1fc0e728ff61654.yaml @ b'557e65d8ebaf7eaecb2f938d65feffa0e97a86d4' - Add ``subnetpool`` as a valid ``--type`` value for the ``network rbac create`` and ``network rbac list`` commands. .. releasenotes/notes/router-extraroute-atomic-d6d406ffb15695f2.yaml @ b'dba57c85d5536369d600ae98599c08b921713bd5' - Add new commands ``router add route`` and ``router remove route`` to support new Neutron extension: ``extraroute-atomic`` (see `Neutron RFE `_). .. releasenotes/notes/stateful-security-group-a21fa8498e866b90.yaml @ b'5e62411e5f6c5b68512d1f72470b4222199eb456' - Add ``--stateful`` and ``--stateless`` option to the ``security group create`` and ``security group set`` commands to support stateful and stateless security groups. .. _python-openstackclient_5.3.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/router-extraroute-atomic-d6d406ffb15695f2.yaml @ b'dba57c85d5536369d600ae98599c08b921713bd5' - 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. .. _python-openstackclient_5.3.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2005246-3fb70206bafc5444.yaml @ b'533af9f1b2de40d98f69e83cdf89ecf254cf3879' - [Story `2005246 `_] The `is_domain` property safely handles type checking. .. releasenotes/notes/fix-story-2007890-0974f3e69f26801e.yaml @ b'c06d82563526c715d3ed508fa3cc5f9dc0963294' - 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. .. releasenotes/notes/task-40279-eb0d718ac1959c50.yaml @ b'b1fc587a6d4eac795a5bc27c2dffd2d876161caa' - Makes ``volume backup record`` commands available in Volume API v3. `Task 40279 `__ .. _python-openstackclient_5.5.1-16: 5.5.1-16 ======== .. _python-openstackclient_5.5.1-16_New Features: New Features ------------ .. releasenotes/notes/fix-flavor-in-server-list-microversion-2.47-af200e9bb4747e2d.yaml @ b'4b7e777c0ce19aa67a9a33cbeb3b4ee2b052383f' - 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. .. _python-openstackclient_5.5.1-16_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1946816-7665858605453578.yaml @ b'3f4142d5ddfca8c594d35bb0e5fd65009286d11b' - Filtering servers by tags (``server list --tag``, ``server list --not-tag``) now works correctly. [Bug `1946816 `_] .. releasenotes/notes/fix-image-create-from-volume-c573e553161605c4.yaml @ b'9425e6fcb6b907fbae7e1eb6b01ad293199cee75' - 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. .. releasenotes/notes/fix-story-2010775-953dbdf03b2b6746.yaml @ b'ecaa2805dcf8ea72729a1cfedb30eb60a66224b4' - Fixed a bug in "access rule" subcommands where the client logic incorrectly assumed that access rules have a "name" property which resulted in unpredictable behaviors. e.g. "access rule delete {non-existent-id}" now results in a not-found error instead of sometimes deleting an unrelated rule. .. _python-openstackclient_5.5.0: 5.5.0 ===== .. _python-openstackclient_5.5.0_New Features: New Features ------------ .. releasenotes/notes/add-image-progress-option-to-create-1ed1881d58ebad4b.yaml @ b'6f616a29b300238c004b676edd98a5337be38193' - Add ``--progress`` option to ``image create`` command to enable a progress bar when creating and uploading an image. .. releasenotes/notes/add-image-project-filter-support-ed6204391e503adf.yaml @ b'3c80b1b3b29307381b869f6a767e14e9d47e212f' - Add ``--project`` and ``--project-domain``options to ``image list`` command to filter by owner. .. releasenotes/notes/add-keypairs-project-filter-99cb6938f247927f.yaml @ b'5645fad7622a18e4f3c550ee7d409bf1b685a1a5' - 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. .. releasenotes/notes/add-keypairs-user-filter-e1ce57a4c09c278b.yaml @ b'98a0016cfa1d39bcc37144f0c7700e9a9d6b2c0b' - 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. .. releasenotes/notes/add-missing-hypervisor-list-opts-71da2cc36eac4edd.yaml @ b'262e525aada8bfaedb4545be5d2bbd27edcc55fd' - Add ``--limit`` and ``--marker`` options to ``hypervisor list`` command, to configure pagination of results. .. releasenotes/notes/add-missing-keypair-list-opts-243a33d8276f91b8.yaml @ b'fc24142ed41e15622687558c68d670bdc37223f0' - Add ``--limit`` and ``--marker`` options to ``keypair list`` command, to configure pagination of results. .. releasenotes/notes/add-missing-server-create-opts-d5e32bd743e9e132.yaml @ b'ace4bfb6404b7b39c597c4884c56e26a47a94fc4' - Add a number of additional options to the ``server create`` command: - ``--snapshot`` - ``--ephemeral`` - ``--swap`` - ``--block-device`` .. releasenotes/notes/add-missing-server-delete-opts-071c3e054e3ce674.yaml @ b'8a164bb09c0801c3ffd2431d41c3e232388ab407' - Add ``--force`` option to ``server delete`` command, allowing users to force delete a server. This is admin-only by default. .. releasenotes/notes/add-missing-server-group-list-opts-d3c3d98b7f7a56a6.yaml @ b'5ec4d4c7188f4766d270be32e12b64b709d2b835' - Add ``--limit`` and ``--offset`` options to ``server group list`` command, to configure pagination of results. .. releasenotes/notes/add-missing-server-group-list-opts-ebcf84bfcea07a4b.yaml @ b'7ed4f68c68cb17b02deced203f9a461605a68dfe' - 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. .. releasenotes/notes/add-missing-server-image-create-opts-3c19a7492dc50fd7.yaml @ b'958344733aa6d8aea6cb8d06cc4d879fe1ee44a6' - Add ``--property`` option to ``server image create`` command, allowing users to record arbitrary key/value metadata to ``meta_data.json`` on the metadata server. .. releasenotes/notes/add-missing-server-list-opts-c41e97e86ff1e1ca.yaml @ b'd0112a801a20c810d92dfcdf1f8fb71df3bd1d26' - 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`` .. releasenotes/notes/add-missing-server-rebuild-opts-5c75e838d8f0487d.yaml @ b'f9fd3642f8e8c59cd5a819e260d0575f884ae174' - 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`` .. releasenotes/notes/add-missing-server-set-opts-e1b4300f5f42e863.yaml @ b'8a0f3fc6a8b30328c575bb5c3fc21ddc4f500d9d' - 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. .. releasenotes/notes/add-project-cleanup-beb08c9df3c95b24.yaml @ b'119d2fae2567285b9149b2c737d7d4452b59288c' - 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. .. releasenotes/notes/add-server-evacuate-8359246692cb642f.yaml @ b'01eb4e839394fe433a92a06daf1499fb00f2fe69' - 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. .. releasenotes/notes/add-server-migration-show-command-2e3a25e383dc5d70.yaml @ b'f80fe2d8cf50f85601e2895a5f878764fa77c154' - Add ``server migration show`` commands. This can be used to show detailed information about an ongoing server migration. .. releasenotes/notes/add-server-nic-tagging-support-f77b4247e87771d5.yaml @ b'9ed34aac0a172ece4cd856319486208fcdba095d' - The ``--nic`` option of the ``server create`` command now supports an optional ``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. .. releasenotes/notes/add-server-volume-update-89740dca61596dd1.yaml @ b'ca7f23d0d1876dc53ef4d5ecbf2c5f367aafe13e' - Add ``server volume list`` command, to list the volumes attached to an instance. .. releasenotes/notes/add-server-volume-update-89740dca61596dd1.yaml @ b'ca7f23d0d1876dc53ef4d5ecbf2c5f367aafe13e' - Add ``server volume update`` command, to update the volumes attached to an instance. .. releasenotes/notes/add-shelve-offload-wait-d0a5c8ba92586f72.yaml @ b'2b073c2034acdabb8d4097b7f2c0408e53fe2d63' - 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. .. releasenotes/notes/add-shelve-offload-wait-d0a5c8ba92586f72.yaml @ b'2b073c2034acdabb8d4097b7f2c0408e53fe2d63' - Add support ``--wait`` option for ``server shelve``. .. releasenotes/notes/add-tag-support-server-add-fixed-ip-8de2db58f2a80e85.yaml @ b'742c80a82574e5a6928c305842047b8b6b2b3807' - 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``. .. releasenotes/notes/add-tag-support-server-add-network-a8590cab5d7babf0.yaml @ b'6f1602312b00bcba6e04a34f7f04af9d69cf2d9c' - Add ``--tag`` option to ``server add network`` command when add network to server. Only available starting with ``--os-compute-api-version 2.49``. .. releasenotes/notes/add-tag-support-server-add-port-7e30aa38202d0839.yaml @ b'f3fbb1b648a96e541b53f96904b85d3fdce2af10' - Add ``--tag`` option to ``server add port`` command when add a port to server. Only available starting with ``--os-compute-api-version 2.49``. .. releasenotes/notes/add-tag-support-server-add-volume-278e79a22dd482f4.yaml @ b'1c7fe3b6bd60aa22ae525d0418729590f6429e96' - Add ``--tag`` option to ``server add volume`` command when add a volume to server. Only available starting with ``--os-compute-api-version 2.49``. .. releasenotes/notes/add_id_and_enabled_to_list_identity_provider-e0981063a2dc5961.yaml @ b'1e053babf4d674ac31d51dfba048704f32b558b3' - Add ``--id`` and ``--enabled`` option to ``identity provider list`` command. .. releasenotes/notes/add_name_and_enabled_to_list_domain-6d23f02994b51c67.yaml @ b'8628e52de7412e57e13238ad1ba7113deb6a2e1b' - Add ``--name`` and ``--domain`` option to ``domain list`` command. .. releasenotes/notes/always-show-direction-for-sg-rule-130efc39bf67d79a.yaml @ b'e410e61d204d09eeb7bcf0a33e3858ef7b110dd3' - 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. .. releasenotes/notes/auto-configure-block-live-migration-437d461c914f8f2f.yaml @ b'2bdf34dcc3f8957ff78709467197b5fcb44e07c3' - 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. .. releasenotes/notes/bp-add-user-id-field-to-the-migrations-table-299b99ccb1f12a1f.yaml @ b'b77c28d2954a2c5861a3a6a1df29d8de448f7c08' - Add ``server migration list`` command. This command allows users to list the status of ongoing server migrations. .. releasenotes/notes/bp-address-groups-in-sg-rules-b3b7742e4e6f5745.yaml @ b'e01e59caeb56cb7bf4f38403b82d0a265b163098' - 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 `_] .. releasenotes/notes/bp-address-groups-in-sg-rules-e0dc7e889e107799.yaml @ b'f57e10b903fa71d02a6e104717824d004178bbf5' - 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 `_] .. releasenotes/notes/bug-1708570-bb19e1213e887723.yaml @ b'fd9a235de3b3592366818ab7799e73f6be029b15' - Add ``--password`` option to ``server create`` command, allowing users to set the admin password when creating a new instance. .. releasenotes/notes/bug-2007489-42e41b14e42128ce.yaml @ b'1c3cf11331a5734700e1c333c98928ab933c0e92' - Add ``server migration abort`` command to abort ongoing live migrations. .. releasenotes/notes/bug-2007513-ae39456aeb93bb98.yaml @ b'08b0e5855be5dc12a2fd04c5c92027c8a85a0d00' - Add ``server migration force complete`` command to force complete ongoing live migrations. .. releasenotes/notes/flavor-list-min-disk-min-ram-65ba35e7acc24134.yaml @ b'da03bd80e3b83faf465f1446c4553c5d97b5bad5' - 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. .. releasenotes/notes/keypair-support-type-6f7c32aab3b61f7b.yaml @ b'4855fef8b8f29542ebdaf86aa5da4daa1f97b060' - 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. .. releasenotes/notes/keypair-user-id-db694210695a0ee0.yaml @ b'17f641e1c3ac58acdc39d064369395198d2654d2' - Add ``--user`` option to the ``keypair create``, ``keypair delete``, and ``keypair show`` commands. Only available starting with ``--os-compute-api-version 2.10``. .. releasenotes/notes/port-device-profile-4a3bf800da21c778.yaml @ b'0cc878e5b053765a0d3c13f5588bc160b05a388b' - Add device profile to ``port create`` command. .. releasenotes/notes/rbac-add-address-group-f9bb83238b5a7c1f.yaml @ b'e8509d81ee0b541033411e744f633e769073530b' - Add ``address_group`` as a valid ``--type`` value for the ``network rbac create`` and ``network rbac list`` commands. .. releasenotes/notes/server-add-tag-63f9cd01dbd82d1b.yaml @ b'2f76bfa3a69b6867491a6c5f0bf3c7e9f62743ca' - Add ``--tag`` option to ``server create`` command to add tags when creating a server. Only available starting with ``--os-compute-api-version 2.52``. .. releasenotes/notes/server-add-tag-63f9cd01dbd82d1b.yaml @ b'2f76bfa3a69b6867491a6c5f0bf3c7e9f62743ca' - 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``. .. releasenotes/notes/server-add-tag-63f9cd01dbd82d1b.yaml @ b'2f76bfa3a69b6867491a6c5f0bf3c7e9f62743ca' - 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``. .. releasenotes/notes/server-add-tag-63f9cd01dbd82d1b.yaml @ b'2f76bfa3a69b6867491a6c5f0bf3c7e9f62743ca' - 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``. .. releasenotes/notes/server-group-create_rule_option-9f84e52f35e7c3ba.yaml @ b'a5c6470f2d76afb9ac87d05c4326bebf925a55da' - Add support for ``--rule`` option for ``server group create``. .. releasenotes/notes/server-list-selectable-fields.yaml-1d5fb4784fa6f232.yaml @ b'311f4130d2c59638074531fa59e67783c2571e91' - Add ``--c project_id | user_id | created_at`` to ``openstack server list`` command to get these columns as an output. .. releasenotes/notes/server-ops-all-projects-2ce2202cdf617184.yaml @ b'1a6df700be2507bcec760994e64042d03b09ae16' - 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. .. releasenotes/notes/show-server-topology-microversion-v2_78-3891fc67f767177e.yaml @ b'f200799848831a00f350c324bb77c00efa50da1c' - Add support for ``openstack server show --topology`` flag, which will include NUMA topology information in the output. .. releasenotes/notes/switch-aggregate-to-sdk-ced451a0f28bf6ea.yaml @ b'f36a34b675e69a811d5cd48f6bcfd6ce7bda6a5a' - Switch aggregate operations to use SDK .. releasenotes/notes/switch-aggregate-to-sdk-ced451a0f28bf6ea.yaml @ b'f36a34b675e69a811d5cd48f6bcfd6ce7bda6a5a' - Adds 'aggregate cache image' operation .. releasenotes/notes/switch-console-log-to-sdk-6ee92b7833364d3d.yaml @ b'74db8dd65d35b326d3fa1c680b04a668a3f66bdc' - Switch console logs operation to use SDK .. releasenotes/notes/switch-flavor-to-sdk-b874a3c39559815e.yaml @ b'0f4f42b65281b9b8b4f8fc3e58da8c9d8b68ee08' - Switch compute.flavor operations from direct API calls (novaclient) to OpenStackSDK. .. _python-openstackclient_5.5.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/add-missing-server-list-opts-c41e97e86ff1e1ca.yaml @ b'd0112a801a20c810d92dfcdf1f8fb71df3bd1d26' - The ``openstack server list --status`` parameter will now validate the requested status. .. releasenotes/notes/add-missing-server-rebuild-opts-5c75e838d8f0487d.yaml @ b'f9fd3642f8e8c59cd5a819e260d0575f884ae174' - The ``--key-unset`` option of the ``server rebuild`` command has been replaced by ``--no-key-name``. An alias is provided. .. releasenotes/notes/add-missing-server-set-opts-e1b4300f5f42e863.yaml @ b'8a0f3fc6a8b30328c575bb5c3fc21ddc4f500d9d' - The ``server set --root-password`` option has been deprecated in favour of a non-interactive ``--password`` option. .. releasenotes/notes/deprecated-server-create-file-option-80246b13bd3c1b43.yaml @ b'6f3969a0c8a608236a6f7258aa213c12af060a9d' - 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. .. releasenotes/notes/remove-deprecated-server-migrate-live-option-28ec43ee210124dc.yaml @ b'70480fa86236f7de583c7b098cc53f0acedfd91d' - 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. .. releasenotes/notes/rename-server-migrate-confirm-revert-commands-84fcb937721f5c4a.yaml @ b'a52beacaa6fcc11d48f5b742c73aa2c0f87634ce' - 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. .. releasenotes/notes/warn-on-disk-overcommit-087ae46f12d74693.yaml @ b'8868c77a201703edaded5d06aa1734265431f786' - 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. .. _python-openstackclient_5.5.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/add-missing-server-create-opts-d5e32bd743e9e132.yaml @ b'ace4bfb6404b7b39c597c4884c56e26a47a94fc4' - 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. .. releasenotes/notes/always-show-direction-for-sg-rule-130efc39bf67d79a.yaml @ b'e410e61d204d09eeb7bcf0a33e3858ef7b110dd3' - Deprecate the ``--long`` option for the ``security group list`` command. This is no longer needed to display all columns. .. releasenotes/notes/story-2005468-server-use-config-drive-9fc68552365cfefa.yaml @ b'12f1e56ebf2ea3999c57246410501c09fced2c4c' - 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. .. _python-openstackclient_5.5.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/fix-flavor-props-formatting-d21e97745543caa7.yaml @ b'ad3369ed1fdad73b5d457a40df7df8ad55eb69cd' - Fix '-f json' output of the flavor properties to return valid json object instead of stringying it. .. releasenotes/notes/fix-openstak-image-save-sdk-port-eb160e8ffc92e514.yaml @ b'5bdcd590ecacbc0aa8db2cbafa0ab1a9f3c28ce0' - 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 .. releasenotes/notes/fix-openstak-image-save-sdk-port-eb160e8ffc92e514.yaml @ b'5bdcd590ecacbc0aa8db2cbafa0ab1a9f3c28ce0' - Restore default behavior of 'openstack image save' to send data to stdout Relates to https://storyboard.openstack.org/#!/story/2007672. .. releasenotes/notes/improved-server-output-6965b664f6abda8d.yaml @ b'bf834f6d7582009672fc65aa983f314684dc4380' - The ``addresses`` and ``flavor`` fields of the ``server show`` command will now be correctly rendered as a list of objects and an object, respectively. .. releasenotes/notes/improved-server-output-6965b664f6abda8d.yaml @ b'bf834f6d7582009672fc65aa983f314684dc4380' - 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. .. releasenotes/notes/improved-server-output-6965b664f6abda8d.yaml @ b'bf834f6d7582009672fc65aa983f314684dc4380' - 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. .. releasenotes/notes/improved-server-output-6965b664f6abda8d.yaml @ b'bf834f6d7582009672fc65aa983f314684dc4380' - 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. .. releasenotes/notes/improved-server-output-6965b664f6abda8d.yaml @ b'bf834f6d7582009672fc65aa983f314684dc4380' - The ``cpu_info`` field of the ``hypervisor show`` output is now correctly decoded and output as an object. .. releasenotes/notes/restore-create-image-duplicates-92e06f64038b120c.yaml @ b'17678c9bd6f3f4c5b9e7b5ceb27c2bd12493fba4' - 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. .. releasenotes/notes/story-2004346-add-floating-ip-with-no-ports-399c5559e1699816.yaml @ b'415545ab9fd842bdc19b7fbfa63e3332dd63fe6c' - 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. .. releasenotes/notes/story-2007727-69b705c561309742.yaml @ b'bb15b29190dfe77ea0218a01edc1f4886993b177' - 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. .. releasenotes/notes/subnet-unset-gateway-20239d5910e10778.yaml @ b'ed731d6cd9254eae047d14ccd55132229e13e7d1' - Add missing ``openstack subnet unset --gateway ``. .. _python-openstackclient_5.5.0_Other Notes: Other Notes ----------- .. releasenotes/notes/remove-nlbaas-quota-8b38e0c91ab113cb.yaml @ b'e9bd4ef007153e4f2e2d69f3bcb94eef8e8983c2' - Remove deprecated neutron-lbaas results from ``quota show`` command. .. _python-openstackclient_5.6.2-4: 5.6.2-4 ======= .. _python-openstackclient_5.6.2-4_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/fix-story-2010775-953dbdf03b2b6746.yaml @ b'560f19b8948acb15bc8510a4be6bdfe7d353a9d6' - Fixed a bug in "access rule" subcommands where the client logic incorrectly assumed that access rules have a "name" property which resulted in unpredictable behaviors. e.g. "access rule delete {non-existent-id}" now results in a not-found error instead of sometimes deleting an unrelated rule. .. _python-openstackclient_5.6.1: 5.6.1 ===== .. _python-openstackclient_5.6.1_New Features: New Features ------------ .. releasenotes/notes/fix-flavor-in-server-list-microversion-2.47-af200e9bb4747e2d.yaml @ b'0873e7580eceab07c3be0824d2ea4163491f8d6e' - 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. .. _python-openstackclient_5.6.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1946816-7665858605453578.yaml @ b'cbc64f9469600624e74631f42ca214487e800155' - Filtering servers by tags (``server list --tag``, ``server list --not-tag``) now works correctly. [Bug `1946816 `_] .. releasenotes/notes/fix-image-create-from-volume-c573e553161605c4.yaml @ b'665d93ff0721801896bf08c3cc4f189a55daae80' - 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. .. _python-openstackclient_5.6.0: 5.6.0 ===== .. _python-openstackclient_5.6.0_New Features: New Features ------------ .. releasenotes/notes/L3-conntrack-helper-bd0d9da041747e84.yaml @ b'fa8c8d26a7696d169b0b9d5aaf6b723d8feee08a' - 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. .. releasenotes/notes/add-missing-volume-backup-opts-b9246aded87427ce.yaml @ b'7f66dfe0e3e8720e847211494c185d7d4983ba5b' - 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. .. releasenotes/notes/add-missing-volume-backup-opts-b9246aded87427ce.yaml @ b'7f66dfe0e3e8720e847211494c185d7d4983ba5b' - 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. .. releasenotes/notes/add-missing-volume-backup-opts-b9246aded87427ce.yaml @ b'7f66dfe0e3e8720e847211494c185d7d4983ba5b' - Add new ``volume backup unset`` command to allow unsetting of properties from an existing volume backup. .. releasenotes/notes/add-volume-attachment-commands-db2974c6460fa3bc.yaml @ b'6dc94e1fb85595653dcdd24185c914b9df1741df' - 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. .. releasenotes/notes/add-volume-group-commands-b121d6ec7da9779a.yaml @ b'af406f33e38a8e9a5fb3c58e34f0d55c1d4d1d74' - 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. .. releasenotes/notes/add-volume-group-snapshot-commands-27fa8920d55f6bdb.yaml @ b'34de2d3352aaef5c1bb86a5441cc8781e03b5587' - 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. .. releasenotes/notes/add-volume-group-type-commands-13eabc7664a5c2bc.yaml @ b'83551d2a0c7604179c0988c13d58455a6b289cc8' - 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. .. releasenotes/notes/add-volume-message-commands-89a590a1549c333e.yaml @ b'0eddab36e52e813e2329ac10044fa4f67830efec' - Add ``volume message list``, ``volume message get`` and ``volume message delete`` commands, to list, get and delete volume failure messages, respectively. .. releasenotes/notes/add-volume-transfer-request-create-snapshots-opts-1361416d37021e89.yaml @ b'a821d6b7c57c7684a990ee39b6b93d5085f25a70' - 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. .. releasenotes/notes/compute-service-list-forced-down-2b16d1cb44f71a08.yaml @ b'12c93c6d5ff420f6a4a8833d33bad6ee7222e2f7' - Add column ``Forced Down`` to the output of ``compute service list --long``. Only available starting with ``--os-compute-api-version 2.11``. .. releasenotes/notes/implements-hide-image-4c726a61c336ebaa.yaml @ b'383289edd8ea222ce1a6e77ed0298ecdb21608a1' - Add mutually exclusive options ``--hidden`` and ``--unhidden`` to ``image set`` command to hide or unhide an image (``is_hidden`` attribute). .. releasenotes/notes/implements-hide-image-4c726a61c336ebaa.yaml @ b'383289edd8ea222ce1a6e77ed0298ecdb21608a1' - Add option ``--hidden`` to ``image list`` command to list hidden images. .. releasenotes/notes/network-port-create-vnic-type-vdpa-fc02516cfb919941.yaml @ b'6f821659795fdc82c694bb9fdddd5d3c61702e21' - The ``port create --vnic-type`` option now accepts a ``vdpa`` value. .. _python-openstackclient_5.6.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/add-missing-volume-backup-opts-b9246aded87427ce.yaml @ b'7f66dfe0e3e8720e847211494c185d7d4983ba5b' - 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. .. _python-openstackclient_5.8.1: 5.8.1 ===== .. _python-openstackclient_5.8.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/fix-image-create-from-volume-c573e553161605c4.yaml @ b'849e7e93f83a220265d11af71e2edc009c3f7bea' - 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. .. releasenotes/notes/fix-story-2010775-953dbdf03b2b6746.yaml @ b'f4748f4d250d4d8eb592b7170f1e020f9ece8df3' - Fixed a bug in "access rule" subcommands where the client logic incorrectly assumed that access rules have a "name" property which resulted in unpredictable behaviors. e.g. "access rule delete {non-existent-id}" now results in a not-found error instead of sometimes deleting an unrelated rule. .. _python-openstackclient_5.8.0: 5.8.0 ===== .. _python-openstackclient_5.8.0_New Features: New Features ------------ .. releasenotes/notes/add-network-local-ip-df3a9ce7610d8b90.yaml @ b'26144743d9207d876df40e030a2a4132e18a79a7' - 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 `_] .. releasenotes/notes/add-option-to-unset-port-host-c76de9b1d2addf9a.yaml @ b'f4629331134c40599f9baf908a391460b74d2767' - Add possibility to unbind Neutron's port from the host by unsetting its host_id. .. releasenotes/notes/add-remote-managed-vnic-type-4fc540b47427c37f.yaml @ b'd565f110938f46224ada92c3d68ca416f05635b6' - 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. .. releasenotes/notes/check-limit-quota-cc7f291dd1b537c1.yaml @ b'bef70397a3e1240cc593b3fb34049f2ff6601e68' - Add ``--check-limit`` option to the ``openstack quota set`` command (only for network commands). The network quota engine will check the resource usage before setting the new quota limit. .. releasenotes/notes/fix-flavor-in-server-list-microversion-2.47-af200e9bb4747e2d.yaml @ b'8e362402dee07744668bcf7f6774af4fbe9a07e3' - 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. .. releasenotes/notes/list-subnet-by-pool-id-a642efc13d04fa08.yaml @ b'e4e9fb594d003ea6c3ec29aab0bccf72ffab6781' - Add ``--subnet-pool`` option to ``subnet list`` to filter by subnets by subnet pool. .. releasenotes/notes/migrate-add-fixed-ip-to-sdk-3d932d77633bc765.yaml @ b'9971d7253e9c3abd2e3940bf549ef8532ef929f9' - Switch the add fixed IP command from novaclient to SDK. .. releasenotes/notes/migrate-create-server-image-to-sdk-e3d8077ffe05bb3d.yaml @ b'9acbd3e1052d533c1395eb59de4274170baed67b' - Migrate openstack server image create from novaclient to sdk. .. releasenotes/notes/migrate-server-add-network-add-port-to-sdk-7d81b25f59cfbec9.yaml @ b'2183a611475090347863917f6c90f0f38cd80893' - Migrate server add network/port from novaclient to openstacksdk. .. releasenotes/notes/migrate-server-add-volume-to-sdk-685e036a88839651.yaml @ b'3078a0a121743c387d83d7f27ce3d8fd8fbb4ccf' - Migrate openstack server add volume to using sdk. .. releasenotes/notes/migrate-server-pause-unpause-to-sdk-d74ec8536b764af6.yaml @ b'b515fe61b27408e78639da8abb3acaa485ebca4e' - Migrate ``server pause`` and ``server unpause`` commands from novaclient to sdk. .. releasenotes/notes/migrate-server-suspend-resume-to-sdk-fd1709336607b496.yaml @ b'ff96fea0120ab43968a10230ce7899a3c6504e75' - Migrate ``server suspend`` and ``server resume`` commands from novaclient to sdk. .. releasenotes/notes/migrate-service-list-delete-set-to-sdk-920cbe0d210af565.yaml @ b'b5a2714b83d4ce1991aae775381dcfb02ff59e9d' - Switch the compute service commands from novaclient to SDK. .. releasenotes/notes/options-create-router-97910a882b604652.yaml @ b'4e9b9298429f5db505987853f98d2388b6745b13' - 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. .. releasenotes/notes/pass_ssh_args-cf26a2ce26ccddaf.yaml @ b'3a929611c0ec5dd8e7bf24692984d1df8b9a97f8' - 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. .. releasenotes/notes/port-list-security-group-4af5d2e789174ff9.yaml @ b'c8c4f76498de3380c7cbf80c5dc800a588bed649' - Added ``--security-group`` option to the ``os port list`` command. This option is appendable and multiple security group IDs can be provided. .. releasenotes/notes/switch-server-remove-network-port-to-sdk-829ba711e0e198d5.yaml @ b'f82afc7f379daebd1994d9133eff801f790c0d32' - Switch server remove volume/port to using sdk. .. releasenotes/notes/switch-server-remove-volume-to-sdk-47e9befd2672dcdf.yaml @ b'fae293dd5218cf4ea03d0a4c44d17b97987dea12' - Switch command server remove volume to using sdk. .. _python-openstackclient_5.8.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/pass_ssh_args-cf26a2ce26ccddaf.yaml @ b'3a929611c0ec5dd8e7bf24692984d1df8b9a97f8' - ``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`` .. _python-openstackclient_5.7.0: 5.7.0 ===== .. _python-openstackclient_5.7.0_New Features: New Features ------------ .. releasenotes/notes/add-server-hostname-opts-3cb4fd90b5bf47ca.yaml @ b'8e833a3ed26467a1190ba69d8ba716a7cd1cccb3' - 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. .. releasenotes/notes/add-trusted-certs-option-server-create-a660488407300f22.yaml @ b'28a376bfb0a330470b028b6d5244ee4c8e1fe864' - 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 .. releasenotes/notes/add_attachment_id_to_volume_attachment-cea605585db29e14.yaml @ b'51ee17a94dccd297101725593b223f01c4f9b906' - 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. .. _microversion 2.89: https://docs.openstack.org/nova/latest/reference/api-microversion-history.html#microversion-2-89 .. releasenotes/notes/migrate-server-backup-to-sdk-0f170baf38e98b40.yaml @ b'57aad01886fe9d98210496a92d517aa067c049a1' - Migrate openstack server backup from novaclient to sdk. .. releasenotes/notes/show-result-for-server-add-volume-f75277ad58e31024.yaml @ b'163cb01e46fc3f906154a7045fdbe9342cd446c7' - The ``server add volume`` command will now return details of the created volume attachment upon successful attachment. .. _python-openstackclient_5.7.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-1946816-7665858605453578.yaml @ b'53debe7fe1978f661768a27430f646a288948ecc' - Filtering servers by tags (``server list --tag``, ``server list --not-tag``) now works correctly. [Bug `1946816 `_] .. _python-openstackclient_6.0.1: 6.0.1 ===== .. _python-openstackclient_6.0.1_New Features: New Features ------------ .. releasenotes/notes/add-reimage-param-to-rebuild-606dd331677b5954.yaml @ b'7d702baf171dba9942db44a3814ce2c9575b2fe2' - 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. .. _python-openstackclient_6.0.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/fix-story-2010775-953dbdf03b2b6746.yaml @ b'48148e7a1197c92febdb3ab1e72085c4eb3d6bf7' - Fixed a bug in "access rule" subcommands where the client logic incorrectly assumed that access rules have a "name" property which resulted in unpredictable behaviors. e.g. "access rule delete {non-existent-id}" now results in a not-found error instead of sometimes deleting an unrelated rule. .. _python-openstackclient_6.0.0: 6.0.0 ===== .. _python-openstackclient_6.0.0_New Features: New Features ------------ .. releasenotes/notes/add-block-storage-cluster-commands-fae8f686582bbbcf.yaml @ b'd727a6502369a6a7244ef1c07c1c483dbe0a8dab' - 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. .. releasenotes/notes/bug-1597189-02a8d8a402725860.yaml @ b'de4a69a29ff4657d0c3cd95ca9f35ff24f653b5f' - 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 `_] .. releasenotes/notes/image-list-multiple-tags-a394799c7807f031.yaml @ b'5cc6fc2b88296035f687f72d92efe4a3cea78fc7' - The ``image list`` now accepts multiple ``--tag`` options, allowing you to filter images on more than one tag. .. releasenotes/notes/qos-min-pps-rule-bfe22cea1966c4a0.yaml @ b'6ccbcdde64670daaaac4f42fe62eb180df700905' - 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`` .. releasenotes/notes/quota-network-force-920913981b45ba1a.yaml @ b'1c6d396ba30c1a92a417f778d7522ea43e9b2d4a' - 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. .. releasenotes/notes/server-list-host-status-1f542a5bc4292a62.yaml @ b'93578ef85ba5f94ec5dc8fc4b2917e91c74121da' - 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. .. releasenotes/notes/server-migration-by-uuid-59f8272f63abee5d.yaml @ b'cffec4517f8bfbe3a6d6d1610c5b3217271a9a9f' - 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. .. _python-openstackclient_6.0.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/fix-image-create-from-volume-c573e553161605c4.yaml @ b'9eea28ba59e44526b9d6f1ad9f80c3553d5853e2' - 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. .. releasenotes/notes/volume-attachment-create-output-fix-56515b8fcdd260b9.yaml @ b'045f2e7e0618fdf22c260625d64554382afefde1' - The ``volume attachment create`` command will now display information for successfully created volume attachments. Previously an empty table was returned. .. _python-openstackclient_2023.1-eom: 2023.1-eom ========== .. _python-openstackclient_2023.1-eom_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/fix-story-2010775-953dbdf03b2b6746.yaml @ b'a03e3dbf75c55561bc3575c53db445868be87a3b' - Fixed a bug in "access rule" subcommands where the client logic incorrectly assumed that access rules have a "name" property which resulted in unpredictable behaviors. e.g. "access rule delete {non-existent-id}" now results in a not-found error instead of sometimes deleting an unrelated rule. .. _python-openstackclient_6.2.0: 6.2.0 ===== .. _python-openstackclient_6.2.0_New Features: New Features ------------ .. releasenotes/notes/add-port-ranges-in-port-forwarding-command-8c6ee05cf625578a.yaml @ b'bced4852c7a92959f5457360dd91eb397af4d270' - Add port ranges support to the ``floating ip port forwarding`` commands. .. releasenotes/notes/migrate-host-list-show-to-sdk-9b80cd9b4196ab01.yaml @ b'ecc6aeeede68db65cb888390dd9299a4cfad6630' - The ``host list`` and ``host show`` commands have been migrated to SDK. .. releasenotes/notes/migrate-server-volume-list-update-to-sdk-95b1d3063e46f813.yaml @ b'25b4714f1cd12c20ff7653f05dddb5486a037fcc' - Switch the server volume list and server volume update command from novaclient to SDK. .. releasenotes/notes/switch-server-migration-show-to-sdk-4adb88a0f1f03f3b.yaml @ b'd1c1c36af15d8cfc43b26b239324b48b0924b66e' - Finish switching server migration to the OpenStackSDK .. _python-openstackclient_6.2.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/consistency-group-create-opts-aliases-e1c2f1498e9b1d3d.yaml @ b'4106926fa65622dc33e7322832394aedb47f95ad' - 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. .. releasenotes/notes/rename-server-volume-update-to-server-volume-set-833f1730a9bf6169.yaml @ b'e0577e7ebe359ff241023b64055f777f8504d3af' - 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. .. _python-openstackclient_6.2.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/deprecate-volume-group-create-positional-arguments-89f6b886c0f1f2b5.yaml @ b'0d57f3f367163dc4d3b57ae574a825563494f133' - The ```` and `` [...]`` 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-type [--volume-type ...] .. _python-openstackclient_6.1.0: 6.1.0 ===== .. _python-openstackclient_6.1.0_New Features: New Features ------------ .. releasenotes/notes/add-backup-option-to-create-vol-fc36c2c745ebcff5.yaml @ b'bd0727c4f897289722ba639930c9e979cfee534a' - Added ``--backup`` option to the ``volume create`` command. .. releasenotes/notes/add-baremetal-agent-type-7c46365e8d457ac8.yaml @ b'b7d01833d02260006e6d4c6e0a065748ecc8b913' - Add ``baremetal`` agent type to ``--agent-type`` option for ``network agent list`` command. .. releasenotes/notes/add-block-storage-manage-commands-6ebf029bd7a67bb3.yaml @ b'73b4ce88eb3e71568cf5330d6c0a8a4e92287d89' - 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. .. releasenotes/notes/add-create-group-from-src-options-6fcb0c87f617ca91.yaml @ b'ec01268ea93141439542fb162a6a12bc2bf533fe' - 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. .. releasenotes/notes/add-image-metadef-namespace-support-4ba37ec3a1a72185.yaml @ b'a726d84f4b7cec761d3d82824997969dffbd4249' - Adds ``openstack image metadef namespace list``. The output is equivalent to glance md-namespace-list. .. releasenotes/notes/add-image-task-commands-50c3643ebfd0421f.yaml @ b'c9d445fc4baf036793103b15c9eb2632da3610e0' - Add ``image task show`` command to show a task for the image service. .. releasenotes/notes/add-image-task-commands-50c3643ebfd0421f.yaml @ b'c9d445fc4baf036793103b15c9eb2632da3610e0' - Add ``image task list`` command to list tasks for the image service. .. releasenotes/notes/add-missing-trust-list-opts-500fd1e4c14e1504.yaml @ b'64e4520b2a79b9046a791f5e3729f5cbfc2d3fa5' - Add missing ``--trustee``, ``--trustee-domain``, ``--trustor``, ``--trustor-domain`` options to ``trust list`` command, to allow filtering trusts by trustee and trustor. .. releasenotes/notes/add-missing-trust-list-opts-500fd1e4c14e1504.yaml @ b'64e4520b2a79b9046a791f5e3729f5cbfc2d3fa5' - Add ``--authuser`` option to ``trust list`` command, to allow displaying only trusts related to current authenticated user .. releasenotes/notes/add-network-rbac-list-tenant-project-filter-1228f2287284e33c.yaml @ b'4d7d7e627eb4bb028251bd7993026aae45db7d8b' - Add a new argument ``--target-project`` to the ``network rbac list`` command to filter for a specific target project. .. releasenotes/notes/add-reimage-param-to-rebuild-606dd331677b5954.yaml @ b'4024bdb3933dd79eec4bcf99c13f3dbf17add40b' - 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. .. releasenotes/notes/add-vol-service-get-set-log-commands-f9420e5061d994b5.yaml @ b'a9e3049e9ce8a6e2d46152ef85ad6679b8cb8f1d' - 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. .. releasenotes/notes/add-volume-revert-command-1c8f695420acbe7e.yaml @ b'e7ebf7544b7bd0b014e9dffa27d6c4c63f078f6e' - Added ``volume revert`` command that reverts the volume to the given snapshot. .. releasenotes/notes/add-volume-summary-command-b2175b48af3ccab1.yaml @ b'77266bd9c3afd94a7043d0fa85075671e7a16b93' - Added ``volume summary`` command to show the total size, total count and metadata of volumes. .. releasenotes/notes/add-workers-cleanup-command-720573c0f642efe9.yaml @ b'2be359677908b81d9985917fd78f9c6897759fb9' - 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. .. releasenotes/notes/add_volume_backend_commands_to_volumeV3-145b114e40ab8615.yaml @ b'f0f54f01001db657b3ed7d618dfd1078f2dde580' - 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. .. releasenotes/notes/auto-no-network-options-f4ddb2bb7544d2f5.yaml @ b'a7975c42003d7df2af91154007435cd5f8560f24' - The ``server create`` command now accepts two new options, ``--no-network`` and ``--auto-network``. These are aliases for ``--nic none`` and ``--nic auto``, respectively. .. releasenotes/notes/bp-unshelve-to-host-9ce4b7abf81aeedf.yaml @ b'6e0699c1cf3e603850580a6bb5ca2e377fe1bc84' - 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. .. releasenotes/notes/detailed-volume-quotas-198dc2e8f57ce1e7.yaml @ b'44443f78561ce4f23d202a42de4a4ceac2ffa097' - The ``quota list`` command can now provide detailed quotas for the volume service, e.g.:: $ openstack quota list --detail --volume .. releasenotes/notes/idp-auth-ttl-6632df5db65a3bdd.yaml @ b'167cf11e825af95fe40c1daefdb6095c791a3ee5' - ``identity provider create`` and ``identity provider set`` commands now accept the ``--authorization-ttl `` argument, with ```` being a non-negative integer. See `note `_ in Keystone documentations for more details on the meaning of this option. .. releasenotes/notes/image-import-d5da3e5ce8733fb0.yaml @ b'4eea3408dc492e948671b625ffc4379212b5857c' - Add ``image import`` command, allowing users to take advantage of the interoperable image import functionality first introduced in Glance 16.0.0 (Queens). .. releasenotes/notes/image-metadef-namespace-b940206bece64f97.yaml @ b'38f972fa637871de8ab2ad4a70780faef6833198' - Add ``openstack image metadef namespace create`` command to create metadef namespace for the image service. .. releasenotes/notes/image-metadef-namespace-b940206bece64f97.yaml @ b'38f972fa637871de8ab2ad4a70780faef6833198' - Add ``openstack image metadef namespace delete`` command to delete image metadef namespace. .. releasenotes/notes/image-metadef-namespace-b940206bece64f97.yaml @ b'38f972fa637871de8ab2ad4a70780faef6833198' - Add ``openstack image metadef namespace set`` command to update metadef namespace for the image service. .. releasenotes/notes/image-metadef-namespace-b940206bece64f97.yaml @ b'38f972fa637871de8ab2ad4a70780faef6833198' - Add ``openstack image metadef namespace show`` command to show metadef namespace for the image service. .. releasenotes/notes/image-stage-ac19c47e6a52ffeb.yaml @ b'1fb8d1f48b256a2bad78e7d5633ea53c6537907c' - Added a new command, ``image stage``, that will allow users to upload data for an image to staging. .. releasenotes/notes/network-ndp-proxy-cli-19afc530fc7061e2.yaml @ b'b36cd0f4c0416182ce69d71a4e99d89507d53e7f' - 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. .. releasenotes/notes/network-ndp-proxy-cli-19afc530fc7061e2.yaml @ b'b36cd0f4c0416182ce69d71a4e99d89507d53e7f' - Add new options ``--enable-ndp-proxy`` and ``--disable-ndp-proxy`` to command ``router create`` and ``router set`` to support Neutron NDP proxy feature. .. releasenotes/notes/network-qos-rule-type-filters-47f4911a02011501.yaml @ b'bfab0199bebf139be5a948fdf8ced868b3e942de' - 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. .. releasenotes/notes/no-force-limit-quota-cc7f291dd1b537c1.yaml @ b'09ff9a0f4c118f50924d2fc078d6a4501e696224' - 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. .. releasenotes/notes/nova-gaps-server-list-to-sdk-88c8bfc10a9e3032.yaml @ b'c97f73ce2a897fe6b83f08de1ce6e1865e9a83c5' - The ``server list`` command now uses the OpenStack SDK instead of the Python nova bindings. .. releasenotes/notes/optional-volume-name-ffbefe463a598b6c.yaml @ b'3fc585332f79358489285eabc298e01007599128' - The ```` argument for the ``volume create`` command is now optional. .. releasenotes/notes/quota-delete-947df66ae5341cbf.yaml @ b'45bec041b206678de36f2f463ac6872b785e592e' - Added a new command, ``quota delete``, that will allow admins delete quotas set for projects. Supported by the compute, volume, and network services. .. releasenotes/notes/quota-show-service-options-ba48d6eca8ffc4f9.yaml @ b'00e7019022585bc2be9aeb55eb40b1d04776ec22' - The ``quota show`` command now allows you to show quotas for a specific service using the ``--compute``, ``--volume``, or ``--network`` options. .. releasenotes/notes/quota-show-usage-option-19b1f59fb5f3498f.yaml @ b'04e68e0d5a49be93f79d6d71821ab8cd0b0ce589' - 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. .. releasenotes/notes/server-list-restrict-images-c0b2c4de6f93df33.yaml @ b'725b7de13cf00da386132a42b2738f4c57026184' - 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. .. releasenotes/notes/switch-hypervisor-to-sdk-2e90b26a14ffcef3.yaml @ b'006e35509d3cea66dc13fe2238dac92f47fe3c5c' - Switch hypervisor to the OpenStackSDK .. releasenotes/notes/switch-hypervisor-to-sdk-f6495f070b034718.yaml @ b'992cfdfb57c359f709a0ceb67502f5bd66b90e5a' - Switch hypervisor operations to consume OpenStackSDK .. releasenotes/notes/switch-server-migration-to-sdk-4e4530f787f90fd2.yaml @ b'86c54701348d519139c52722197d262c35f7ea8e' - The ``server migration *`` commands now use the OpenStackSDK instead of novaclient. .. releasenotes/notes/switch-server-show-to-sdk-44a614aebf2c6da6.yaml @ b'70dbb01ea3ed900a41092d46ed5ae1370d5771af' - 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. .. _python-openstackclient_6.1.0_Deprecation Notes: Deprecation Notes ----------------- .. releasenotes/notes/deprecated-quota-class-options-ba33a45caedbdf3e.yaml @ b'b62021260c9c2d372ea635a2a7f0608b7c8472e1' - 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. .. releasenotes/notes/no-force-limit-quota-cc7f291dd1b537c1.yaml @ b'09ff9a0f4c118f50924d2fc078d6a4501e696224' - 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. .. releasenotes/notes/quota-show-usage-option-19b1f59fb5f3498f.yaml @ b'04e68e0d5a49be93f79d6d71821ab8cd0b0ce589' - 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. .. releasenotes/notes/quota-show-usage-option-19b1f59fb5f3498f.yaml @ b'04e68e0d5a49be93f79d6d71821ab8cd0b0ce589' - The ``--project`` option for the ``quota list`` command has been deprecated for removal. Use the ``quota show`` command instead. .. _python-openstackclient_6.1.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2010376-e15362bdd6c8d6ec.yaml @ b'91277e7e51849d197554b633a579c92116a5afc4' - 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. .. releasenotes/notes/story-2010343-b5eb4ed593f51d3f.yaml @ b'ec8dba29f9f646ec05c0d6fad32b4b3aaf99f6af' - 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 `_] .. _python-openstackclient_6.3.0: 6.3.0 ===== .. _python-openstackclient_6.3.0_New Features: New Features ------------ .. releasenotes/notes/add-auto-approve-cleanup-a2d225faa42dfdcb.yaml @ b'7506eb8e0c459494bdb4ec47de2e18a2a953d727' - An ``--auto-approve`` option has been added to the ``project cleanup`` command. This allows the interactive confirmation of resource deletion to be skipped. .. releasenotes/notes/add-flavor-id-to-router-create-76e916e129b5b80c.yaml @ b'f8f174c458a8a33e1c7279cc3266ef0087378a86' - Add the ``--flavor-id`` option to the ``router create`` command. .. releasenotes/notes/add-image-metadef-resource-type-list-command-020adcaa2ad14e07.yaml @ b'52bf194741c2594f38539ae63d3ea3fe05152a09' - Added ``image metadef resource type list`` command. This is equivalent to the ``+md-namespace-resource-type-list`` command in glanceclient. .. releasenotes/notes/add-import-info-stores-delete-c50b5222c21e1077.yaml @ b'b347347986ebc8677c1d656299020fe58b1dc2a3' - Add ``image import info`` command, allowing users to know available import methods, and `--store` option to ``image delete``, allowing users to delete image from particular store. .. releasenotes/notes/add-port-hints-attribute-be1779e640a47d0d.yaml @ b'22d1a26d1dfd53a4337d541354544031ec6fdd17' - Enable management of Neutron port hints: ``port create --hint HINT``, ``set port --hint HINT and ``unset port --hint``. Port hints allow passing backend specific hints to Neutron mainly to tune backend performance. The first hint controls Open vSwitch Tx steering. .. releasenotes/notes/add-stores-info-9f1488dd29013767.yaml @ b'18a6199ed0dc9d173ff18302b85615143077a887' - Add ``image stores info`` command, allowing users to know available backends. .. releasenotes/notes/add-volume-qos-set-no-property-option-348480dfc42a0a64.yaml @ b'629eb33c4dcb73d44d1a4c6105e40d28f6cebdfc' - Add ``--no-property`` option in ``volume qos set``. .. releasenotes/notes/add-volume-type-set-public-private-opts-891fc7ab5de9bb6a.yaml @ b'83f5c8033fa2a29dde422215277befd0ec63290e' - The ``volume type set`` command now supports ``--public`` and ``--private`` options. .. releasenotes/notes/keypair-create-client-side-generation-73d8dd36192f70c9.yaml @ b'2454636386d443473dedff1f07f8623108e87298' - 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. .. releasenotes/notes/migrate-backup-commands-0becc8f18cf9737b.yaml @ b'bfd6170b03ab5c20cafdc96443cd73b3e8f3ae82' - Migrated the following backup commands to SDK: * Create Backup * Show Backup * List Backup * Restore Backup * Delete Backup .. releasenotes/notes/migrate-server-events-to-sdk-6a1f5dce582df245.yaml @ b'737540cca0b820ceaf53fc74e81f4fdafbc8f518' - The ``server event list`` and ``server event show`` commands have been migrated to SDK. .. releasenotes/notes/migrate-server-reboot-to-sdk-a49822810def4c8a.yaml @ b'864f51f427c01d13c8408782dd03be4b473f7b2e' - Migrate ``server reboot`` command from novaclient to SDK. .. releasenotes/notes/migrate-server-restore-to-sdk-4540f26753031779.yaml @ b'004b2ab2fbad3655915f226ca2f479b35f7bfc46' - The ``server restore`` command has been migrated to SDK. .. releasenotes/notes/migrate-server-shelve-unshelve-to-sdk-8fce77586aa68a51.yaml @ b'f56f0e333ed5873f72be6ee554e8f18499dbb00b' - The ``server shelve`` and ``server unshelve`` commands have been migrated to SDK. .. releasenotes/notes/migrate-server-start-stop-to-sdk-55edd4e1ff5e6ac7.yaml @ b'9241514137cd8d45fa6f36808536c5d0f218cb97' - Migrate ``server start`` and ``server stop`` commands from novaclient to sdk. .. releasenotes/notes/migrate-volume-revert-to-sdk-1e399853d80ba5f8.yaml @ b'aaeda25e28ba27c7e5d1870eba448e94e4a8aa1b' - The ``volume revert`` command has been migrated to SDK. .. releasenotes/notes/migrate-volume-summary-to-sdk-96ff58f653e0feaa.yaml @ b'4dfbc5011efe6b5cd30d5eac20b8cf29003004b2' - The ``volume summary`` command has been migrated to SDK. .. releasenotes/notes/project-cleanup-skip-resource-option-4f80db0d8cf36fdb.yaml @ b'f29e3ccc37a510c40ea61216ac3a7e3ef944e1bf' - A new option ``--skip-resource`` has been added to the ``project cleanup`` command. This allows to exclude certain resources from project cleanups, e. g. ``--skip-resource "block_storage.backup"`` to keep Cinder backups. .. releasenotes/notes/story-2010751-server-rebuild-wait-shutoff-c84cddcd3f15e9ce.yaml @ b'417a7ad2039c09adbd497392c0199b7667e65ef7' - ``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 `_. .. releasenotes/notes/switch-server-lock-to-sdk-d5dd17e4987233a5.yaml @ b'ce8171bad90f15ac8a753f50bb3792862b66cc7c' - The ``server lock`` and ``server unlock`` commands now use SDK. .. _python-openstackclient_6.3.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/remove-project-purge-d372374b1a7c4641.yaml @ b'601d9717c2a5c125912ca27e43259c48e548939b' - The ``project purge`` command has been removed. This has been superseded by the ``project cleanup`` command, was not tested, and has not been functional for some time hence its removal without a deprecation period. The replacement is ``project cleanup``, which is more powerful and more flexible. .. _python-openstackclient_6.3.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/fix-story-2010775-953dbdf03b2b6746.yaml @ b'bc60e3bb908a7f10c87993d791184bfe46784d6c' - Fixed a bug in "access rule" subcommands where the client logic incorrectly assumed that access rules have a "name" property which resulted in unpredictable behaviors. e.g. "access rule delete {non-existent-id}" now results in a not-found error instead of sometimes deleting an unrelated rule. .. releasenotes/notes/story-2010751-server-rebuild-wait-shutoff-c84cddcd3f15e9ce.yaml @ b'417a7ad2039c09adbd497392c0199b7667e65ef7' - ``openstack server rebuild --wait`` now properly works for servers in ``SHUTOFF`` state without hanging. [Story `2010751 `_] .. _python-openstackclient_6.6.0: 6.6.0 ===== .. _python-openstackclient_6.6.0_New Features: New Features ------------ .. releasenotes/notes/add-image-metadef-object-update-f4880e423bf4faba.yaml @ b'3cd5ad2c1babc9bddc85c1faf5005728a909725c' - Add ``image metadef object update`` command which updates the attributes of an object. .. _python-openstackclient_6.5.0: 6.5.0 ===== .. _python-openstackclient_6.5.0_New Features: New Features ------------ .. releasenotes/notes/add-image-member-get-25e913ef2b861bf3.yaml @ b'93b2e66d2dd245d36774a2725d6786ef325ae35b' - Add ``image member get`` command which accepts an image_id and member_id and displays the detail of the particular meber associated to the image. .. releasenotes/notes/add-port-hardware-offload-type-011c98ab748357d7.yaml @ b'0725bb474c138c84cbe1131cbf5ab5d877f9d964' - Add the port hardware offload attribute to the ``port create`` command. Once defined, the value cannot be modified. .. releasenotes/notes/server-create-server-group-a5b630f2a64de28d.yaml @ b'7708106cf06cd590ca581802d55094418bdc1feb' - The ``server create`` command now accepts a new option, ``--server-group``, which is a shortcut for configuring the ``group`` scheduler hint. .. _python-openstackclient_6.4.0: 6.4.0 ===== .. _python-openstackclient_6.4.0_New Features: New Features ------------ .. releasenotes/notes/Add-default-security-group-rule-CRUD-2916568f829ea38c.yaml @ b'7b99b5716544bccf455ad0bf6d8a0ccfe2788331' - Add ``default security group rule create``, ``default security group rule delete``, ``default security group rule list`` and ``default security group rule show`` commands to support Neutron Default Security Group Rule CRUD operations. [Bug `1983053 `_] .. releasenotes/notes/add-cache-commands-a6f046348a3a0b1f.yaml @ b'c628c2dcd3efb6cde7d6322ce7fa405508e2e487' - Add commands for the image Cache API, to list, queue, delete and clear images in the cache. .. releasenotes/notes/add-metadef-object-create-3939ee1453585484.yaml @ b'f8c708900c7c522d12b2ca95e0c335219db75bf8' - Add ``image metadef object show`` command to create the metadata definitions objects inside a specific namespace .. releasenotes/notes/add-metadef-object-list-c8831e73c696b9d9.yaml @ b'4bb6efa8f8ec60f288b1e7a246e97dacb0f6ad33' - Add ``image metadef object list`` command to list the metadata definitions objects inside a specific namespace .. releasenotes/notes/add-metadef-object-show-1b05dd33ecf42210.yaml @ b'78ef009a3aebe43583d6b93e65f53c49a1d818a6' - Add ``image metadef object show`` command to show the metadata definitions objects inside a specific namespace .. releasenotes/notes/add-metadef-property-create-c9a4ec2bced892af.yaml @ b'd9c4c43a409977ed593169011b103b618302cc08' - Add ``image metadef property create`` command to create a new metadef property inside a specific namespace. .. releasenotes/notes/add-metadef-property-delete-ebb999d92a588ad4.yaml @ b'9094e540b582073f62635c64d762b3a19db7a8e5' - Add ``image metadef property delete`` command to delete a metadef property inside a specific namespace. .. releasenotes/notes/add-metadef-property-list-fe89ae8ff9780002.yaml @ b'5fb922e46953963ffbdadeef3e4854e7ae3c37b5' - Add ``image metadef property list`` command to list the metadata definitions properties inside a specific namespace. .. releasenotes/notes/add-metadef-property-set-ab9cdcb73adf6397.yaml @ b'705ecef7a949ef6df0401fe98b66d1c8d96de1d6' - Add ``image metadef property set`` command to update a metadef property inside a specific namespace. .. releasenotes/notes/add-metadef-property-show-8bf2ec421f74cb2d.yaml @ b'190f06a9633f2804a0aeff5d3effac8b7255d26c' - Add ``image metadef property show`` command to show details about a metadef property inside a specific namespace. .. releasenotes/notes/migrate-volume-backend-commands-259e553e213c71b0.yaml @ b'39a084f91cd580be6adf46e8e752233112f6ec74' - Migrated following volume backends commands to SDK. * Capability Show * Pool List .. releasenotes/notes/volume-type-extra-specs-22a22fcb6e269832.yaml @ b'a3410cd4f785ec188973d85509448a320e882514' - The ``volume type create``, ``volume type set``, ``volume type list`` commands now accept four new options - ``--multiattach``, ``--cacheable``, ``--replicated``, and ``--availability-zone`` - which are short cuts for setting or filtering on the relevant properties on the volume type. .. releasenotes/notes/volume-type-list-properties-filter-8532f96d16733915.yaml @ b'67bec7785ce2e1af745a55d1838315dc6e849eaa' - The ``volume type list`` command now accepts a ``--property =`` option, allowing users to filter volume types by their extra spec properties. .. _python-openstackclient_6.4.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/block-storage-x-manageable-list-long-option-a16a4641acfcf781.yaml @ b'8735b862c52daaafffd3c6d91c14be21891ac74b' - The ``--detailed`` option of the ``block storage volume manageable list`` and ``block storage snapshot manageable list`` commands has been deprecated in favour of a ``--long`` option. These commands will no longer default to detailed output by default. .. _python-openstackclient_6.4.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/migrate-resource-filter-commands-2a353edb965723d1.yaml @ b'ae10851a682adb1db7d3dca2794415437c2eaa79' - Migrated ``block storage resource filters list`` and ``block storage resource filters show`` commands to SDK. .. _python-openstackclient_7.1.4: 7.1.4 ===== .. _python-openstackclient_7.1.4_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2084580-cb1e8c47501e730c.yaml @ b'c6946f4743533449b5b8a3db2b1a8fe099b842da' - The ``quota set`` and ``limits show`` commands will now check for the ``block-storage`` and ``block-store`` service types along with ``volume``, ``volumev2`` and ``volumev3``. [Bug `2084580 `_] .. _python-openstackclient_7.1.0: 7.1.0 ===== .. _python-openstackclient_7.1.0_New Features: New Features ------------ .. releasenotes/notes/aggregate-list-uuid-column-808a0d051006a5ef.yaml @ b'04ebe0853d1f59b8a18fcb8c8afffbc23dd0efc4' - The ``aggregate list`` command will now include the UUIDs of the aggregates when the cloud supports it. .. _python-openstackclient_7.0.0: 7.0.0 ===== .. _python-openstackclient_7.0.0_New Features: New Features ------------ .. releasenotes/notes/add-cluster-to-service-list-5eab3e828de7547e.yaml @ b'ca81b1acf05d87871ae2c672d7900dfb67d52ec0' - Added the ``Cluster`` and ``Backend State`` columns to ``openstack volume service list`` command. Note that the ``Cluster`` parameter is available since microversion 3.7 and ``Backend State`` parameter is available since microversion 3.49. .. releasenotes/notes/add-image-metadef-object-property-show-4ab2c957451ea230.yaml @ b'2a90a6f07b52760b9442493d4c382d7e6ee1ced2' - Add ``image metadef object property show`` command which shows a particular property inside metadef object. .. releasenotes/notes/add-image-metadef-resource-type-association-commands-4d373d7d8eca5d55.yaml @ b'276dbb6f5630cf96f260c8e347e85293b86a876f' - Added ``image metadef resource type association list`` to list resource type associations for the image service. This is equivalent to the ``md-namespace-resource-type-list`` command in glance. .. releasenotes/notes/add-image-metadef-resource-type-association-commands-4d373d7d8eca5d55.yaml @ b'276dbb6f5630cf96f260c8e347e85293b86a876f' - Added ``image metadef resource type association create`` to create a resource type association for the image service. This is equivalent to the ``md-resource-type-associate`` command in glance. .. releasenotes/notes/add-image-metadef-resource-type-association-commands-4d373d7d8eca5d55.yaml @ b'276dbb6f5630cf96f260c8e347e85293b86a876f' - Added ``image metadef resource type association delete`` to delete a resource type association for the image service. This is equivalent to the ``md-resource-type-deassociate`` command in glance. .. releasenotes/notes/add-port-numa-affinity-policy-socket-5a986b14033e0f6e.yaml @ b'966051cfe2e35c2a9c8a497bf5a6b626ba192b0c' - Add a new NUMA affinity policy option: "socket". That applies to any new port (using ``port create``) or any existing port (using ``port set``). .. releasenotes/notes/add-snapshot-unmanage-command-d4c0c8fd8b638d48.yaml @ b'4e94c415ed57c0d6366a7e49259e79fd6505ed6a' - Added support for unmanaging snapshots with the ``openstack snapshot delete --remote`` command. .. releasenotes/notes/add-volume-manage-command-088890446d0e81c7.yaml @ b'cc7773f53bac61f602ce8ebc908878fd0914724c' - Add support for managing volumes with ``openstack volume create --remote-source --host `` command. .. releasenotes/notes/add-volume-unmanage-support-9b7139e5e948de77.yaml @ b'fdc2763ac2052f121e919a8513119e95ddd362d8' - Add support for unmanaging volumes with ``openstack volume delete --remote `` command. .. releasenotes/notes/migrate-application-credential-to-sdk-c79d8dfc3c8e1d9f.yaml @ b'bef8a7a63098f903bcd2a9d42f2f37458602340f' - The following commands have been migrated to SDK: - ``application credential create`` - ``application credential delete`` - ``application credential list`` - ``application credential show`` .. releasenotes/notes/migrate-role-assignment-to-sdk-e6e52bef467b4e4c.yaml @ b'de9d0f9e1b511c6aca7dea57f62331bb2638ef18' - Migrate ``role assignment`` commands from keystoneclient to SDK. .. releasenotes/notes/migrate-server-set-unset-to-sdk-ae32ebcced845b06.yaml @ b'bcaf2ab559e82d571cf46ed50aba60abf0b41637' - The ``server set`` and ``server unset`` commands have been migrated to SDK. .. releasenotes/notes/migrate-service-to-sdk-6ff62ebf7e41db7c.yaml @ b'717f242881ff58f1ddec994ffc68b82103ca7dab' - The following commands have been migrated to SDK: - ``service create`` - ``service delete`` - ``service set`` - ``service list`` - ``service show`` .. releasenotes/notes/migrate-volume-attachment-commands-4309409bca1ca5d4.yaml @ b'9f30ee9af2f43d0754956454ab08cb0a10e847f4' - Migrated volume attachment commands to SDK. .. releasenotes/notes/quota-set-default-option-bc26d37dc150533b.yaml @ b'7d8baa87bba1003d61f08f0d20a4748513e1c45a' - The ``quota set`` command now supports a ``--default`` option. When provided, this will allow you to set quotas for the default quota class which is the only quota class supported by the Compute and Block Storage services. This replaces the deprecated ``quota set --class`` option. .. _python-openstackclient_7.0.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/migrate-agent-commands-1c50ffcb75f91418.yaml @ b'0f07c97e847b8da75208bf7eedf6617d22ed65a5' - The ``compute agent *`` commands have been migrated to SDK. .. releasenotes/notes/migrate-host-set-438997eb6f81f2b1.yaml @ b'7252a7a7817f57c2f38d0f5bf10739ff1fa58320' - The ``host set`` command has been migrated to SDK. .. releasenotes/notes/migrate-limits-show-f586c9762dfd7d0c.yaml @ b'9d394372823053e6a4038e14f81e14d1a32a6e3b' - The ``limits show`` command has been migrated to SDK. .. releasenotes/notes/migrate-server-evacuate-to-sdk-a0415988ef5451b2.yaml @ b'e6dc0f39c0891ea551867b77663a463b5f76987c' - The ``server evacuate`` command has been migrated to SDK. .. releasenotes/notes/network-quota-no-force-default-0975bdf15655070c.yaml @ b'da7eda66e96a72e7f51a9c6bebb4722503cc9662' - The ``openstack quota set`` command previously defaulted to ``--force`` behavior for network quotas. This behavior has now changed and the command now defaults to ``--no-force`` behavior. Users should specify the ``--force`` option if they wish to retain previous behavior. .. releasenotes/notes/remove-deprecated-quota-show-class-option-2109a6ff7ac18e80.yaml @ b'ba2d2358e614b8def13834c760ba551e973b33b1' - The ``--class`` options of the ``quota show`` command, which was deprecated in 6.1.0 (Antelope), has now been removed in favour of the ``--default`` option. Quota classes were never fully implemented and the compute and volume services only support a single ``default`` quota class while the network service does not support quota classes at all. .. releasenotes/notes/rename-volume-set-retype-policy-6bacb7dd92f1ad82.yaml @ b'5a18f995a8ef31efb9ab324e2b5c9e572e75c2d1' - The ``volume set --retype-policy`` parameter has been renamed to ``--migration-policy`` to better convey the correct meaning of the options usage. The migration policy determines whether we are going to perform the migration in the retype opearation or not and is not related to the actual retype which just changes the volume type of the volume. .. _python-openstackclient_7.0.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/Router-flavor-accepts-name-or-id-e9cecafcddf81cb2.yaml @ b'2e7ba5e3dd8055e7eb2dcac9db1009db512a7fcc' - The ``router create --flavor-id`` parameter has been deprecated in favour of the ``--flavor`` parameter, which accepts both flavor names and flavor IDs. .. releasenotes/notes/fix-backup-incremental-d1c1e6886cf32256.yaml @ b'205bac3caf5ff983c60da0d171e51c1cc286024a' - Fixed issue with creating incremental volume backup. Previously, ``incremental`` value was not passed in the API request which is now included in the backup create request. .. _python-openstackclient_7.4.0: 7.4.0 ===== .. _python-openstackclient_7.4.0_New Features: New Features ------------ .. releasenotes/notes/port_uplink_status_propagation_updatable-d1e155c19247b666.yaml @ b'426abbdc681d3f36f186fd685a3f1c0b6058f626' - Add ``--enable-uplink-status-propagation`` option and ``--disable-uplink-status-propagation`` option to ``port update`` command. .. _python-openstackclient_7.3.0: 7.3.0 ===== .. _python-openstackclient_7.3.0_New Features: New Features ------------ .. releasenotes/notes/Add-trusted-vif-to-the-port-0a0c76d9da8f3da0.yaml @ b'47144103cabf11edb108ae80f700ea936bf50b30' - Add ``trusted`` attribute to the ``port create`` and ``port set`` commands. It can be set to ``true`` with ``--trusted`` and to ``false`` with ``--not-trusted`` CLI arguments passed to the ``port create`` and ``port set`` commands`` .. releasenotes/notes/add-vlan_qinq-to-the-network-3556c094aeedc0de.yaml @ b'34121473722b1e10ba9b64af9a3517dc2d6e422f' - Add ``qinq-vlan`` and ``no-qinq-vlan`` arguments to the ``network create`` command. It will enable/disable QinQ feature for the created network. This new argument is mutually exclusive with the ``transparent-vlan`` - only one of them can be set to ``True`` for the network. .. releasenotes/notes/server-create-no-security-group-option-627697bddae429b1.yaml @ b'5ef5cc9c82799290962b80aa663af0094572c903' - The ``server create`` command now supports a ``--no-security-group`` option. When provided, no security groups will be associated with ports created and attached to the server during server creation. This does not affect pre-created ports. .. releasenotes/notes/volume-backup-created-at-list-v3-47400b31be5143bc.yaml @ b'695d025f0028dae2715096b53629f1a00810d270' - Listing volume backups now shows the created_at column when volume v3 API is used. .. _python-openstackclient_7.3.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/migrate-credential-to-sdk-33a841847fe7d568.yaml @ b'9c6df823e24fcb94823ebce9515973386cfed372' - The following commands have been migrated to SDK: - ``credential create`` - ``credential delete`` - ``credential list`` - ``credential set`` - ``credential show`` .. releasenotes/notes/migrate-region-to-sdk-fbd27bceaa1db9dc.yaml @ b'4c8290012d60b1b535594f95dbc5a9e18db721ea' - The following commands have been migrated to SDK: - ``region create`` - ``region list`` - ``region delete`` - ``region set`` - ``region show`` .. releasenotes/notes/migrate-service-provider-to-sdk-74dc48b227f21a05.yaml @ b'56baf50655cfe7948ca5e010b9377749066b6bf9' - The following commands have been migrated to SDK: - ``service provider create`` - ``service provider delete`` - ``service provider set`` - ``service provider list`` - ``service provider show`` .. releasenotes/notes/migrate-trust-to-sdk-9397c9cfddcb636a.yaml @ b'769bf87d0a2a305d9ce53c91931f1c7016848053' - The following commands have been migrated to SDK: - ``trust create`` - ``trust list`` - ``trust delete`` - ``trust show`` .. _python-openstackclient_7.3.0_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/fix-restore-resp-e664a643a723cd2e.yaml @ b'03e2fdd1622d79b0199e349be042991f927f0414' - Fixed the output of ``volume backup restore`` command. .. releasenotes/notes/fix-show-backup-by-name-0759c55396be77a3.yaml @ b'b6b18489b0b1b200c40e060f6c830103070d90f5' - Fixed the ``openstack volume backup show`` command to show a backup by name. .. _python-openstackclient_7.2.1: 7.2.1 ===== .. _python-openstackclient_7.2.1_Bug Fixes: Bug Fixes --------- .. releasenotes/notes/bug-2084580-cb1e8c47501e730c.yaml @ b'7c6b47b451f30d1d3965358c515baae87955d7dc' - The ``quota set`` and ``limits show`` commands will now check for the ``block-storage`` and ``block-store`` service types along with ``volume``, ``volumev2`` and ``volumev3``. [Bug `2084580 `_] .. _python-openstackclient_7.2.0: 7.2.0 ===== .. _python-openstackclient_7.2.0_New Features: New Features ------------ .. releasenotes/notes/add-port-list-status-option-f51da0aed0528a5d.yaml @ b'9c223696a0e3b45bcd8bcb0a8f81e3354ccea9c6' - Add ``--status`` option to ``port list`` command. [Bug `1672680 `_] .. releasenotes/notes/add-remove-multiple-security-groups-2c0b2d599124c9c9.yaml @ b'ece30e8f703f918e391e934ecd2b201f211bfbfe' - The ``server add security group`` and ``server remove security group`` commands now accept multiple security groups. .. _python-openstackclient_7.2.0_Upgrade Notes: Upgrade Notes ------------- .. releasenotes/notes/drop-python-38-9dcbd2b2b51f24f2.yaml @ b'7a92bc4abc4587c270fd86fdc44f231fdab7ab96' - Support for Python 3.8 has been dropped. .. releasenotes/notes/migrate-access-rule-to-sdk-923682b4c71fea8a.yaml @ b'415f68016ca783b5e44aa6b152c7136463467ab0' - The following commands have been migrated to SDK: - ``access rule list`` - ``access rule delete`` - ``access rule show`` ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/bindep.txt0000664000175100017510000000066715033046464020362 0ustar00mylesmyles# This is a cross-platform list tracking distribution packages needed by tests; # see https://docs.openstack.org/infra/bindep/ for additional information. gcc [compile test] libc6-dev [compile test platform:dpkg] libffi-devel [platform:rpm] libffi-dev [compile test platform:dpkg] libssl-dev [compile test platform:dpkg] python3-dev [compile test platform:dpkg] python3-devel [compile test platform:rpm] libpcre3-dev [test platform:dpkg] ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9241114 python_openstackclient-8.1.1.dev14/doc/0000775000175100017510000000000015033046512017106 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/Makefile0000664000175100017510000001126415033046464020560 0ustar00mylesmyles# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source .PHONY: help clean html pdf dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " pdf to make pdf with rst2pdf" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " text to make text files" @echo " man to make manual pages" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." pdf: $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf @echo @echo "Build finished. The PDFs are in $(BUILDDIR)/pdf." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NebulaDocs.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NebulaDocs.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/NebulaDocs" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NebulaDocs" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." make -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/requirements.txt0000664000175100017510000000166315033046464022406 0ustar00mylesmylesopenstackdocstheme>=2.2.1 # Apache-2.0 reno>=3.1.0 # Apache-2.0 sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD # redirect tests in docs whereto>=0.4.0 # Apache-2.0 # Install these to generate sphinx autodocs aodhclient>=0.9.0 # Apache-2.0 gnocchiclient>=3.3.1 # Apache-2.0 osc-placement>=1.7.0 # Apache-2.0 python-barbicanclient>=4.5.2 # Apache-2.0 python-cyborgclient>=1.2.1 # Apache-2.0 python-designateclient>=2.7.0 # Apache-2.0 python-heatclient>=1.10.0 # Apache-2.0 python-ironicclient>=2.3.0 # Apache-2.0 python-ironic-inspector-client>=1.5.0 # Apache-2.0 python-magnumclient>=2.3.0 # Apache-2.0 python-manilaclient>=2.0.0 # Apache-2.0 python-mistralclient!=3.2.0,>=3.1.0 # Apache-2.0 python-neutronclient>=6.7.0 # Apache-2.0 python-octaviaclient>=1.11.0 # Apache-2.0 python-troveclient>=3.1.0 # Apache-2.0 python-watcherclient>=2.5.0 # Apache-2.0 python-zaqarclient>=1.0.0 # Apache-2.0 python-zunclient>=3.6.0 # Apache-2.0 ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9241114 python_openstackclient-8.1.1.dev14/doc/source/0000775000175100017510000000000015033046512020406 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9241114 python_openstackclient-8.1.1.dev14/doc/source/_extra/0000775000175100017510000000000015033046512021670 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/_extra/.htaccess0000664000175100017510000000261215033046464023475 0ustar00mylesmyles# Redirect docs from the old to new location following the Great Docs Migration of 2017 redirectmatch 301 ^/python-openstackclient/([^/]+)/command-objects/([^/.]+).html$ /python-openstackclient/$1/cli/command-objects/$2.html redirectmatch 301 ^/python-openstackclient/([^/]+)/(authentication|backward-incompatible|command-list|commands|decoder|interactive).html$ /python-openstackclient/$1/cli/$2.html redirectmatch 301 ^/python-openstackclient/([^/]+)/plugin-commands.html$ /python-openstackclient/$1/cli/plugin-commands/index.html redirectmatch 301 ^/python-openstackclient/([^/]+)/specs/([^/.]+).html$ /python-openstackclient/$1/contributor/specs/$2.html redirectmatch 301 ^/python-openstackclient/([^/]+)/(command-(beta|errors|logs|options|wrappers)|developing|humaninterfaceguide|plugins).html$ /python-openstackclient/$1/contributor/$2.html redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/plugin-commands.html$ /python-openstackclient/$1/cli/plugin-commands/index.html # For common subcommand names: # - identity pages were split into -v2 and -v3 # - image pages were split into -v1 and -v2 # The unversioned page is hidden but contains links to the versioned pages so links in the wild redirect somewhere sane. redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(ec2-credentials|endpoint|image|project|role|service|token|user).html$ /python-openstackclient/$1/cli/_hidden/$2.html ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9241114 python_openstackclient-8.1.1.dev14/doc/source/cli/0000775000175100017510000000000015033046512021155 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9241114 python_openstackclient-8.1.1.dev14/doc/source/cli/_hidden/0000775000175100017510000000000015033046512022547 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/_hidden/ec2-credentials.rst0000664000175100017510000000053615033046464026257 0ustar00mylesmyles=============== ec2 credentials =============== .. NOTE(efried): This page is hidden from the main TOC; it's here so links in the wild redirect somewhere sane, because previously identity v2 and v3 were combined in a single page. .. toctree:: :maxdepth: 2 ../command-objects/ec2-credentials-v2 ../command-objects/ec2-credentials-v3 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/_hidden/endpoint.rst0000664000175100017510000000047315033046464025133 0ustar00mylesmyles======== endpoint ======== .. NOTE(efried): This page is hidden from the main TOC; it's here so links in the wild redirect somewhere sane, because previously identity v2 and v3 were combined in a single page. .. toctree:: :maxdepth: 2 ../command-objects/endpoint-v2 ../command-objects/endpoint-v3 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/_hidden/image.rst0000664000175100017510000000045115033046464024371 0ustar00mylesmyles===== image ===== .. NOTE(efried): This page is hidden from the main TOC; it's here so links in the wild redirect somewhere sane, because previously image v2 and v3 were combined in a single page. .. toctree:: :maxdepth: 2 ../command-objects/image-v1 ../command-objects/image-v2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/_hidden/project.rst0000664000175100017510000000046615033046464024763 0ustar00mylesmyles======= project ======= .. NOTE(efried): This page is hidden from the main TOC; it's here so links in the wild redirect somewhere sane, because previously identity v2 and v3 were combined in a single page. .. toctree:: :maxdepth: 2 ../command-objects/project-v2 ../command-objects/project-v3 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/_hidden/role.rst0000664000175100017510000000044715033046464024255 0ustar00mylesmyles==== role ==== .. NOTE(efried): This page is hidden from the main TOC; it's here so links in the wild redirect somewhere sane, because previously identity v2 and v3 were combined in a single page. .. toctree:: :maxdepth: 2 ../command-objects/role-v2 ../command-objects/role-v3 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/_hidden/service.rst0000664000175100017510000000046615033046464024755 0ustar00mylesmyles======= service ======= .. NOTE(efried): This page is hidden from the main TOC; it's here so links in the wild redirect somewhere sane, because previously identity v2 and v3 were combined in a single page. .. toctree:: :maxdepth: 2 ../command-objects/service-v2 ../command-objects/service-v3 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/_hidden/token.rst0000664000175100017510000000045415033046464024432 0ustar00mylesmyles===== token ===== .. NOTE(efried): This page is hidden from the main TOC; it's here so links in the wild redirect somewhere sane, because previously identity v2 and v3 were combined in a single page. .. toctree:: :maxdepth: 2 ../command-objects/token-v2 ../command-objects/token-v3 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/_hidden/user.rst0000664000175100017510000000044715033046464024272 0ustar00mylesmyles==== user ==== .. NOTE(efried): This page is hidden from the main TOC; it's here so links in the wild redirect somewhere sane, because previously identity v2 and v3 were combined in a single page. .. toctree:: :maxdepth: 2 ../command-objects/user-v2 ../command-objects/user-v3 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/authentication.rst0000664000175100017510000002645215033046464024745 0ustar00mylesmyles.. _authentication: ============== Authentication ============== OpenStackClient leverages `python-keystoneclient`_ authentication plugins to support a number of different authentication methods. .. _`python-keystoneclient`: https://docs.openstack.org/python-keystoneclient/latest/using-sessions.html#sharing-authentication-plugins Authentication Process ---------------------- The user provides some number of authentication credential options. If an authentication type is not provided (``--os-auth-type``), the authentication options are examined to determine if one of the default types can be used. If no match is found an error is reported and OSC exits. Note that the authentication call to the Identity service has not yet occurred. It is deferred until the last possible moment in order to reduce the number of unnecessary queries to the server, such as when further processing detects an invalid command. Authentication Plugins ---------------------- The Keystone client library implements the base set of plugins. Additional plugins may be available from the Keystone project or other sources. There are at least three authentication types that are always available: * **Password**: A project, username and password are used to identify the user. An optional domain may also be included. This is the most common type and is the default any time a username is supplied. An authentication URL for the Identity service is also required. [Required: ``--os-auth-url``, ``--os-project-name``, ``--os-username``; Optional: ``--os-password``] * **Token**: This is slightly different from the usual token authentication in that a token and an authentication URL are supplied and the plugin retrieves a new token. [Required: ``--os-auth-url``, ``--os-token``] * **Others**: Other authentication plugins such as SAML, Kerberos, and OAuth1.0 are under development and also supported. To use them, they must be selected by supplying the ``--os-auth-type`` option. Detailed Process ---------------- The authentication process in OpenStackClient is all contained in and handled by the ``ClientManager`` object. * On import ``api.auth``: * obtains the list of installed Keystone authentication plugins from the ``keystoneclient.auth.plugin`` entry point. * builds a list of authentication options from the plugins. * The command line arguments are processed and a configuration is loaded from :file:`clouds.yaml` if ``--os-cloud`` is provided. * A new ``ClientManager`` is created and supplied with the set of options from the command line, environment and/or :file:`clouds.yaml`: * If ``--os-auth-type`` is provided and is a valid and available plugin it is used. * If ``--os-auth-type`` is not provided an authentication plugin is selected based on the existing options. This is a short-circuit evaluation, the first match wins. * If ``--os-username`` is supplied ``password`` is selected * If ``--os-token`` is supplied ``token`` is selected * If no selection has been made by now exit with error * Load the selected plugin class. * When an operation that requires authentication is attempted ``ClientManager`` makes the actual initial request to the Identity service. * if ``--os-auth-url`` is not supplied for any of the types except Token/Endpoint, exit with an error. Authenticating using Identity Server API v3 ------------------------------------------- To authenticate against an Identity Server API v3, the ``OS_IDENTITY_API_VERSION`` environment variable or ``--os-identity-api-version`` option must be changed to ``3``, instead of the default ``2.0``. Similarly ``OS_AUTH_URL`` or ``os-auth-url`` should also be updated. .. code-block:: bash $ export OS_IDENTITY_API_VERSION=3 (Defaults to 2.0) $ export OS_AUTH_URL=http://localhost:5000/v3 Since Identity API v3 authentication is a bit more complex, there are additional options that may be set, either as command line options or environment variables. The most common case will be a user supplying both user name and password, along with the project name; previously in v2.0 this would be sufficient, but since the Identity API v3 has a ``Domain`` component, we need to tell the client in which domain the user and project exists. If using a user name and password to authenticate, specify either it's owning domain name or ID. * ``--os-user-domain-name`` or ``OS_USER_DOMAIN_NAME`` * ``--os-user-domain-id`` or ``OS_USER_DOMAIN_ID`` If using a project name as authorization scope, specify either it's owning domain name or ID. * ``--os-project-domain-name`` or ``OS_PROJECT_DOMAIN_NAME`` * ``--os-project-domain-id`` or ``OS_PROJECT_DOMAIN_ID`` If using a domain as authorization scope, set either it's name or ID. * ``--os-domain-name`` or ``OS_DOMAIN_NAME`` * ``--os-domain-id`` or ``OS_DOMAIN_ID`` Note that if the user and project share the same domain, then simply setting ``--os-default-domain`` or ``OS_DEFAULT_DOMAIN`` to the domain ID is sufficient. Thus, a minimal set of environment variables would be: .. code-block:: bash $ export OS_IDENTITY_API_VERSION=3 $ export OS_AUTH_URL=http://localhost:5000/v3 $ export OS_DEFAULT_DOMAIN=default $ export OS_USERNAME=admin $ export OS_PASSWORD=secret $ export OS_PROJECT_NAME=admin Federated users support ----------------------- The OpenStackClient also allows the use of Federated users to log in. It enables one to use the identity providers credentials such as Google or Facebook to log in the OpenStackClient instead of using the Keystone credentials. This is useful in a Federated environment where one credential give access to many applications/services that the Federation supports. To check how to configure the OpenStackClient to allow Federated users to log in, please check the :ref:`Authentication using federation. ` Examples -------- .. todo: It would be nice to add more examples here, particularly for complicated things like oauth2 ``v3password`` ~~~~~~~~~~~~~~ Using ``clouds.yaml``: .. code-block:: yaml clouds: demo: auth: auth_url: http://openstack.dev/identity project_name: demo project_domain_name: default user_domain_name: default username: demo password: password auth_type: v3password or, using command line options: .. code-block:: bash $ openstack \ --os-auth-url "http://openstack.dev/identity" \ --os-project-name demo \ --os-project-domain-name default \ --os-user-domain-name default \ --os-auth-type=v3password \ --os-username demo \ --os-password password \ server list or, using environment variables: .. code-block:: bash $ export OS_AUTH_URL="http://openstack.dev/identity" $ export OS_PROJECT_NAME=demo $ export OS_PROJECT_DOMAIN_NAME=default $ export OS_AUTH_TYPE=v3password $ export OS_USERNAME=demo $ export OS_PASSWORD=password $ openstack server list .. note:: If a password is not provided, you will be prompted for one. ``v3applicationcredential`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Using ``clouds.yaml``: .. code-block:: yaml clouds: demo: auth: auth_url: http://openstack.dev/identity application_credential_id: ${APP_CRED_ID} application_credential_secret: ${APP_CRED_SECRET} auth_type: v3applicationcredential or, using command line options: .. code-block:: bash $ openstack \ --os-auth-url "http://openstack.dev/identity" \ --os-auth-type=v3applicationcredential \ --os-application-credential-id=${APP_CRED_ID} \ --os-application-credential-secret=${APP_CRED_SECRET} server list or, using environment variables: .. code-block:: bash $ export OS_AUTH_URL="http://openstack.dev/identity" $ export OS_AUTH_TYPE=v3applicationcredential $ export OS_APPLICATION_CREDENTIAL_ID=${APP_CRED_ID} $ export OS_APPLICATION_CREDENTIAL_SECRET=${APP_CRED_SECRET} $ openstack server list .. note:: You can generate application credentials using the :program:`openstack application credential create` command: .. code-block:: bash $ readarray -t lines <<< $(openstack application credential create test -f value -c id -c secret) $ APP_CRED_ID=${lines[0]} $ APP_CRED_SECRET=${lines[1]} ``v3token`` ~~~~~~~~~~~ Using ``clouds.yaml``: .. code-block:: yaml clouds: demo: auth: auth_url: http://openstack.dev/identity project_name: demo project_domain_name: default token: ${TOKEN} auth_type: v3token or, using command line options: .. code-block:: bash $ openstack \ --os-auth-url "http://openstack.dev/identity" \ --os-project-name demo \ --os-project-domain-name default \ --os-auth-type=v3token \ --os-token ${TOKEN} \ server list or, using environment variables: .. code-block:: bash $ export OS_AUTH_URL="http://openstack.dev/identity" $ export OS_PROJECT_NAME=demo $ export OS_PROJECT_DOMAIN_NAME=default $ export OS_AUTH_TYPE=v3token $ export OS_TOKEN=${TOKEN} $ openstack server list .. note:: You can generate tokens using the :program:`openstack token issue` command: .. code-block:: bash $ TOKEN=$(openstack token issue -f value -c id) ``v3totp`` ~~~~~~~~~~ .. note:: The TOTP mechanism is poorly suited to command line-driven API interactions. Where the TOTP mechanism is configured for a cloud, it is expected that it is to be used for initial authentication and to create a token or application credential, which can then be used for future interactions. .. note:: The TOTP mechanism is often combined with other mechanisms to enable Multi-Factor Authentication, or MFA. The authentication type ``v3multifactor`` is used in this case, while the ``v3totp`` authentication type is specified alongside the other mechanisms in ``auth_methods``. Using ``clouds.yaml``: .. code-block:: yaml clouds: demo: auth: auth_url: http://openstack.dev/identity project_name: demo project_domain_name: default user_domain_name: default username: demo passcode: ${PASSCODE} auth_type: v3totp or, using command line options: .. code-block:: bash $ openstack \ --os-auth-url "http://openstack.dev/identity" \ --os-project-name demo \ --os-project-domain-name default \ --os-user-domain-name default \ --os-auth-type=v3totp \ --os-username demo \ --os-passcode ${PASSCODE} \ server list or, using environment variables: .. code-block:: bash $ export OS_AUTH_URL="http://openstack.dev/identity" $ export OS_PROJECT_NAME=demo $ export OS_PROJECT_DOMAIN_NAME=default $ export OS_AUTH_TYPE=v3totp $ export OS_USERNAME=demo $ export OS_PASSCODE=${PASSCODE} $ openstack server list .. note:: The passcode will be generated by an authenticator application such FreeOTP or Google Authenticator. Refer to your cloud provider's documentation for information on how to configure an authenticator application, or to the `Keystone documentation`__ if you are configuring this for your own cloud. .. __: https://docs.openstack.org/keystone/latest/admin/auth-totp.html .. note:: If a passcode is not provided, you will be prompted for one. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/backwards-incompatible.rst0000664000175100017510000003301415033046464026323 0ustar00mylesmyles============================== Backwards Incompatible Changes ============================== Despite our best efforts, sometimes the OpenStackClient team may introduce a backwards incompatible change. For user convenience we are tracking any such changes here (as of the 1.0.0 release). Should positional arguments for a command need to change, the OpenStackClient team attempts to make the transition as painless as possible. Look for deprecation warnings that indicate the new commands (or options) to use. Commands labeled as a beta according to :ref:`command-beta` are exempt from this backwards incompatible change handling. Backwards Incompatible Changes ============================== Release 4.0 ----------- 1. Remove ``ip fixed add|remove`` commands. Use ``server add|remove fixed ip`` commands instead. * Removed in: 4.0 * Commit: https://review.opendev.org/612781 2. Remove ``ip floating add|remove`` commands. Use ``server add|remove floating ip`` commands instead. * Removed in: 4.0 * Commit: https://review.opendev.org/612781 3. Remove ``service create`` option ``--type``. Service type is a positional argument. * Removed in: 4.0 * Commit: https://review.opendev.org/612798 4. Remove ``role list`` options ``--project`` and ``--user``. Use ``role assignment list`` options ``--project`` and ``--user`` instead. * Removed in: 4.0 * Commit: https://review.opendev.org/612798 5. Remove ``user role list`` command. Use ``role assignment list`` options ``--project`` and ``--user`` instead. * Removed in: 4.0 * Commit: https://review.opendev.org/612798 6. Remove ``image create|set`` option ``--owner``. Use ``--project`` option instead. * Removed in: 4.0 * Commit: https://review.opendev.org/659431 7. Remove ``port create|set`` options ``--device-id`` and ``--host-id``. Use ``--device`` and ``--host`` instead. * Removed in: 4.0 * Commit: https://review.opendev.org/613644 8. Remove ``router set`` option ``--clear-routes``. Use ``no-route`` option instead. * Removed in: 4.0 * Commit: https://review.opendev.org/613644 9. Remove ``security group rule create`` options ``--src-ip`` and ``--src-group``. Use ``--remote-ip`` and ``--remote-group`` options instead. * Removed in: 4.0 * Commit: https://review.opendev.org/613644 10. Remove ``backup`` commands. Use ``volume backup`` commands instead. * Removed in: 4.0 * Commit: https://review.opendev.org/612751 11. Remove ``snapshot`` commands. Use ``volume snapshot`` commands instead. * Removed in: 4.0 * Commit: https://review.opendev.org/612751 12. Remove ``volume create`` options ``--project``, ``--user``, ``--multi-attach``. * Removed in: 4.0 * Commit: https://review.opendev.org/612751 13. Change ``volume transfer request accept`` to use new option ``--auth-key`` rather than a second positional argument. * Removed in: 4.0 * Commit: https://review.opendev.org/612751 14. Remove 'Token/Endpoint' auth plugin support (type ``token_endpoint``). This remained as a compatibility for the ``admin_token`` auth type to support the ``--url`` global option. That option is also now removed, use ``--endpoint`` instead. * Removed in: 4.0 * Commit: https://review.opendev.org/ Release 3.12 ------------ 1. Replace ``Display Name`` by ``Name`` in volume list. 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. * In favor of: ``openstack volume list -c Name`` * As of: 3.12.0 * Removed in: n/a * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1657956 * Commit: https://review.opendev.org/#/c/423081/ Release 3.10 ------------ 1. The ``network create`` command now requires the ``--subnet`` option when used with nova-network clouds. * As of: 3.10 * Commit: https://review.opendev.org/460679 2. The positional argument ```` of the ``volume snapshot create`` command is no longer optional. Previously when the ``--volume`` option was present ```` defaulted to the ``--volume`` value. When the ``--volume`` option is not present now it defaults to the value of ````. * As of: 3.10 * Bug: 1659894 * Commit: https://review.opendev.org/440497 Release 3.0 ----------- 1. Remove the ``osc_password`` authentication plugin. This was the 'last-resort' plugin default that worked around an old default Keystone configuration for the ``admin_endpoint`` and ``public_endpoint``. * In favor of: ``password`` * As of: 3.0 * Removed in: n/a * Bug: n/a * Commit: https://review.opendev.org/332938 Releases Before 3.0 ------------------- 1. Rename command `openstack project usage list` The `project` part of the command was pointless. * In favor of: `openstack usage list` instead. * As of: 1.0.2 * Removed in: TBD * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1406654 * Commit: https://review.opendev.org/#/c/147379/ 2. should not be optional for command `openstack service create` Previously, the command was `openstack service create --type `, whereas now it is: `openstack service create --name `. This bug also affected python-keystoneclient, and keystone. * In favor of: making a positional argument. * As of: 1.0.2 * Removed in: TBD * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1404073 * Commit: https://review.opendev.org/#/c/143242/ 3. Command `openstack security group rule delete` now requires rule id Previously, the command was `openstack security group rule delete --proto [--src-ip --dst-port ] `, whereas now it is: `openstack security group rule delete `. * In favor of: Using `openstack security group rule delete `. * As of: 1.2.1 * Removed in: NA * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1450872 * Commit: https://review.opendev.org/#/c/179446/ 4. Command `openstack image create` does not update already existing image Previously, the image create command updated already existing image if it had same name. It disabled possibility to create multiple images with same name and lead to potentially unwanted update of existing images by image create command. Now, update code was moved from create action to set action. * In favor of: Create multiple images with same name (as glance does). * As of: 1.5.0 * Removed in: NA * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1461817 * Commit: https://review.opendev.org/#/c/194654/ 5. Command `openstack network list --dhcp` has been removed The --dhcp option to network list is not a logical use case of listing networks, it lists agents. Another command should be added in the future to provide this functionality. It is highly unlikely anyone uses this feature as we don't support any other agent commands. Use neutron dhcp-agent-list-hosting-net command instead. * In favor of: Create network agent list command in the future * As of: 1.6.0 * Removed in: NA * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/472613 * Commit: https://review.opendev.org/#/c/194654/ 6. Plugin interface change for default API versions Previously, the default version was set in the parsed arguments, but this makes it impossible to tell what has been passed in at the command line, set in an environment variable or is just the default. Now, the module should have a DEFAULT_API_VERSION that contains the value and it will be set after command line argument, environment and OCC file processing. * In favor of: DEFAULT_API_VERSION * As of: 1.2.1 * Removed in: NA * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1453229 * Commit: https://review.opendev.org/#/c/181514/ 7. `image set` commands will no longer return the modified resource Previously, modifying an image would result in the new image being displayed to the user. To keep things consistent with other `set` commands, we will no longer be showing the modified resource. * In favor of: Use `set` then `show` * As of: NA * Removed in: NA * Bug: NA * Commit: NA 8. `region` commands no longer support `url` The Keystone team removed support for the `url` attribute from the client and server side. Changes to the `create`, `set` and `list` commands for regions have been affected. * In favor of: NA * As of 1.9.0 * Removed in: NA * Bug: https://launchpad.net/bugs/1506841 * Commit: https://review.opendev.org/#/c/236736/ 9. `flavor set/unset` commands will no longer return the modified resource Previously, modifying a flavor would result in the new flavor being displayed to the user. To keep things consistent with other `set/unset` commands, we will no longer be showing the modified resource. * In favor of: Use `set/unset` then `show` * As of: NA * Removed in: NA * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 * Commit: https://review.opendev.org/#/c/280663/ 10. `security group set` commands will no longer return the modified resource Previously, modifying a security group would result in the new security group being displayed to the user. To keep things consistent with other `set` commands, we will no longer be showing the modified resource. * In favor of: Use `set` then `show` * As of: NA * Removed in: NA * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 * Commit: https://review.opendev.org/#/c/281087/ 11. `compute agent set` commands will no longer return the modified resource Previously, modifying an agent would result in the new agent being displayed to the user. To keep things consistent with other `set` commands, we will no longer be showing the modified resource. * In favor of: Use `set` then `show` * As of: NA * Removed in: NA * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 * Commit: https://review.opendev.org/#/c/281088/ 12. ` ` should be optional for command `openstack compute agent set` Previously, the command was `openstack compute agent set `, whereas now it is: `openstack compute agent set --version --url --md5hash `. * In favor of: making optional. * As of: NA * Removed in: NA * Bug: NA * Commit: https://review.opendev.org/#/c/328819/ 13. `aggregate set` commands will no longer return the modified resource Previously, modifying an aggregate would result in the new aggregate being displayed to the user. To keep things consistent with other `set` commands, we will no longer be showing the modified resource. * In favor of: Use `set` then `show` * As of: NA * Removed in: NA * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 * Commit: https://review.opendev.org/#/c/281089/ 14. Output of `ip floating list` command has changed. When using Compute v2, the original output is: .. code-block:: bash # ip floating list +----+--------+------------+----------+-------------+ | ID | Pool | IP | Fixed IP | Instance ID | +----+--------+-----------------------+-------------+ | 1 | public | 172.24.4.1 | None | None | +----+--------+------------+----------+-------------+ Now it changes to: .. code-block:: bash # ip floating list +----+---------------------+------------------+-----------+--------+ | ID | Floating IP Address | Fixed IP Address | Server ID | Pool | +----+---------------------+------------------+-----------+--------+ | 1 | 172.24.4.1 | None | None | public | +----+---------------------+------------------+-----------+--------+ When using Network v2, which is different from Compute v2. The output is: .. code-block:: bash # ip floating list +--------------------------------------+---------------------+------------------+------+ | ID | Floating IP Address | Fixed IP Address | Port | +--------------------------------------+---------------------+------------------+------+ | 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3 | None | None | +--------------------------------------+---------------------+------------------+------+ * In favor of: Use `ip floating list` command * As of: NA * Removed in: NA * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1519502 * Commit: https://review.opendev.org/#/c/277720/ For Developers ============== If introducing a backwards incompatible change, then add the tag: ``BackwardsIncompatibleImpact`` to your git commit message, and if possible, update this file. To review all changes that are affected, use the following query: https://review.opendev.org/#/q/project:openstack/python-openstackclient+AND+message:BackwardsIncompatibleImpact,n,z ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-list.rst0000664000175100017510000000017015033046464024302 0ustar00mylesmyles.. _command-list: ============ Command List ============ .. toctree:: :glob: :maxdepth: 2 command-objects/* ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9291112 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/0000775000175100017510000000000015033046512024222 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/access-rules.rst0000664000175100017510000000105615033046464027355 0ustar00mylesmyles=========== access rule =========== Identity v3 Access rules are fine-grained permissions for application credentials. An access rule comprises of a service type, a request path, and a request method. Access rules may only be created as attributes of application credentials, but they may be viewed and deleted independently. .. autoprogram-cliff:: openstack.identity.v3 :command: access rule delete .. autoprogram-cliff:: openstack.identity.v3 :command: access rule list .. autoprogram-cliff:: openstack.identity.v3 :command: access rule show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/access-token.rst0000664000175100017510000000050615033046464027342 0ustar00mylesmyles============ access token ============ An **access token** is used by the Identity service's OS-OAUTH1 extension. It is used by the **consumer** to request new Identity API tokens on behalf of the authorizing **user**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: access token create ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/address-group.rst0000664000175100017510000000044115033046464027540 0ustar00mylesmyles============= address group ============= An **address group** is a group of IPv4 or IPv6 address blocks which could be referenced as a remote source or destination when creating a security group rule. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: address group * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/address-scope.rst0000664000175100017510000000037715033046464027525 0ustar00mylesmyles============= address scope ============= An **address scope** is a scope of IPv4 or IPv6 addresses that belongs to a given project and may be shared between projects. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: address scope * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/aggregate.rst0000664000175100017510000000030315033046464026704 0ustar00mylesmyles========= aggregate ========= Host aggregates provide a mechanism to group hosts according to certain criteria. Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: aggregate * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/application-credentials.rst0000664000175100017510000000061315033046464031560 0ustar00mylesmyles====================== application credential ====================== Identity v3 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. .. autoprogram-cliff:: openstack.identity.v3 :command: application credential * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/availability-zone.rst0000664000175100017510000000042415033046464030405 0ustar00mylesmyles================= availability zone ================= An **availability zone** is a logical partition of cloud block storage, compute and network services. Block Storage v2, Compute v2, Network v2 .. autoprogram-cliff:: openstack.common :command: availability zone list ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/block-storage-cleanup.rst0000664000175100017510000000021315033046464031137 0ustar00mylesmyles============= block storage ============= Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: block storage cleanup ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/block-storage-cluster.rst0000664000175100017510000000024515033046464031176 0ustar00mylesmyles===================== block storage cluster ===================== Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: block storage cluster * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/block-storage-log-level.rst0000664000175100017510000000025515033046464031404 0ustar00mylesmyles======================= Block Storage Log Level ======================= Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: block storage log level * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/block-storage-manage.rst0000664000175100017510000000041715033046464030746 0ustar00mylesmyles==================== Block Storage Manage ==================== Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: block storage volume manageable list .. autoprogram-cliff:: openstack.volume.v3 :command: block storage snapshot manageable list ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/block-storage-resource-filter.rst0000664000175100017510000000030515033046464032624 0ustar00mylesmyles============================= block storage resource filter ============================= Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: block storage resource filter * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/catalog.rst0000664000175100017510000000030715033046464026374 0ustar00mylesmyles======= catalog ======= A **catalog** lists OpenStack services that are available on the cloud. Applicable to Identity v2 and v3 .. autoprogram-cliff:: openstack.identity.v3 :command: catalog * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/command.rst0000664000175100017510000000020715033046464026377 0ustar00mylesmyles======= command ======= Internal Installed commands in the OSC process. .. autoprogram-cliff:: openstack.cli :command: command * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/complete.rst0000664000175100017510000000164215033046464026575 0ustar00mylesmyles======== complete ======== The ``complete`` command is inherited from the `python-cliff` library, it can be used to generate a bash-completion script. Currently, the command will generate a script for bash versions 3 or 4. The bash-completion script is printed directly to standard out. Typical usage for this command is:: openstack complete | sudo tee /etc/bash_completion.d/osc.bash_completion > /dev/null It is highly recommended to install ``python-openstackclient`` from a package (``apt-get`` or ``yum``). In some distributions the package ``bash-completion`` is shipped as dependency, and the `openstack complete` command will be run as a post-install action, however not every distribution include this dependency and you might need to install ``bash-completion`` package to enable autocomplete feature. complete -------- print bash completion command .. program:: complete .. code:: bash openstack complete ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/compute-agent.rst0000664000175100017510000000020015033046464027522 0ustar00mylesmyles============= compute agent ============= Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: compute agent * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/compute-service.rst0000664000175100017510000000021015033046464030065 0ustar00mylesmyles=============== compute service =============== Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: compute service * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/configuration.rst0000664000175100017510000000025015033046464027626 0ustar00mylesmyles============= configuration ============= Available for all services .. _configuration-show: .. autoprogram-cliff:: openstack.common :command: configuration show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/consistency-group-snapshot.rst0000664000175100017510000000071715033046464032317 0ustar00mylesmyles========================== consistency group snapshot ========================== Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group snapshot create .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group snapshot delete .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group snapshot list .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group snapshot show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/consistency-group.rst0000664000175100017510000000121615033046464030455 0ustar00mylesmyles================= consistency group ================= Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group add volume .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group create .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group delete .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group list .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group remove volume .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group set .. autoprogram-cliff:: openstack.volume.v3 :command: consistency group show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/console-connection.rst0000664000175100017510000000027615033046464030566 0ustar00mylesmyles================== console connection ================== Server console connection information Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: console connection show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/console-log.rst0000664000175100017510000000022215033046464027177 0ustar00mylesmyles=========== console log =========== Server console text dump Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: console log * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/console-url.rst0000664000175100017510000000022315033046464027221 0ustar00mylesmyles=========== console url =========== Server remote console URL Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: console url * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/consumer.rst0000664000175100017510000000040315033046464026612 0ustar00mylesmyles======== consumer ======== An **consumer** is used by the Identity service's OS-OAUTH1 extension. It is used to create a **request token** and **access token**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: consumer * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/container.rst0000664000175100017510000000122715033046464026746 0ustar00mylesmyles========= container ========= A **container** defines a namespace for **objects**. Applies to Object Storage v1 .. autoprogram-cliff:: openstack.object_store.v1 :command: container create .. autoprogram-cliff:: openstack.object_store.v1 :command: container delete .. autoprogram-cliff:: openstack.object_store.v1 :command: container list .. autoprogram-cliff:: openstack.object_store.v1 :command: container save .. autoprogram-cliff:: openstack.object_store.v1 :command: container set .. autoprogram-cliff:: openstack.object_store.v1 :command: container show .. autoprogram-cliff:: openstack.object_store.v1 :command: container unset ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/credential.rst0000664000175100017510000000016615033046464027077 0ustar00mylesmyles========== credential ========== Identity v3 .. autoprogram-cliff:: openstack.identity.v3 :command: credential * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/default-security-group-rule.rst0000664000175100017510000000053115033046464032351 0ustar00mylesmyles=========================== default security group rule =========================== A **default security group rule** specifies the template of the security group rules which will be used by neutron to create rules in every new security group. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: default security group rule * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/domain.rst0000664000175100017510000000104015033046464026224 0ustar00mylesmyles====== domain ====== A **domain** is a collection of **users**, **groups**, and **projects**. Each **group** and **project** is owned by exactly one **domain**. Applies to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: domain create .. autoprogram-cliff:: openstack.identity.v3 :command: domain delete .. autoprogram-cliff:: openstack.identity.v3 :command: domain list .. autoprogram-cliff:: openstack.identity.v3 :command: domain set .. autoprogram-cliff:: openstack.identity.v3 :command: domain show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/ec2-credentials-v2.rst0000664000175100017510000000024715033046464030256 0ustar00mylesmyles============================= ec2 credentials (Identity v2) ============================= .. autoprogram-cliff:: openstack.identity.v2 :command: ec2 credentials * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/ec2-credentials-v3.rst0000664000175100017510000000024715033046464030257 0ustar00mylesmyles============================= ec2 credentials (Identity v3) ============================= .. autoprogram-cliff:: openstack.identity.v3 :command: ec2 credentials * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/endpoint-v2.rst0000664000175100017510000000021315033046464027123 0ustar00mylesmyles====================== endpoint (Identity v2) ====================== .. autoprogram-cliff:: openstack.identity.v2 :command: endpoint * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/endpoint-v3.rst0000664000175100017510000000113015033046464027123 0ustar00mylesmyles====================== endpoint (Identity v3) ====================== .. autoprogram-cliff:: openstack.identity.v3 :command: endpoint add project .. autoprogram-cliff:: openstack.identity.v3 :command: endpoint create .. autoprogram-cliff:: openstack.identity.v3 :command: endpoint delete .. autoprogram-cliff:: openstack.identity.v3 :command: endpoint list .. autoprogram-cliff:: openstack.identity.v3 :command: endpoint remove project .. autoprogram-cliff:: openstack.identity.v3 :command: endpoint set .. autoprogram-cliff:: openstack.identity.v3 :command: endpoint show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/endpoint_group.rst0000664000175100017510000000043615033046464030021 0ustar00mylesmyles============== endpoint group ============== A **endpoint group** is used to create groups of endpoints that then can be used to filter the endpoints that are available to a project. Applicable to Identity v3 .. autoprogram-cliff:: openstack.identity.v3 :command: endpoint group * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/extension.rst0000664000175100017510000000027215033046464026777 0ustar00mylesmyles========= extension ========= Many OpenStack server APIs include API extensions that enable additional functionality. .. autoprogram-cliff:: openstack.common :command: extension * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/federation-domain-project.rst0000664000175100017510000000037215033046464032015 0ustar00mylesmyles========================= federation domain/project ========================= Identity v3 .. autoprogram-cliff:: openstack.identity.v3 :command: federation domain * .. autoprogram-cliff:: openstack.identity.v3 :command: federation project * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/federation-protocol.rst0000664000175100017510000000046515033046464030746 0ustar00mylesmyles=================== federation protocol =================== A **federation protocol** is used by the Identity service's OS-FEDERATION extension. It is used by **identity providers** and **mappings**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: federation protocol * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/flavor.rst0000664000175100017510000000014415033046464026252 0ustar00mylesmyles====== flavor ====== Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: flavor * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/floating-ip-pool.rst0000664000175100017510000000021415033046464030137 0ustar00mylesmyles================ floating ip pool ================ Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: floating ip pool * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/floating-ip-port-forwarding.rst0000664000175100017510000000027115033046464032315 0ustar00mylesmyles=========================== floating ip port forwarding =========================== Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: floating ip port forwarding * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/floating-ip.rst0000664000175100017510000000116515033046464027176 0ustar00mylesmyles=========== floating ip =========== Network v2 .. NOTE(efried): have to list these out one by one; 'floating ip' pulls in ... pool and ... port forwarding. .. autoprogram-cliff:: openstack.network.v2 :command: floating ip create .. autoprogram-cliff:: openstack.network.v2 :command: floating ip delete .. autoprogram-cliff:: openstack.network.v2 :command: floating ip list .. autoprogram-cliff:: openstack.network.v2 :command: floating ip set .. autoprogram-cliff:: openstack.network.v2 :command: floating ip show .. autoprogram-cliff:: openstack.network.v2 :command: floating ip unset ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/group.rst0000664000175100017510000000014215033046464026113 0ustar00mylesmyles===== group ===== Identity v3 .. autoprogram-cliff:: openstack.identity.v3 :command: group * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/host.rst0000664000175100017510000000021115033046464025731 0ustar00mylesmyles==== host ==== Compute v2 The physical computer running a hypervisor. .. autoprogram-cliff:: openstack.compute.v2 :command: host * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/hypervisor-stats.rst0000664000175100017510000000021415033046464030325 0ustar00mylesmyles================ hypervisor stats ================ Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: hypervisor stats * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/hypervisor.rst0000664000175100017510000000045215033046464027175 0ustar00mylesmyles========== hypervisor ========== Compute v2 .. NOTE(efried): have to list these out one by one; 'hypervisor *' pulls in ... stats. .. autoprogram-cliff:: openstack.compute.v2 :command: hypervisor list .. autoprogram-cliff:: openstack.compute.v2 :command: hypervisor show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/identity-provider.rst0000664000175100017510000000045615033046464030450 0ustar00mylesmyles================= identity provider ================= An **identity provider** is used by the Identity service's OS-FEDERATION extension. It is used by **federation protocols** and **mappings**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: identity provider * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/image-member.rst0000664000175100017510000000042215033046464027307 0ustar00mylesmyles============ image member ============ Image v2 .. autoprogram-cliff:: openstack.image.v2 :command: image add project .. autoprogram-cliff:: openstack.image.v2 :command: image remove project .. autoprogram-cliff:: openstack.image.v2 :command: image member list ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/image-metadef.rst0000664000175100017510000000246215033046464027453 0ustar00mylesmyles============= image metadef ============= Image v2 .. autoprogram-cliff:: openstack.image.v2 :command: image metadef namespace create .. autoprogram-cliff:: openstack.image.v2 :command: image metadef namespace delete .. autoprogram-cliff:: openstack.image.v2 :command: image metadef namespace list .. autoprogram-cliff:: openstack.image.v2 :command: image metadef namespace set .. autoprogram-cliff:: openstack.image.v2 :command: image metadef namespace show .. autoprogram-cliff:: openstack.image.v2 :command: image metadef resource type list .. autoprogram-cliff:: openstack.image.v2 :command: image metadef object create .. autoprogram-cliff:: openstack.image.v2 :command: image metadef object show .. autoprogram-cliff:: openstack.image.v2 :command: image metadef object list .. autoprogram-cliff:: openstack.image.v2 :command: image metadef object delete .. autoprogram-cliff:: openstack.image.v2 :command: image metadef object update .. autoprogram-cliff:: openstack.image.v2 :command: image metadef object property show .. autoprogram-cliff:: openstack.image.v2 :command: image metadef property create .. autoprogram-cliff:: openstack.image.v2 :command: image metadef property list .. autoprogram-cliff:: openstack.image.v2 :command: image metadef property show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/image-task.rst0000664000175100017510000000027315033046464027006 0ustar00mylesmyles========== image task ========== Image v2 .. autoprogram-cliff:: openstack.image.v2 :command: image task list .. autoprogram-cliff:: openstack.image.v2 :command: image task show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/image-v1.rst0000664000175100017510000000013315033046464026365 0ustar00mylesmyles======== image v1 ======== .. autoprogram-cliff:: openstack.image.v1 :command: image * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/image-v2.rst0000664000175100017510000000117615033046464026376 0ustar00mylesmyles===== image ===== Image v2 .. autoprogram-cliff:: openstack.image.v2 :command: image create .. autoprogram-cliff:: openstack.image.v2 :command: image delete .. autoprogram-cliff:: openstack.image.v2 :command: image list .. autoprogram-cliff:: openstack.image.v2 :command: image save .. autoprogram-cliff:: openstack.image.v2 :command: image set .. autoprogram-cliff:: openstack.image.v2 :command: image unset .. autoprogram-cliff:: openstack.image.v2 :command: image show .. autoprogram-cliff:: openstack.image.v2 :command: image stage .. autoprogram-cliff:: openstack.image.v2 :command: image import ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/implied_role.rst0000664000175100017510000000017615033046464027432 0ustar00mylesmyles============ implied role ============ Identity v3 .. autoprogram-cliff:: openstack.identity.v3 :command: implied role * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/ip-availability.rst0000664000175100017510000000021015033046464030033 0ustar00mylesmyles=============== ip availability =============== Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: ip availability * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/keypair.rst0000664000175100017510000000052715033046464026432 0ustar00mylesmyles======= keypair ======= The badly named keypair is really the public key of an OpenSSH key pair to be used for access to created servers. You can also create a private key for access to a created server by not passing any argument to the keypair create command. Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: keypair * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/limit.rst0000664000175100017510000000025715033046464026104 0ustar00mylesmyles===== limit ===== Identity v3 Limits are used to specify project-specific limits thresholds of resources. .. autoprogram-cliff:: openstack.identity.v3 :command: limit * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/limits.rst0000664000175100017510000000026715033046464026270 0ustar00mylesmyles====== limits ====== The Compute and Block Storage APIs have resource usage limits. Block Storage v2, v3; Compute v2 .. autoprogram-cliff:: openstack.common :command: limits * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/local-ip-association.rst0000664000175100017510000000052115033046464030772 0ustar00mylesmyles============================================= Local IP Associations (local_ip_associations) ============================================= The resource lets users assign Local IPs to user Ports. This is a sub-resource of the Local IP resource. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: local ip association * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/local-ip.rst0000664000175100017510000000054715033046464026470 0ustar00mylesmyles===================== Local IPs (local_ips) ===================== Extension that allows users to create a virtual IP that can later be assigned to multiple ports/VMs (similar to anycast IP) and is guaranteed to only be reachable within the same physical server/node boundaries Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: local ip * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/mapping.rst0000664000175100017510000000040415033046464026413 0ustar00mylesmyles======= mapping ======= A **mapping** is used by the Identity service's OS-FEDERATION extension. It is used by **federation protocols** and **identity providers**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: mapping *././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/module.rst0000664000175100017510000000021115033046464026241 0ustar00mylesmyles====== module ====== Internal Installed Python modules in the OSC process. .. autoprogram-cliff:: openstack.cli :command: module * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-agent.rst0000664000175100017510000000063715033046464027555 0ustar00mylesmyles============= network agent ============= A **network agent** is an agent that handles various tasks used to implement virtual networks. These agents include neutron-dhcp-agent, neutron-l3-agent, neutron-metering-agent, and neutron-lbaas-agent, among others. The agent is available when the alive status of the agent is "True". Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network agent * ././@PaxHeader0000000000000000000000000000020500000000000010212 xustar00111 path=python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-auto-allocated-topology.rst 22 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-auto-allocated-topology.rs0000664000175100017510000000100715033046464033033 0ustar00mylesmyles=============================== network auto allocated topology =============================== An **auto allocated topology** allows admins to quickly set up external connectivity for end-users. Only one auto allocated topology is allowed per project. For more information on how to set up the resources required for auto allocated topology review :neutron-doc:`the documentation `. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network auto allocated topology * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-flavor-profile.rst0000664000175100017510000000111715033046464031400 0ustar00mylesmyles====================== network flavor profile ====================== A **network flavor profile** allows administrators to create, delete, list, show and update network service profile, which details a framework to enable operators to configure and users to select from different abstract representations of a service implementation in the Networking service. It decouples the logical configuration from its instantiation enabling operators to create user options according to deployment needs. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network flavor profile * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-flavor.rst0000664000175100017510000000161315033046464027743 0ustar00mylesmyles============== network flavor ============== A **network flavor** extension allows the user selection of operator-curated flavors during resource creations. It allows administrators to create network service flavors. Network v2 .. NOTE(efried): have to list these out one by one; 'network flavor' pulls in ... profile *. .. autoprogram-cliff:: openstack.network.v2 :command: network flavor add profile .. autoprogram-cliff:: openstack.network.v2 :command: network flavor create .. autoprogram-cliff:: openstack.network.v2 :command: network flavor delete .. autoprogram-cliff:: openstack.network.v2 :command: network flavor list .. autoprogram-cliff:: openstack.network.v2 :command: network flavor remove profile .. autoprogram-cliff:: openstack.network.v2 :command: network flavor set .. autoprogram-cliff:: openstack.network.v2 :command: network flavor show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-l3-conntrack-helper.rst0000664000175100017510000000027015033046464032223 0ustar00mylesmyles=========================== network l3 conntrack helper =========================== Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network l3 conntrack helper * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-meter-rule.rst0000664000175100017510000000046115033046464030533 0ustar00mylesmyles================== network meter rule ================== A **meter rule** sets the rule for a meter to measure traffic for a specific IP range. The following uses **meter** and requires the L3 metering extension. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network meter rule * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-meter.rst0000664000175100017510000000115715033046464027571 0ustar00mylesmyles============= network meter ============= A **network meter** allows operators to measure traffic for a specific IP range. The following commands are specific to the L3 metering extension. Network v2 .. NOTE(efried): have to list these out one by one; 'network meter *' pulls in ... rule *. .. autoprogram-cliff:: openstack.network.v2 :command: network meter create .. autoprogram-cliff:: openstack.network.v2 :command: network meter delete .. autoprogram-cliff:: openstack.network.v2 :command: network meter list .. autoprogram-cliff:: openstack.network.v2 :command: network meter show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-qos-policy.rst0000664000175100017510000000036415033046464030553 0ustar00mylesmyles================== network qos policy ================== A **Network QoS policy** groups a number of Network QoS rules, applied to a network or a port. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network qos policy * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-qos-rule-type.rst0000664000175100017510000000036715033046464031205 0ustar00mylesmyles===================== network qos rule type ===================== A **Network QoS rule type** is a specific Network QoS rule type available to be used. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network qos rule type * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-qos-rule.rst0000664000175100017510000000151115033046464030216 0ustar00mylesmyles================ network qos rule ================ A **Network QoS rule** specifies a rule defined in a Network QoS policy; its type is defined by the parameter 'type'. Can be assigned, within a Network QoS policy, to a port or a network. Each Network QoS policy can contain several rules, each of them Network v2 .. NOTE(efried): have to list these out one by one; 'network qos rule *' pulls network qos rule type *. .. autoprogram-cliff:: openstack.network.v2 :command: network qos rule create .. autoprogram-cliff:: openstack.network.v2 :command: network qos rule delete .. autoprogram-cliff:: openstack.network.v2 :command: network qos rule list .. autoprogram-cliff:: openstack.network.v2 :command: network qos rule set .. autoprogram-cliff:: openstack.network.v2 :command: network qos rule show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-rbac.rst0000664000175100017510000000046415033046464027364 0ustar00mylesmyles============ network rbac ============ A **network rbac** is a Role-Based Access Control (RBAC) policy for network resources. It enables both operators and users to grant access to network resources for specific projects. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network rbac * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-segment.rst0000664000175100017510000000145615033046464030121 0ustar00mylesmyles=============== network segment =============== A **network segment** is an isolated Layer 2 segment within a network. A network may contain multiple network segments. Depending on the network configuration, Layer 2 connectivity between network segments within a network may not be guaranteed. Network v2 .. NOTE(efried): have to list these out one by one; 'network segment *' pulls ... range *. .. autoprogram-cliff:: openstack.network.v2 :command: network segment create .. autoprogram-cliff:: openstack.network.v2 :command: network segment delete .. autoprogram-cliff:: openstack.network.v2 :command: network segment list .. autoprogram-cliff:: openstack.network.v2 :command: network segment set .. autoprogram-cliff:: openstack.network.v2 :command: network segment show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-service-provider.rst0000664000175100017510000000045715033046464031747 0ustar00mylesmyles======================== network service provider ======================== A **network service provider** is a particular driver that implements a networking service Network v2 .. _network_service_provider_list: .. autoprogram-cliff:: openstack.network.v2 :command: network service provider list ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network-trunk.rst0000664000175100017510000000072115033046464027614 0ustar00mylesmyles============= network trunk ============= A **network trunk** is a container to group logical ports from different networks and provide a single trunked vNIC for servers. It consists of one parent port which is a regular VIF and multiple subports which allow the server to connect to more networks. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network subport list .. autoprogram-cliff:: openstack.network.v2 :command: network trunk * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network.rst0000664000175100017510000000202515033046464026452 0ustar00mylesmyles======= network ======= A **network** is an isolated Layer 2 networking segment. There are two types of networks, project and provider networks. Project networks are fully isolated and are not shared with other projects. Provider networks map to existing physical networks in the data center and provide external network access for servers and other resources. Only an OpenStack administrator can create provider networks. Networks can be connected via routers. Compute v2, Network v2 .. NOTE(efried): have to list these out one by one; 'network *' pulls in ... flavor *, ... qos policy *, etc. .. autoprogram-cliff:: openstack.network.v2 :command: network create .. autoprogram-cliff:: openstack.network.v2 :command: network delete .. autoprogram-cliff:: openstack.network.v2 :command: network list .. autoprogram-cliff:: openstack.network.v2 :command: network set .. autoprogram-cliff:: openstack.network.v2 :command: network show .. autoprogram-cliff:: openstack.network.v2 :command: network unset ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/network_segment_range.rst0000664000175100017510000000072515033046464031355 0ustar00mylesmyles===================== network segment range ===================== A **network segment range** is a resource for tenant network segment allocation. A network segment range exposes the segment range management to be administered via the Neutron API. In addition, it introduces the ability for the administrator to control the segment ranges globally or on a per-tenant basis. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network segment range * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/object-store-account.rst0000664000175100017510000000074415033046464031021 0ustar00mylesmyles==================== object store account ==================== An **object store account** represents the top-level of the hierarchy that is comprised of **containers** and **objects**. Applies to Object Storage v1. .. autoprogram-cliff:: openstack.object_store.v1 :command: object store account set .. autoprogram-cliff:: openstack.object_store.v1 :command: object store account show .. autoprogram-cliff:: openstack.object_store.v1 :command: object store account unset ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/object.rst0000664000175100017510000000130215033046464026224 0ustar00mylesmyles====== object ====== An **object** stores data content, such as documents, images, and so on. They can also store custom metadata with an object. Applies to Object Storage v1. .. autoprogram-cliff:: openstack.object_store.v1 :command: object create .. autoprogram-cliff:: openstack.object_store.v1 :command: object delete .. autoprogram-cliff:: openstack.object_store.v1 :command: object list .. autoprogram-cliff:: openstack.object_store.v1 :command: object save .. autoprogram-cliff:: openstack.object_store.v1 :command: object set .. autoprogram-cliff:: openstack.object_store.v1 :command: object show .. autoprogram-cliff:: openstack.object_store.v1 :command: object unset ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/policy.rst0000664000175100017510000000032715033046464026263 0ustar00mylesmyles====== policy ====== A **policy** is an arbitrarily serialized policy engine rule set to be consumed by a remote service. Applies to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: policy * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/port.rst0000664000175100017510000000050015033046464025741 0ustar00mylesmyles==== port ==== A **port** is a connection point for attaching a single device, such as the NIC of a server, to a network. The port also describes the associated network configuration, such as the MAC and IP addresses to be used on that port. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: port * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/project-cleanup.rst0000664000175100017510000000042615033046464030057 0ustar00mylesmyles=============== project cleanup =============== Clean resources associated with a specific project based on OpenStackSDK implementation Block Storage v2, v3; Compute v2; Network v2; DNS v2; Orchestrate v1 .. autoprogram-cliff:: openstack.common :command: project cleanup ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/project-v2.rst0000664000175100017510000000020715033046464026754 0ustar00mylesmyles===================== project (Identity v2) ===================== .. autoprogram-cliff:: openstack.identity.v2 :command: project * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/project-v3.rst0000664000175100017510000000020715033046464026755 0ustar00mylesmyles===================== project (Identity v3) ===================== .. autoprogram-cliff:: openstack.identity.v3 :command: project * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/quota.rst0000664000175100017510000000036315033046464026115 0ustar00mylesmyles===== quota ===== Resource quotas appear in multiple APIs, OpenStackClient presents them as a single object with multiple properties. Block Storage v1, v3; Compute v2; Network v2 .. autoprogram-cliff:: openstack.common :command: quota * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/region.rst0000664000175100017510000000042615033046464026247 0ustar00mylesmyles====== region ====== A **region** is a general division of an OpenStack deployment. You can associate zero or more sub-regions with a region to create a tree-like structured hierarchy. Applies to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: region * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/registered-limit.rst0000664000175100017510000000034615033046464030236 0ustar00mylesmyles================ registered limit ================ Identity v3 Registered limits are used to define default limits for resources within a deployment. .. autoprogram-cliff:: openstack.identity.v3 :command: registered limit * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/request-token.rst0000664000175100017510000000043115033046464027566 0ustar00mylesmyles============= request token ============= A **request token** is used by the Identity service's OS-OAUTH1 extension. It is used by the **consumer** to request **access tokens**. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: request token * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/role-assignment.rst0000664000175100017510000000022115033046464030064 0ustar00mylesmyles=============== role assignment =============== Identity v2, v3 .. autoprogram-cliff:: openstack.identity.v3 :command: role assignment list ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/role-v2.rst0000664000175100017510000000017315033046464026251 0ustar00mylesmyles================== role (Identity v2) ================== .. autoprogram-cliff:: openstack.identity.v2 :command: role * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/role-v3.rst0000664000175100017510000000017315033046464026252 0ustar00mylesmyles================== role (Identity v3) ================== .. autoprogram-cliff:: openstack.identity.v3 :command: role * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/router-ndp-proxy.rst0000664000175100017510000000053015033046464030236 0ustar00mylesmyles================= router ndp proxy ================= An **NDP proxy** publishes a internal IPv6 address to public network. With the **NDP proxy**, the IPv6 address can be accessed from external. It is similar to **Floating IP** of IPv4 in functionality. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: router ndp proxy * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/router.rst0000664000175100017510000000044615033046464026306 0ustar00mylesmyles====== router ====== A **router** is a logical component that forwards data packets between networks. It also provides Layer 3 and NAT forwarding to provide external network access for servers on project networks. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: router * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/security-group-rule.rst0000664000175100017510000000042215033046464030726 0ustar00mylesmyles=================== security group rule =================== A **security group rule** specifies the network access rules for servers and other resources on the network. Compute v2, Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: security group rule * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/security-group.rst0000664000175100017510000000147515033046464027772 0ustar00mylesmyles============== security group ============== A **security group** acts as a virtual firewall for servers and other resources on a network. It is a container for security group rules which specify the network access rules. Compute v2, Network v2 .. NOTE(efried): have to list these out one by one; 'security group *' pulls in ... rule *. .. autoprogram-cliff:: openstack.network.v2 :command: security group create .. autoprogram-cliff:: openstack.network.v2 :command: security group delete .. autoprogram-cliff:: openstack.network.v2 :command: security group list .. autoprogram-cliff:: openstack.network.v2 :command: security group set .. autoprogram-cliff:: openstack.network.v2 :command: security group show .. autoprogram-cliff:: openstack.network.v2 :command: security group unset ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/server-backup.rst0000664000175100017510000000044515033046464027536 0ustar00mylesmyles============= server backup ============= A server backup is a disk image created in the Image store from a running server instance. The backup command manages the number of archival copies to retain. Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: server backup create ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/server-event.rst0000664000175100017510000000052415033046464027410 0ustar00mylesmyles============ server event ============ Server event are event record for server operations. They consist of: type (create, delete, reboot and so on), result (success, error), start time, finish time and so on. These are important for server maintenance. Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: server event * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/server-group.rst0000664000175100017510000000031515033046464027421 0ustar00mylesmyles============ server group ============ Server groups provide a mechanism to group servers according to certain policy. Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: server group * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/server-image.rst0000664000175100017510000000036315033046464027352 0ustar00mylesmyles============ server image ============ A server image is a disk image created from a running server instance. The image is created in the Image store. Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: server image create ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/server-migration.rst0000664000175100017510000000051315033046464030256 0ustar00mylesmyles================ server migration ================ A server migration provides a way to move an instance from one host to another. There are four types of migration operation supported: live migration, cold migration, resize and evacuation. Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: server migration * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/server.rst0000664000175100017510000000400315033046464026265 0ustar00mylesmyles====== server ====== Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: server add * .. autoprogram-cliff:: openstack.compute.v2 :command: server create .. autoprogram-cliff:: openstack.compute.v2 :command: server evacuate .. autoprogram-cliff:: openstack.compute.v2 :command: server delete .. autoprogram-cliff:: openstack.compute.v2 :command: server dump create .. autoprogram-cliff:: openstack.compute.v2 :command: server list .. autoprogram-cliff:: openstack.compute.v2 :command: server lock .. autoprogram-cliff:: openstack.compute.v2 :command: server migrate* .. autoprogram-cliff:: openstack.compute.v2 :command: server pause .. autoprogram-cliff:: openstack.compute.v2 :command: server reboot .. autoprogram-cliff:: openstack.compute.v2 :command: server rebuild .. autoprogram-cliff:: openstack.compute.v2 :command: server remove * .. autoprogram-cliff:: openstack.compute.v2 :command: server rescue .. autoprogram-cliff:: openstack.compute.v2 :command: server resize* .. autoprogram-cliff:: openstack.compute.v2 :command: server restore .. autoprogram-cliff:: openstack.compute.v2 :command: server resume .. autoprogram-cliff:: openstack.compute.v2 :command: server set .. autoprogram-cliff:: openstack.compute.v2 :command: server shelve .. autoprogram-cliff:: openstack.compute.v2 :command: server show .. autoprogram-cliff:: openstack.compute.v2 :command: server ssh .. autoprogram-cliff:: openstack.compute.v2 :command: server start .. autoprogram-cliff:: openstack.compute.v2 :command: server stop .. autoprogram-cliff:: openstack.compute.v2 :command: server suspend .. autoprogram-cliff:: openstack.compute.v2 :command: server unlock .. autoprogram-cliff:: openstack.compute.v2 :command: server unpause .. autoprogram-cliff:: openstack.compute.v2 :command: server unrescue .. autoprogram-cliff:: openstack.compute.v2 :command: server unset .. autoprogram-cliff:: openstack.compute.v2 :command: server unshelve ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/service-provider.rst0000664000175100017510000000045515033046464030256 0ustar00mylesmyles================ service provider ================ A **service provider** is used by the Identity service's OS-FEDERATION extension. It is used by to register another OpenStack Identity service. Applicable to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: service provider * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/service-v2.rst0000664000175100017510000000020715033046464026746 0ustar00mylesmyles===================== service (Identity v2) ===================== .. autoprogram-cliff:: openstack.identity.v2 :command: service * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/service-v3.rst0000664000175100017510000000065515033046464026756 0ustar00mylesmyles===================== service (Identity v3) ===================== .. autoprogram-cliff:: openstack.identity.v3 :command: service create .. autoprogram-cliff:: openstack.identity.v3 :command: service delete .. autoprogram-cliff:: openstack.identity.v3 :command: service list .. autoprogram-cliff:: openstack.identity.v3 :command: service show .. autoprogram-cliff:: openstack.identity.v3 :command: service set ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/subnet-pool.rst0000664000175100017510000000035415033046464027233 0ustar00mylesmyles=========== subnet pool =========== A **subnet pool** contains a collection of prefixes in CIDR notation that are available for IP address allocation. Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: subnet pool * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/subnet.rst0000664000175100017510000000132215033046464026260 0ustar00mylesmyles====== subnet ====== A **subnet** is a block of IP addresses and associated configuration state. Subnets are used to allocate IP addresses when new ports are created on a network. Network v2 .. NOTE(efried): have to list these out one by one; 'subnet *' pulls in subnet pool *. .. autoprogram-cliff:: openstack.network.v2 :command: subnet create .. autoprogram-cliff:: openstack.network.v2 :command: subnet delete .. autoprogram-cliff:: openstack.network.v2 :command: subnet list .. autoprogram-cliff:: openstack.network.v2 :command: subnet set .. autoprogram-cliff:: openstack.network.v2 :command: subnet show .. autoprogram-cliff:: openstack.network.v2 :command: subnet unset ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/token-v2.rst0000664000175100017510000000020015033046464026417 0ustar00mylesmyles=================== token (Identity v2) =================== .. autoprogram-cliff:: openstack.identity.v2 :command: token * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/token-v3.rst0000664000175100017510000000020015033046464026420 0ustar00mylesmyles=================== token (Identity v3) =================== .. autoprogram-cliff:: openstack.identity.v3 :command: token * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/trust.rst0000664000175100017510000000036015033046464026142 0ustar00mylesmyles===== trust ===== A **trust** provide project-specific role delegation between users, with optional impersonation. Requires the OS-TRUST extension. Applies to Identity v3. .. autoprogram-cliff:: openstack.identity.v3 :command: trust * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/usage.rst0000664000175100017510000000014015033046464026061 0ustar00mylesmyles===== usage ===== Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: usage * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/user-v2.rst0000664000175100017510000000017415033046464026267 0ustar00mylesmyles================== user (Identity v2) ================== .. autoprogram-cliff:: openstack.identity.v2 :command: user * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/user-v3.rst0000664000175100017510000000017415033046464026270 0ustar00mylesmyles================== user (Identity v3) ================== .. autoprogram-cliff:: openstack.identity.v3 :command: user * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/versions.rst0000664000175100017510000000023715033046464026634 0ustar00mylesmyles======== versions ======== Get a list of every version of every service in a given cloud. .. autoprogram-cliff:: openstack.common :command: versions show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-attachment.rst0000664000175100017510000000022515033046464030416 0ustar00mylesmyles================= volume attachment ================= Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume attachment * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-backend.rst0000664000175100017510000000021515033046464027654 0ustar00mylesmyles============== volume backend ============== Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume backend * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-backup.rst0000664000175100017510000000021215033046464027527 0ustar00mylesmyles============= volume backup ============= Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume backup * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-group-snapshot.rst0000664000175100017510000000024515033046464031261 0ustar00mylesmyles===================== volume group snapshot ===================== Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume group snapshot * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-group-type.rst0000664000175100017510000000022515033046464030401 0ustar00mylesmyles================= volume group type ================= Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume group type * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-group.rst0000664000175100017510000000100215033046464027414 0ustar00mylesmyles============ volume group ============ Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume group create .. autoprogram-cliff:: openstack.volume.v3 :command: volume group delete .. autoprogram-cliff:: openstack.volume.v3 :command: volume group list .. autoprogram-cliff:: openstack.volume.v3 :command: volume group failover .. autoprogram-cliff:: openstack.volume.v3 :command: volume group set .. autoprogram-cliff:: openstack.volume.v3 :command: volume group show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-host.rst0000664000175100017510000000020115033046464027235 0ustar00mylesmyles=========== volume host =========== Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume host * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-message.rst0000664000175100017510000000021115033046464027705 0ustar00mylesmyles============== volume message ============== Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume message * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-qos.rst0000664000175100017510000000017515033046464027074 0ustar00mylesmyles========== volume qos ========== Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume qos * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-service.rst0000664000175100017510000000021515033046464027725 0ustar00mylesmyles============== volume service ============== Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume service * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-snapshot.rst0000664000175100017510000000022115033046464030121 0ustar00mylesmyles=============== volume snapshot =============== Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume snapshot * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-transfer-request.rst0000664000175100017510000000026115033046464031600 0ustar00mylesmyles======================= volume transfer request ======================= Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume transfer request * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume-type.rst0000664000175100017510000000020115033046464027241 0ustar00mylesmyles=========== volume type =========== Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume type * ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/command-objects/volume.rst0000664000175100017510000000127015033046464026271 0ustar00mylesmyles====== volume ====== Block Storage v2, v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume create .. autoprogram-cliff:: openstack.volume.v3 :command: volume delete .. autoprogram-cliff:: openstack.volume.v3 :command: volume list .. autoprogram-cliff:: openstack.volume.v3 :command: volume migrate .. autoprogram-cliff:: openstack.volume.v3 :command: volume set .. autoprogram-cliff:: openstack.volume.v3 :command: volume show .. autoprogram-cliff:: openstack.volume.v3 :command: volume unset Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume summary .. autoprogram-cliff:: openstack.volume.v3 :command: volume revert ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/commands.rst0000664000175100017510000004327315033046464023527 0ustar00mylesmyles.. _command-structure: ================= Command Structure ================= OpenStackClient has a consistent and predictable format for all of its commands. Commands take the form:: openstack [] [] [] .. NOTE:: All long options names begin with two dashes (``--``) and use a single dash (``-``) internally between words (``--like-this``). Underscores (``_``) are not used in option names. Global Options -------------- Global options are global in the sense that they apply to every command invocation regardless of action to be performed. They include authentication credentials and API version selection. Most global options have a corresponding environment variable that may also be used to set the value. If both are present, the command-line option takes priority. The environment variable names are derived from the option name by dropping the leading dashes (``--``), converting each embedded dash (``-``) to an underscore (``_``), and converting to upper case. For example, the default value of ``--os-username`` can be set by defining the environment variable ``OS_USERNAME``. Command Object(s) and Action ---------------------------- Commands consist of an object described by one or more words followed by an action. Commands that require two objects have the primary object ahead of the action and the secondary object after the action. Any positional arguments identifying the objects shall appear in the same order as the objects. In badly formed English it is expressed as "(Take) object1 (and perform) action (using) object2 (to it)." :: Examples: .. code-block:: bash $ group add user $ volume type list # 'volume type' is a two-word single object Command Arguments and Options ----------------------------- Each command may have its own set of options distinct from the global options. They follow the same style as the global options and always appear between the command and any positional arguments the command requires. Objects ------- The objects consist of one or more words to compose a unique name. Occasionally when multiple APIs have a common name with common overlapping purposes there will be options to select which object to use, or the API resources will be merged, as in the ``quota`` object that has options referring to both Compute and Volume quotas. * ``access token``: (**Identity**) long-lived OAuth-based token * ``address scope``: (**Network**) a scope of IPv4 or IPv6 addresses * ``aggregate``: (**Compute**) a grouping of compute hosts * ``availability zone``: (**Compute**, **Network**, **Volume**) a logical partition of hosts or block storage or network services * ``block storage cluster``: (**Volume**) clusters of volume services * ``block storage resource filter``: (**Volume**) filters for volume service resources * ``catalog``: (**Identity**) service catalog * ``command``: (**Internal**) installed commands in the OSC process * ``compute agent``: (**Compute**) a cloud Compute agent available to a hypervisor * ``compute service``: (**Compute**) a cloud Compute process running on a host * ``configuration``: (**Internal**) OpenStack client configuration * ``consistency group``: (**Volume**) a consistency group of volumes * ``consistency group snapshot``: (**Volume**) a point-in-time copy of a consistency group * ``console log``: (**Compute**) server console text dump * ``console url``: (**Compute**) server remote console URL * ``consumer``: (**Identity**) OAuth-based delegatee * ``container``: (**Object Storage**) a grouping of objects * ``credential``: (**Identity**) specific to identity providers * ``domain``: (**Identity**) a grouping of projects * ``ec2 credentials``: (**Identity**) AWS EC2-compatible credentials * ``endpoint``: (**Identity**) the base URL used to contact a specific service * ``endpoint group``: (**Identity**) group endpoints to be used as filters * ``extension``: (**Compute**, **Identity**, **Network**, **Volume**) OpenStack server API extensions * ``federation protocol``: (**Identity**) the underlying protocol used while federating identities * ``flavor``: (**Compute**) predefined server configurations: ram, root disk and so on * ``fixed ip``: (**Compute**) - an internal IP address assigned to a server * ``floating ip``: (**Network**) - a public IP address that can be mapped to a server * ``floating ip pool``: (**Network**) - a pool of public IP addresses * ``group``: (**Identity**) a grouping of users * ``host``: (**Compute**) - the physical computer running compute services * ``hypervisor``: (**Compute**) the virtual machine manager * ``hypervisor stats``: (**Compute**) hypervisor statistics over all compute nodes * ``identity provider``: (**Identity**) a source of users and authentication * ``image``: (**Image**) a disk image * ``image member``: (**Image**) a project that is a member of an Image * ``ip availability``: (**Network**) - details of IP usage of a network * ``keypair``: (**Compute**) an SSH public key * ``limits``: (**Compute**, **Volume**) resource usage limits * ``mapping``: (**Identity**) a definition to translate identity provider attributes to Identity concepts * ``module``: (**Internal**) - installed Python modules in the OSC process * ``network``: (**Compute**, **Network**) - a virtual network for connecting servers and other resources * ``network agent``: (**Network**) - A network agent is an agent that handles various tasks used to implement virtual networks * ``network auto allocated topology``: (**Network**) - an auto-allocated topology for a project * ``network flavor``: (**Network**) - allows the user to choose the type of service by a set of advertised service capabilities (e.g., LOADBALANCER, FWAAS, L3, VPN, etc) rather than by a provider type or named vendor * ``network flavor profile``: (**Network**) - predefined neutron service configurations: driver * ``network meter``: (**Network**) - allow traffic metering in a network * ``network meter rule``: (**Network**) - rules for network traffic metering * ``network rbac``: (**Network**) - an RBAC policy for network resources * ``network qos rule``: (**Network**) - a QoS rule for network resources * ``network qos policy``: (**Network**) - a QoS policy for network resources * ``network qos rule type``: (**Network**) - list of QoS available rule types * ``network segment``: (**Network**) - a segment of a virtual network * ``network segment range``: (**Network**) - a segment range for tenant network segment allocation * ``network service provider``: (**Network**) - a driver providing a network service * ``object``: (**Object Storage**) a single file in the Object Storage * ``object store account``: (**Object Storage**) owns a group of Object Storage resources * ``policy``: (**Identity**) determines authorization * ``port``: (**Network**) - a virtual port for connecting servers and other resources to a network * ``project``: (**Identity**) owns a group of resources * ``quota``: (**Compute**, **Volume**) resource usage restrictions * ``region``: (**Identity**) a subset of an OpenStack deployment * ``request token``: (**Identity**) temporary OAuth-based token * ``role``: (**Identity**) a policy object used to determine authorization * ``role assignment``: (**Identity**) a relationship between roles, users or groups, and domains or projects * ``router``: (**Network**) - a virtual router * ``security group``: (**Compute**, **Network**) - groups of network access rules * ``security group rule``: (**Compute**, **Network**) - the individual rules that define protocol/IP/port access * ``server``: (**Compute**) virtual machine instance * ``server backup``: (**Compute**) backup server disk image by using snapshot method * ``server dump``: (**Compute**) a dump file of a server created by features like kdump * ``server event``: (**Compute**) events of a server * ``server group``: (**Compute**) a grouping of servers * ``server image``: (**Compute**) saved server disk image * ``service``: (**Identity**) a cloud service * ``service provider``: (**Identity**) a resource that consumes assertions from an ``identity provider`` * ``subnet``: (**Network**) - a contiguous range of IP addresses assigned to a network * ``subnet pool``: (**Network**) - a pool of subnets * ``token``: (**Identity**) a bearer token managed by Identity service * ``trust``: (**Identity**) project-specific role delegation between users, with optional impersonation * ``usage``: (**Compute**) display host resources being consumed * ``user``: (**Identity**) individual cloud resources users * ``user role``: (**Identity**) roles assigned to a user * ``volume``: (**Volume**) block volumes * ``volume attachment``: (**Volume**) an attachment of a volumes to a server * ``volume backup``: (**Volume**) backup for volumes * ``volume backend capability``: (**Volume**) volume backend storage capabilities * ``volume backend pool``: (**Volume**) volume backend storage pools * ``volume backup record``: (**Volume**) volume record that can be imported or exported * ``volume backend``: (**Volume**) volume backend storage * ``volume group``: (**Volume**) group of volumes * ``volume group snapshot``: (**Volume**) a point-in-time copy of a volume group * ``volume group type``: (**Volume**) deployment-specific types of volumes groups available * ``volume host``: (**Volume**) the physical computer for volumes * ``volume message``: (**Volume**) volume API internal messages detailing volume failure messages * ``volume qos``: (**Volume**) quality-of-service (QoS) specification for volumes * ``volume snapshot``: (**Volume**) a point-in-time copy of a volume * ``volume type``: (**Volume**) deployment-specific types of volumes available * ``volume service``: (**Volume**) services to manage block storage operations * ``volume transfer request``: (**Volume**) volume owner transfer request Plugin Objects -------------- The following are known `Objects` used by OpenStack :ref:`plugins`. These are listed here to avoid name conflicts when creating new plugins. For a complete list check out :ref:`plugin-commands`. * ``acl``: (**Key Manager (Barbican)**) * ``acl user``: (**Key Manager (Barbican)**) * ``action definition``: (**Workflow Engine (Mistral)**) * ``action execution``: (**Workflow Engine (Mistral)**) * ``appcontainer``: (**Application Container (Zun)**) * ``appcontainer host``: (**Application Container (Zun)**) * ``appcontainer image``: (**Application Container (Zun)**) * ``appcontainer network``: (**Application Container (Zun)**) * ``appcontainer service``: (**Application Container (Zun)**) * ``baremetal``: (**Baremetal (Ironic)**) * ``claim``: (**Messaging (Zaqar)**) * ``coe ca``: (**Container Orchestration Engine (Magnum)**) * ``coe cluster``: (**Container Orchestration Engine (Magnum)**) * ``coe cluster template``: (**Container Orchestration Engine (Magnum)**) * ``coe quotas``: (**Container Orchestration Engine (Magnum)**) * ``coe service``: (**Container Orchestration Engine (Magnum)**) * ``coe stats``: (**Container Orchestration Engine (Magnum)**) * ``cron trigger``: (**Workflow Engine (Mistral)**) * ``database flavor``: (**Database (Trove)**) * ``loadbalancer``: (**Load Balancer (Octavia)**) * ``loadbalancer healthmonitor``: (**Load Balancer (Octavia)**) * ``loadbalancer l7policy``: (**Load Balancer (Octavia)**) * ``loadbalancer l7rule``: (**Load Balancer (Octavia)**) * ``loadbalancer listener``: (**Load Balancer (Octavia)**) * ``loadbalancer member``: (**Load Balancer (Octavia)**) * ``loadbalancer pool``: (**Load Balancer (Octavia)**) * ``message-broker cluster``: (**Message Broker (Cue)**) * ``messaging``: (**Messaging (Zaqar)**) * ``messaging flavor``: (**Messaging (Zaqar)**) * ``network subport``: (**Networking (Neutron)**) * ``network trunk``: (**Networking (Neutron)**) * ``orchestration resource``: (**Orchestration (Heat)**) * ``orchestration template``: (**Orchestration (Heat)**) * ``pool``: (**Messaging (Zaqar)**) * ``ptr record``: (**DNS (Designate)**) * ``queue``: (**Messaging (Zaqar)**) * ``recordset``: (**DNS (Designate)**) * ``secret``: (**Key Manager (Barbican)**) * ``secret container``: (**Key Manager (Barbican)**) * ``secret order``: (**Key Manager (Barbican)**) * ``share``: (**Share (Manila)**) * ``share access``: (**Share (Manila)**) * ``share availability zone``: (**Share (Manila)**) * ``share backup``: (**Share (Manila)**) * ``share export location``: (**Share (Manila)**) * ``share group``: (**Share (Manila)**) * ``share group snapshot``: (**Share (Manila)**) * ``share group type``: (**Share (Manila)**) * ``share instance``: (**Share (Manila)**) * ``share limits show``: (**Share (Manila)**) * ``share lock``: (**Share (Manila)**) * ``share message``: (**Share (Manila)**) * ``share migration``: (**Share (Manila)**) * ``share network``: (**Share (Manila)**) * ``share quota``: (**Share (Manila)**) * ``share replica``: (**Share (Manila)**) * ``share security service``: (**Share (Manila)**) * ``share server``: (**Share (Manila)**) * ``share server migration``: (**Share (Manila)**) * ``share service``: (**Share (Manila)**) * ``share snapshot``: (**Share (Manila)**) * ``share snapshot access``: (**Share (Manila)**) * ``share snapshot export location``: (**Share (Manila)**) * ``share snapshot instance``: (**Share (Manila)**) * ``share transfer``: (**Share (Manila)**) * ``share type``: (**Share (Manila)**) * ``software config``: (**Orchestration (Heat)**) * ``software deployment``: (**Orchestration (Heat)**) * ``stack event``: (**Orchestration (Heat)**) * ``stack hook``: (**Orchestration (Heat)**) * ``stack output``: (**Orchestration (Heat)**) * ``stack resource``: (**Orchestration (Heat)**) * ``stack snapshot``: (**Orchestration (Heat)**) * ``stack template``: (**Orchestration (Heat)**) * ``subscription``: (**Messaging (Zaqar)**) * ``task execution``: (**Workflow Engine (Mistral)**) * ``tld``: (**DNS (Designate)**) * ``workbook``: (**Workflow Engine (Mistral)**) * ``workflow``: (**Workflow Engine (Mistral)**) * ``workflow execution``: (**Workflow Engine (Mistral)**) * ``zone``: (**DNS (Designate)**) * ``zone blacklist``: (**DNS (Designate)**) * ``zone export``: (**DNS (Designate)**) * ``zone import``: (**DNS (Designate)**) * ``zone transfer``: (**DNS (Designate)**) Actions ------- The actions used by OpenStackClient are defined below to provide a consistent meaning to each action. Many of them have logical opposite actions. Those actions with an opposite action are noted in parens if applicable. * ``authorize`` - authorize a token (used in OAuth) * ``add`` (``remove``) - add some object to a container object; the command is built in the order of ``container add object ``, the positional arguments appear in the same order * ``create`` (``delete``) - create a new occurrence of the specified object * ``delete`` (``create``) - delete specific occurrences of the specified objects * ``expand`` (``shrink``) - increase the capacity of a cluster * ``failover`` - failover volume host to different backend * ``issue`` (``revoke``) - issue a token * ``list`` - display summary information about multiple objects * ``lock`` (``unlock``) - lock one or more servers so that non-admin user won't be able to execute actions * ``migrate`` - move a server or a volume to a different host; ``--live`` performs a live server migration if possible * ``pause`` (``unpause``) - stop one or more servers and leave them in memory * ``query`` - Query resources by Elasticsearch query string or json format DSL. * ``cleanup`` - flexible clean resources associated with a specific project * ``reboot`` - forcibly reboot a server * ``rebuild`` - rebuild a server using (most of) the same arguments as in the original create * ``remove`` (``add``) - remove an object from a group of objects * ``rescue`` (``unrescue``) - reboot a server in a special rescue mode allowing access to the original disks * ``resize`` - change a server's flavor or a cluster's capacity * ``restore`` - restore a heat stack snapshot or restore a server in soft-deleted state * ``resume`` (``suspend``) - return one or more suspended servers to running state * ``revoke`` (``issue``) - revoke a token * ``save`` - download an object locally * ``set`` (``unset``) - set a property on the object, formerly called metadata * ``shelve`` (``unshelve``) - shelve one or more servers * ``show`` - display detailed information about the specific object * ``shrink`` (``expand``) - reduce the capacity of a cluster * ``start`` (``stop``) - start one or more servers * ``stop`` (``start``) - stop one or more servers * ``suspend`` (``resume``) - stop one or more servers and save to disk freeing memory * ``unlock`` (``lock``) - unlock one or more servers * ``unpause`` (``pause``) - return one or more paused servers to running state * ``unrescue`` (``rescue``) - return a server to normal boot mode * ``unset`` (``set``) - remove an attribute of the object * ``unshelve`` (``shelve``) - unshelve one or more servers Implementation -------------- The command structure is designed to support seamless addition of plugin command modules via Python's *entry points* mechanism. The plugin commands must be subclasses of Cliff's ``command.Command`` object. See :ref:`plugins` for more information. Command Entry Points -------------------- Commands are added to the client using ``setuptools`` entry points in ``setup.cfg``. There is a single common group ``openstack.cli`` for commands that are not versioned, and a group for each combination of OpenStack API and version that is supported. For example, to support Identity API v3 there is a group called ``openstack.identity.v3`` that contains the individual commands. The command entry points have the form:: action_object = fully.qualified.module.vXX.object:ActionObject For example, the ``list user`` command for the Identity API is identified in ``setup.cfg`` with:: openstack.identity.v3 = # ... list_user = openstackclient.identity.v3.user:ListUser # ... ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9291112 python_openstackclient-8.1.1.dev14/doc/source/cli/data/0000775000175100017510000000000015033046512022066 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/data/cinder.csv0000664000175100017510000003124115033046464024056 0ustar00mylesmylesabsolute-limits,limits show --absolute,Lists absolute limits for a user. api-version,openstack versions show --service volume,Display the server API version information. availability-zone-list,availability zone list --volume,Lists all availability zones. attachment-complete,volume attachment complete,Complete an attachment for a cinder volume. (Supported by API versions 3.44 - 3.latest) attachment-create,volume attachment create,Create an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) attachment-delete,volume attachment delete,Delete an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) attachment-list,volume attachment list,Lists all attachments. (Supported by API versions 3.27 - 3.latest) attachment-show,volume attachment show,Show detailed information for attachment. (Supported by API versions 3.27 - 3.latest) attachment-update,volume attachment update,Update an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) backup-create,volume backup create,Creates a volume backup. backup-delete,volume backup delete,Removes a backup. backup-export,volume backup record export,Export backup metadata record. backup-import,volume backup record import,Import backup metadata record. backup-list,volume backup list,Lists all backups. backup-reset-state,volume backup set --state,Explicitly updates the backup state. backup-restore,volume backup restore,Restores a backup. backup-show,volume backup show,Show backup details. backup-update,volume backup set,Updates a backup. (Supported by API versions 3.9 - 3.latest) cgsnapshot-create,consistency group snapshot create,Creates a cgsnapshot. cgsnapshot-delete,consistency group snapshot delete,Removes one or more cgsnapshots. cgsnapshot-list,consistency group snapshot list,Lists all cgsnapshots. cgsnapshot-show,consistency group snapshot show,Shows cgsnapshot details. cluster-disable,block storage cluster set --disable,Disables clustered services. (Supported by API versions 3.7 - 3.latest) cluster-enable,block storage cluster set --enable,Enables clustered services. (Supported by API versions 3.7 - 3.latest) cluster-list,block storage cluster list,Lists clustered services with optional filtering. (Supported by API versions 3.7 - 3.latest) cluster-show,block storage cluster show,Show detailed information on a clustered service. (Supported by API versions 3.7 - 3.latest) consisgroup-create,consistency group create,Creates a consistency group. consisgroup-create-from-src,consistency group create --consistency-group-snapshot,Creates a consistency group from a cgsnapshot or a source CG consisgroup-delete,consistency group delete,Removes one or more consistency groups. consisgroup-list,consistency group list,Lists all consistencygroups. consisgroup-show,consistency group show,Shows details of a consistency group. consisgroup-update,consistency group set,Updates a consistencygroup. create,volume create,Creates a volume. delete,volume delete,Removes one or more volumes. encryption-type-create,volume type create --encryption-provider --enc..,Creates encryption type for a volume type. Admin only. encryption-type-delete,volume type delete,Deletes encryption type for a volume type. Admin only. encryption-type-list,volume type list --encryption-type,Shows encryption type details for volume types. Admin only. encryption-type-show,volume type list --encryption-show,Shows encryption type details for volume type. Admin only. encryption-type-update,volume type set --encryption-provider --enc..,Update encryption type information for a volume type (Admin Only). extend,volume set --size,Attempts to extend size of an existing volume. extra-specs-list,volume type list --long,Lists current volume types and extra specs. failover-host,volume host failover,Failover a replicating cinder-volume host. force-delete,volume delete --force,"Attempts force-delete of volume regardless of state." freeze-host,volume host set --disable,Freeze and disable the specified cinder-volume host. get-capabilities,volume backend capability show,Show capabilities of a volume backend. Admin only. get-pools,volume backend pool list,Show pool information for backends. Admin only. group-create,volume group create,Creates a group. (Supported by API versions 3.13 - 3.latest) group-create-from-src,volume group create [--source-group|--group-snapshot],Creates a group from a group snapshot or a source group. (Supported by API versions 3.14 - 3.latest) group-delete,volume group delete,Removes one or more groups. (Supported by API versions 3.13 - 3.latest) group-disable-replication,volume group set --disable-replication,Disables replication for group. (Supported by API versions 3.38 - 3.latest) group-enable-replication,volume group set --enable-replication,Enables replication for group. (Supported by API versions 3.38 - 3.latest) group-failover-replication,volume group failover,Fails over replication for group. (Supported by API versions 3.38 - 3.latest) group-list,volume group list,Lists all groups. (Supported by API versions 3.13 - 3.latest) group-list-replication-targets,volume group list --replication-targets,Lists replication targets for group. (Supported by API versions 3.38 - 3.latest) group-show,volume group show,Shows details of a group. (Supported by API versions 3.13 - 3.latest) group-snapshot-create,volume group snapshot create,Creates a group snapshot. (Supported by API versions 3.14 - 3.latest) group-snapshot-delete,volume group snapshot delete,Removes one or more group snapshots. (Supported by API versions 3.14 - 3.latest) group-snapshot-list,volume group snapshot list,Lists all group snapshots. (Supported by API versions 3.14 - 3.latest) group-snapshot-show,volume group snapshot show,Shows group snapshot details. (Supported by API versions 3.14 - 3.latest) group-specs-list,volume group type list,Lists current group types and specs. (Supported by API versions 3.11 - 3.latest) group-type-create,volume group type create,Creates a group type. (Supported by API versions 3.11 - 3.latest) group-type-default,volume group type list --default,List the default group type. (Supported by API versions 3.11 - 3.latest) group-type-delete,volume group type delete,Deletes group type or types. (Supported by API versions 3.11 - 3.latest) group-type-key,volume group type set,Sets or unsets group_spec for a group type. (Supported by API versions 3.11 - 3.latest) group-type-list,volume group type set,Lists available 'group types'. (Admin only will see private types) (Supported by API versions 3.11 - 3.latest) group-type-show,volume group type show,Show group type details. (Supported by API versions 3.11 - 3.latest) group-type-update,volume group type set,Updates group type name description and/or is_public. (Supported by API versions 3.11 - 3.latest) group-update,volume group set,Updates a group. (Supported by API versions 3.13 - 3.latest) image-metadata,volume set --image-property,Sets or deletes volume image metadata. image-metadata-show,volume show,Shows volume image metadata. list,volume list,Lists all volumes. list-filters,block storage resource filter list,List enabled filters. (Supported by API versions 3.33 - 3.latest) manage,volume create --remote-source k=v,Manage an existing volume. manageable-list,block storage volume manageable list,Lists all manageable volumes. (Supported by API versions 3.8 - 3.latest) message-delete,volume message delete,Removes one or more messages. (Supported by API versions 3.3 - 3.latest) message-list,volume message list,Lists all messages. (Supported by API versions 3.3 - 3.latest) message-show,volume message show,Shows message details. (Supported by API versions 3.3 - 3.latest) metadata,volume set --property k=v / volume unset --property k,Sets or deletes volume metadata. metadata-show,volume show,Shows volume metadata. metadata-update-all,volume set --property k=v,Updates volume metadata. migrate,volume migrate --host --force-copy --lock-volume ,Migrates volume to a new host. qos-associate,volume qos associate,Associates qos specs with specified volume type. qos-create,volume qos create,Creates a qos specs. qos-delete,volume qos delete,Deletes a specified qos specs. qos-disassociate,volume qos disassociate,Disassociates qos specs from specified volume type. qos-disassociate-all,volume qos disassociate --all,Disassociates qos specs from all associations. qos-get-association,volume qos show,Gets all associations for specified qos specs. qos-key,volume qos set --property k=v / volume qos unset --property k,Sets or unsets specifications for a qos spec qos-list,volume qos list,Lists qos specs. qos-show,volume qos show,Shows a specified qos specs. quota-class-show,quota show --class,Lists quotas for a quota class. quota-class-update,quota set --class,Updates quotas for a quota class. quota-defaults,quota show --default,Lists default quotas for a tenant. quota-delete,quota delete --volume,Delete the quotas for a tenant. quota-show,quota show,Lists quotas for a tenant. quota-update,quota set,Updates quotas for a tenant. quota-usage,quota show --usage,Lists quota usage for a tenant. rate-limits,limits show --rate,Lists rate limits for a user. readonly-mode-update,volume set --read-only-mode | --read-write-mode,Updates volume read-only access-mode flag. rename,volume set --name,Renames a volume. reset-state,volume set --state,Explicitly updates the volume state. retype,volume type set --type,Changes the volume type for a volume. revert-to-snapshot,volume revert,Revert a volume to the specified snapshot. (Supported by API versions 3.40 - 3.latest) service-disable,volume service set --disable,Disables the service. service-enable,volume service set --enable,Enables the service. service-get-log,block storage log level list,(Supported by API versions 3.32 - 3.latest) service-list,volume service list,Lists all services. Filter by host and service binary. service-set-log,block storage log level set,(Supported by API versions 3.32 - 3.latest) set-bootable,volume set --bootable / --not-bootable,Update bootable status of a volume. show,volume show,Shows volume details. snapshot-create,volume snapshot create,Creates a snapshot. snapshot-delete,volume snapshot delete,Remove one or more snapshots. snapshot-list,volume snapshot list,Lists all snapshots. snapshot-manage,volume snapshot create --remote-source ,Manage an existing snapshot. snapshot-manageable-list,block storage snapshot manageable list,Lists all manageable snapshots. (Supported by API versions 3.8 - 3.latest) snapshot-metadata,volume snapshot set --property k=v / snapshot unset --property k,Sets or deletes snapshot metadata. snapshot-metadata-show,volume snapshot show,Shows snapshot metadata. snapshot-metadata-update-all,volume snapshot set --property k=v,Updates snapshot metadata. snapshot-rename,volume snapshot set --name,Renames a snapshot. snapshot-reset-state,volume snapshot set --state,Explicitly updates the snapshot state. snapshot-show,volume snapshot show,Shows snapshot details. snapshot-unmanage,volume snapshot delete --remote,Stop managing a snapshot. summary,volume summary,Get volumes summary. (Supported by API versions 3.12 - 3.latest) thaw-host,volume host set --enable,Thaw and enable the specified cinder-volume host. transfer-accept,volume transfer accept,Accepts a volume transfer. transfer-create,volume transfer create,Creates a volume transfer. transfer-delete,volume transfer delete,Undoes a transfer. transfer-list,volume transfer list,Lists all transfers. transfer-show,volume transfer show,Show transfer details. type-access-add,volume type set --project,Adds volume type access for the given project. type-access-list,volume type show,Print access information about the given volume type. type-access-remove,volume type unset --project,Removes volume type access for the given project. type-create,volume type create,Creates a volume type. type-default,volume type list --default,List the default volume type. type-delete,volume type delete,Deletes a specified volume type. type-key,volume type set --property k=v / volume type unset --property k,Sets or unsets extra_spec for a volume type. type-list,volume type list,Lists available 'volume types'. type-show,volume type show,Show volume type details. type-update,volume type set,"Updates volume type name description and/or is_public." unmanage,volume delete --remote,Stop managing a volume. upload-to-image,image create --volume,Uploads volume to Image Service as an image. version-list,versions show --service block-storage,List all API versions. (Supported by API versions 3.0 - 3.latest) work-cleanup,block storage cleanup,Request cleanup of services with optional filtering. (Supported by API versions 3.24 - 3.latest) bash-completion,complete,Prints arguments for bash_completion. help,help,Shows help about this program or one of its subcommands. list-extensions,extension list --volume,Lists all available os-api extensions. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/data/glance.csv0000664000175100017510000001275615033046464024055 0ustar00mylesmylescache-clear,cached image clear,"Clear all images from cache, queue or both." cache-delete,cached image delete,Delete image from cache/caching queue. cache-list,cached image list,Get cache state. cache-queue,cached image queue,Queue image(s) for caching. explain,WONTFIX,Describe a specific model. image-create,image create,Create a new image. image-create-via-import, image create --import,"EXPERIMENTAL: Create a new image via image import using glance-direct import method. Missing support for web-download, copy-image and glance-download import methods. The OSC command is also missing support for importing image to specified store as well as all stores (--store, --stores, --all-stores) and skip or stop processing if import fails to one of the store (--allow-failure)" image-deactivate,image set --deactivate,Deactivate specified image. image-delete,image delete,Delete specified image. image-download,image save,Download a specific image. image-import,image import,Initiate the image import taskflow. image-list,image list,List images you can access. image-reactivate,image set --activate,Reactivate specified image. image-show,image show,Describe a specific image. image-stage,image stage,Upload data for a specific image to staging. image-tag-delete,image unset --tag ,Delete the tag associated with the given image. image-tag-update,image set --tag ,Update an image with the given tag. image-tasks,,Get tasks associated with image. image-update,image set,Update an existing image. image-upload,,Upload data for a specific image. import-info,image import info,Show available import methods from Glance. location-add,,Add a location (and related metadata) to an image. location-delete,,Remove locations (and related metadata) from an image. location-update,,Update metadata of an image's location. md-namespace-create,image metadef namespace create,Create a new metadata definitions namespace. md-namespace-delete,image metadef namespace delete,Delete specified metadata definitions namespace with its contents. md-namespace-import,,Import a metadata definitions namespace from file or standard input. md-namespace-list,image metadef namespace list,List metadata definitions namespaces. md-namespace-objects-delete,,Delete all metadata definitions objects inside a specific namespace. md-namespace-properties-delete,,Delete all metadata definitions property inside a specific namespace. md-namespace-resource-type-list,image metadef resource type association list,List resource types associated to specific namespace. md-namespace-show,image metadef namespace show,Describe a specific metadata definitions namespace. md-namespace-tags-delete,,Delete all metadata definitions tags inside a specific namespace. md-namespace-update,,Update an existing metadata definitions namespace. md-object-create,image metadef object create,Create a new metadata definitions object inside a namespace. md-object-show,image metadef object show,Describe a specific metadata definitions object inside a namespace. md-object-list,image metadef object list,List metadata definitions objects inside a specific namespace. md-object-delete,image metadef object delete,Delete a specific metadata definitions object inside a namespace. md-object-property-show,image metadef object property show,Describe a specific metadata definitions property inside an object. md-object-update,image metadef object update,Update metadata definitions object inside a namespace. md-property-create,image metadef property create,Create a new metadata definitions property inside a namespace. md-property-delete,image metadef property delete,Delete a specific metadata definitions property inside a namespace. md-property-list,image metadef property list,List metadata definitions properties inside a specific namespace. md-property-show,image metadef property show,Describe a specific metadata definitions property inside a namespace. md-property-update,image metadef property set,Update metadata definitions property inside a namespace. md-resource-type-associate,image metadef resource type association create,Associate resource type with a metadata definitions namespace. md-resource-type-deassociate,image metadef resource type association delete,Deassociate resource type with a metadata definitions namespace. md-resource-type-list,image metadef resource type list,List available resource type names. md-tag-create,,Add a new metadata definitions tag inside a namespace. md-tag-create-multiple,,Create new metadata definitions tags inside a namespace. md-tag-delete,,Delete a specific metadata definitions tag inside a namespace. md-tag-list,,List metadata definitions tags inside a specific namespace. md-tag-show,,Describe a specific metadata definitions tag inside a namespace. md-tag-update,,Rename a metadata definitions tag inside a namespace. member-create,image add project,Create member for a given image. member-delete,image remove project,Delete image member. member-get,image member get,Show details of an image member member-list,image member list,Describe sharing permissions by image. member-update,image set --accept --reject --status,Update the status of a member for a given image. stores-delete,image delete --store,Delete image from specific store. stores-info,,Print available backends from Glance. task-create,WONTFIX,Create a new task. task-list,image task list,List tasks you can access. task-show,image task show,Describe a specific task. usage,,Get quota usage information. bash-completion,complete,Prints arguments for bash_completion. help,help,Display help about this program or one of its subcommands. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/data/keystone.csv0000664000175100017510000000442015033046464024452 0ustar00mylesmylescatalog,catalog show,"List service catalog, possibly filtered by service." ec2-credentials-create,ec2 credentials create,Create EC2-compatible credentials for user per tenant. ec2-credentials-delete,ec2 credentials delete,Delete EC2-compatible credentials. ec2-credentials-get,ec2 credentials show,Display EC2-compatible credentials. ec2-credentials-list,ec2 credentials list,List EC2-compatible credentials for a user. endpoint-create,endpoint create,Create a new endpoint associated with a service. endpoint-delete,endpoint delete,Delete a service endpoint. endpoint-get,endpoint get,Find endpoint filtered by a specific attribute or service type. endpoint-list,endpoint list,List configured service endpoints. password-update,user password set,Update own password. role-create,role create,Create new role. role-delete,role delete,Delete role. role-get,role show,Display role details. role-list,role list,List all roles. service-create,service create,Add service to Service Catalog. service-delete,service delete,Delete service from Service Catalog. service-get,service show,Display service from Service Catalog. service-list,service list,List all services in Service Catalog. tenant-create,project create,Create new tenant. tenant-delete,project delete,Delete tenant. tenant-get,project show,Display tenant details. tenant-list,project list,List all tenants. tenant-update,project set,"Update tenant name, description, enabled status." token-get,token issue,Display the current user token. user-create,user create,Create new user. user-delete,user delete,Delete user. user-get,user show,Display user details. user-list,user list,List users. user-password-update,user set --password,Update user password. user-role-add,role add --user --project,Add role to user. user-role-list,role assignment list --user --project,List roles granted to a user. user-role-remove,role remove --user --project,Remove role from user. user-update,user set,"Update user's name, email, and enabled status." discover,WONTFIX,"Discover Keystone servers, supported API versions and extensions." bootstrap,WONTFIX,"Grants a new role to a new user on a new tenant, after creating each." bash-completion,complete,Prints all of the commands and options to stdout. help,help,Display help about this program or one of its subcommands. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/data/neutron.csv0000664000175100017510000004455515033046464024320 0ustar00mylesmylesaddress-scope-create,address scope create,Create an address scope for a given tenant. address-scope-delete,address scope delete,Delete an address scope. address-scope-list,address scope list,List address scopes that belong to a given tenant. address-scope-show,address scope show,Show information about an address scope. address-scope-update,address scope set,Update an address scope. agent-delete,network agent delete,Delete a given agent. agent-list,network agent list,List agents. agent-show,network agent show,Show information of a given agent. agent-update,network agent set,Updates the admin status and description for a specified agent. auto-allocated-topology-delete,network auto allocated topology delete,Delete the auto-allocated topology of a given tenant. auto-allocated-topology-show,network auto allocated topology create,Show the auto-allocated topology of a given tenant. availability-zone-list,availability zone list,List availability zones. bash-completion,complete,Prints all of the commands and options for bash-completion. bgp-dragent-list-hosting-speaker,bgp speaker show dragents,List Dynamic Routing agents hosting a BGP speaker. bgp-dragent-speaker-add,bgp dragent add speaker,Add a BGP speaker to a Dynamic Routing agent. bgp-dragent-speaker-remove,bgp dragent remove speaker,Removes a BGP speaker from a Dynamic Routing agent. bgp-peer-create,bgp peer create,Create a BGP Peer. bgp-peer-delete,bgp peer delete,Delete a BGP peer. bgp-peer-list,bgp peer list,List BGP peers. bgp-peer-show,bgp peer show,Show information of a given BGP peer. bgp-peer-update,bgp peer set,Update BGP Peer's information. bgp-speaker-advertiseroute-list,bgp speaker list advertised routes,List routes advertised by a given BGP speaker. bgp-speaker-create,bgp speaker create,Create a BGP Speaker. bgp-speaker-delete,bgp speaker delete,Delete a BGP speaker. bgp-speaker-list,bgp speaker list,List BGP speakers. bgp-speaker-list-on-dragent,bgp speaker list --agent,List BGP speakers hosted by a Dynamic Routing agent. bgp-speaker-network-add,bgp speaker add network,Add a network to the BGP speaker. bgp-speaker-network-remove,bgp speaker remove network,Remove a network from the BGP speaker. bgp-speaker-peer-add,bgp speaker add peer,Add a peer to the BGP speaker. bgp-speaker-peer-remove,bgp speaker remove peer,Remove a peer from the BGP speaker. bgp-speaker-show,bgp speaker show,Show information of a given BGP speaker. bgp-speaker-update,bgp speaker set,Update BGP Speaker's information. dhcp-agent-list-hosting-net,network agent list --network,List DHCP agents hosting a network. dhcp-agent-network-add,network agent add network,Add a network to a DHCP agent. dhcp-agent-network-remove,network agent remove network,Remove a network from a DHCP agent. ext-list,extension list,List all extensions. ext-show,extension show,Show information of a given resource. firewall-create,,Create a firewall. firewall-delete,,Delete a given firewall. firewall-list,,List firewalls that belong to a given tenant. firewall-policy-create,,Create a firewall policy. firewall-policy-delete,,Delete a given firewall policy. firewall-policy-insert-rule,,Insert a rule into a given firewall policy. firewall-policy-list,,List firewall policies that belong to a given tenant. firewall-policy-remove-rule,,Remove a rule from a given firewall policy. firewall-policy-show,,Show information of a given firewall policy. firewall-policy-update,,Update a given firewall policy. firewall-rule-create,,Create a firewall rule. firewall-rule-delete,,Delete a given firewall rule. firewall-rule-list,,List firewall rules that belong to a given tenant. firewall-rule-show,,Show information of a given firewall rule. firewall-rule-update,,Update a given firewall rule. firewall-show,,Show information of a given firewall. firewall-update,,Update a given firewall. flavor-associate,network flavor add profile,Add a Neutron service flavor with a flavor profile. flavor-create,network flavor create,Create a Neutron service flavor. flavor-delete,network flavor delete,Delete a given Neutron service flavor. flavor-disassociate,network flavor remove profile,Remove a Neutron service flavor from a flavor profile. flavor-list,network flavor list,List Neutron service flavors. flavor-profile-create,network flavor profile create,Create a Neutron service flavor profile. flavor-profile-delete,network flavor profile delete,Delete a given Neutron service flavor profile. flavor-profile-list,network flavor profile list,List Neutron service flavor profiles. flavor-profile-show,network flavor profile show,Show information about a given Neutron service flavor profile. flavor-profile-update,network flavor profile set,Update a given Neutron service flavor profile. flavor-show,network flavor show,Show information about a given Neutron service flavor. flavor-update,network flavor set,Update a Neutron service flavor. floatingip-associate,floating ip set port --fixed-ip,Create a mapping between a floating IP and a fixed IP. floatingip-create,floating ip create,Create a floating IP for a given tenant. floatingip-delete,floating ip delete,Delete a given floating IP. floatingip-disassociate,floating ip unset --port,Remove a mapping from a floating IP to a fixed IP. floatingip-list,floating ip list,List floating IPs that belong to a given tenant. floatingip-show,floating ip show,Show information of a given floating IP. help,help,print detailed help for another command ipsec-site-connection-create,,Create an IPsec site connection. ipsec-site-connection-delete,,Delete a given IPsec site connection. ipsec-site-connection-list,,List IPsec site connections that belong to a given tenant. ipsec-site-connection-show,,Show information of a given IPsec site connection. ipsec-site-connection-update,,Update a given IPsec site connection. l3-agent-list-hosting-router,network agent list --routers,List L3 agents hosting a router. l3-agent-router-add,network agent add router --agent-type l3,Add a router to a L3 agent. l3-agent-router-remove,network agent remove router --agent-type l3,Remove a router from a L3 agent. lb-agent-hosting-pool,,Get loadbalancer agent hosting a pool. lb-healthmonitor-associate,,Create a mapping between a health monitor and a pool. lb-healthmonitor-create,,Create a health monitor. lb-healthmonitor-delete,,Delete a given health monitor. lb-healthmonitor-disassociate,,Remove a mapping from a health monitor to a pool. lb-healthmonitor-list,,List health monitors that belong to a given tenant. lb-healthmonitor-show,,Show information of a given health monitor. lb-healthmonitor-update,,Update a given health monitor. lb-member-create,,Create a member. lb-member-delete,,Delete a given member. lb-member-list,,List members that belong to a given tenant. lb-member-show,,Show information of a given member. lb-member-update,,Update a given member. lb-pool-create,,Create a pool. lb-pool-delete,,Delete a given pool. lb-pool-list,,List pools that belong to a given tenant. lb-pool-list-on-agent,,List the pools on a loadbalancer agent. lb-pool-show,,Show information of a given pool. lb-pool-stats,,Retrieve stats for a given pool. lb-pool-update,,Update a given pool. lb-vip-create,,Create a vip. lb-vip-delete,,Delete a given vip. lb-vip-list,,List vips that belong to a given tenant. lb-vip-show,,Show information of a given vip. lb-vip-update,,Update a given vip. lbaas-agent-hosting-loadbalancer,,Get lbaas v2 agent hosting a loadbalancer. lbaas-healthmonitor-create,,LBaaS v2 Create a healthmonitor. lbaas-healthmonitor-delete,,LBaaS v2 Delete a given healthmonitor. lbaas-healthmonitor-list,,LBaaS v2 List healthmonitors that belong to a given tenant. lbaas-healthmonitor-show,,LBaaS v2 Show information of a given healthmonitor. lbaas-healthmonitor-update,,LBaaS v2 Update a given healthmonitor. lbaas-l7policy-create,,LBaaS v2 Create L7 policy. lbaas-l7policy-delete,,LBaaS v2 Delete a given L7 policy. lbaas-l7policy-list,,LBaaS v2 List L7 policies that belong to a given listener. lbaas-l7policy-show,,LBaaS v2 Show information of a given L7 policy. lbaas-l7policy-update,,LBaaS v2 Update a given L7 policy. lbaas-l7rule-create,,LBaaS v2 Create L7 rule. lbaas-l7rule-delete,,LBaaS v2 Delete a given L7 rule. lbaas-l7rule-list,,LBaaS v2 List L7 rules that belong to a given L7 policy. lbaas-l7rule-show,,LBaaS v2 Show information of a given rule. lbaas-l7rule-update,,LBaaS v2 Update a given L7 rule. lbaas-listener-create,,LBaaS v2 Create a listener. lbaas-listener-delete,,LBaaS v2 Delete a given listener. lbaas-listener-list,,LBaaS v2 List listeners that belong to a given tenant. lbaas-listener-show,,LBaaS v2 Show information of a given listener. lbaas-listener-update,,LBaaS v2 Update a given listener. lbaas-loadbalancer-create,,LBaaS v2 Create a loadbalancer. lbaas-loadbalancer-delete,,LBaaS v2 Delete a given loadbalancer. lbaas-loadbalancer-list,,LBaaS v2 List loadbalancers that belong to a given tenant. lbaas-loadbalancer-list-on-agent,,List the loadbalancers on a loadbalancer v2 agent. lbaas-loadbalancer-show,,LBaaS v2 Show information of a given loadbalancer. lbaas-loadbalancer-stats,,Retrieve stats for a given loadbalancer. lbaas-loadbalancer-status,,Retrieve status for a given loadbalancer. lbaas-loadbalancer-update,,LBaaS v2 Update a given loadbalancer. lbaas-member-create,,LBaaS v2 Create a member. lbaas-member-delete,,LBaaS v2 Delete a given member. lbaas-member-list,,LBaaS v2 List members that belong to a given pool. lbaas-member-show,,LBaaS v2 Show information of a given member. lbaas-member-update,,LBaaS v2 Update a given member. lbaas-pool-create,,LBaaS v2 Create a pool. lbaas-pool-delete,,LBaaS v2 Delete a given pool. lbaas-pool-list,,LBaaS v2 List pools that belong to a given tenant. lbaas-pool-show,,LBaaS v2 Show information of a given pool. lbaas-pool-update,,LBaaS v2 Update a given pool. meter-label-create,network meter create,Create a metering label for a given tenant. meter-label-delete,network meter delete,Delete a given metering label. meter-label-list,network meter list,List metering labels that belong to a given tenant. meter-label-rule-create,network meter rule create,Create a metering label rule for a given label. meter-label-rule-delete,network meter rule delete,Delete a given metering label. meter-label-rule-list,network meter rule list,List metering labels that belong to a given label. meter-label-rule-show,network meter rule show,Show information of a given metering label rule. meter-label-show,network meter show,Show information of a given metering label. net-create,network create,Create a network for a given tenant. net-delete,network delete,Delete a given network. net-external-list,network list --external,List external networks that belong to a given tenant. net-ip-availability-list,ip availability list,List IP usage of networks net-ip-availability-show,ip availability show,Show IP usage of specific network net-list,network list,List networks that belong to a given tenant. net-list-on-dhcp-agent,network list --agent,List the networks on a DHCP agent. net-show,network show,Show information of a given network. net-update,network set / network unset,Update network's information. port-create,port create,Create a port for a given tenant. port-delete,port delete,Delete a given port. port-list,port list,List ports that belong to a given tenant. port-show,port show,Show information of a given port. port-update,port set / port unset,Update port's information. purge,,Delete all resources that belong to a given tenant. qos-available-rule-types,network qos rule type list,List available qos rule types. qos-bandwidth-limit-rule-create,network qos rule create --type bandwidth-limit,Create a qos bandwidth limit rule. qos-bandwidth-limit-rule-delete,network qos rule delete --type bandwidth-limit,Delete a given qos bandwidth limit rule. qos-bandwidth-limit-rule-list,network qos rule list --type bandwidth-limit,List all qos bandwidth limit rules belonging to the specified policy. qos-bandwidth-limit-rule-show,network qos rule show --type bandwidth-limit,Show information about the given qos bandwidth limit rule. qos-bandwidth-limit-rule-update,network qos rule update --type bandwidth-limit,Update the given qos bandwidth limit rule. qos-dscp-marking-rule-create,network qos rule create --type dscp-marking,Create a QoS DSCP marking rule. qos-dscp-marking-rule-delete,network qos rule delete --type dscp-marking,Delete a given qos dscp marking rule. qos-dscp-marking-rule-list,network qos rule list --type dscp-marking,List all QoS DSCP marking rules belonging to the specified policy. qos-dscp-marking-rule-show,network qos rule show --type dscp-marking,Show information about the given qos dscp marking rule. qos-dscp-marking-rule-update,network qos rule update --type dscp-marking,Update the given QoS DSCP marking rule. qos-minimum-bandwidth-rule-create,network qos rule create --type minimum-bandwidth,Create a qos minimum bandwidth rule. qos-minimum-bandwidth-rule-delete,network qos rule delete --type minimum-bandwidth,Delete a given qos minimum bandwidth rule. qos-minimum-bandwidth-rule-list,network qos rule list --type minimum-bandwidth,List all qos minimum bandwidth rules belonging to the specified policy. qos-minimum-bandwidth-rule-show,network qos rule show --type minimum-bandwidth,Show information about the given qos minimum bandwidth rule. qos-minimum-bandwidth-rule-update,network qos rule update --type minimum-bandwidth,Update the given qos minimum bandwidth rule. qos-policy-create,network qos policy create,Create a qos policy. qos-policy-delete,network qos policy delete,Delete a given qos policy. qos-policy-list,network qos policy list,List QoS policies that belong to a given tenant connection. qos-policy-show,network qos policy show,Show information of a given qos policy. qos-policy-update,network qos policy set,Update a given qos policy. quota-default-show,quota show --default,Show default quotas for a given tenant. quota-delete,quota delete --network,Delete defined quotas of a given tenant. quota-list,quota list,List quotas of all tenants who have non-default quota values. quota-show,quota show,Show quotas for a given tenant. quota-update,quota set,Define tenant's quotas not to use defaults. rbac-create,network rbac create,Create a RBAC policy for a given tenant. rbac-delete,network rbac delete,Delete a RBAC policy. rbac-list,network rbac list,List RBAC policies that belong to a given tenant. rbac-show,network rbac show,Show information of a given RBAC policy. rbac-update,network rbac set,Update RBAC policy for given tenant. router-create,router create,Create a router for a given tenant. router-delete,router delete,Delete a given router. router-gateway-clear,router unset,Remove an external network gateway from a router. router-gateway-set,router set / router unset,Set the external network gateway for a router. router-interface-add,router add subnet / router add port,Add an internal network interface to a router. router-interface-delete,router remove subnet / router remove port,Remove an internal network interface from a router. router-list,router list,List routers that belong to a given tenant. router-list-on-l3-agent,router list --agents,List the routers on a L3 agent. router-port-list,port list --router,"List ports that belong to a given tenant, with specified router." router-show,router show,Show information of a given router. router-update,router set,Update router's information. security-group-create,security group create,Create a security group. security-group-delete,security group delete,Delete a given security group. security-group-list,security group list,List security groups that belong to a given tenant. security-group-rule-create,security group rule create,Create a security group rule. security-group-rule-delete,security group rule delete,Delete a given security group rule. security-group-rule-list,security group rule list,List security group rules that belong to a given tenant. security-group-rule-show,security group rule show,Show information of a given security group rule. security-group-show,security group show,Show information of a given security group. security-group-update,security group set / security group unset,Update a given security group. service-provider-list,network service provider list,List service providers. subnet-create,subnet create,Create a subnet for a given tenant. subnet-delete,subnet delete,Delete a given subnet. subnet-list,subnet list,List subnets that belong to a given tenant. subnet-show,subnet show,Show information of a given subnet. subnet-update,subnet set / subnet unset,Update subnet's information. subnetpool-create,subnet pool create,Create a subnetpool for a given tenant. subnetpool-delete,subnet pool delete,Delete a given subnetpool. subnetpool-list,subnet pool list,List subnetpools that belong to a given tenant. subnetpool-show,subnet pool show,Show information of a given subnetpool. subnetpool-update,subnet pool set / subnet pool unset,Update subnetpool's information. tag-add,network set --tag,Add a tag into the resource. tag-remove,network unset --tag,Remove a tag on the resource. tag-replace,network set --no-tag --tag,Replace all tags on the resource. vpn-endpoint-group-create,,Create a VPN endpoint group. vpn-endpoint-group-delete,,Delete a given VPN endpoint group. vpn-endpoint-group-list,,List VPN endpoint groups that belong to a given tenant. vpn-endpoint-group-show,,Show a specific VPN endpoint group. vpn-endpoint-group-update,,Update a given VPN endpoint group. vpn-ikepolicy-create,,Create an IKE policy. vpn-ikepolicy-delete,,Delete a given IKE policy. vpn-ikepolicy-list,,List IKE policies that belong to a tenant. vpn-ikepolicy-show,,Show information of a given IKE policy. vpn-ikepolicy-update,,Update a given IKE policy. vpn-ipsecpolicy-create,,Create an IPsec policy. vpn-ipsecpolicy-delete,,Delete a given IPsec policy. vpn-ipsecpolicy-list,,List IPsec policies that belong to a given tenant connection. vpn-ipsecpolicy-show,,Show information of a given IPsec policy. vpn-ipsecpolicy-update,,Update a given IPsec policy. vpn-service-create,,Create a VPN service. vpn-service-delete,,Delete a given VPN service. vpn-service-list,,List VPN service configurations that belong to a given tenant. vpn-service-show,,Show information of a given VPN service. vpn-service-update,,Update a given VPN service. tap-flow-create,tapflow create,Create a tap flow tap-flow-delete,tapflow delete,Delete a tap flow tap-flow-list,tapflow list,List all tap flows tap-flow-show,tapflow show,Show details of the tap flow tap-service-create,tapservice create,Create a tap service tap-service-delete,tapservice delete,Delete a tap service tap-service-list,tapservice list,List all tap services tap-service-show,tapservice show,Show details of the tap service ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/data/nova.csv0000664000175100017510000002236315033046464023562 0ustar00mylesmylesadd-secgroup,server add security group,Add a Security Group to a server. agent-create,compute agent create,Create new agent build. agent-delete,compute agent delete,Delete existing agent build. agent-list,compute agent list,List all builds. agent-modify,compute agent set,Modify existing agent build. aggregate-add-host,aggregate add host,Add the host to the specified aggregate. aggregate-cache-images,aggregate cache image,Request images be cached. (Supported by API versions '2.81' - '2.latest') [hint: use '-- os-compute-api-version' flag to show help message for proper version] aggregate-create,aggregate create,Create a new aggregate with the specified details. aggregate-delete,aggregate delete,Delete the aggregate. aggregate-list,aggregate list,Print a list of all aggregates. aggregate-remove-host,aggregate remove host,Remove the specified host from the specified aggregate. aggregate-set-metadata,aggregate set / unset,Update the metadata associated with the aggregate. aggregate-show,aggregate show,Show details of the specified aggregate. aggregate-update,aggregate set / unset,Update the aggregate's name and optionally availability zone. availability-zone-list,availability zone list,List all the availability zones. backup,server backup create,Backup a server by creating a 'backup' type snapshot. boot,server create,Boot a new server. clear-password,server set --root-password,Clear the admin password for a server from the metadata server. This action does not actually change the instance server password. console-log,console log show,Get console log output of a server. delete,server delete,Immediately shut down and delete specified server(s). diagnostics,openstack server show --diagnostics,Retrieve server diagnostics. evacuate,server evacuate,Evacuate server from failed host. flavor-access-add,flavor set --project,Add flavor access for the given tenant. flavor-access-list,flavor show,Print access information about the given flavor. flavor-access-remove,flavor unset,Remove flavor access for the given tenant. flavor-create,flavor create,Create a new flavor. flavor-delete,flavor delete,Delete a specific flavor flavor-key,flavor set / unset --property,Set or unset extra_spec for a flavor. flavor-list,flavor list,Print a list of available 'flavors' flavor-show,flavor show,Show details about the given flavor. flavor-update,flavor set --description,Update the description of an existing flavor. (Supported by API versions '2.55' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version] force-delete,server delete,Force delete a server. get-mks-console,console url show --mks,Get an MKS console to a server. (Supported by API versions '2.8' - '2.latest') [hint: use ' --os-compute-api-version' flag to show help message for proper version] get-password,WONTFIX,Get the admin password for a server. This operation calls the metadata service to query metadata information and does not read password information from the server itself. get-rdp-console,console url show --rdp,Get a rdp console to a server. get-serial-console,console url show --serial,Get a serial console to a server. get-spice-console,console url show --spice,Get a spice console to a server. get-vnc-console,console url show --novnc,Get a vnc console to a server. host-evacuate,WONTFIX,Evacuate all instances from failed host. host-evacuate-live,WONTFIX,Live migrate all instances off the specified host to other available hosts. host-meta,WONTFIX,Set or Delete metadata on all instances of a host. host-servers-migrate,WONTFIX,Cold migrate all instances off the specified host to other available hosts. hypervisor-list,hypervisor list,List hypervisors. (Supported by API versions '2.0' - '2.latest') hypervisor-servers,server list --host,List servers belonging to specific hypervisors. hypervisor-show,hypervisor show,Display the details of the specified hypervisor. hypervisor-stats,hypervisor stats show,Get hypervisor statistics over all compute nodes. hypervisor-uptime,hypervisor show,Display the uptime of the specified hypervisor. image-create,server image create,Create a new image by taking a snapshot of a running server. instance-action,server event show,Show an action. instance-action-list,server event list,List actions on a server. instance-usage-audit-log,WONTFIX,List/Get server usage audits. interface-attach,server add port / server add floating ip / server add fixed ip,Attach a network interface to a server. interface-detach,server remove port,Detach a network interface from a server. interface-list,port list --server,List interfaces attached to a server. keypair-add,keypair create,Create a new key pair for use with servers. keypair-delete,keypair delete,Delete keypair given by its name. keypair-list,keypair list,Print a list of keypairs for a user keypair-show,keypair show,Show details about the given keypair. limits,limits show,Print rate and absolute limits. list,server list,List active servers. list-secgroup,security group list,List Security Group(s) of a server. live-migration,server migration list,Migrate running server to a new machine. live-migration-abort,server migration abort,Abort an on-going live migration. live-migration-force-comp,server migration force complete,Force on-going live migration to complete. lock,server lock,Lock a server. meta,server set --property / unset,Set or delete metadata on a server. migrate,server migrate,Migrate a server. The new host will be selected by the scheduler. migration-list,server migration list,Print a list of migrations. pause,server pause,Pause a server. quota-class-show,quota show --class,List the quotas for a quota class. quota-class-update,quota set --class,Update the quotas for a quota class. quota-defaults,quota list,List the default quotas for a tenant. quota-delete,quota delete --compute,Delete quota for a tenant/user so their quota will Revert back to default. quota-show,quota show,List the quotas for a tenant/user. quota-update,quota set,Update the quotas for a tenant/user. reboot,server reboot,Reboot a server. rebuild,server rebuild,"Shutdown, re-image, and re-boot a server." refresh-network,WONTFIX,Refresh server network information. remove-secgroup,server remove security group,Remove a Security Group from a server. rescue,server rescue,Reboots a server into rescue mode. reset-network,WONTFIX,Reset network of a server. reset-state,server set --state,Reset the state of a server. resize,server resize,Resize a server. resize-confirm,server resize --confirm,Confirm a previous resize. resize-revert,server resize --revert,Revert a previous resize. restore,server restore,Restore a soft-deleted server. resume,server resume,Resume a server. server-group-create,server group create,Create a new server group with the specified details. server-group-delete,server group delete,Delete specific server group(s). server-group-get,server group show,Get a specific server group. server-group-list,server group list,Print a list of all server groups. server-migration-list,server migration list,Get the migrations list of specified server. server-migration-show,server migration show,Get the migration of specified server. server-tag-add,server set --tag,Add one or more tags to a server. server-tag-delete,server unset --tag,Delete one or more tags from a server. server-tag-delete-all,server unset --tag,Delete all tags from a server. server-tag-list,server list --tag,Get list of tags from a server. server-tag-set,server set --tag,Set list of tags to a server. server-topology,openstack server show --topology,Retrieve server topology. (Supported by API versions '2.78' - '2.latest') [hint: use '-- os-compute-api-version' flag to show help message for proper version] service-delete,compute service delete,Delete the service. service-disable,compute service set --disable,Disable the service. service-enable,compute service set --enable,Enable the service. service-force-down,compute service set --force,Force service to down. service-list,compute service list,Show a list of all running services. set-password,server set --root-password,Change the admin password for a server. shelve,server shelve,Shelve a server. shelve-offload,shelve --offload,Remove a shelved server from the compute node. show,server show,Show details about the given server. ssh,server ssh,SSH into a server. start,server start,Start the server(s). stop,server stop,Stop the server(s). suspend,server suspend,Suspend a server. trigger-crash-dump,server dump create,Trigger crash dump in an instance. unlock,server unlock,Unlock a server. unpause,server unpause,Unpause a server. unrescue,server unrescue,Restart the server from normal boot disk again. unshelve,server unshelve,Unshelve a server. update,server set / unset,Update the name or the description for a server. usage,usage show,Show usage data for a single tenant. usage-list,usage list,List usage data for all tenants. version-list,versions show --service compute,List all API versions. volume-attach,server add volume,Attach a volume to a server. volume-attachments,server volume list,List all the volumes attached to a server. volume-detach,server remove volume,Detach a volume from a server. volume-update,server volume update,Update volume attachment. bash-completion,complete,Prints all of the commands and options to stdout so that the nova.bash_completion script doesn't have to hard code them. help,help,Display help about this program or one of its subcommands. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/data/swift.csv0000664000175100017510000000141715033046464023750 0ustar00mylesmylesdelete,object delete / container delete,Delete a container or objects within a container. download,object save / container save,Download objects from containers. list,object list / container list,Lists the containers for the account or the objects for a container. post,container create / object set / container set / object store account set,"Updates meta information for the account, container, or object." copy,,"Copies object, optionally adds meta." stat,object show / container show / object store account show,"Displays information for the account, container, or object." upload,object create,Uploads files or directories to the given container. capabilities,,List cluster capabilities. tempurl,,Create a temporary URL. auth,WONTFIX,Display auth related environment variables. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/decoder.rst0000664000175100017510000000227715033046464023332 0ustar00mylesmyles============= Mapping Guide ============= The following is an incomplete mapping between legacy OpenStack CLIs and OpenStackClient. Think of it as a magic decoder ring if you were using the legacy CLIs and want to transition to OpenStack CLI. Command options are only shown when necessary. ``cinder CLI`` -------------- .. csv-table:: :header: "Cinder CLI", "OSC Equivalent", "Description" :widths: 25, 25, 50 :file: data/cinder.csv ``glance CLI`` -------------- .. csv-table:: :header: "Glance CLI", "OSC Equivalent", "Description" :widths: 25, 25, 50 :file: data/glance.csv ``keystone CLI`` ---------------- .. csv-table:: :header: "Keystone CLI", "OSC Equivalent", "Description" :widths: 25, 25, 50 :file: data/keystone.csv ``neutron CLI`` --------------- .. csv-table:: :header: "Neutron CLI", "OSC Equivalent", "Description" :widths: 25, 25, 50 :file: data/neutron.csv ``nova CLI`` ------------ .. csv-table:: :header: "Nova CLI", "OSC Equivalent", "Description" :widths: 25, 25, 50 :file: data/nova.csv ``swift CLI`` ------------- .. csv-table:: :header: "Swift CLI", "OSC Equivalent", "Description" :widths: 25, 25, 50 :file: data/swift.csv ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/index.rst0000664000175100017510000000062015033046464023022 0ustar00mylesmyles==================== User Documentation ==================== .. toctree:: :maxdepth: 2 Manual Page command-list commands plugin-commands/index authentication interactive decoder backwards-incompatible .. NOTE(efried): Everything must be in a toctree but we don't want these to show up to the reader. .. toctree:: :glob: :hidden: _hidden/* ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/interactive.rst0000664000175100017510000001425715033046464024243 0ustar00mylesmyles================ Interactive Mode ================ OpenStackClient has an interactive mode, similar to the :program:`virsh(1)` or :program:`lvm(8)` commands on Linux. This mode is useful for executing a series of commands without having to reload the CLI, or more importantly, without having to re-authenticate to the cloud. Enter interactive mode by issuing the :command:`openstack` command with no subcommand. An :code:`(openstack)` prompt will be displayed. Interactive mode is terminated with :command:`exit`. Authentication ============== Authentication happens exactly as before, using the same global command line options and environment variables, except it only happens once. The credentials are cached and re-used for subsequent commands. This means that to work with multiple clouds interactive mode must be ended so a authentication to the second cloud can occur. Scripting ========= Using interactive mode inside scripts sounds counter-intuitive, but the same single-authentication benefit can be achieved by passing OSC commands to the CLI via :code:`stdin`. Sample session: .. code-block:: bash # assume auth credentials are in the environment $ openstack (openstack) keypair list +--------+-------------------------------------------------+ | Name | Fingerprint | +--------+-------------------------------------------------+ | bunsen | a5:da:0c:52:e8:52:42:a3:4f:b8:22:62:7b:e4:e8:89 | | beaker | 45:9c:50:56:7c:fc:3a:b6:b5:60:02:2f:41:fb:a9:4c | +--------+-------------------------------------------------+ (openstack) image list +--------------------------------------+----------------+ | ID | Name | +--------------------------------------+----------------+ | 78b23835-c800-4d95-9d2a-e4de59a553d8 | OpenWRT r42884 | | 2e45d43a-7c25-45f1-b012-06ac313e2f6b | Fedora 20 | | de3a8396-3bae-42de-84bd-f4e398b8c320 | CirrOS | +--------------------------------------+----------------+ (openstack) flavor list +--------------------------------------+----------+--------+--------+-----------+------+-------+-------------+-----------+-------------+ | ID | Name | RAM | Disk | Ephemeral | Swap | VCPUs | RXTX Factor | Is Public | Extra Specs | +--------------------------------------+----------+--------+--------+-----------+------+-------+-------------+-----------+-------------+ | 12594680-56f7-4da2-8322-7266681b3070 | m1.small | 2048 | 20 | 0 | | 1 | | True | | | 9274f903-0cc7-4a95-9124-1968018e355d | m1.tiny | 512 | 5 | 0 | | 1 | | True | | +--------------------------------------+----------+--------+--------+-----------+------+-------+-------------+-----------+-------------+ (openstack) server create --image CirrOS --flavor m1.small --key-name beaker sample-server +-----------------------------+-------------------------------------------------+ | Field | Value | +-----------------------------+-------------------------------------------------+ | config_drive | | | created | 2014-11-19T18:08:41Z | | flavor | m1.small (12594680-56f7-4da2-8322-7266681b3070) | | id | 3a9a7f82-e902-4948-9245-52b045c76a1d | | image | CirrOS (de3a8396-3bae-42de-84bd-f4e398b8c320) | | key_name | bunsen | | name | sample-server | | progress | 0 | | properties | | | security_groups | [{u'name': u'default'}] | | status | BUILD | | tenant_id | 53c93c7952594d9ba16bd7072a165ce8 | | updated | 2014-11-19T18:08:42Z | | user_id | 1e4eea54c7124688a8092bec6e2dbee6 | +-----------------------------+-------------------------------------------------+ A similar session can be issued all at once: .. code-block:: bash $ openstack < keypair list > flavor show m1.small > EOF (openstack) +--------+-------------------------------------------------+ | Name | Fingerprint | +--------+-------------------------------------------------+ | bunsen | a5:da:0c:52:e8:52:42:a3:4f:b8:22:62:7b:e4:e8:89 | | beaker | 45:9c:50:56:7c:fc:3a:b6:b5:60:02:2f:41:fb:a9:4c | +--------+-------------------------------------------------+ (openstack) +----------------------------+--------------------------------------+ | Field | Value | +----------------------------+--------------------------------------+ | OS-FLV-DISABLED:disabled | False | | OS-FLV-EXT-DATA:ephemeral | 0 | | disk | 20 | | id | 12594680-56f7-4da2-8322-7266681b3070 | | name | m1.small | | os-flavor-access:is_public | True | | ram | 2048 | | swap | | | vcpus | 1 | +----------------------------+--------------------------------------+ Limitations =========== The obvious limitations to Interactive Mode is that it is not a Domain Specific Language (DSL), just a simple command processor. That means there are no variables or flow control. ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9291112 python_openstackclient-8.1.1.dev14/doc/source/cli/man/0000775000175100017510000000000015033046512021730 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/man/openstack.rst0000664000175100017510000004445615033046464024474 0ustar00mylesmyles.. _manpage: ==================== :program:`openstack` ==================== OpenStack Command Line SYNOPSIS ======== :program:`openstack` [] [] :program:`openstack help` :program:`openstack` :option:`--help` DESCRIPTION =========== :program:`openstack` provides a common command-line interface to OpenStack APIs. It is generally equivalent to the CLIs provided by the OpenStack project client libraries, but with a distinct and consistent command structure. AUTHENTICATION METHODS ====================== :program:`openstack` uses a similar authentication scheme as the OpenStack project CLIs, with the credential information supplied either as environment variables or as options on the command line. The primary difference is the use of 'project' in the name of the options ``OS_PROJECT_NAME``/``OS_PROJECT_ID`` over the old tenant-based names. :: export OS_AUTH_URL= export OS_PROJECT_NAME= export OS_USERNAME= export OS_PASSWORD= # (optional) :program:`openstack` can use different types of authentication plugins provided by the keystoneclient library. The following default plugins are available: * ``token``: Authentication with a token * ``password``: Authentication with a username and a password * ``openid`` : Authentication using the protocol OpenID Connect Refer to the keystoneclient library documentation for more details about these plugins and their options, and for a complete list of available plugins. Please bear in mind that some plugins might not support all of the functionalities of :program:`openstack`; for example the v3unscopedsaml plugin can deliver only unscoped tokens, some commands might not be available through this authentication method. Additionally, it is possible to use Keystone's service token to authenticate, by setting the options :option:`--os-token` and :option:`--os-endpoint` (or the environment variables :envvar:`OS_TOKEN` and :envvar:`OS_ENDPOINT` respectively). This method takes precedence over authentication plugins. .. NOTE:: To use the ``v3unscopedsaml`` method, the lxml package will need to be installed. AUTHENTICATION USING FEDERATION ------------------------------- To use federated authentication, your configuration file needs the following: :: export OS_PROJECT_NAME= export OS_PROJECT_DOMAIN_NAME= export OS_AUTH_URL= export OS_IDENTITY_API_VERSION=3 export OS_AUTH_PLUGIN=openid export OS_AUTH_TYPE=v3oidcpassword export OS_USERNAME= export OS_PASSWORD= export OS_IDENTITY_PROVIDER= export OS_CLIENT_ID= export OS_CLIENT_SECRET= export OS_OPENID_SCOPE= export OS_PROTOCOL= export OS_ACCESS_TOKEN_TYPE= export OS_DISCOVERY_ENDPOINT= export OS_ACCESS_TOKEN_ENDPOINT= OPTIONS ======= :program:`openstack` takes global options that control overall behaviour and command-specific options that control the command operation. Most global options have a corresponding environment variable that may also be used to set the value. If both are present, the command-line option takes priority. The environment variable names are derived from the option name by dropping the leading dashes ('--'), converting each embedded dash ('-') to an underscore ('_'), and converting to upper case. :program:`openstack` recognizes the following global options: .. option:: --os-cloud :program:`openstack` will look for a ``clouds.yaml`` file that contains a cloud configuration to use for authentication. See CLOUD CONFIGURATION below for more information. .. option:: --os-auth-type The authentication plugin type to use when connecting to the Identity service. If this option is not set, :program:`openstack` will attempt to guess the authentication method to use based on the other options. If this option is set, its version must match :option:`--os-identity-api-version` .. option:: --os-auth-url Authentication URL .. option:: --os-endpoint Service ENDPOINT, when using a service token for authentication .. option:: --os-domain-name Domain-level authorization scope (by name) .. option:: --os-domain-id Domain-level authorization scope (by ID) .. option:: --os-project-name Project-level authentication scope (by name) .. option:: --os-project-id Project-level authentication scope (by ID) .. option:: --os-project-domain-name Domain name containing project .. option:: --os-project-domain-id Domain ID containing project .. option:: --os-username Authentication username .. option:: --os-password Authentication password .. option:: --os-token Authenticated token or service token .. option:: --os-user-domain-name Domain name containing user .. option:: --os-user-domain-id Domain ID containing user .. option:: --os-trust-id ID of the trust to use as a trustee user .. option:: --os-default-domain Default domain ID (Default: 'default') .. option:: --os-region-name Authentication region name .. option:: --os-cacert CA certificate bundle file .. option:: --verify` | :option:`--insecure Verify or ignore server certificate (default: verify) .. option:: --os-cert Client certificate bundle file .. option:: --os-key Client certificate key file .. option:: --os-identity-api-version Identity API version (Default: 2.0) .. option:: --os-XXXX-api-version Additional API version options will be available depending on the installed API libraries. .. option:: --os-interface Interface type. Valid options are `public`, `admin` and `internal`. .. NOTE:: If you switch to openstackclient from project specified clients, like: novaclient, neutronclient and so on, please use `--os-interface` instead of `--os-endpoint-type`. .. option:: --os-profile Performance profiling HMAC key for encrypting context data This key should be the value of one of the HMAC keys defined in the configuration files of OpenStack services to be traced. .. option:: --os-beta-command Enable beta commands which are subject to change .. option:: --log-file Specify a file to log output. Disabled by default. .. option:: -v, --verbose Increase verbosity of output. Can be repeated. .. option:: -q, --quiet Suppress output except warnings and errors .. option:: --debug Show tracebacks on errors and set verbosity to debug .. option:: --help Show help message and exit .. option:: --timing Print API call timing information COMMANDS ======== To get a list of the available commands:: openstack --help To get a description of a specific command:: openstack help Note that the set of commands shown will vary depending on the API versions that are in effect at that time. For example, to force the display of the Identity v3 commands:: openstack --os-identity-api-version 3 --help .. option:: complete Print the bash completion functions for the current command set. .. option:: help Print help for an individual command Additional information on the OpenStackClient command structure and arguments is available in the `OpenStackClient Commands`_ wiki page. .. _`OpenStackClient Commands`: https://wiki.openstack.org/wiki/OpenStackClient/Commands Command Objects --------------- The list of command objects is growing longer with the addition of OpenStack project support. The object names may consist of multiple words to compose a unique name. Occasionally when multiple APIs have a common name with common overlapping purposes there will be options to select which object to use, or the API resources will be merged, as in the ``quota`` object that has options referring to both Compute and Block Storage quotas. Command Actions --------------- The actions used by OpenStackClient are defined with specific meaning to provide a consistent behavior for each object. Some actions have logical opposite actions, and those pairs will always match for any object that uses them. CLOUD CONFIGURATION =================== Working with multiple clouds can be simplified by keeping the configuration information for those clouds in a local file. :program:`openstack` supports using a ``clouds.yaml`` configuration file. Config Files ------------ :program:`openstack` will look for a file called clouds.yaml in the following locations: * Current Directory * ~/.config/openstack * /etc/openstack The first file found wins. The keys match the :program:`openstack` global options but without the ``--os-`` prefix: :: clouds: devstack: auth: auth_url: http://192.168.122.10:5000/ project_name: demo username: demo password: 0penstack region_name: RegionOne ds-admin: auth: auth_url: http://192.168.122.10:5000/ project_name: admin username: admin password: 0penstack region_name: RegionOne infra: cloud: rackspace auth: project_id: 275610 username: openstack password: xyzpdq!lazydog region_name: DFW,ORD,IAD In the above example, the ``auth_url`` for the ``rackspace`` cloud is taken from :file:`clouds-public.yaml`: :: public-clouds: rackspace: auth: auth_url: 'https://identity.api.rackspacecloud.com/v2.0/' Authentication Settings ----------------------- OpenStackClient uses the Keystone authentication plugins so the required auth settings are not always known until the authentication type is selected. :program:`openstack` will attempt to detect a couple of common auth types based on the arguments passed in or found in the configuration file, but if those are incomplete it may be impossible to know which auth type is intended. The :option:`--os-auth-type` option can always be used to force a specific type. When :option:`--os-token` and :option:`--os-endpoint` are both present the ``token_endpoint`` auth type is selected automatically. If :option:`--os-auth-url` and :option:`--os-username` are present ``password`` auth type is selected. Logging Settings ---------------- :program:`openstack` can record the operation history by logging settings in configuration file. Recording the user operation, it can identify the change of the resource and it becomes useful information for troubleshooting. See :ref:`configuration` about Logging Settings for more details. NOTES ===== The command list displayed in help output reflects the API versions selected. For example, to see Identity v3 commands ``OS_IDENTITY_API_VERSION`` must be set to ``3``. EXAMPLES ======== Show the detailed information for server ``appweb01``:: openstack \ --os-project-name ExampleCo \ --os-username demo --os-password secret \ --os-auth-url http://localhost:5000:/v2.0 \ server show appweb01 The same but using openid to authenticate in keystone:: openstack \ --os-project-name ExampleCo \ --os-auth-url http://localhost:5000:/v2.0 \ --os-auth-plugin openid \ --os-auth-type v3oidcpassword \ --os-username demo-idp \ --os-password secret-idp \ --os-identity-provider google \ --os-client-id the-id-assigned-to-keystone-in-google \ --os-client-secret 3315162f-2b28-4809-9369-cb54730ac837 \ --os-openid-scope 'openid email profile'\ --os-protocol openid \ --os-access-token-type access_token \ --os-discovery-endpoint https://accounts.google.com/.well-known/openid-configuration \ server show appweb01 The same command if the auth environment variables (:envvar:`OS_AUTH_URL`, :envvar:`OS_PROJECT_NAME`, :envvar:`OS_USERNAME`, :envvar:`OS_PASSWORD`) are set:: openstack server show appweb01 Create a new image:: openstack image create \ --disk-format=qcow2 \ --container-format=bare \ --public \ --copy-from http://somewhere.net/foo.img \ foo FILES ===== :file:`~/.config/openstack/clouds.yaml` Configuration file used by the :option:`--os-cloud` global option. :file:`~/.config/openstack/clouds-public.yaml` Configuration file containing public cloud provider information such as authentication URLs and service definitions. The contents of this file should be public and sharable. ``clouds.yaml`` may contain references to clouds defined here as shortcuts. :file:`~/.openstack` Placeholder for future local state directory. This directory is intended to be shared among multiple OpenStack-related applications; contents are namespaced with an identifier for the app that owns it. Shared contents (such as :file:`~/.openstack/cache`) have no prefix and the contents must be portable. ENVIRONMENT VARIABLES ===================== The following environment variables can be set to alter the behaviour of :program:`openstack`. Most of them have corresponding command-line options that take precedence if set. .. envvar:: OS_CLOUD The name of a cloud configuration in ``clouds.yaml``. .. envvar:: OS_AUTH_PLUGIN The authentication plugin to use when connecting to the Identity service, its version must match the Identity API version .. envvar:: OS_AUTH_URL Authentication URL .. envvar:: OS_AUTH_TYPE Define the authentication plugin that will be used to handle the authentication process. One of the following: - ``v2password`` - ``v2token`` - ``v3password`` - ``v3token`` - ``v3oidcclientcredentials`` - ``v3oidcpassword`` - ``v3oidcauthorizationcode`` - ``v3oidcaccesstoken`` - ``v3totp`` - ``v3tokenlessauth`` - ``v3applicationcredential`` - ``v3multifactor`` .. envvar:: OS_ENDPOINT Service ENDPOINT (when using the service token) .. envvar:: OS_DOMAIN_NAME Domain-level authorization scope (name or ID) .. envvar:: OS_PROJECT_NAME Project-level authentication scope (name or ID) .. envvar:: OS_PROJECT_DOMAIN_NAME Domain name or ID containing project .. envvar:: OS_USERNAME Authentication username .. envvar:: OS_TOKEN Authenticated or service token .. envvar:: OS_PASSWORD Authentication password .. envvar:: OS_USER_DOMAIN_NAME Domain name or ID containing user .. envvar:: OS_TRUST_ID ID of the trust to use as a trustee user .. envvar:: OS_DEFAULT_DOMAIN Default domain ID (Default: 'default') .. envvar:: OS_REGION_NAME Authentication region name .. envvar:: OS_CACERT CA certificate bundle file .. envvar:: OS_CERT Client certificate bundle file .. envvar:: OS_KEY Client certificate key file .. envvar:: OS_IDENTITY_API_VERSION Identity API version (Default: 2.0) .. envvar:: OS_XXXX_API_VERSION Additional API version options will be available depending on the installed API libraries. .. envvar:: OS_INTERFACE Interface type. Valid options are `public`, `admin` and `internal`. .. envvar:: OS_PROTOCOL Define the protocol that is used to execute the federated authentication process. It is used in the Keystone authentication URL generation process. .. envvar:: OS_IDENTITY_PROVIDER Define the identity provider of your federation that will be used. It is used by the Keystone authentication URL generation process. The available Identity Providers can be listed using the :program:`openstack identity provider list` command .. envvar:: OS_CLIENT_ID Configure the ``CLIENT_ID`` that the CLI will use to authenticate the application (OpenStack) in the Identity Provider. This value is defined on the identity provider side. Do not confuse with the user ID. .. envvar:: OS_CLIENT_SECRET Configure the OS_CLIENT_SECRET that the CLI will use to authenticate the CLI (OpenStack secret in the identity provider). .. envvar:: OS_OPENID_SCOPE Configure the attribute scopes that will be claimed by the Service Provider (SP), in this case OpenStack, from the identity provider. These scopes and which attributes each scope contains are defined in the identity provider side. This parameter can receive multiple values separated by space. .. envvar:: OS_ACCESS_TOKEN_TYPE Define the type of access token that is used in the token introspection process. This variable can assume only one of the states ("access_token" or "id_token"). .. envvar:: OS_DISCOVERY_ENDPOINT Configure the identity provider's discovery URL. This URL will provide a discover document that contains metadata describing the identity provider endpoints. This variable is optional if the variable ``OS_ACCESS_TOKEN_ENDPOINT`` is defined. .. envvar:: OS_ACCESS_TOKEN_ENDPOINT Overrides the value presented in the discovery document retrieved from ``OS_DISCOVERY_ENDPOINT`` URL request. This variable is optional if the ``OS_DISCOVERY_ENDPOINT`` is configured. .. NOTE:: If you switch to openstackclient from project specified clients, like: novaclient, neutronclient and so on, please use `OS_INTERFACE` instead of `OS_ENDPOINT_TYPE`. BUGS ==== Bug reports are accepted at the python-openstackclient Launchpad project "https://bugs.launchpad.net/python-openstackclient". AUTHORS ======= Please refer to the AUTHORS file distributed with OpenStackClient. COPYRIGHT ========= Copyright 2011-2014 OpenStack Foundation and the authors listed in the AUTHORS file. LICENSE ======= http://www.apache.org/licenses/LICENSE-2.0 SEE ALSO ======== The `OpenStackClient page `_ in the `OpenStack Docs `_ contains further documentation. The individual OpenStack project CLIs, the OpenStack API references. ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9301114 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/0000775000175100017510000000000015033046512024252 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/aodh.rst0000664000175100017510000000007015033046464025722 0ustar00mylesmylesaodh ---- .. autoprogram-cliff:: openstack.alarming.v2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/barbican.rst0000664000175100017510000000010315033046464026545 0ustar00mylesmylesbarbican -------- .. autoprogram-cliff:: openstack.key_manager.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/cyborg.rst0000664000175100017510000000007715033046464026303 0ustar00mylesmylescyborg ------ .. autoprogram-cliff:: openstack.accelerator.v2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/designate.rst0000664000175100017510000000007515033046464026757 0ustar00mylesmylesdesignate --------- .. autoprogram-cliff:: openstack.dns.v2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/gnocchi.rst0000664000175100017510000000007415033046464026425 0ustar00mylesmylesgnocchi ------- .. autoprogram-cliff:: openstack.metric.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/heat.rst0000664000175100017510000000007515033046464025735 0ustar00mylesmylesheat ---- .. autoprogram-cliff:: openstack.orchestration.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/index.rst0000664000175100017510000000044715033046464026126 0ustar00mylesmyles.. _plugin-commands: =============== Plugin Commands =============== .. toctree:: :maxdepth: 1 aodh barbican cyborg designate gnocchi heat ironic ironic-inspector magnum manila mistral neutron octavia placement trove watcher zaqar zun ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/ironic-inspector.rst0000664000175100017510000000013715033046464030302 0ustar00mylesmylesironic-inspector ---------------- .. autoprogram-cliff:: openstack.baremetal_introspection.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/ironic.rst0000664000175100017510000000007515033046464026277 0ustar00mylesmylesironic ------ .. autoprogram-cliff:: openstack.baremetal.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/magnum.rst0000664000175100017510000000010315033046464026270 0ustar00mylesmylesmagnum ------ .. autoprogram-cliff:: openstack.container_infra.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/manila.rst0000664000175100017510000000007115033046464026251 0ustar00mylesmylesmanila ------ .. autoprogram-cliff:: openstack.share.v2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/mistral.rst0000664000175100017510000000010515033046464026461 0ustar00mylesmylesmistral ------- .. autoprogram-cliff:: openstack.workflow_engine.v2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/neutron.rst0000664000175100017510000000010315033046464026476 0ustar00mylesmylesneutron ------- .. autoprogram-cliff:: openstack.neutronclient.v2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/octavia.rst0000664000175100017510000000010315033046464026432 0ustar00mylesmylesoctavia ------- .. autoprogram-cliff:: openstack.load_balancer.v2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/placement.rst0000664000175100017510000000010315033046464026754 0ustar00mylesmylesplacement --------- .. autoprogram-cliff:: openstack.placement.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/trove.rst0000664000175100017510000000007215033046464026150 0ustar00mylesmylestrove ----- .. autoprogram-cliff:: openstack.database.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/watcher.rst0000664000175100017510000000010115033046464026437 0ustar00mylesmyleswatcher ------- .. autoprogram-cliff:: openstack.infra_optim.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/zaqar.rst0000664000175100017510000000007315033046464026130 0ustar00mylesmyleszaqar ----- .. autoprogram-cliff:: openstack.messaging.v2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/cli/plugin-commands/zun.rst0000664000175100017510000000006715033046464025631 0ustar00mylesmyleszun --- .. autoprogram-cliff:: openstack.container.v1 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/conf.py0000664000175100017510000002072215033046464021716 0ustar00mylesmyles# # OpenStack Command Line Client documentation build configuration file, created # by sphinx-quickstart on Wed May 16 12:05:58 2012. # # This file is execfile()d with the current directory set to its containing # dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'openstackdocstheme', 'stevedore.sphinxext', 'cliff.sphinxext', 'sphinxcontrib.apidoc', ] # openstackdocstheme options openstackdocs_repo_name = 'openstack/python-openstackclient' openstackdocs_auto_name = False # Add project 'foo' to this list to enable the :foo-doc: role openstackdocs_projects = [ 'neutron', ] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. # source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = 'OpenStack Command Line Client' copyright = '2012-2013 OpenStack Foundation' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # today = '' # Else, today_fmt is used as the format for a strftime call. # today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['**tests**'] # The reST default role (used for this markup: `text`) to use for all # documents. # default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. # add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). # add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. # show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'native' # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['openstackclient.'] # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme_path = ["."] # html_theme = '_theme' html_theme = 'openstackdocs' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". # html_title = None # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. # html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True # Custom sidebar templates, maps document names to template names. # html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. # html_additional_pages = {} # If false, no module index is generated. # html_domain_indices = True # If false, no index is generated. # html_use_index = True # If true, the index is split into individual pages for each letter. # html_split_index = False # If true, links to the reST sources are added to the pages. # html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. # html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). # html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'OpenStackCommandLineClientdoc' # Add any paths that contain "extra" files, such as .htaccess or robots.txt html_extra_path = ['_extra'] # -- Options for LaTeX output ------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]) # . latex_documents = [ ( 'index', 'OpenStackCommandLineClient.tex', 'OpenStack Command Line Client Documentation', 'OpenStack', 'manual', ), ] # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. # latex_use_parts = False # If true, show page references after internal links. # latex_show_pagerefs = False # If true, show URL addresses after external links. # latex_show_urls = False # Documents to append as an appendix to all manuals. # latex_appendices = [] # If false, no module index is generated. # latex_domain_indices = True # -- Options for manual page output ------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ( 'cli/man/openstack', 'openstack', 'OpenStack Command Line Client', ['OpenStack contributors'], 1, ), ] # If true, show URL addresses after external links. # man_show_urls = False # -- Options for Texinfo output ----------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ( 'index', 'OpenStackCommandLineClient', 'OpenStack Command Line Client Documentation', 'OpenStack', 'OpenStackCommandLineClient', 'One line description of project.', 'Miscellaneous', ), ] # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # -- Options for cliff.sphinxext plugin --------------------------------------- autoprogram_cliff_application = 'openstack' autoprogram_cliff_ignored = [ '--help', '--format', '--column', '--max-width', '--fit-width', '--print-empty', '--prefix', '--noindent', '--quote', ] # Prevent cliff from generating "This command is provided by the # python-openstackclient plugin." autoprogram_cliff_app_dist_name = 'python-openstackclient' # -- Options for sphinxcontrib.apidoc ---------------------------------------- apidoc_module_dir = '../../openstackclient' apidoc_excluded_paths = [ 'volume/v3', 'tests', ] apidoc_output_dir = 'contributor/api' ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9301114 python_openstackclient-8.1.1.dev14/doc/source/configuration/0000775000175100017510000000000015033046512023255 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/configuration/index.rst0000664000175100017510000002122415033046464025125 0ustar00mylesmyles.. _configuration: ============= Configuration ============= OpenStackClient is primarily configured using command line options and environment variables. Most of those settings can also be placed into a configuration file to simplify managing multiple cloud configurations. There is a relationship between the global options, environment variables and keywords used in the configuration files that should make translation between these three areas simple. Most global options have a corresponding environment variable that may also be used to set the value. If both are present, the command-line option takes priority. The environment variable names are derived from the option name by dropping the leading dashes (--), converting each embedded dash (-) to an underscore (_), and converting to upper case. The keyword names in the configurations files are derived from the global option names by dropping the ``--os-`` prefix if present. Global Options -------------- The :ref:`openstack manpage ` lists all of the global options recognized by OpenStackClient and the default authentication plugins. Environment Variables --------------------- The :ref:`openstack manpage ` also lists all of the environment variables recognized by OpenStackClient and the default authentication plugins. Configuration Files ------------------- clouds.yaml ~~~~~~~~~~~ :file:`clouds.yaml` is a configuration file that contains everything needed to connect to one or more clouds. It may contain private information and is generally considered private to a user. OpenStackClient looks for a file called :file:`clouds.yaml` in the following locations: * current directory * :file:`~/.config/openstack` * :file:`/etc/openstack` The first file found wins. The keys match the :program:`openstack` global options but without the ``--os-`` prefix. :: clouds: devstack: auth: auth_url: http://192.168.122.10:5000/ project_name: demo username: demo password: 0penstack region_name: RegionOne ds-admin: auth: auth_url: http://192.168.122.10:5000/ project_name: admin username: admin password: 0penstack region_name: RegionOne infra: cloud: rackspace auth: project_id: 275610 username: openstack password: xyzpdq!lazydog region_name: DFW,ORD,IAD interface: internal In the above example, the ``auth_url`` for the ``rackspace`` cloud is taken from :file:`clouds-public.yaml` (see below). The first two entries are for two of the default users of the same DevStack cloud. The third entry is for a Rackspace Cloud Servers account. It is equivalent to the following options if the ``rackspace`` entry in :file:`clouds-public.yaml` (below) is present: :: --os-auth-url https://identity.api.rackspacecloud.com/v2.0/ --os-project-id 275610 --os-username openstack --os-password xyzpdq!lazydog --os-region-name DFW --os-interface internal and can be selected on the command line:: openstack --os-cloud infra server list Note that multiple regions are listed in the ``rackspace`` entry. An otherwise identical configuration is created for each region. If ``-os-region-name`` is not specified on the command line, the first region in the list is used by default. The selection of ``interface`` (as seen above in the ``rackspace`` entry) is optional. For this configuration to work, every service for this cloud instance must already be configured to support this type of interface. If you are using Identity v3 you need to specify the user and the project domain name as shown in the example below: :: clouds: devstack: auth: auth_url: http://192.168.122.10:5000/ project_name: demo username: demo password: 0penstack user_domain_name: Default project_domain_name: Default region_name: RegionOne clouds-public.yaml ~~~~~~~~~~~~~~~~~~ :file:`clouds-public.yaml` is a configuration file that is intended to contain public information about clouds that are common across a large number of users. The idea is that :file:`clouds-public.yaml` could easily be shared among users to simplify public cloud configuration. Similar to :file:`clouds.yaml`, OpenStackClient looks for :file:`clouds-public.yaml` in the following locations: * current directory * :file:`~/.config/openstack` * :file:`/etc/openstack` The first file found wins. The keys here are referenced in :file:`clouds.yaml` ``cloud`` keys. Anything that appears in :file:`clouds.yaml` :: public-clouds: rackspace: auth: auth_url: 'https://identity.api.rackspacecloud.com/v2.0/' Debugging ~~~~~~~~~ You may find the :ref:`configuration show ` command helpful to debug configuration issues. It will display your current configuration. Logging Settings ---------------- By setting `log_level` or `log_file` in the configuration :file:`clouds.yaml`, a user may enable additional logging:: clouds: devstack: auth: auth_url: http://192.168.122.10:5000/ project_name: demo username: demo password: 0penstack region_name: RegionOne operation_log: logging: TRUE file: /tmp/openstackclient_demo.log level: info ds-admin: auth: auth_url: http://192.168.122.10:5000/ project_name: admin username: admin password: 0penstack region_name: RegionOne log_file: /tmp/openstackclient_admin.log log_level: debug :dfn:`log_file`: ```` Full path to logging file. :dfn:`log_level`: ``error`` | ``info`` | ``debug`` If log level is not set, ``warning`` will be used. If log level is ``info``, the following information is recorded: * cloud name * user name * project name * CLI start time (logging start time) * CLI end time * CLI arguments * CLI return value * and any ``info`` messages. If log level is ``debug``, the following information is recorded: * cloud name * user name * project name * CLI start time (logging start time) * CLI end time * CLI arguments * CLI return value * API request header/body * API response header/body * and any ``debug`` messages. When a command is executed, these logs are saved every time. Recording the user operations can help to identify resource changes and provide useful information for troubleshooting. If saving the output of a single command use the `--log-file` option instead. * `--log-file ` The logging level for `--log-file` can be set by using following options. * `-v, --verbose` * `-q, --quiet` * `--debug` Locale and Language Support --------------------------- Full support for languages is included as of OpenStackClient 3.0.0. Here are a few tips to ensure you have a correct configuration. Verify preferred python encoding ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Please perform the following to diagnose ensure locale settings are correct. Run python interactively and print the preferred encoding value, e.g.: :: $ python -c "import locale; print locale.getpreferredencoding()" If the value is ``ascii`` or ``ANSI_X3.4-1968`` or any other equivalent name for ASCII the problem is in your environment. You most likely do not have your LANG environment variable set correctly. Check the LANG environment variable ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``LANG`` should be of the form: `lang_code`_`[region_code]`.`encoding`. For example, it may look like: ``en_US.UTF-8`` The critical part here is the `encoding` value of ``UTF-8``. Python will look up locale information and if it finds an encoding value, it will set the encoding property of stdin, stdout and stderr to the value found in your environment, if it's not defined in your environment it defaults to ASCII. Redirecting output ~~~~~~~~~~~~~~~~~~ The above only occurs if stdin, stdout and stderr are attached to a TTY. If redirecting data the encoding on these streams will default to the default encoding which is set in the `site.py` of your Python distribution, which defaults to ASCII. A workaround for this is to set ``PYTHONIOENCODING`` to UTF8. :: $ PYTHONIOENCODING=utf-8 A final note about DevStack ~~~~~~~~~~~~~~~~~~~~~~~~~~~ A common post devstack operation is to source the ``openrc`` file to set up environment variables. Doing so will unset the default ``LANG`` environment variable in your terminal, which will cause the preferred python encoding to be ``ascii``. We recommend either setting these environment variables independently or using the ``devstack`` or ``devstack-admin`` os-cloud profile. :: $ openstack project list --os-cloud devstack-admin ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1751928137.9301114 python_openstackclient-8.1.1.dev14/doc/source/contributor/0000775000175100017510000000000015033046512022760 5ustar00mylesmyles././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/contributor/command-beta.rst0000664000175100017510000000554515033046464026060 0ustar00mylesmyles.. _command-beta: ============ Command Beta ============ OpenStackClient releases do not always coincide with OpenStack releases. This creates challenges when developing new OpenStackClient commands for the current OpenStack release under development since there may not be an official release of the REST API enhancements necessary for the command. In addition, backwards compatibility may not be guaranteed until an official OpenStack release. To address these challenges, an OpenStackClient command may be labeled as a beta command according to the guidelines below. Such commands may introduce backwards incompatible changes and may use REST API enhancements not yet released. This also applies to command options associated with the beta command object. See the examples below on how to label an entire command or a specific option as a beta by updating the documentation and implementation. The initial release note must label the new command or option as a beta. No further release notes are required until the command or option is no longer a beta. At which time, the beta label or the command or option itself must be removed and a new release note must be provided. Beta Command Example -------------------- Documentation ~~~~~~~~~~~~~ The command documentation must label the command as a beta. example list ++++++++++++ List examples .. caution:: This is a beta command and subject to change. Use global option ``--os-beta-command`` to enable this command. .. program:: example list .. code:: bash openstack example list Help ~~~~ The command help must label the command as a beta. .. code-block:: python class ShowExample(command.ShowOne): """Display example details (Caution: This is a beta command and subject to change. Use global option --os-beta-command to enable this command) """ Implementation ~~~~~~~~~~~~~~ The command must raise a ``CommandError`` exception if beta commands are not enabled via ``--os-beta-command`` global option. .. code-block:: python def take_action(self, parsed_args): self.validate_os_beta_command_enabled() Beta Option Example ------------------- Documentation ~~~~~~~~~~~~~ The option documentation must label the option as a beta. .. option:: --example Example .. caution:: This is a beta command option and subject to change. Use global option ``--os-beta-command`` to enable this command option. Implementation ~~~~~~~~~~~~~~ The option must not be added if beta commands are not enabled via ``--os-beta-command`` global option. .. code-block:: python def get_parser(self, prog_name): if self.app.options.os_beta_command: parser.add_argument( '--example', metavar='', help=_("Example") ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/contributor/command-errors.rst0000664000175100017510000001606515033046464026460 0ustar00mylesmyles============== Command Errors ============== Handling errors in OpenStackClient commands is fairly straightforward. An exception is thrown and handled by the application-level caller. Note: There are many cases that need to be filled out here. The initial version of this document considers the general command error handling as well as the specific case of commands that make multiple REST API calls and how to handle when one or more of those calls fails. General Command Errors ====================== The general pattern for handling OpenStackClient command-level errors is to raise a CommandError exception with an appropriate message. This should include conditions arising from arguments that are not valid/allowed (that are not otherwise enforced by ``argparse``) as well as errors arising from external conditions. External Errors --------------- External errors are a result of things outside OpenStackClient not being as expected. Example ~~~~~~~ This example is taken from ``keypair create`` where the ``--public-key`` option specifies a file containing the public key to upload. If the file is not found, the ``IOError`` exception is trapped and a more specific ``CommandError`` exception is raised that includes the name of the file that was attempted to be opened. .. code-block:: python class CreateKeypair(command.ShowOne): """Create new public key""" ## ... def take_action(self, parsed_args): compute_client = self.app.client_manager.compute public_key = parsed_args.public_key if public_key: try: with open( os.path.expanduser(parsed_args.public_key), "rb" ) as p: public_key = p.read() except IOError as e: msg = _("Key file %s not found: %s") raise exceptions.CommandError( msg % (parsed_args.public_key, e), ) keypair = compute_client.create_keypair( name=parsed_args.name, public_key=public_key, ) ## ... REST API Errors =============== Most commands make a single REST API call via the supporting client library or SDK. Errors based on HTML return codes are usually handled well by default, but in some cases more specific or user-friendly messages need to be logged. Trapping the exception and raising a CommandError exception with a useful message is the correct approach. Multiple REST API Calls ----------------------- Some CLI commands make multiple calls to library APIs and thus REST APIs. Most of the time these are ``create`` or ``set`` commands that expect to add or change a resource on the server. When one of these calls fails, the behaviour of the remainder of the command handler is defined as such: * Whenever possible, all API calls will be made. This may not be possible for specific commands where the subsequent calls are dependent on the results of an earlier call. * Any failure of an API call will be logged for the user * A failure of any API call results in a non-zero exit code * In the cases of failures in a ``create`` command a follow-up mode needs to be present that allows the user to attempt to complete the call, or cleanly remove the partially-created resource and re-try. The desired behaviour is for commands to appear to the user as idempotent whenever possible, i.e. a partial failure in a ``set`` command can be safely retried without harm. ``create`` commands are a harder problem and may need to be handled by having the proper options in a set command available to allow recovery in the case where the primary resource has been created but the subsequent calls did not complete. Example 1 ~~~~~~~~~ This example is taken from the ``volume snapshot set`` command where ``--property`` arguments are set using the volume manager's ``set_metadata()`` method, ``--state`` arguments are set using the ``reset_state()`` method, and the remaining arguments are set using the ``update()`` method. .. code-block:: python class SetSnapshot(command.Command): """Set snapshot properties""" ## ... def take_action(self, parsed_args): volume_client = self.app.client_manager.volume snapshot = utils.find_resource( volume_client.volume_snapshots, parsed_args.snapshot, ) kwargs = {} if parsed_args.name: kwargs['name'] = parsed_args.name if parsed_args.description: kwargs['description'] = parsed_args.description result = 0 if parsed_args.property: try: volume_client.volume_snapshots.set_metadata( snapshot.id, parsed_args.property, ) except SomeException: # Need to define the exceptions to catch here LOG.error(_("Property set failed")) result += 1 if parsed_args.state: try: volume_client.volume_snapshots.reset_state( snapshot.id, parsed_args.state, ) except SomeException: # Need to define the exceptions to catch here LOG.error(_("State set failed")) result += 1 try: volume_client.volume_snapshots.update( snapshot.id, **kwargs ) except SomeException: # Need to define the exceptions to catch here LOG.error(_("Update failed")) result += 1 # NOTE(dtroyer): We need to signal the error, and a non-zero return code, # without aborting prematurely if result > 0: raise SomeNonFatalException Example 2 ~~~~~~~~~ This example is taken from the ``network delete`` command which takes multiple networks to delete. All networks will be deleted in a loop, which makes multiple ``delete_network()`` calls. .. code-block:: python class DeleteNetwork(common.NetworkAndComputeCommand): """Delete network(s)""" def update_parser_common(self, parser): parser.add_argument( 'network', metavar="", nargs="+", help=_("Network(s) to delete (name or ID)") ) return parser def take_action(self, client, parsed_args): ret = 0 for network in parsed_args.network: try: obj = client.find_network(network, ignore_missing=False) client.delete_network(obj) except Exception: LOG.error(_("Failed to delete network with name " "or ID %s."), network) ret += 1 if ret > 0: total = len(parsed_args.network) msg = (_("Failed to delete %(ret)s of %(total)s networks.") % {"ret": ret, "total": total}) raise exceptions.CommandError(msg) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/contributor/command-logs.rst0000664000175100017510000000407215033046464026103 0ustar00mylesmyles============ Command Logs ============ Logger usage in OpenStackClient is not exactly the same as those in other OpenStack projects. The following basic rules should be followed. 1. OpenStackClient uses python standard logging library instead of oslo.log so that it will depend on oslo as little as possible. 2. All logs except debug log need to be translated. The log message strings that need to be translated should follow the rule of i18n guidelines: https://docs.openstack.org/oslo.i18n/latest/user/guidelines.html 3. There are mainly two kinds of logs in OpenStackClient: command specific log and general log. Use different logger to record them. The examples below will show the detail. Command specific log ==================== Command specific logs are those messages that used to record info, warning and error generated from a specific command. OpenStackClient uses the logger of the module the command belongs to to record the command specific logs. Example ~~~~~~~ This example shows how to log command specific logs in OpenStackClient. .. code-block:: python import logging from openstackclient.i18n import _ LOG = logging.getLogger(__name__) # Get the logger of this module ## ... LOG.error(_("Error message")) LOG.warning(_("Warning message")) LOG.info(_("Info message")) LOG.debug("Debug message") # Debug messages do not need to be translated ## ... General log =========== General logs are those messages that not specific to any single command. Use the logger of ``openstackclient.shell`` to record them. In each command class, we can simply get this logger by ``self.app.log``. Example ~~~~~~~ This example shows how to log general logs in OpenStackClient. .. code-block:: python from openstackclient.i18n import _ ## ... self.app.log.error(_("Error message")) self.app.log.warning(_("Warning message")) self.app.log.info(_("Info message")) self.app.log.debug("Debug message") # Debug messages do not need to be translated ## ... ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/contributor/command-options.rst0000664000175100017510000002361615033046464026637 0ustar00mylesmyles=============== Command Options =============== OpenStackClient commands all have a set of zero or more options unique to the command, however there are of course ways in which these options are common and consistent across all of the commands that include them. These are the set of guidelines for OSC developers that help keep the interface and commands consistent. In some cases (like the boolean variables below) we use the same pattern for defining and using options in all situations. The alternative of only using it when necessary leads to errors when copy-n-paste is used for a new command without understanding why or why not that instance is correct. The :ref:`hig` describes the guidelines for option names and usage. In short: * All option names shall be GNU-style long names (two leading dashes). * Some global options may have short names, generally limited to those defined in support libraries such as `cliff `__. General Command Options ======================= Boolean Options --------------- Boolean options for any command that sets a resource state, such as 'enabled' or 'public', shall always have both positive and negative options defined. The names of those options shall either be a naturally occurring pair of words (in English) or a positive option and a negative option with `no-` prepended (such as in the traditional GNU option usage) like `--share` and `--no-share`. In order to handle those APIs that behave differently when a field is set to `None` and when the field is not present in a passed argument list or dict, each of the boolean options shall set its own variable to `True` as part of a mutually exclusive group, rather than the more common configuration of setting a single destination variable `True` or `False` directly. This allows us to detect the situation when neither option is present (both variables will be `False`) and act accordingly for those APIs where this matters. This also requires that each of the boolean values be tested in the `take_action()` method to correctly set (or not) the underlying API field values. .. option:: --enable Enable (default) .. option:: --disable Disable Implementation ~~~~~~~~~~~~~~ The parser declaration should look like this: .. code-block:: python enable_group = parser.add_mutually_exclusive_group() enable_group.add_argument( '--enable', action='store_true', help=_('Enable (default)'), ) enable_group.add_argument( '--disable', action='store_true', help=_('Disable '), ) An example handler in `take_action()`: .. code-block:: python # This leaves 'enabled' undefined if neither option is present if parsed_args.enable: kwargs['enabled'] = True if parsed_args.disable: kwargs['enabled'] = False Options with Choices -------------------- Some options have a specific set of values (or choices) that are valid. These choices may be validated by the CLI. If the underlying API is stable and the list of choices are unlikely to change then the CLI may validate the choices. Otherwise, the CLI must defer validation of the choices to the API. If the option has a default choice then it must be documented. Having the CLI validate choices will be faster and may provide a better error message for the user if an invalid choice is specified (for example: ``argument --test: invalid choice: 'choice4' (choose from 'choice1', 'choice2', 'choice3')``). The trade-off is that CLI changes are required in order to take advantage of new choices. Implementation ~~~~~~~~~~~~~~ An example parser declaration: .. code-block:: python choice_option.add_argument( '--test', metavar='', choices=['choice1', 'choice2', 'choice3'], help=_('Test type (choice1, choice2 or choice3)'), ) Options with Multiple Values ---------------------------- Some options can be repeated to build a collection of values for a property. Adding a value to the collection must be provided via the ``set`` action. Removing a value from the collection must be provided via an ``unset`` action. As a convenience, removing all values from the collection may be provided via a ``--no`` option on the ``set`` action and a ``--all`` option on ``unset`` action. If both ``--no`` option and option are specified, the values specified on the command would overwrite the collection property instead of appending on the ``set`` action. The ``--all`` option must be part of a mutually exclusive group with the related property option on the ``unset`` action, overwrite case don't exist in ``unset`` action. An example behavior for ``set`` action: Append: .. code-block:: bash object set --example-property xxx Overwrite: .. code-block:: bash object set --no-example-property --example-property xxx The example below assumes a property that contains a list of unique values. However, this example can also be applied to other collections using the appropriate parser action and action implementation (e.g. a dict of key/value pairs). Implementations will vary depending on how the REST API handles adding/removing values to/from the collection and whether or not duplicate values are allowed. Implementation ~~~~~~~~~~~~~~ An example parser declaration for `set` action: .. code-block:: python parser.add_argument( '--no-example-property', dest='no_example_property', action='store_true', help=_('Remove all example properties for this ' '(specify both --no-example-property and --example-property' ' to remove the current properties before setting' ' new properties.)'), ) parser.add_argument( '--example-property', metavar='', dest='example_property', action='append', help=_('Example property for this ' '(repeat option to set multiple properties)'), ) Please make `--no-example-property` be shown in front of `--example-property` in the help, like above, that help make users aware of the processing order. An example handler in `take_action()` for `set` action: .. code-block:: python if parsed_args.no_example_property and parsed_args.example_property: kwargs['example_property'] = parsed_args.example_property elif parsed_args.no_example_property: kwargs['example_property'] = [] elif parsed_args.example_property: kwargs['example_property'] = \ resource_example_property + parsed_args.example_property An example parser declaration for `unset` action: .. code-block:: python example_property_group = parser.add_mutually_exclusive_group() example_property_group.add_argument( '--example-property', metavar='', dest='example_property', action='append', help=_('Example property for this ' '(repeat option to remove multiple properties)'), ) example_property_group.add_argument( '--all-example-property', dest='all_example_property', action='store_true', help=_('Remove all example properties for this '), ) An example handler in `take_action()` for `unset` action: .. code-block:: python if parsed_args.example_property: kwargs['example_property'] = \ list(set(resource_example_property) - \ set(parsed_args.example_property)) if parsed_args.all_example_property: kwargs['example_property'] = [] Required Options ---------------- Some options have no default value and the API does not allow them to be `None`, then these options are always required when users use the command to which these options belong. Required options must be validated by the CLI to avoid omissions. The CLI validation may provide an error message for the user if a required option is not specified. (for example: ``error: argument --test is required``) .. option:: --test Test option (required) Implementation ~~~~~~~~~~~~~~ The parser declaration should look like this: .. code-block:: python parser.add_argument( '--test', metavar='', required=True, help=_('Test option (required)'), ) List Command Options ==================== Additional Fields ----------------- Most list commands only return a subset of the available fields by default. Additional fields are available with the `--long` option. All list commands should allow `--long` even if they return all fields by default. .. option:: --long List additional fields in output Implementation ~~~~~~~~~~~~~~ The parser declaration should look like this: .. code-block:: python parser.add_argument( '--long', action='store_true', default=False, help='List additional fields in output', ) Pagination ---------- There are many ways to do pagination, some OpenStack APIs support it, some don't. OpenStackClient attempts to define a single common way to specify pagination on the command line. .. option:: --marker Anchor for paging (name or ID) .. option:: --limit Limit number of returned (*integer*) Implementation ~~~~~~~~~~~~~~ The parser declaration should look like this: .. code-block:: python parser.add_argument( "--marker", metavar="", help="Anchor for paging (name or ID)", ) parser.add_argument( "--limit", metavar="", type=int, help="Limit the number of returned", ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/contributor/command-wrappers.rst0000664000175100017510000000372715033046464027010 0ustar00mylesmyles====================== Command Class Wrappers ====================== When we want to deprecate a command, policy says we need to alert the user. We do this with a message logged at WARNING level before any command output is emitted. OpenStackClient command classes are derived from the ``cliff`` classes. Cliff uses Python's *entry points* mechanism for dispatching the parsed command to the respective handler classes. This lends itself to modifying the command execution at run-time. The obvious approach to adding the deprecation message would be to just add the message to the command class ``take_action()`` method directly. But then the various deprecations are scattered throughout the code base. If we instead wrap the deprecated command class with a new class we can put all of the wrappers into a separate, dedicated module. This also lets us leave the original class unmodified and puts all of the deprecation bits in one place. This is an example of a minimal wrapper around a command class that logs a deprecation message as a warning to the user then calls the original class. * Subclass the deprecated command. * Set class attribute ``deprecated`` to ``True`` to signal cliff to not emit help text for this command. * Log the deprecation message at WARNING level and refer to the replacement for the deprecated command in the log warning message. * Change the entry point class in ``setup.cfg`` to point to the new class. Example Deprecation Class ------------------------- .. code-block:: python class ListFooOld(ListFoo): """List resources""" # This notifies cliff to not display the help for this command deprecated = True log = logging.getLogger('deprecated') def take_action(self, parsed_args): self.log.warning( "%s is deprecated, use 'foobar list'", getattr(self, 'cmd_name', 'this command'), ) return super(ListFooOld, self).take_action(parsed_args) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/contributor/developing.rst0000664000175100017510000001315115033046464025655 0ustar00mylesmyles=============================== Developing with OpenStackClient =============================== Communication ------------- IRC Channel ~~~~~~~~~~~ The OpenStackClient team doesn't have regular meetings so if you have questions or anything you want to discuss, come to our channel: #openstack-sdks Testing ------- Tox prerequisites and installation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Install the prerequisites for Tox: * On Ubuntu or Debian: .. code-block:: bash $ apt-get install gcc gettext python3-dev libxml2-dev libxslt1-dev \ zlib1g-dev You may need to use pip install for some packages. * On RHEL or CentOS including Fedora: .. code-block:: bash $ yum install gcc python3-devel libxml2-devel libxslt-devel * On openSUSE or SUSE linux Enterprise: .. code-block:: bash $ zypper install gcc python3-devel libxml2-devel libxslt-devel Install python-tox: .. code-block:: bash $ pip install tox To run the full suite of tests maintained within OpenStackClient. .. code-block:: bash $ tox .. NOTE:: The first time you run ``tox``, it will take additional time to build virtualenvs. You can later use the ``-r`` option with ``tox`` to rebuild your virtualenv in a similar manner. To run tests for one or more specific test environments (for example, the most common configuration of the latest Python version and PEP-8), list the environments with the ``-e`` option, separated by spaces: .. code-block:: bash $ tox -e py38,pep8 See ``tox.ini`` for the full list of available test environments. Running functional tests ~~~~~~~~~~~~~~~~~~~~~~~~ OpenStackClient also maintains a set of functional tests that are optimally designed to be run against OpenStack's gate. Optionally, a developer may choose to run these tests against any OpenStack deployment, however depending on the services available, results vary. To run the entire suite of functional tests: .. code-block:: bash $ tox -e functional To run a specific functional test: .. code-block:: bash $ tox -e functional -- --regex tests.functional.compute.v2.test_server Running with PDB ~~~~~~~~~~~~~~~~ Using PDB breakpoints with ``tox`` and ``testr`` normally does not work since the tests fail with a `BdbQuit` exception rather than stopping at the breakpoint. To run with PDB breakpoints during testing, use the ``debug`` ``tox`` environment. For example, passing a test name since you will normally only want to run the test that hits your breakpoint: .. code-block:: bash $ tox -e debug openstackclient.tests.identity.v3.test_group For reference, the `debug`_ ``tox`` environment implements the instructions .. _`debug`: https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests Coding Style ------------ OpenStackClient uses `flake8`__ along with `hacking`__, an OpenStack-specific superset of ``flake8`` rules, to enforce coding style. This can be run manually using ``tox``: .. code-block:: bash $ tox -e pep8 Alternatively, you can use the `pre-commit framework`__ to allow running of some linters on each commit. This must be enabled locally to function: .. code-block:: bash $ pip install --user pre-commit $ pre-commit install --allow-missing-config .. __: https://flake8.pycqa.org/en/latest/ .. __: https://docs.openstack.org/hacking/latest/user/hacking.html .. __: https://pre-commit.com/ Documentation ------------- The documentation is generated with Sphinx using the ``tox`` command. To create HTML docs, run the commands: .. code-block:: bash $ tox -e docs The resultant HTML will be in the ``doc/build/html`` directory. Release Notes ------------- The release notes for a patch should be included in the patch. See the `Project Team Guide`_ for more information on using reno in OpenStack. .. _`Project Team Guide`: http://docs.openstack.org/project-team-guide/release-management.html#managing-release-notes If any of the following applies to the patch, a release note is required: * The deployer needs to take an action when upgrading * The plugin interface changes * A new feature is implemented * A command or option is removed * Current behavior is changed * A security bug is fixed Reno is used to generate release notes. Use the commands: .. code-block:: bash $ tox -e venv -- reno new Then edit the sample file that was created and push it with your change. To run the commands and see results: .. code-block:: bash $ git commit # Commit the change because reno scans git log. $ tox -e releasenotes At last, look at the generated release notes files in ``releasenotes/build/html`` in your browser. Testing new code ---------------- If a developer wants to test new code (feature, command or option) that they have written, OpenStackClient may be installed from source by running the following commands in the base directory of the project: .. code-block:: bash $ python setup.py develop or .. code-block:: bash $ pip install -e . Standardize Import Format ~~~~~~~~~~~~~~~~~~~~~~~~~ More information about Import Format, see `Import Order Guide `__. The import order shows below: .. code-block:: none {{stdlib imports in human alphabetical order}} \n {{third-party lib imports in human alphabetical order}} \n {{project imports in human alphabetical order}} \n \n {{begin your code}} Example ^^^^^^^ .. code-block:: python import copy import fixtures import os from osc_lib.api import auth from osc_lib import utils from openstackclient import shell from openstackclient.tests import utils from unittest import mock ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1751928116.0 python_openstackclient-8.1.1.dev14/doc/source/contributor/humaninterfaceguide.rst0000664000175100017510000006547515033046464027550 0ustar00mylesmyles.. _hig: ===================== Human Interface Guide ===================== *Note: This page covers the OpenStackClient CLI only but looks familiar because it was derived from the Horizon HIG.* Overview ======== What is a HIG? The Human Interface Guidelines document was created for OpenStack developers in order to direct the creation of new OpenStackClient command interfaces. Personas ======== Personas are archetypal users of the system. Keep these types of users in mind when designing the interface. Alice the admin --------------- Alice is an administrator who is responsible for maintaining the OpenStack cloud installation. She has many years of experience with Linux systems administration. Darren the deployer ------------------- Darren is responsible for doing the initial OpenStack deployment on the host machines. Emile the end-user ------------------ Emile uses the cloud to do software development inside of the virtual machines. She uses the command-line tools because she finds it quicker than using the dashboard. Principles ========== The principles established in this section define the high-level priorities to be used when designing and evaluating interactions for the OpenStack command line interface. Principles are broad in scope and can be considered the philosophical foundation for the OpenStack experience; while they may not describe the tactical implementation of design, they should be used when deciding between multiple courses of design. A significant theme for designing for the OpenStack experience concerns focusing on common uses of the system rather than adding complexity to support functionality that is rarely used. Consistency ----------- Consistency between OpenStack experiences will ensure that the command line interface feels like a single experience instead of a jumble of disparate products. Fractured experiences only serve to undermine user expectations about how they should interact with the system, creating an unreliable user experience. To avoid this, each interaction and visual representation within the system must be used uniformly and predictably. The architecture and elements detailed in this document will provide a strong foundation for establishing a consistent experience. Example Review Criteria ~~~~~~~~~~~~~~~~~~~~~~~ * Do the command actions adhere to a consistent application of actions? * Has a new type of command subject or output been introduced? * Does the design use command elements (options and arguments) as defined? (See Core Elements.) * Can any newly proposed command elements (actions or subjects) be accomplished with existing elements? * Does the design adhere to the structural model of the core experience? (See Core Architecture.) * Are any data objects displayed or manipulated in a way contradictory to how they are handled elsewhere in the core experience? Simplicity ---------- To best support new users and create straight forward interactions, designs should be as simple as possible. When crafting new commands, designs should minimize the amount of noise present in output: large amounts of nonessential data, overabundance of possible actions and so on. Designs should focus on the intent of the command, requiring only the necessary components and either removing superfluous elements or making them accessible through optional arguments. An example of this principle occurs in OpenStack's use of tables: only the most often used columns are shown by default. Further data may be accessed through the output control options, allowing users to specify the types of data that they find useful in their day-to-day work. Example Review Criteria ~~~~~~~~~~~~~~~~~~~~~~~ * Can options be used to combine otherwise similar commands? * How many of the displayed elements are relevant to the majority of users? * If multiple actions are required for the user to complete a task, is each step required or can the process be more efficient? User-Centered Design -------------------- Commands should be design based on how a user will interact with the system and not how the system's backend is organized. While database structures and APIs may define what is possible, they often do not define good user experience; consider user goals and the way in which users will want to interact with their data, then design for these work flows and mold the interface to the user, not the user to the interface. Commands should be discoverable via the interface itself. To determine a list of available commands, use the ``-h`` or ``--help`` options: .. code-block:: bash $ openstack --help For help with an individual command, use the ``help`` command: .. code-block:: bash $ openstack help server create Example Review Criteria ~~~~~~~~~~~~~~~~~~~~~~~ * How quickly can a user figure out how to accomplish a given task? * Has content been grouped and ordered according to usage relationships? * Do work flows support user goals or add complexity? Transparency ------------ Make sure users understand the current state of their infrastructure and interactions. For example, users should be able to access information about the state of each machine/virtual machine easily, without having to actively seek out this information. Whenever the user initiates an action, make sure a confirmation is displayed[1] to show that an input has been received. Upon completion of a process, make sure the user is informed. Ensure that the user never questions the state of their environment. [1] This goes against the common UNIX philosophy of only reporting error conditions and output that is specifically requested. Example Review Criteria ~~~~~~~~~~~~~~~~~~~~~~~ * Does the user receive feedback when initiating a process? * When a process is completed? * Does the user have quick access to the state of their infrastructure? Architecture ============ Command Structure ----------------- OpenStackClient has a consistent and predictable format for all of its commands. * The top level command name is ``openstack`` * Sub-commands take the form: .. code-block:: bash openstack [] [] [] Subcommands shall have three distinct parts to its commands (in order that they appear): * global options * command object(s) and action * command options and arguments Output formats: * user-friendly tables with headers, etc * machine-parsable delimited .. note:: A note on terminology. An **argument** is a positional parameter to the command. As discussed later, these should be used sparingly in OpenStackClient. An **option** - also known as a **flag** - is a named parameter denoted with either a hyphen and a single-letter name (``-r``) or a double hyphen and a multiple-letter name (``--recursive``). They may or may not also include a user-specified value (``--file foo.txt`` or ``--file=foo.txt``). For more information on this topic and CLIs in general, refer to the excellent `Command Line Interface Guidelines website`__. .. __: https://clig.dev/#arguments-and-flags Global Options ~~~~~~~~~~~~~~ Global options are global in the sense that they apply to every command invocation regardless of action to be performed. They include authentication credentials and API version selection. Most global options have a corresponding environment variable that may also be used to set the value. If both are present, the command-line option takes priority. The environment variable names are derived from the option name by dropping the leading dashes (``--``), converting each embedded dash (``-``) to an underscore (``_``), and converting to upper case. * Global options shall always have a long option name, certain common options may also have short names. Short names should be reserved for global options to limit the potential for duplication and multiple meanings between commands given the limited set of available short names. * All long options names shall begin with two dashes (``--``) and use a single dash (``-``) internally between words (``--like-this``). Underscores (``_``) shall not be used in option names. * Authentication options conform to the common CLI authentication guidelines in :ref:`authentication`. For example, ``--os-username`` can be set from the environment via ``OS_USERNAME``. ``--help`` ++++++++++ The standard ``--help`` global option displays the documentation for invoking the program and a list of the available commands on standard output. All other options and commands are ignored when this is present. The traditional short form help option (``-h``) is also available. ``--version`` +++++++++++++ The standard ``--version`` option displays the name and version on standard output. All other options and commands are ignored when this is present. Objects and Actions ~~~~~~~~~~~~~~~~~~~ Commands consist of an object, described by one or more words, followed by an action. :: For example: * ``group create`` * ``server set`` * ``volume type list`` (note that ``volume type`` is a two-word single object) Some commands require two objects. These commands have the primary object ahead of the action and the secondary object after the action. In badly formed English it is expressed as "(Take) object-1 (and perform) action (using) object-2 (to it)." :: For example: * ``group add user`` * ``aggregate add host`` * ``image remove project`` Object names are always specified in command in their singular form. This is contrary to natural language use. ``help`` ++++++++ The ``help`` command is unique as it appears in front of a normal command and displays the help text for that command rather than execute it. Arguments ~~~~~~~~~ Commands that interact with a specific instance of an object should accept a single argument. This argument should be a name or identifier for the object. :: [] For example: * ``group create `` * ``server set `` (note that ``volume type`` is a two-word single object) For commands that require two objects, the commands should accept two arguments when interacting with specific instances of the two objects. These arguments should appear in the same order as the objects. :: [ ] For example: * ``group add user `` * ``aggregate add host `` * ``image remove project `` Options ~~~~~~~ Each command may have its own set of options distinct from the global options. They follow the same style as the global options and always appear between the command and any arguments the command requires. Command options should only have long names. The small range of available short names makes it hard for a single short option name to have a consistent meaning across multiple commands. Option Forms ++++++++++++ * **datetime**: Datetime options shall accept a value in `ISO-8061`__ format. For example, you can list servers last modified before a given date using ``--changes-before``. :: server list --changes-before 2020-01-01T12:30:00+00:00 * **list**: List options shall be passed via multiple options rather than as a single delimited option. For example, you can set multiple properties on a compute flavor using multiple ``--property`` options. :: flavor set --property quota:read_bytes_sec=10240000 \ --property quota:write_bytes_sec=10240000 \ * **boolean**: Boolean options shall use a form of ``--|--`` (preferred) or ``--