././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.7274013 python-openstackclient-5.8.0/0000775000175000017500000000000000000000000016254 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/.coveragerc0000664000175000017500000000011400000000000020371 0ustar00zuulzuul00000000000000[run] branch = True source = openstackclient [report] ignore_errors = True ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/.mailmap0000664000175000017500000000014300000000000017673 0ustar00zuulzuul00000000000000 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/.pre-commit-config.yaml0000664000175000017500000000143600000000000022541 0ustar00zuulzuul00000000000000--- default_language_version: # force all unspecified python hooks to run python3 python: python3 repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v3.4.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)$ - repo: local hooks: - id: flake8 name: flake8 additional_dependencies: - hacking>=2.0.0 - flake8-import-order>=0.13 language: python entry: flake8 files: '^.*\.py$' exclude: '^(doc|releasenotes|tools)/.*$' ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/.stestr.conf0000664000175000017500000000014500000000000020525 0ustar00zuulzuul00000000000000[DEFAULT] test_path=${OS_TEST_PATH:-./openstackclient/tests/unit} top_dir=./ group_regex=([^\.]+\.)+ ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/.zuul.yaml0000664000175000017500000002124700000000000020223 0ustar00zuulzuul00000000000000--- - 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. 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-py36-tips parent: openstack-tox-py36 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: ^(?!stable) 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-base parent: devstack-tox-functional description: | Base job for devstack-based functional tests timeout: 9000 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 devstack_local_conf: post-config: $CINDER_CONF: DEFAULT: # NOTE(dtroyer): OSC needs to support Volume v1 for a while yet so re-enable enable_v1_api: true devstack_services: ceilometer-acentral: false ceilometer-acompute: false ceilometer-alarm-evaluator: false ceilometer-alarm-notifier: false ceilometer-anotification: false ceilometer-api: false ceilometer-collector: false s-account: true s-container: true s-object: true s-proxy: true osc_environment: PYTHONUNBUFFERED: 'true' OS_CLOUD: devstack-admin zuul_work_dir: src/opendev.org/openstack/python-openstackclient # The Neutron bits are here rather than in osc-functional-devstack-base to # simplify removing Neutron in the osc-functional-devstack-n-net job. - job: name: osc-functional-devstack parent: osc-functional-devstack-base timeout: 7800 vars: devstack_plugins: # NOTE(amotoki): Some neutron features are enabled by devstack plugin neutron: https://opendev.org/openstack/neutron devstack_services: # 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 devstack_localrc: Q_AGENT: openvswitch Q_ML2_TENANT_NETWORK_TYPE: vxlan Q_ML2_PLUGIN_MECHANISM_DRIVERS: openvswitch tox_envlist: functional - job: name: osc-functional-devstack-n-net parent: osc-functional-devstack-base timeout: 7800 vars: devstack_localrc: FLAT_INTERFACE: br_flat PUBLIC_INTERFACE: br_pub devstack_services: n-cell: true n-net: true neutron: false neutron-segments: false q-agt: false q-dhcp: false q-l3: false q-meta: false q-metering: false q-qos: false q-svc: false tox_envlist: functional - job: name: osc-functional-devstack-tips parent: osc-functional-devstack 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 # This is insufficient, but leaving it here as a reminder of what may # someday be all we need to make this work # disable_python3_package swift DISABLED_PYTHON3_PACKAGES: swift devstack_services: # Swift is not ready for python3 yet: At a minimum keystonemiddleware needs # to be installed in the py2 env, there are probably other things too... s-account: false s-container: false s-object: false s-proxy: false # As swift is not available for this job, c-bak service won't be functional. # The backup related tests can be handled by other jobs having swift enabled. # The backup service along with swift services can be enabled once swift is # compatible with py3 c-bak: false tox_envlist: functional tox_install_siblings: true - secret: name: osc-dockerhub data: username: osclientzuul password: !encrypted/pkcs1-oaep - LbIZjJiVstRVXMpoLQ3+/JcNB6lKVUWJXXo5+Outf+PKAaO7mNnv8XLiFMKnJ6ftopLyu hWbX9rA+NddvplLQkf1xxkh7QBBU8PToLr58quI2SENUclt4tpjxbZfZu451kFSNJvNvR E58cHHpfJZpyRnS2htXmN/Qy24gbV2w7CQxSZD2YhlcrerD8uQ8rWEnlY1wcJEaEGomtS ZTGxsdK2TsZC2cd4b7TG7+xbl2i+hjADzwSQAgUzlLlwuG71667+IWk4SOZ7OycJTv9NN ZTak8+CGfiMKdmsxZ1Z8uD7DC+RIklDjMWyly6zuhWzfhOmsmU0CesR50moodRUvbK79p NZM8u0hBex5cl2EpUEwJL/FSPJXUhDMPoMoTZT/SAuXf25R9eZ9JGrKsIAlmVhpl8ifoE 8TpPyvIHGS3YelTQjhqOX0wGb9T4ZauQCcI5Ajzy9NuCTyD9xxme9OX1zz7gMACRnVHvz q7U7Ue90MnmGH6E2SgKjIZhyzy9Efwb7JUvH1Zb3hlrjCjEhwi9MV5FnABTEeXyYwE10s 3o/KZg2zvdWkVG6x0dEkjpoQaNuaB7T2Na7Sm421n/z3LCzhiQGuTUjENnL6cMEtuA6Pp BfI5+Qlg7HMwkBXNB73EPfWHzbCR3VNrzGYTy9FvhGud0/cXsuBXgps4WH63ic= - job: name: osc-build-image parent: opendev-build-docker-image description: Build Docker images. allowed-projects: openstack/python-openstackclient requires: - python-builder-3.7-container-image - python-base-3.7-container-image provides: osc-container-image vars: &osc_image_vars docker_images: - context: . repository: osclient/python-openstackclient - job: name: osc-upload-image parent: opendev-upload-docker-image description: Build Docker images and upload to Docker Hub. allowed-projects: openstack/python-openstackclient requires: - python-builder-3.7-container-image - python-base-3.7-container-image provides: osc-container-image secrets: - name: docker_credentials secret: osc-dockerhub pass-to-parent: true vars: *osc_image_vars - job: name: osc-promote-image parent: opendev-promote-docker-image allowed-projects: openstack/python-openstackclient description: Promote previously uploaded Docker images. secrets: - name: docker_credentials secret: osc-dockerhub pass-to-parent: true nodeset: nodes: [] vars: *osc_image_vars - project-template: name: osc-tox-unit-tips check: jobs: - osc-tox-py36-tips gate: jobs: - osc-tox-py36-tips - project: templates: - openstackclient-plugin-jobs - osc-tox-unit-tips - openstack-cover-jobs - openstack-lower-constraints-jobs - openstack-python3-yoga-jobs - publish-openstack-docs-pti - check-requirements - release-notes-jobs-python3 check: jobs: - osc-build-image - osc-functional-devstack # - osc-functional-devstack-n-net: # voting: false # # The job testing nova-network no longer works before Pike, and # # should be disabled until the New Way of testing against old clouds # # is ready and backported # branches: ^(?!stable/(newton|ocata)).*$ - osc-functional-devstack-tips: # The functional-tips job only tests the latest and shouldn't be run # on the stable branches branches: ^(?!stable) gate: jobs: - osc-upload-image - osc-functional-devstack promote: jobs: - osc-promote-image ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744444.0 python-openstackclient-5.8.0/AUTHORS0000664000175000017500000004524600000000000017337 0ustar00zuulzuul00000000000000Aaron 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 Aradhana Singh Artem Goncharov Artem Goncharov 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 Rosmaita Brian Rosmaita Brianna Poulos Cao Xuan Hoang Carl Baldwin Carlos Goncalves Carlos Konstanski Cedric Brandily Chaozhe.Chen Chen Chen Hanxiao Choe, Cheng-Dae Chris Johnson Christian Berendt 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 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 Dmitriy Rabotyagov Dmitriy Rabotyagov Dmitry Tantsur Dolph Mathews Dongcan Ye Doug Hellmann Doug Hellmann Doug Wiegley Dougal Matthews Dr. Jens Harbott Einst Crazy Elena Ezhova Elod Illes Emilien Macchi Eric Brown Eric Fried Fan Zhang Fang Zhen Fei Long Wang Felix Yan Flavio Percoco Florent Flament 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 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 Hugh Saunders Ian Wienand Igor Malinovskiy Igor_Bolotin Igor_Bolotin Ilya Persky Imtiaz Chowdhury Inessa Vasilevskaya Iswarya_Vakati Ivan Kolodyazhny JIHOJU JP Parkin Jackie Yuan Jake Yip James Denton James E. Blair James E. Blair Jamie Lennox Jan Gutter Jas Jaspreet Singh Rawel Javier Pena Jean-Philippe Evrard Jens Harbott (frickler) Jens Harbott Jens Rosenboom Jeremy Houser Jeremy Liu Jeremy Stanley Jerry George JieonLee Jim Rollenhagen Jimmy McCrory JingLiu Jirayut Nimsaeng Joe Gordon Joe Wigglesworth 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 Manjeet Singh Bhatia Manuel Silveyra Marc Abramowitz Marco Fargetta Marcos Fermin Lobo Marek Aufart Marek Denis Mark Vanderwiel Martin Chlumsky Martin Schuppert Masayuki Igawa Matt Fischer Matt Joyce Matt Riedemann Matt Riedemann Matthew Treinish Matthieu Huin Michael Gugino Michael Johnson Michael McCune Miguel Lavalle Mike Fedosin Mikhail Feoktistov Min Min Ren Mohammed Naser Mohan Muppidi Monty Taylor Mouad Benchchaoui Myeongchul Chae Nakul Dahiwade Nam Nguyen Hoai Natal Ngétal Nathan Kinder Navid Pustchi Nguyen Phuong An Nguyen Van Duc NiallBunting NiallBunting 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 Navarro Pete Zaitcev Petr Blaho Pierre Hanselmann Pierre Prinetti Pierre Riteau Qiu Yu Radoslaw Smigielski Radosław Piliszek Radu Mateescu Rafael Weingärtner Rajasi Kulkarni Ramaraja Ramaraja Ramachandran Reedip Reedip 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 ShogoAdachi Shu Yingya Simon Merrick Sindhu Devale Sirushti Murugesan Slawek Kaplonski SongmingYan Stephen Finucane Stephen Finucane Stephen Finucane Steve Martinelli Steve Martinelli Steven Hardy Stuart McLaren Surya Seetharaman Sven Wegener Swapnil Kulkarni (coolsvap) Sławek Kapłoński Takashi Kajinami Tang Chen Tang Chen Telles Nobrega Terry Howe Terry Howe TerryHowe Thomas Goirand Thrivikram Mudunuri Tim Burke Tom Cocozzello Tom Jose Kalapura Tom Stappaerts Tovin Seven Travis Tripp Trevor McCasland Tuan Do Anh Tytus Kurek Ukesh Kumar Vasudevan Valery Tschopp Vasyl Saienko Victor Silva Vijendra Soni Vincent Legoll Vishakha Agarwal Vladimir Eremin Vu Cong Tuan Wenran Xiao Wenzhi Yu Witold Bedyk Xi Yang Xiaoyang Zhang YAMAMOTO Takashi Yan Xing'an Yang Hongyang Yang Youseok Yejia Xu Yi Zhao Yongli He YuehuiLei Yunpeng Li Zane Bitter ZhaoBo Zhaokun Fu Zhenguo Niu ZhongShengping Zhou Zhihong adrian-turjak asarfaty blue55 caoyuan chengkunye chenxing chenying choidoa-git daizhiyong dongwenshuai gecong1973 gengchc2 guang-yee guangpei.liu guiyanxing gvrangan hackertron heha henriquetruta 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 mb711d melanie witt melissaml nidhimittalhada npraveen35 okozachenko pedh pedro pengyuesheng phil-hopkins-a qinchunhua qingszhao qtang rabi reedip root ryanKor sharat.sharma shizhihui songminglong songwenping sonu.kumar sunjia sunyajing tanlin tengqm tianhui timothy-symanczyk ting wang ting.wang venkata anil venkatamahesh wanghong wangxiyuan wangzihao whoami-rajat wingwj wu.chunyang wu.chunyang wu.shiming wuyuting xiexs yang wang yangweiwei yangxi yanpuqing ycx yfzhao youngho choi <0505zxc@gmail.com> yushangbin zhang.lei zhang.xiuhua zhangbailin zhangboye zhanghongtao zheng yin zhengsenyan zhiyong.dai zhiyuan_cai zhouhenglc zhouqi zhu.boxiang zhufl zhurong Édouard Thuleau ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/CONTRIBUTING.rst0000664000175000017500000000155400000000000020722 0ustar00zuulzuul00000000000000The 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 StoryBoard: https://storyboard.openstack.org/#!/project/openstack/python-openstackclient Developers should also join the discussion on the mailing list, at: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744444.0 python-openstackclient-5.8.0/ChangeLog0000664000175000017500000040212200000000000020027 0ustar00zuulzuul00000000000000CHANGES ======= 5.8.0 ----- * Add support for setting extra DHCP options on existing ports * 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 * 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: Don't warn if disk overcommit params unset * Switch server backup to sdk * 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 * 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/Dockerfile0000664000175000017500000000163300000000000020251 0ustar00zuulzuul00000000000000# 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.7 as builder COPY . /tmp/src RUN assemble FROM docker.io/opendevorg/python-base:3.7 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"] ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/HACKING.rst0000664000175000017500000000240700000000000020055 0ustar00zuulzuul00000000000000OpenStack 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'], ) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/LICENSE0000664000175000017500000002363700000000000017274 0ustar00zuulzuul00000000000000 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. ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.7274013 python-openstackclient-5.8.0/PKG-INFO0000664000175000017500000001606600000000000017362 0ustar00zuulzuul00000000000000Metadata-Version: 1.2 Name: python-openstackclient Version: 5.8.0 Summary: OpenStack Command-line Client Home-page: https://docs.openstack.org/python-openstackclient/latest/ Author: OpenStack Author-email: openstack-discuss@lists.openstack.org License: UNKNOWN Description: ======================== Team and repository tags ======================== .. image:: https://governance.openstack.org/tc/badges/python-openstackclient.svg :target: https://governance.openstack.org/tc/reference/tags/index.html .. Change things from this point on =============== OpenStackClient =============== .. image:: https://img.shields.io/pypi/v/python-openstackclient.svg :target: https://pypi.org/project/python-openstackclient/ :alt: Latest Version OpenStackClient (aka 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. The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack. * `PyPi`_ - package installation * `Online Documentation`_ * `Storyboard project`_ - bugs and feature requests * `Blueprints`_ - feature specifications (historical only) * `Source`_ * `Developer`_ - getting started as a developer * `Contributing`_ - contributing code * `Testing`_ - testing code * IRC: #openstack-sdks on OFTC (irc.oftc.net) * License: Apache 2.0 .. _PyPi: https://pypi.org/project/python-openstackclient .. _Online Documentation: https://docs.openstack.org/python-openstackclient/latest/ .. _Blueprints: https://blueprints.launchpad.net/python-openstackclient .. _`Storyboard project`: https://storyboard.openstack.org/#!/project/openstack/python-openstackclient .. _Source: https://opendev.org/openstack/python-openstackclient .. _Developer: https://docs.openstack.org/project-team-guide/project-setup/python.html .. _Contributing: https://docs.openstack.org/infra/manual/developers.html .. _Testing: https://docs.openstack.org/python-openstackclient/latest/contributor/developing.html#testing .. _Release Notes: https://docs.openstack.org/releasenotes/python-openstackclient Getting Started =============== OpenStack Client can be installed from PyPI using pip:: pip install python-openstackclient There are a few variants on getting help. A list of global options and supported commands is shown with ``--help``:: openstack --help There is also a ``help`` command that can be used to get help text for a specific command:: openstack help openstack help server create If you want to make changes to the OpenStackClient for testing and contribution, make any changes and then run:: python setup.py develop or:: pip install -e . Configuration ============= The CLI is configured via environment variables and command-line options as listed in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html. Authentication using username/password is most commonly used: - For a local user, your configuration will look like the one below:: export OS_AUTH_URL= export OS_IDENTITY_API_VERSION=3 export OS_PROJECT_NAME= export OS_PROJECT_DOMAIN_NAME= export OS_USERNAME= export OS_USER_DOMAIN_NAME= export OS_PASSWORD= # (optional) The corresponding command-line options look very similar:: --os-auth-url --os-identity-api-version 3 --os-project-name --os-project-domain-name --os-username --os-user-domain-name [--os-password ] - For a federated user, your configuration will look the so:: 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= The corresponding command-line options look very similar:: --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 If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely. Platform: UNKNOWN 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.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Requires-Python: >=3.6 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/README.rst0000664000175000017500000001225600000000000017751 0ustar00zuulzuul00000000000000======================== Team and repository tags ======================== .. image:: https://governance.openstack.org/tc/badges/python-openstackclient.svg :target: https://governance.openstack.org/tc/reference/tags/index.html .. Change things from this point on =============== OpenStackClient =============== .. image:: https://img.shields.io/pypi/v/python-openstackclient.svg :target: https://pypi.org/project/python-openstackclient/ :alt: Latest Version OpenStackClient (aka 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. The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack. * `PyPi`_ - package installation * `Online Documentation`_ * `Storyboard project`_ - bugs and feature requests * `Blueprints`_ - feature specifications (historical only) * `Source`_ * `Developer`_ - getting started as a developer * `Contributing`_ - contributing code * `Testing`_ - testing code * IRC: #openstack-sdks on OFTC (irc.oftc.net) * License: Apache 2.0 .. _PyPi: https://pypi.org/project/python-openstackclient .. _Online Documentation: https://docs.openstack.org/python-openstackclient/latest/ .. _Blueprints: https://blueprints.launchpad.net/python-openstackclient .. _`Storyboard project`: https://storyboard.openstack.org/#!/project/openstack/python-openstackclient .. _Source: https://opendev.org/openstack/python-openstackclient .. _Developer: https://docs.openstack.org/project-team-guide/project-setup/python.html .. _Contributing: https://docs.openstack.org/infra/manual/developers.html .. _Testing: https://docs.openstack.org/python-openstackclient/latest/contributor/developing.html#testing .. _Release Notes: https://docs.openstack.org/releasenotes/python-openstackclient Getting Started =============== OpenStack Client can be installed from PyPI using pip:: pip install python-openstackclient There are a few variants on getting help. A list of global options and supported commands is shown with ``--help``:: openstack --help There is also a ``help`` command that can be used to get help text for a specific command:: openstack help openstack help server create If you want to make changes to the OpenStackClient for testing and contribution, make any changes and then run:: python setup.py develop or:: pip install -e . Configuration ============= The CLI is configured via environment variables and command-line options as listed in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html. Authentication using username/password is most commonly used: - For a local user, your configuration will look like the one below:: export OS_AUTH_URL= export OS_IDENTITY_API_VERSION=3 export OS_PROJECT_NAME= export OS_PROJECT_DOMAIN_NAME= export OS_USERNAME= export OS_USER_DOMAIN_NAME= export OS_PASSWORD= # (optional) The corresponding command-line options look very similar:: --os-auth-url --os-identity-api-version 3 --os-project-name --os-project-domain-name --os-username --os-user-domain-name [--os-password ] - For a federated user, your configuration will look the so:: 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= The corresponding command-line options look very similar:: --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 If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/bindep.txt0000664000175000017500000000062500000000000020261 0ustar00zuulzuul00000000000000# 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] ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6314015 python-openstackclient-5.8.0/doc/0000775000175000017500000000000000000000000017021 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/Makefile0000664000175000017500000001126400000000000020465 0ustar00zuulzuul00000000000000# 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." ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/requirements.txt0000664000175000017500000000232200000000000022304 0ustar00zuulzuul00000000000000# The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. openstackdocstheme>=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-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-manilaclient>=2.0.0 # Apache-2.0 python-mistralclient!=3.2.0,>=3.1.0 # Apache-2.0 python-muranoclient>=0.8.2 # Apache-2.0 python-neutronclient>=6.7.0 # Apache-2.0 python-octaviaclient>=1.11.0 # Apache-2.0 python-rsdclient>=1.0.1 # Apache-2.0 python-saharaclient>=1.4.0 # Apache-2.0 python-senlinclient>=1.1.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 ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6314015 python-openstackclient-5.8.0/doc/source/0000775000175000017500000000000000000000000020321 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6314015 python-openstackclient-5.8.0/doc/source/_extra/0000775000175000017500000000000000000000000021603 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/_extra/.htaccess0000664000175000017500000000261200000000000023402 0ustar00zuulzuul00000000000000# 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 ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6314015 python-openstackclient-5.8.0/doc/source/cli/0000775000175000017500000000000000000000000021070 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6314015 python-openstackclient-5.8.0/doc/source/cli/_hidden/0000775000175000017500000000000000000000000022462 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/_hidden/ec2-credentials.rst0000664000175000017500000000053600000000000026164 0ustar00zuulzuul00000000000000=============== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/_hidden/endpoint.rst0000664000175000017500000000047300000000000025040 0ustar00zuulzuul00000000000000======== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/_hidden/image.rst0000664000175000017500000000045400000000000024301 0ustar00zuulzuul00000000000000===== image ===== .. 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/image-v1 ../command-objects/image-v2 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/_hidden/project.rst0000664000175000017500000000046600000000000024670 0ustar00zuulzuul00000000000000======= 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/_hidden/role.rst0000664000175000017500000000044700000000000024162 0ustar00zuulzuul00000000000000==== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/_hidden/service.rst0000664000175000017500000000046600000000000024662 0ustar00zuulzuul00000000000000======= 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/_hidden/token.rst0000664000175000017500000000045400000000000024337 0ustar00zuulzuul00000000000000===== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/_hidden/user.rst0000664000175000017500000000044700000000000024177 0ustar00zuulzuul00000000000000==== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/authentication.rst0000664000175000017500000001346400000000000024651 0ustar00zuulzuul00000000000000.. _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 (described below as token/endpoint) 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. ` ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/backwards-incompatible.rst0000664000175000017500000003237400000000000026240 0ustar00zuulzuul00000000000000============================== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-list.rst0000664000175000017500000000017000000000000024207 0ustar00zuulzuul00000000000000.. _command-list: ============ Command List ============ .. toctree:: :glob: :maxdepth: 2 command-objects/* ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6394017 python-openstackclient-5.8.0/doc/source/cli/command-objects/0000775000175000017500000000000000000000000024135 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/access-rules.rst0000664000175000017500000000236300000000000027264 0ustar00zuulzuul00000000000000=========== 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. access rule delete ------------------ Delete access rule(s) .. program:: access rule delete .. code:: bash openstack access rule delete [ ...] .. describe:: Access rule(s) to delete (ID) access rule list ---------------- List access rules .. program:: access rule list .. code:: bash openstack access rule list [--user ] [--user-domain ] .. option:: --user User whose access rules to list (name or ID). If not provided, looks up the current user's access rules. .. option:: --user-domain Domain the user belongs to (name or ID). This can be used in case collisions between user names exist. access rule show --------------------------- Display access rule details .. program:: access rule show .. code:: bash openstack access rule show .. describe:: Access rule to display (ID) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/access-token.rst0000664000175000017500000000050600000000000027247 0ustar00zuulzuul00000000000000============ 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/address-group.rst0000664000175000017500000000044100000000000027445 0ustar00zuulzuul00000000000000============= 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/address-scope.rst0000664000175000017500000000037700000000000027432 0ustar00zuulzuul00000000000000============= 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/aggregate.rst0000664000175000017500000000030300000000000026611 0ustar00zuulzuul00000000000000========= aggregate ========= Host aggregates provide a mechanism to group hosts according to certain criteria. Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: aggregate * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/application-credentials.rst0000664000175000017500000000061300000000000031465 0ustar00zuulzuul00000000000000====================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/availability-zone.rst0000664000175000017500000000042400000000000030312 0ustar00zuulzuul00000000000000================= 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/catalog.rst0000664000175000017500000000030700000000000026301 0ustar00zuulzuul00000000000000======= 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/command.rst0000664000175000017500000000020700000000000026304 0ustar00zuulzuul00000000000000======= command ======= Internal Installed commands in the OSC process. .. autoprogram-cliff:: openstack.cli :command: command * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/complete.rst0000664000175000017500000000164200000000000026502 0ustar00zuulzuul00000000000000======== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/compute-agent.rst0000664000175000017500000000020000000000000027427 0ustar00zuulzuul00000000000000============= compute agent ============= Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: compute agent * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/compute-service.rst0000664000175000017500000000021000000000000027772 0ustar00zuulzuul00000000000000=============== compute service =============== Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: compute service * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/configuration.rst0000664000175000017500000000025000000000000027533 0ustar00zuulzuul00000000000000============= configuration ============= Available for all services .. _configuration-show: .. autoprogram-cliff:: openstack.common :command: configuration show ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/consistency-group-snapshot.rst0000664000175000017500000000457600000000000032233 0ustar00zuulzuul00000000000000========================== consistency group snapshot ========================== Block Storage v2 consistency group snapshot create --------------------------------- Create new consistency group snapshot. .. program:: consistency group snapshot create .. code:: bash openstack consistency group snapshot create [--consistency-group ] [--description ] [] .. option:: --consistency-group Consistency group to snapshot (name or ID) (default to be the same as ) .. option:: --description Description of this consistency group snapshot .. _consistency_group_snapshot_create-snapshot-name: .. describe:: Name of new consistency group snapshot (default to None) consistency group snapshot delete --------------------------------- Delete consistency group snapshot(s) .. program:: consistency group snapshot delete .. code:: bash openstack consistency group snapshot delete [ ...] .. _consistency_group_snapshot_delete-consistency-group-snapshot: .. describe:: Consistency group snapshot(s) to delete (name or ID) consistency group snapshot list ------------------------------- List consistency group snapshots. .. program:: consistency group snapshot list .. code:: bash openstack consistency group snapshot list [--all-projects] [--long] [--status ] [--consistency-group ] .. option:: --all-projects Show detail for all projects. Admin only. (defaults to False) .. option:: --long List additional fields in output .. option:: --status Filters results by a status ("available", "error", "creating", "deleting" or "error_deleting") .. option:: --consistency-group Filters results by a consistency group (name or ID) consistency group snapshot show ------------------------------- Display consistency group snapshot details. .. program:: consistency group snapshot show .. code:: bash openstack consistency group snapshot show .. _consistency_group_snapshot_show-consistency-group-snapshot: .. describe:: Consistency group snapshot to display (name or ID) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/consistency-group.rst0000664000175000017500000000747500000000000030377 0ustar00zuulzuul00000000000000================= consistency group ================= Block Storage v2 consistency group add volume ---------------------------- Add volume(s) to consistency group. .. program:: consistency group add volume .. code:: bash openstack consistency group add volume [ ...] .. _consistency_group_add_volume: .. describe:: Consistency group to contain (name or ID) .. describe:: Volume(s) to add to (name or ID) (repeat option to add multiple volumes) consistency group create ------------------------ Create new consistency group. .. program:: consistency group create .. code:: bash openstack consistency group create --volume-type | --consistency-group-source | --consistency-group-snapshot [--description ] [--availability-zone ] [] .. option:: --volume-type Volume type of this consistency group (name or ID) .. option:: --consistency-group-source Existing consistency group (name or ID) .. option:: --consistency-group-snapshot Existing consistency group snapshot (name or ID) .. option:: --description Description of this consistency group .. option:: --availability-zone Availability zone for this consistency group (not available if creating consistency group from source) .. _consistency_group_create-name: .. describe:: Name of new consistency group (default to None) consistency group delete ------------------------ Delete consistency group(s). .. program:: consistency group delete .. code:: bash openstack consistency group delete [--force] [ ...] .. option:: --force Allow delete in state other than error or available .. _consistency_group_delete-consistency-group: .. describe:: Consistency group(s) to delete (name or ID) consistency group list ---------------------- List consistency groups. .. program:: consistency group list .. code:: bash openstack consistency group list [--all-projects] [--long] .. option:: --all-projects Show detail for all projects. Admin only. (defaults to False) .. option:: --long List additional fields in output consistency group remove volume ------------------------------- Remove volume(s) from consistency group. .. program:: consistency group remove volume .. code:: bash openstack consistency group remove volume [ ...] .. _consistency_group_remove_volume: .. describe:: Consistency group containing (name or ID) .. describe:: Volume(s) to remove from (name or ID) (repeat option to remove multiple volumes) consistency group set --------------------- Set consistency group properties. .. program:: consistency group set .. code:: bash openstack consistency group set [--name ] [--description ] .. option:: --name New consistency group name .. option:: --description New consistency group description .. _consistency_group_set-consistency-group: .. describe:: Consistency group to modify (name or ID) consistency group show ---------------------- Display consistency group details. .. program:: consistency group show .. code:: bash openstack consistency group show .. _consistency_group_show-consistency-group: .. describe:: Consistency group to display (name or ID) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/console-log.rst0000664000175000017500000000022200000000000027104 0ustar00zuulzuul00000000000000=========== console log =========== Server console text dump Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: console log * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/console-url.rst0000664000175000017500000000022300000000000027126 0ustar00zuulzuul00000000000000=========== console url =========== Server remote console URL Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: console url * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/consumer.rst0000664000175000017500000000040300000000000026517 0ustar00zuulzuul00000000000000======== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/container.rst0000664000175000017500000000122700000000000026653 0ustar00zuulzuul00000000000000========= 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/credential.rst0000664000175000017500000000016600000000000027004 0ustar00zuulzuul00000000000000========== credential ========== Identity v3 .. autoprogram-cliff:: openstack.identity.v3 :command: credential * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/domain.rst0000664000175000017500000000104000000000000026131 0ustar00zuulzuul00000000000000====== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/ec2-credentials-v2.rst0000664000175000017500000000024700000000000030163 0ustar00zuulzuul00000000000000============================= ec2 credentials (Identity v2) ============================= .. autoprogram-cliff:: openstack.identity.v2 :command: ec2 credentials * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/ec2-credentials-v3.rst0000664000175000017500000000024700000000000030164 0ustar00zuulzuul00000000000000============================= ec2 credentials (Identity v3) ============================= .. autoprogram-cliff:: openstack.identity.v3 :command: ec2 credentials * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/endpoint-v2.rst0000664000175000017500000000021300000000000027030 0ustar00zuulzuul00000000000000====================== endpoint (Identity v2) ====================== .. autoprogram-cliff:: openstack.identity.v2 :command: endpoint * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/endpoint-v3.rst0000664000175000017500000000113000000000000027030 0ustar00zuulzuul00000000000000====================== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/endpoint_group.rst0000664000175000017500000000043600000000000027726 0ustar00zuulzuul00000000000000============== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/extension.rst0000664000175000017500000000027200000000000026704 0ustar00zuulzuul00000000000000========= extension ========= Many OpenStack server APIs include API extensions that enable additional functionality. .. autoprogram-cliff:: openstack.common :command: extension * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/federation-domain-project.rst0000664000175000017500000000037200000000000031722 0ustar00zuulzuul00000000000000========================= federation domain/project ========================= Identity v3 .. autoprogram-cliff:: openstack.identity.v3 :command: federation domain * .. autoprogram-cliff:: openstack.identity.v3 :command: federation project * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/federation-protocol.rst0000664000175000017500000000046500000000000030653 0ustar00zuulzuul00000000000000=================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/flavor.rst0000664000175000017500000000014400000000000026157 0ustar00zuulzuul00000000000000====== flavor ====== Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: flavor * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/floating-ip-pool.rst0000664000175000017500000000021400000000000030044 0ustar00zuulzuul00000000000000================ floating ip pool ================ Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: floating ip pool * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/floating-ip-port-forwarding.rst0000664000175000017500000000027100000000000032222 0ustar00zuulzuul00000000000000=========================== floating ip port forwarding =========================== Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: floating ip port forwarding * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/floating-ip.rst0000664000175000017500000000116500000000000027103 0ustar00zuulzuul00000000000000=========== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/group.rst0000664000175000017500000000014200000000000026020 0ustar00zuulzuul00000000000000===== group ===== Identity v3 .. autoprogram-cliff:: openstack.identity.v3 :command: group * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/host.rst0000664000175000017500000000021100000000000025636 0ustar00zuulzuul00000000000000==== host ==== Compute v2 The physical computer running a hypervisor. .. autoprogram-cliff:: openstack.compute.v2 :command: host * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/hypervisor-stats.rst0000664000175000017500000000021400000000000030232 0ustar00zuulzuul00000000000000================ hypervisor stats ================ Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: hypervisor stats * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/hypervisor.rst0000664000175000017500000000045200000000000027102 0ustar00zuulzuul00000000000000========== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/identity-provider.rst0000664000175000017500000000045600000000000030355 0ustar00zuulzuul00000000000000================= 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/image-v1.rst0000664000175000017500000000013300000000000026272 0ustar00zuulzuul00000000000000======== image v1 ======== .. autoprogram-cliff:: openstack.image.v1 :command: image * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/image-v2.rst0000664000175000017500000000013300000000000026273 0ustar00zuulzuul00000000000000======== image v2 ======== .. autoprogram-cliff:: openstack.image.v2 :command: image * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/implied_role.rst0000664000175000017500000000017600000000000027337 0ustar00zuulzuul00000000000000============ implied role ============ Identity v3 .. autoprogram-cliff:: openstack.identity.v3 :command: implied role * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/ip-availability.rst0000664000175000017500000000021000000000000027740 0ustar00zuulzuul00000000000000=============== ip availability =============== Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: ip availability * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/keypair.rst0000664000175000017500000000052700000000000026337 0ustar00zuulzuul00000000000000======= 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/limit.rst0000664000175000017500000000025700000000000026011 0ustar00zuulzuul00000000000000===== limit ===== Identity v3 Limits are used to specify project-specific limits thresholds of resources. .. autoprogram-cliff:: openstack.identity.v3 :command: limit * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/limits.rst0000664000175000017500000000026300000000000026171 0ustar00zuulzuul00000000000000====== limits ====== The Compute and Block Storage APIs have resource usage limits. Compute v2, Block Storage v1 .. autoprogram-cliff:: openstack.common :command: limits * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/local-ip-association.rst0000664000175000017500000000052100000000000030677 0ustar00zuulzuul00000000000000============================================= 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/local-ip.rst0000664000175000017500000000054700000000000026375 0ustar00zuulzuul00000000000000===================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/mapping.rst0000664000175000017500000000040400000000000026320 0ustar00zuulzuul00000000000000======= 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 *././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/module.rst0000664000175000017500000000021100000000000026146 0ustar00zuulzuul00000000000000====== module ====== Internal Installed Python modules in the OSC process. .. autoprogram-cliff:: openstack.cli :command: module * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-agent.rst0000664000175000017500000000063700000000000027462 0ustar00zuulzuul00000000000000============= 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-auto-allocated-topology.rst0000664000175000017500000000100700000000000033124 0ustar00zuulzuul00000000000000=============================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-flavor-profile.rst0000664000175000017500000000111700000000000031305 0ustar00zuulzuul00000000000000====================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-flavor.rst0000664000175000017500000000161300000000000027650 0ustar00zuulzuul00000000000000============== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-l3-conntrack-helper.rst0000664000175000017500000000027000000000000032130 0ustar00zuulzuul00000000000000=========================== network l3 conntrack helper =========================== Network v2 .. autoprogram-cliff:: openstack.network.v2 :command: network l3 conntrack helper * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-meter-rule.rst0000664000175000017500000000046100000000000030440 0ustar00zuulzuul00000000000000================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-meter.rst0000664000175000017500000000115700000000000027476 0ustar00zuulzuul00000000000000============= 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-qos-policy.rst0000664000175000017500000000036400000000000030460 0ustar00zuulzuul00000000000000================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-qos-rule-type.rst0000664000175000017500000000036700000000000031112 0ustar00zuulzuul00000000000000===================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-qos-rule.rst0000664000175000017500000000151100000000000030123 0ustar00zuulzuul00000000000000================ 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-rbac.rst0000664000175000017500000000046400000000000027271 0ustar00zuulzuul00000000000000============ 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-segment.rst0000664000175000017500000000145600000000000030026 0ustar00zuulzuul00000000000000=============== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network-service-provider.rst0000664000175000017500000000045700000000000031654 0ustar00zuulzuul00000000000000======================== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network.rst0000664000175000017500000000202500000000000026357 0ustar00zuulzuul00000000000000======= 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/network_segment_range.rst0000664000175000017500000000072500000000000031262 0ustar00zuulzuul00000000000000===================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/object-store-account.rst0000664000175000017500000000074400000000000030726 0ustar00zuulzuul00000000000000==================== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/object.rst0000664000175000017500000000130200000000000026131 0ustar00zuulzuul00000000000000====== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/policy.rst0000664000175000017500000000032700000000000026170 0ustar00zuulzuul00000000000000====== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/port.rst0000664000175000017500000000050000000000000025646 0ustar00zuulzuul00000000000000==== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/project-cleanup.rst0000664000175000017500000000042600000000000027764 0ustar00zuulzuul00000000000000=============== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/project-purge.rst0000664000175000017500000000032400000000000027454 0ustar00zuulzuul00000000000000============= project purge ============= Clean resources associated with a specific project. Block Storage v1, v2; Compute v2; Image v1, v2 .. autoprogram-cliff:: openstack.common :command: project purge ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/project-v2.rst0000664000175000017500000000020700000000000026661 0ustar00zuulzuul00000000000000===================== project (Identity v2) ===================== .. autoprogram-cliff:: openstack.identity.v2 :command: project * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/project-v3.rst0000664000175000017500000000020700000000000026662 0ustar00zuulzuul00000000000000===================== project (Identity v3) ===================== .. autoprogram-cliff:: openstack.identity.v3 :command: project * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/quota.rst0000664000175000017500000000036300000000000026022 0ustar00zuulzuul00000000000000===== quota ===== Resource quotas appear in multiple APIs, OpenStackClient presents them as a single object with multiple properties. Block Storage v1, v2, Compute v2, Network v2 .. autoprogram-cliff:: openstack.common :command: quota * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/region.rst0000664000175000017500000000042600000000000026154 0ustar00zuulzuul00000000000000====== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/registered-limit.rst0000664000175000017500000000034600000000000030143 0ustar00zuulzuul00000000000000================ 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/request-token.rst0000664000175000017500000000043100000000000027473 0ustar00zuulzuul00000000000000============= 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/role-assignment.rst0000664000175000017500000000423600000000000030003 0ustar00zuulzuul00000000000000=============== role assignment =============== Identity v2, v3 role assignment list -------------------- List role assignments .. program:: role assignment list .. code:: bash openstack role assignment list [--role ] [--role-domain ] [--user ] [--user-domain ] [--group ] [--group-domain ] [--domain ] [--project ] [--project-domain ] [--effective] [--inherited] [--names] .. option:: --role Role to filter (name or ID) .. versionadded:: 3 .. option:: --role-domain Domain the role belongs to (name or ID). This can be used in case collisions between role names exist. .. versionadded:: 3 .. option:: --user User to filter (name or ID) .. option:: --user-domain Domain the user belongs to (name or ID). This can be used in case collisions between user names exist. .. versionadded:: 3 .. option:: --group Group to filter (name or ID) .. versionadded:: 3 .. option:: --group-domain Domain the group belongs to (name or ID). This can be used in case collisions between group names exist. .. versionadded:: 3 .. option:: --domain Domain to filter (name or ID) .. versionadded:: 3 .. option:: --project Project to filter (name or ID) .. option:: --project-domain Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. .. versionadded:: 3 .. option:: --effective Returns only effective role assignments (defaults to False) .. versionadded:: 3 .. option:: --inherited Specifies if the role grant is inheritable to the sub projects .. versionadded:: 3 .. option:: --names Returns role assignments with names instead of IDs .. option:: --auth-user Returns role assignments for the authenticated user. .. option:: --auth-project Returns role assignments for the project to which the authenticated user is scoped. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/role-v2.rst0000664000175000017500000000017300000000000026156 0ustar00zuulzuul00000000000000================== role (Identity v2) ================== .. autoprogram-cliff:: openstack.identity.v2 :command: role * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/role-v3.rst0000664000175000017500000000017300000000000026157 0ustar00zuulzuul00000000000000================== role (Identity v3) ================== .. autoprogram-cliff:: openstack.identity.v3 :command: role * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/router.rst0000664000175000017500000000044600000000000026213 0ustar00zuulzuul00000000000000====== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/security-group-rule.rst0000664000175000017500000000042200000000000030633 0ustar00zuulzuul00000000000000=================== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/security-group.rst0000664000175000017500000000147500000000000027677 0ustar00zuulzuul00000000000000============== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/server-backup.rst0000664000175000017500000000044500000000000027443 0ustar00zuulzuul00000000000000============= 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/server-event.rst0000664000175000017500000000052400000000000027315 0ustar00zuulzuul00000000000000============ 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/server-group.rst0000664000175000017500000000031500000000000027326 0ustar00zuulzuul00000000000000============ server group ============ Server groups provide a mechanism to group servers according to certain policy. Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: server group * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/server-image.rst0000664000175000017500000000036300000000000027257 0ustar00zuulzuul00000000000000============ 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/server-migration.rst0000664000175000017500000000051300000000000030163 0ustar00zuulzuul00000000000000================ 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/server.rst0000664000175000017500000000400300000000000026172 0ustar00zuulzuul00000000000000====== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/service-provider.rst0000664000175000017500000000045500000000000030163 0ustar00zuulzuul00000000000000================ 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/service-v2.rst0000664000175000017500000000020700000000000026653 0ustar00zuulzuul00000000000000===================== service (Identity v2) ===================== .. autoprogram-cliff:: openstack.identity.v2 :command: service * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/service-v3.rst0000664000175000017500000000065500000000000026663 0ustar00zuulzuul00000000000000===================== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/subnet-pool.rst0000664000175000017500000000035400000000000027140 0ustar00zuulzuul00000000000000=========== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/subnet.rst0000664000175000017500000000132200000000000026165 0ustar00zuulzuul00000000000000====== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/token-v2.rst0000664000175000017500000000020000000000000026324 0ustar00zuulzuul00000000000000=================== token (Identity v2) =================== .. autoprogram-cliff:: openstack.identity.v2 :command: token * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/token-v3.rst0000664000175000017500000000020000000000000026325 0ustar00zuulzuul00000000000000=================== token (Identity v3) =================== .. autoprogram-cliff:: openstack.identity.v3 :command: token * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/trust.rst0000664000175000017500000000036000000000000026047 0ustar00zuulzuul00000000000000===== 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 * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/usage.rst0000664000175000017500000000014000000000000025766 0ustar00zuulzuul00000000000000===== usage ===== Compute v2 .. autoprogram-cliff:: openstack.compute.v2 :command: usage * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/user-v2.rst0000664000175000017500000000017400000000000026174 0ustar00zuulzuul00000000000000================== user (Identity v2) ================== .. autoprogram-cliff:: openstack.identity.v2 :command: user * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/user-v3.rst0000664000175000017500000000017400000000000026175 0ustar00zuulzuul00000000000000================== user (Identity v3) ================== .. autoprogram-cliff:: openstack.identity.v3 :command: user * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/versions.rst0000664000175000017500000000023700000000000026541 0ustar00zuulzuul00000000000000======== versions ======== Get a list of every version of every service in a given cloud. .. autoprogram-cliff:: openstack.common :command: versions show ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-attachment.rst0000664000175000017500000000022500000000000030323 0ustar00zuulzuul00000000000000================= volume attachment ================= Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume attachment * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-backend.rst0000664000175000017500000000021100000000000027555 0ustar00zuulzuul00000000000000============== volume backend ============== Block Storage v2 .. autoprogram-cliff:: openstack.volume.v2 :command: volume backend * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-backup.rst0000664000175000017500000000021200000000000027434 0ustar00zuulzuul00000000000000============= volume backup ============= Block Storage v1, v2 .. autoprogram-cliff:: openstack.volume.v2 :command: volume backup * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-group-snapshot.rst0000664000175000017500000000024500000000000031166 0ustar00zuulzuul00000000000000===================== volume group snapshot ===================== Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume group snapshot * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-group-type.rst0000664000175000017500000000022500000000000030306 0ustar00zuulzuul00000000000000================= volume group type ================= Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume group type * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-group.rst0000664000175000017500000000100200000000000027321 0ustar00zuulzuul00000000000000============ 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-host.rst0000664000175000017500000000164100000000000027153 0ustar00zuulzuul00000000000000=========== volume host =========== Block Storage v2 volume host failover -------------------- Failover volume host to different backend .. program:: volume host failover .. code:: bash openstack volume host failover --volume-backend .. option:: --volume-backend The ID of the volume backend replication target where the host will failover to (required) .. _volume_host_failover-host-name: .. describe:: Name of volume host volume host set --------------- Set volume host properties .. program:: volume host set .. code:: bash openstack volume host set [--enable | --disable] .. option:: --enable Thaw and enable the specified volume host. .. option:: --disable Freeze and disable the specified volume host .. _volume_host_set-host-name: .. describe:: Name of volume host ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-message.rst0000664000175000017500000000021100000000000027612 0ustar00zuulzuul00000000000000============== volume message ============== Block Storage v3 .. autoprogram-cliff:: openstack.volume.v3 :command: volume message * ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-qos.rst0000664000175000017500000000617500000000000027007 0ustar00zuulzuul00000000000000========== volume qos ========== Block Storage v1, v2 volume qos associate -------------------- Associate a QoS specification to a volume type .. program:: volume qos associate .. code:: bash openstack volume qos associate .. _volume_qos_associate: .. describe:: QoS specification to modify (name or ID) .. describe:: Volume type to associate the QoS (name or ID) volume qos create ----------------- Create new QoS Specification .. program:: volume qos create .. code:: bash openstack volume qos create [--consumer ] [--property [...] ] .. option:: --consumer Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both') .. option:: --property Set a property on this QoS specification (repeat option to set multiple properties) .. _volume_qos_create-name: .. describe:: New QoS specification name volume qos delete ----------------- Delete QoS specification .. program:: volume qos delete .. code:: bash openstack volume qos delete [--force] [ ...] .. option:: --force Allow to delete in-use QoS specification(s) .. _volume_qos_delete-qos-spec: .. describe:: QoS specification(s) to delete (name or ID) volume qos disassociate ----------------------- Disassociate a QoS specification from a volume type .. program:: volume qos disassociate .. code:: bash openstack volume qos disassociate --volume-type | --all .. option:: --volume-type Volume type to disassociate the QoS from (name or ID) .. option:: --all Disassociate the QoS from every volume type .. _volume_qos_disassociate-qos-spec: .. describe:: QoS specification to modify (name or ID) volume qos list --------------- List QoS specifications .. program:: volume qos list .. code:: bash openstack volume qos list volume qos set -------------- Set QoS specification properties .. program:: volume qos set .. code:: bash openstack volume qos set [--property [...] ] .. option:: --property Property to add or modify for this QoS specification (repeat option to set multiple properties) .. _volume_qos_set-qos-spec: .. describe:: QoS specification to modify (name or ID) volume qos show --------------- Display QoS specification details .. program:: volume qos show .. code:: bash openstack volume qos show .. _volume_qos_show-qos-spec: .. describe:: QoS specification to display (name or ID) volume qos unset ---------------- Unset QoS specification properties .. program:: volume qos unset .. code:: bash openstack volume qos unset [--property [...] ] .. option:: --property Property to remove from QoS specification (repeat option to remove multiple properties) .. _volume_qos_unset-qos-spec: .. describe:: QoS specification to modify (name or ID) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-service.rst0000664000175000017500000000212300000000000027632 0ustar00zuulzuul00000000000000============== volume service ============== Block Storage v1, v2 volume service list ------------------- List volume service .. program:: volume service list .. code:: bash openstack volume service list [--host ] [--service ] [--long] .. option:: --host List services on specified host (name only) .. option:: --service List only specified service (name only) .. option:: --long List additional fields in output volume service set ------------------ Set volume service properties .. program:: volume service set .. code:: bash openstack volume service set [--enable | --disable] [--disable-reason ] .. option:: --enable Enable volume service .. option:: --disable Disable volume service .. option:: --disable-reason Reason for disabling the service (should be used with :option:`--disable` option) .. _volume_service_set-host: .. describe:: Name of host .. describe:: Name of service (Binary name) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-snapshot.rst0000664000175000017500000001145600000000000030042 0ustar00zuulzuul00000000000000=============== volume snapshot =============== Block Storage v1, v2 volume snapshot create ---------------------- Create new volume snapshot .. program:: volume snapshot create .. code:: bash openstack volume snapshot create [--volume ] [--description ] [--force] [--property [...] ] [--remote-source [...]] .. option:: --volume Volume to snapshot (name or ID) (default is ) .. option:: --description Description of the snapshot .. option:: --force Create a snapshot attached to an instance. Default is False .. option:: --property Set a property to this snapshot (repeat option to set multiple properties) *Volume version 2 only* .. option:: --remote-source The attribute(s) of the exsiting remote volume snapshot (admin required) (repeat option to specify multiple attributes) e.g.: '--remote-source source-name=test_name --remote-source source-id=test_id' *Volume version 2 only* .. _volume_snapshot_create-snapshot-name: .. describe:: Name of the new snapshot volume snapshot delete ---------------------- Delete volume snapshot(s) .. program:: volume snapshot delete .. code:: bash openstack volume snapshot delete [--force] [ ...] .. option:: --force Attempt forced removal of snapshot(s), regardless of state (defaults to False) .. _volume_snapshot_delete-snapshot: .. describe:: Snapshot(s) to delete (name or ID) volume snapshot list -------------------- List volume snapshots .. program:: volume snapshot list .. code:: bash openstack volume snapshot list [--all-projects] [--project [--project-domain ]] [--long] [--limit ] [--marker ] [--name ] [--status ] [--volume ] .. option:: --all-projects Include all projects (admin only) .. option:: --project Filter results by project (name or ID) (admin only) *Volume version 2 only* .. option:: --project-domain Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. *Volume version 2 only* .. option:: --long List additional fields in output .. option:: --status Filters results by a status. ('available', 'error', 'creating', 'deleting' or 'error_deleting') .. option:: --name Filters results by a name. .. option:: --volume Filters results by a volume (name or ID). .. option:: --limit Maximum number of snapshots to display *Volume version 2 only* .. option:: --marker The last snapshot ID of the previous page *Volume version 2 only* volume snapshot set ------------------- Set volume snapshot properties .. program:: volume snapshot set .. code:: bash openstack volume snapshot set [--name ] [--description ] [--no-property] [--property [...] ] [--state ] .. option:: --name New snapshot name .. option:: --description New snapshot description .. option:: --no-property Remove all properties from :ref:`\ ` (specify both :option:`--no-property` and :option:`--property` to remove the current properties before setting new properties.) .. option:: --property Property to add or modify for this snapshot (repeat option to set multiple properties) .. option:: --state New snapshot state. ("available", "error", "creating", "deleting", or "error_deleting") (admin only) (This option simply changes the state of the snapshot in the database with no regard to actual status, exercise caution when using) *Volume version 2 only* .. _volume_snapshot_set-snapshot: .. describe:: Snapshot to modify (name or ID) volume snapshot show -------------------- Display volume snapshot details .. program:: volume snapshot show .. code:: bash openstack volume snapshot show .. _volume_snapshot_show-snapshot: .. describe:: Snapshot to display (name or ID) volume snapshot unset --------------------- Unset volume snapshot properties .. program:: volume snapshot unset .. code:: bash openstack volume snapshot unset [--property ] .. option:: --property Property to remove from snapshot (repeat option to remove multiple properties) .. _volume_snapshot_unset-snapshot: .. describe:: Snapshot to modify (name or ID) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-transfer-request.rst0000664000175000017500000000405700000000000031514 0ustar00zuulzuul00000000000000======================= volume transfer request ======================= Block Storage v1, v2 volume transfer request accept ------------------------------ Accept volume transfer request .. program:: volume transfer request accept .. code:: bash openstack volume transfer request accept --auth-key .. option:: --auth-key Volume transfer request authentication key .. _volume_transfer_request_accept: .. describe:: Volume transfer request to accept (ID only) Non-admin users are only able to specify the transfer request by ID. volume transfer request create ------------------------------ Create volume transfer request .. program:: volume transfer request create .. code:: bash openstack volume transfer request create [--name ] .. option:: --name New transfer request name (default to None) .. _volume_transfer_request_create-volume: .. describe:: Volume to transfer (name or ID) volume transfer request delete ------------------------------ Delete volume transfer request(s) .. program:: volume transfer request delete .. code:: bash openstack volume transfer request delete [ ...] .. _volume_transfer_request_delete-transfer-request: .. describe:: Volume transfer request(s) to delete (name or ID) volume transfer request list ---------------------------- Lists all volume transfer requests .. program:: volume transfer request list .. code:: bash openstack volume transfer request list --all-projects .. option:: --all-projects Include all projects (admin only) volume transfer request show ---------------------------- Show volume transfer request details .. program:: volume transfer request show .. code:: bash openstack volume transfer request show .. _volume_transfer_request_show-transfer-request: .. describe:: Volume transfer request to display (name or ID) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume-type.rst0000664000175000017500000001574600000000000027172 0ustar00zuulzuul00000000000000=========== volume type =========== Block Storage v1, v2 volume type create ------------------ Create new volume type .. program:: volume type create .. code:: bash openstack volume type create [--description ] [--public | --private] [--property [...] ] [--project ] [--project-domain ] [--encryption-provider ] [--encryption-cipher ] [--encryption-key-size ] [--encryption-control-location ] .. option:: --description Volume type description .. versionadded:: 2 .. option:: --public Volume type is accessible to the public .. versionadded:: 2 .. option:: --private Volume type is not accessible to the public .. versionadded:: 2 .. option:: --property Set a property on this volume type (repeat option to set multiple properties) .. option:: --project Allow to access private type (name or ID) (Must be used with :option:`--private` option) *Volume version 2 only* .. option:: --project-domain Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. *Volume version 2 only* .. option:: --encryption-provider Set the encryption provider format for this volume type (e.g "luks" or "plain") (admin only) This option is required when setting encryption type of a volume. Consider using other encryption options such as: :option:`--encryption-cipher`, :option:`--encryption-key-size` and :option:`--encryption-control-location` .. option:: --encryption-cipher Set the encryption algorithm or mode for this volume type (e.g "aes-xts-plain64") (admin only) .. option:: --encryption-key-size Set the size of the encryption key of this volume type (e.g "128" or "256") (admin only) .. option:: --encryption-control-location Set the notional service where the encryption is performed ("front-end" or "back-end") (admin only) The default value for this option is "front-end" when setting encryption type of a volume. Consider using other encryption options such as: :option:`--encryption-cipher`, :option:`--encryption-key-size` and :option:`--encryption-provider` .. _volume_type_create-name: .. describe:: Volume type name volume type delete ------------------ Delete volume type(s) .. program:: volume type delete .. code:: bash openstack volume type delete [ ...] .. _volume_type_delete-volume-type: .. describe:: Volume type(s) to delete (name or ID) volume type list ---------------- List volume types .. program:: volume type list .. code:: bash openstack volume type list [--long] [--default | --public | --private] [--encryption-type] .. option:: --long List additional fields in output .. option:: --public List only public types *Volume version 2 only* .. option:: --private List only private types (admin only) *Volume version 2 only* .. option:: --default List the default volume type *Volume version 2 only* .. option:: --encryption-type Display encryption information for each volume type (admin only) volume type set --------------- Set volume type properties .. program:: volume type set .. code:: bash openstack volume type set [--name ] [--description ] [--property [...] ] [--project ] [--project-domain ] [--encryption-provider ] [--encryption-cipher ] [--encryption-key-size ] [--encryption-control-location ] .. option:: --name Set volume type name .. versionadded:: 2 .. option:: --description Set volume type description .. versionadded:: 2 .. option:: --project Set volume type access to project (name or ID) (admin only) *Volume version 2 only* .. option:: --project-domain Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. .. option:: --property Set a property on this volume type (repeat option to set multiple properties) .. option:: --encryption-provider Set the encryption provider format for this volume type (e.g "luks" or "plain") (admin only) This option is required when setting encryption type of a volume for the first time. Consider using other encryption options such as: :option:`--encryption-cipher`, :option:`--encryption-key-size` and :option:`--encryption-control-location` .. option:: --encryption-cipher Set the encryption algorithm or mode for this volume type (e.g "aes-xts-plain64") (admin only) .. option:: --encryption-key-size Set the size of the encryption key of this volume type (e.g "128" or "256") (admin only) .. option:: --encryption-control-location Set the notional service where the encryption is performed ("front-end" or "back-end") (admin only) The default value for this option is "front-end" when setting encryption type of a volume for the first time. Consider using other encryption options such as: :option:`--encryption-cipher`, :option:`--encryption-key-size` and :option:`--encryption-provider` .. _volume_type_set-volume-type: .. describe:: Volume type to modify (name or ID) volume type show ---------------- Display volume type details .. program:: volume type show .. code:: bash openstack volume type show [--encryption-type] .. option:: --encryption-type Display encryption information of this volume type (admin only) .. _volume_type_show-volume-type: .. describe:: Volume type to display (name or ID) volume type unset ----------------- Unset volume type properties .. program:: volume type unset .. code:: bash openstack volume type unset [--property [...] ] [--project ] [--project-domain ] [--encryption-type] .. option:: --property Property to remove from volume type (repeat option to remove multiple properties) .. option:: --project Removes volume type access from project (name or ID) (admin only) *Volume version 2 only* .. option:: --project-domain Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. *Volume version 2 only* .. option:: --encryption-type Remove the encryption type for this volume type (admin only) .. _volume_type_unset-volume-type: .. describe:: Volume type to modify (name or ID) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/command-objects/volume.rst0000664000175000017500000002031300000000000026175 0ustar00zuulzuul00000000000000====== volume ====== Block Storage v1, v2 volume create ------------- Create new volume .. program:: volume create .. code:: bash openstack volume create [--size ] [--type ] [--image | --snapshot | --source ] [--description ] [--availability-zone ] [--consistency-group ] [--property [...] ] [--hint [...] ] [--bootable | --non-bootable] [--read-only | --read-write] .. option:: --size Volume size in GB (Required unless --snapshot or --source is specified) .. option:: --type Set the type of volume Select ```` from the available types as shown by ``volume type list``. .. option:: --image Use ```` as source of volume (name or ID) This is commonly used to create a boot volume for a server. .. option:: --snapshot Use ```` as source of volume (name or ID) .. option:: --source Volume to clone (name or ID) .. option:: --description Volume description .. option:: --availability-zone Create volume in ```` .. option:: --consistency-group Consistency group where the new volume belongs to .. option:: --property Set a property on this volume (repeat option to set multiple properties) .. option:: --hint Arbitrary scheduler hint key-value pairs to help boot an instance (repeat option to set multiple hints) .. option:: --bootable Mark volume as bootable .. option:: --non-bootable Mark volume as non-bootable (default) .. option:: --read-only Set volume to read-only access mode .. option:: --read-write Set volume to read-write access mode (default) .. _volume_create-name: .. describe:: Volume name volume delete ------------- Delete volume(s) .. program:: volume delete .. code:: bash openstack volume delete [--force | --purge] [ ...] .. option:: --force Attempt forced removal of volume(s), regardless of state (defaults to False) .. option:: --purge Remove any snapshots along with volume(s) (defaults to False) *Volume version 2 only* .. _volume_delete-volume: .. describe:: Volume(s) to delete (name or ID) volume list ----------- List volumes .. program:: volume list .. code:: bash openstack volume list [--project [--project-domain ]] [--user [--user-domain ]] [--name ] [--status ] [--all-projects] [--long] [--limit ] [--marker ] .. option:: --project Filter results by ```` (name or ID) (admin only) *Volume version 2 only* .. option:: --project-domain Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. *Volume version 2 only* .. option:: --user Filter results by ```` (name or ID) (admin only) *Volume version 2 only* .. option:: --user-domain Domain the user belongs to (name or ID). This can be used in case collisions between user names exist. *Volume version 2 only* .. option:: --name Filter results by volume name .. option:: --status Filter results by status .. option:: --all-projects Include all projects (admin only) .. option:: --long List additional fields in output .. option:: --limit Maximum number of volumes to display .. option:: --marker The last volume ID of the previous page *Volume version 2 only* volume migrate -------------- Migrate volume to a new host .. program:: volume migrate .. code:: bash openstack volume migrate --host [--force-host-copy] [--lock-volume] .. option:: --host Destination host (takes the form: host@backend-name#pool) (required) .. option:: --force-host-copy Enable generic host-based force-migration, which bypasses driver optimizations .. option:: --lock-volume If specified, the volume state will be locked and will not allow a migration to be aborted (possibly by another operation) *Volume version 2 only* .. _volume_migrate-volume: .. describe:: Volume to migrate (name or ID) volume set ---------- Set volume properties .. program:: volume set .. code:: bash openstack volume set [--name ] [--size ] [--description ] [--no-property] [--property [...] ] [--image-property [...] ] [--state ] [--attached | --detached ] [--type ] [--retype-policy ] [--bootable | --non-bootable] [--read-only | --read-write] .. option:: --name New volume name .. option:: --size Extend volume size in GB .. option:: --description New volume description .. option:: --no-property Remove all properties from :ref:`\ ` (specify both :option:`--no-property` and :option:`--property` to remove the current properties before setting new properties.) .. option:: --property Set a property on this volume (repeat option to set multiple properties) .. option:: --type New volume type (name or ID) *Volume version 2 only* .. option:: --retype-policy Migration policy while re-typing volume ("never" or "on-demand", default is "never" ) (available only when :option:`--type` option is specified) *Volume version 2 only* .. option:: --bootable Mark volume as bootable .. option:: --non-bootable Mark volume as non-bootable .. option:: --read-only Set volume to read-only access mode .. option:: --read-write Set volume to read-write access mode .. option:: --image-property Set an image property on this volume (repeat option to set multiple image properties) Image properties are copied along with the image when creating a volume using ``--image``. Note that these properties are immutable on the image itself, this option updates the copy attached to this volume. *Volume version 2 only* .. option:: --state New volume state ("available", "error", "creating", "deleting", "in-use", "attaching", "detaching", "error_deleting" or "maintenance") (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using) *Volume version 2 only* .. option:: --attached Set volume attachment status to "attached" (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using) *Volume version 2 only* .. option:: --deattach Set volume attachment status to "detached" (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using) *Volume version 2 only* .. _volume_set-volume: .. describe:: Volume to modify (name or ID) volume show ----------- Show volume details .. program:: volume show .. code:: bash openstack volume show .. _volume_show-volume: .. describe:: Volume to display (name or ID) volume unset ------------ Unset volume properties .. program:: volume unset .. code:: bash openstack volume unset [--property ] [--image-property ] .. option:: --property Remove a property from volume (repeat option to remove multiple properties) .. option:: --image-property Remove an image property from volume (repeat option to remove multiple image properties) *Volume version 2 only* .. _volume_unset-volume: .. describe:: Volume to modify (name or ID) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/commands.rst0000664000175000017500000004206200000000000023427 0ustar00zuulzuul00000000000000.. _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 * ``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)**) * ``cluster``: (**Clustering (Senlin)**) * ``cluster action``: (**Clustering (Senlin)**) * ``cluster event``: (**Clustering (Senlin)**) * ``cluster members``: (**Clustering (Senlin)**) * ``cluster node``: (**Clustering (Senlin)**) * ``cluster policy``: (**Clustering (Senlin)**) * ``cluster policy binding``: (**Clustering (Senlin)**) * ``cluster policy type``: (**Clustering (Senlin)**) * ``cluster profile``: (**Clustering (Senlin)**) * ``cluster profile type``: (**Clustering (Senlin)**) * ``cluster receiver``: (**Clustering (Senlin)**) * ``cron trigger``: (**Workflow Engine (Mistral)**) * ``database flavor``: (**Database (Trove)**) * ``dataprocessing data source``: (**Data Processing (Sahara)**) * ``dataprocessing image``: (**Data Processing (Sahara)**) * ``dataprocessing image tags``: (**Data Processing (Sahara)**) * ``dataprocessing plugin``: (**Data Processing (Sahara)**) * ``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)**) * ``rsd``: (**Disaggregated Hardware Resource Management (RSD)**) * ``search`` (**Search (Searchlight)**) * ``search facet`` (**Search (Searchlight)**) * ``search resource type`` (**Search (Searchlight)**) * ``secret``: (**Key Manager (Barbican)**) * ``secret container``: (**Key Manager (Barbican)**) * ``secret order``: (**Key Manager (Barbican)**) * ``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. * ``purge`` - clean resources associated with a specific project * ``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 # ... ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6394017 python-openstackclient-5.8.0/doc/source/cli/data/0000775000175000017500000000000000000000000022001 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/data/cinder.csv0000664000175000017500000003016400000000000023766 0ustar00zuulzuul00000000000000absolute-limits,limits show --absolute,Lists absolute limits for a user. api-version,WONTFIX,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,,Disables clustered services. (Supported by API versions 3.7 - 3.latest) cluster-enable,,Enables clustered services. (Supported by API versions 3.7 - 3.latest) cluster-list,,Lists clustered services with optional filtering. (Supported by API versions 3.7 - 3.latest) 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,,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,,List enabled filters. (Supported by API versions 3.33 - 3.latest) manage,volume create --remote-source k=v,Manage an existing 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,,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,,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,,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,,(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,,(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,snapshot create,Creates a snapshot. snapshot-delete,snapshot delete,Remove one or more snapshots. snapshot-list,snapshot list,Lists all snapshots. snapshot-manage,volume snapshot create --remote-source ,Manage an existing snapshot. snapshot-manageable-list,,Lists all manageable snapshots. (Supported by API versions 3.8 - 3.latest) snapshot-metadata,snapshot set --property k=v / snapshot unset --property k,Sets or deletes snapshot metadata. snapshot-metadata-show,snapshot show,Shows snapshot metadata. snapshot-metadata-update-all,snapshot set --property k=v,Updates snapshot metadata. snapshot-rename,snapshot set --name,Renames a snapshot. snapshot-reset-state,snapshot set --state,Explicitly updates the snapshot state. snapshot-show,snapshot show,Shows snapshot details. snapshot-unmanage,volume snapshot delete --remote,Stop managing a snapshot. 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,,List all API versions. (Supported by API versions 3.0 - 3.latest) work-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. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/data/glance.csv0000664000175000017500000001010200000000000023741 0ustar00zuulzuul00000000000000explain,WONTFIX,Describe a specific model. image-create,image create,Create a new image. image-create-via-import,,EXPERIMENTAL: Create a new image via image import. 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,,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,,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-update,image set,Update an existing image. image-upload,,Upload data for a specific image. import-info,,Print import methods available 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,,Create a new metadata definitions namespace. md-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,,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,,List resource types associated to specific namespace. md-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,,Create a new metadata definitions object inside a namespace. md-object-delete,,Delete a specific metadata definitions object inside a namespace. md-object-list,,List metadata definitions objects inside a specific namespace. md-object-property-show,,Describe a specific metadata definitions property inside an object. md-object-show,,Describe a specific metadata definitions object inside a namespace. md-object-update,,Update metadata definitions object inside a namespace. md-property-create,,Create a new metadata definitions property inside a namespace. md-property-delete,,Delete a specific metadata definitions property inside a namespace. md-property-list,,List metadata definitions properties inside a specific namespace. md-property-show,,Describe a specific metadata definitions property inside a namespace. md-property-update,,Update metadata definitions property inside a namespace. md-resource-type-associate,,Associate resource type with a metadata definitions namespace. md-resource-type-deassociate,,Deassociate resource type with a metadata definitions namespace. md-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-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,,Delete image from specific store. stores-info,,Print available backends from Glance. task-create,,Create a new task. task-list,,List tasks you can access. task-show,,Describe a specific task. bash-completion,complete,Prints arguments for bash_completion. help,help,Display help about this program or one of its subcommands. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/data/keystone.csv0000664000175000017500000000446500000000000024370 0ustar00zuulzuul00000000000000catalog,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. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/data/neutron.csv0000664000175000017500000004447500000000000024226 0ustar00zuulzuul00000000000000address-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,,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,,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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/data/nova.csv0000664000175000017500000002205500000000000023465 0ustar00zuulzuul00000000000000add-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,,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,,Evacuate all instances from failed host. host-evacuate-live,,Live migrate all instances off the specified host to other available hosts. host-meta,,Set or Delete metadata on all instances of a host. host-servers-migrate,,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,,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,,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,,List actions on a server. instance-usage-audit-log,,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,,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 set,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,,List all API versions. volume-attach,server add volume,Attach a volume to a server. volume-attachments,server show,List all the volumes attached to a server. volume-detach,server remove volume,Detach a volume from a 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. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/data/swift.csv0000664000175000017500000000143100000000000023651 0ustar00zuulzuul00000000000000delete,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. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/decoder.rst0000664000175000017500000000227700000000000023237 0ustar00zuulzuul00000000000000============= 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/index.rst0000664000175000017500000000062000000000000022727 0ustar00zuulzuul00000000000000==================== 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/* ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/interactive.rst0000664000175000017500000001425700000000000024150 0ustar00zuulzuul00000000000000================ 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. ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6394017 python-openstackclient-5.8.0/doc/source/cli/man/0000775000175000017500000000000000000000000021643 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/man/openstack.rst0000664000175000017500000004441200000000000024371 0ustar00zuulzuul00000000000000.. _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-url` (or the environment variables :envvar:`OS_TOKEN` and :envvar:`OS_URL` 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-url Service URL, 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-url` 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_URL Service URL (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 StoryBoard project "https://storyboard.openstack.org/#!/project/975". 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. ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6434016 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/0000775000175000017500000000000000000000000024165 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/barbican.rst0000664000175000017500000000010300000000000026452 0ustar00zuulzuul00000000000000barbican -------- .. autoprogram-cliff:: openstack.key_manager.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/designate.rst0000664000175000017500000000007500000000000026664 0ustar00zuulzuul00000000000000designate --------- .. autoprogram-cliff:: openstack.dns.v2 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/gnocchi.rst0000664000175000017500000000007400000000000026332 0ustar00zuulzuul00000000000000gnocchi ------- .. autoprogram-cliff:: openstack.metric.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/heat.rst0000664000175000017500000000007500000000000025642 0ustar00zuulzuul00000000000000heat ---- .. autoprogram-cliff:: openstack.orchestration.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/index.rst0000664000175000017500000000152700000000000026033 0ustar00zuulzuul00000000000000.. _plugin-commands: =============== Plugin Commands =============== .. toctree:: :maxdepth: 1 barbican designate gnocchi heat ironic ironic-inspector manila mistral neutron octavia placement rsd sahara senlin trove watcher zaqar zun .. TODO(efried): Make pages for the following once they're fixed. .. aodh .. # aodhclient docs build is failing with recent pyparsing .. # autoprogram-cliff:: openstack.alarming.v2 .. cue .. # cueclient is not in global-requirements .. # list-plugins:: openstack.mb.v1 .. # :detailed: .. murano .. # the murano docs cause warnings and a broken docs build .. # .. list-plugins:: openstack.application_catalog.v1 .. # :detailed: .. tripleo .. # tripleoclient is not in global-requirements .. # list-plugins:: openstack.tripleoclient.v1 .. # :detailed: ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/ironic-inspector.rst0000664000175000017500000000013700000000000030207 0ustar00zuulzuul00000000000000ironic-inspector ---------------- .. autoprogram-cliff:: openstack.baremetal_introspection.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/ironic.rst0000664000175000017500000000007500000000000026204 0ustar00zuulzuul00000000000000ironic ------ .. autoprogram-cliff:: openstack.baremetal.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/manila.rst0000664000175000017500000000007100000000000026156 0ustar00zuulzuul00000000000000manila ------ .. autoprogram-cliff:: openstack.share.v2 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/mistral.rst0000664000175000017500000000010500000000000026366 0ustar00zuulzuul00000000000000mistral ------- .. autoprogram-cliff:: openstack.workflow_engine.v2 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/neutron.rst0000664000175000017500000000010300000000000026403 0ustar00zuulzuul00000000000000neutron ------- .. autoprogram-cliff:: openstack.neutronclient.v2 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/octavia.rst0000664000175000017500000000010300000000000026337 0ustar00zuulzuul00000000000000octavia ------- .. autoprogram-cliff:: openstack.load_balancer.v2 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/placement.rst0000664000175000017500000000010300000000000026661 0ustar00zuulzuul00000000000000placement --------- .. autoprogram-cliff:: openstack.placement.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/rsd.rst0000664000175000017500000000006100000000000025504 0ustar00zuulzuul00000000000000rsd --- .. autoprogram-cliff:: openstack.rsd.v2 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/sahara.rst0000664000175000017500000000010300000000000026150 0ustar00zuulzuul00000000000000sahara ------ .. autoprogram-cliff:: openstack.data_processing.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/senlin.rst0000664000175000017500000000007600000000000026212 0ustar00zuulzuul00000000000000senlin ------ .. autoprogram-cliff:: openstack.clustering.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/trove.rst0000664000175000017500000000007200000000000026055 0ustar00zuulzuul00000000000000trove ----- .. autoprogram-cliff:: openstack.database.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/watcher.rst0000664000175000017500000000010100000000000026344 0ustar00zuulzuul00000000000000watcher ------- .. autoprogram-cliff:: openstack.infra_optim.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/zaqar.rst0000664000175000017500000000007300000000000026035 0ustar00zuulzuul00000000000000zaqar ----- .. autoprogram-cliff:: openstack.messaging.v2 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/cli/plugin-commands/zun.rst0000664000175000017500000000006700000000000025536 0ustar00zuulzuul00000000000000zun --- .. autoprogram-cliff:: openstack.container.v1 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/conf.py0000664000175000017500000002065300000000000021626 0ustar00zuulzuul00000000000000# -*- coding: utf-8 -*- # # 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_use_storyboard = True 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 = u'OpenStack Command Line Client' copyright = u'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', u'OpenStack Command Line Client Documentation', u'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', u'OpenStack Command Line Client', [u'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', u'OpenStack Command Line Client Documentation', u'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' ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6434016 python-openstackclient-5.8.0/doc/source/configuration/0000775000175000017500000000000000000000000023170 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/configuration/index.rst0000664000175000017500000002122400000000000025032 0ustar00zuulzuul00000000000000.. _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 ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1646744444.6434016 python-openstackclient-5.8.0/doc/source/contributor/0000775000175000017500000000000000000000000022673 5ustar00zuulzuul00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/contributor/command-beta.rst0000664000175000017500000000554500000000000025765 0ustar00zuulzuul00000000000000.. _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") ) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/contributor/command-errors.rst0000664000175000017500000001605400000000000026363 0ustar00zuulzuul00000000000000============== 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 io.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.keypairs.create( 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) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/contributor/command-logs.rst0000664000175000017500000000407200000000000026010 0ustar00zuulzuul00000000000000============ 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 ## ... ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/contributor/command-options.rst0000664000175000017500000002361600000000000026544 0ustar00zuulzuul00000000000000=============== 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", ) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/contributor/command-wrappers.rst0000664000175000017500000000372700000000000026715 0ustar00zuulzuul00000000000000====================== 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) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/contributor/developing.rst0000664000175000017500000001315100000000000025562 0ustar00zuulzuul00000000000000=============================== 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 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1646744410.0 python-openstackclient-5.8.0/doc/source/contributor/humaninterfaceguide.rst0000664000175000017500000003502700000000000027443 0ustar00zuulzuul00000000000000.. _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 :code:`-h` or :code:`--help` options: .. code-block:: bash $ openstack --help For help with an individual command, use the :code:`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 :code:`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 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 (:code:`--like-this`). Underscores ('_') shall not be used in option names. * Authentication options conform to the common CLI authentication guidelines in :ref:`authentication`. For example, :code:`--os-username` can be set from the environment via :code:`OS_USERNAME`. --help ++++++ The standard :code:`--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 (:code:`-h`) is also available. --version +++++++++ The standard :code:`--version` option displays the name and version on standard output. All other options and commands are ignored when this is present. 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:`group add user ` * :code:`volume type list` # Note that :code:`volume type` is a two-word single object The :code:`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. Object names are always specified in command in their singular form. This is contrary to natural language use. 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. Command options shall 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 ++++++++++++ * **boolean**: boolean options shall use a form of :code:`--|--` (preferred) or :code:`--