diff --git a/.coveragerc b/.coveragerc deleted file mode 100644 index 3685187b..00000000 --- a/.coveragerc +++ /dev/null @@ -1,6 +0,0 @@ -[run] -branch = True -source = openstackclient - -[report] -ignore_errors = True diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 2c0139cf..00000000 --- a/.gitignore +++ /dev/null @@ -1,25 +0,0 @@ -*.DS_Store -*.egg* -*.log -*.mo -*.pyc -*.swo -*.swp -*~ -.coverage -.idea -.testrepository -.tox -AUTHORS -build -ChangeLog -dist -# Doc related -doc/build -doc/source/contributor/api/ -# Development environment files -.project -.pydevproject -cover -# Files created by releasenotes build -releasenotes/build diff --git a/.gitreview b/.gitreview deleted file mode 100644 index 784c1900..00000000 --- a/.gitreview +++ /dev/null @@ -1,4 +0,0 @@ -[gerrit] -host=review.openstack.org -port=29418 -project=openstack/python-openstackclient.git diff --git a/.mailmap b/.mailmap deleted file mode 100644 index c3f1f561..00000000 --- a/.mailmap +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/.testr.conf b/.testr.conf deleted file mode 100644 index 633aae1f..00000000 --- a/.testr.conf +++ /dev/null @@ -1,9 +0,0 @@ -[DEFAULT] -test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \ - OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \ - OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \ - ${PYTHON:-python} -m subunit.run discover -t ./ ${OS_TEST_PATH:-./openstackclient/tests/unit} $LISTOPT $IDOPTION - -test_id_option=--load-list $IDFILE -test_list_option=--list -group_regex=([^\.]+\.)+ diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index de9324ec..00000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,16 +0,0 @@ -If you would like to contribute to the development of OpenStack, -you must follow the steps documented at: - - http://docs.openstack.org/infra/manual/developers.html#development-workflow - -Once those steps have been completed, changes to OpenStack -should be submitted for review via the Gerrit tool, following -the workflow documented at: - - http://docs.openstack.org/infra/manual/developers.html#development-workflow - -Pull requests submitted through GitHub will be ignored. - -Bugs should be filed on Launchpad, not GitHub: - - https://bugs.launchpad.net/python-openstackclient diff --git a/HACKING.rst b/HACKING.rst deleted file mode 100644 index e6c8d078..00000000 --- a/HACKING.rst +++ /dev/null @@ -1,108 +0,0 @@ -OpenStack Style Commandments -============================ - -- Step 1: Read the OpenStack Style Commandments - http://docs.openstack.org/developer/hacking/ -- 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'], - ) - -Text encoding -------------- - -Note: this section clearly has not been implemented in this project yet, it is -the intention to do so. - -All text within python code should be of type 'unicode'. - - WRONG: - - >>> s = 'foo' - >>> s - 'foo' - >>> type(s) - - - RIGHT: - - >>> u = u'foo' - >>> u - u'foo' - >>> type(u) - - -Transitions between internal unicode and external strings should always -be immediately and explicitly encoded or decoded. - -All external text that is not explicitly encoded (database storage, -commandline arguments, etc.) should be presumed to be encoded as utf-8. - - WRONG: - - infile = open('testfile', 'r') - mystring = infile.readline() - myreturnstring = do_some_magic_with(mystring) - outfile.write(myreturnstring) - - RIGHT: - - infile = open('testfile', 'r') - mystring = infile.readline() - mytext = mystring.decode('utf-8') - returntext = do_some_magic_with(mytext) - returnstring = returntext.encode('utf-8') - outfile.write(returnstring) - -Python 3.x Compatibility ------------------------- - -OpenStackClient strives to be Python 3.3 compatible. Common guidelines: - -* Convert print statements to functions: print statements should be converted - to an appropriate log or other output mechanism. -* Use six where applicable: x.iteritems is converted to six.iteritems(x) - for example. - -Running Tests -------------- - -Note: Oh boy, are we behind on writing tests. But they are coming! - -The testing system is based on a combination of tox and testr. If you just -want to run the whole suite, run `tox` and all will be fine. However, if -you'd like to dig in a bit more, you might want to learn some things about -testr itself. A basic walkthrough for OpenStack can be found at -http://wiki.openstack.org/testr diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 68c771a0..00000000 --- a/LICENSE +++ /dev/null @@ -1,176 +0,0 @@ - - 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. - diff --git a/README b/README new file mode 100644 index 00000000..8fcd2b2f --- /dev/null +++ b/README @@ -0,0 +1,14 @@ +This project is no longer maintained. + +The contents of this repository are still available in the Git +source code management system. To see the contents of this +repository before it reached its end of life, please check out the +previous commit with "git checkout HEAD^1". + +For ongoing work on maintaining OpenStack packages in the Debian +distribution, please see the Debian OpenStack packaging team at +https://wiki.debian.org/OpenStack/. + +For any further questions, please email +openstack-dev@lists.openstack.org or join #openstack-dev on +Freenode. diff --git a/README.rst b/README.rst deleted file mode 100644 index b030efd1..00000000 --- a/README.rst +++ /dev/null @@ -1,117 +0,0 @@ -======================== -Team and repository tags -======================== - -.. image:: http://governance.openstack.org/badges/python-openstackclient.svg - :target: http://governance.openstack.org/reference/tags/index.html - -.. Change things from this point on - -=============== -OpenStackClient -=============== - -.. image:: https://img.shields.io/pypi/v/python-openstackclient.svg - :target: https://pypi.python.org/pypi/python-openstackclient/ - :alt: Latest Version - -.. image:: https://img.shields.io/pypi/dm/python-openstackclient.svg - :target: https://pypi.python.org/pypi/python-openstackclient/ - :alt: Downloads - -OpenStackClient (aka OSC) is a command-line client for OpenStack that brings -the command set for Compute, Identity, Image, 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`_ -* `Launchpad project`_ - release management -* `Blueprints`_ - feature specifications -* `Bugs`_ - issue tracking -* `Source`_ -* `Developer` - getting started as a developer -* `Contributing` - contributing code -* `Testing` - testing code -* IRC: #openstack-sdks on Freenode (irc.freenode.net) -* License: Apache 2.0 - -.. _PyPi: https://pypi.python.org/pypi/python-openstackclient -.. _Online Documentation: http://docs.openstack.org/python-openstackclient/ -.. _Launchpad project: https://launchpad.net/python-openstackclient -.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient -.. _Bugs: https://bugs.launchpad.net/python-openstackclient -.. _Source: https://git.openstack.org/cgit/openstack/python-openstackclient -.. _Developer: http://docs.openstack.org/project-team-guide/project-setup/python.html -.. _Contributing: http://docs.openstack.org/infra/manual/developers.html -.. _Testing: http://docs.openstack.org/python-openstackclient/developing.html#testing - -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 http://docs.openstack.org/python-openstackclient/authentication.html. - -Authentication using username/password is most commonly used:: - - 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 ] - -If a password is not provided above (in plaintext), you will be interactively -prompted to provide one securely. - -Authentication may also be performed using an already-acquired token -and a URL pointing directly to the service API that presumably was acquired -from the Service Catalog:: - - export OS_TOKEN= - export OS_URL= - -The corresponding command-line options look very similar:: - - --os-token - --os-url diff --git a/babel.cfg b/babel.cfg deleted file mode 100644 index efceab81..00000000 --- a/babel.cfg +++ /dev/null @@ -1 +0,0 @@ -[python: **.py] diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index 2cdd0f5c..00000000 --- a/doc/Makefile +++ /dev/null @@ -1,136 +0,0 @@ -# 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." diff --git a/doc/source/cli/authentication.rst b/doc/source/cli/authentication.rst deleted file mode 100644 index 5a1d2797..00000000 --- a/doc/source/cli/authentication.rst +++ /dev/null @@ -1,146 +0,0 @@ -.. _authentication: - -============== -Authentication -============== - -OpenStackClient leverages `python-keystoneclient`_ authentication -plugins to support a number of different authentication methods. - -.. _`python-keystoneclient`: http://docs.openstack.org/developer/python-keystoneclient/authentication-plugins.html - -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``] -* **Token/Endpoint**: This is the original token authentication (known as 'token - flow' in the early CLI documentation in the OpenStack wiki). It requires - a token and a direct endpoint that is used in the API call. The difference - from the new Token type is this token is used as-is, no call is made - to the Identity service from the client. This type is most often used to - bootstrap a Keystone server where the token is the ``admin_token`` configured - in ``keystone.conf``. It will also work with other services and a regular - scoped token such as one obtained from a ``token issue`` command. - [Required: ``--os-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-url`` and ``--os-token`` are both present ``token_endpoint`` - is selected - * 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 diff --git a/doc/source/cli/backwards-incompatible.rst b/doc/source/cli/backwards-incompatible.rst deleted file mode 100644 index fcb68684..00000000 --- a/doc/source/cli/backwards-incompatible.rst +++ /dev/null @@ -1,305 +0,0 @@ -============================== -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 -============================== - -.. Carry this section as comments until 4.0 release -.. Release 4.0 -.. ----------- - -.. 1. Change ``volume transfer request accept`` to use new option ``--auth-key`` -.. rather than a second positional argument. - -.. * As of: 4.0 -.. * Remove in: <5.0> -.. * Commit: - -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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.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.openstack.org/#/q/project:openstack/python-openstackclient+AND+message:BackwardsIncompatibleImpact,n,z diff --git a/doc/source/cli/command-list.rst b/doc/source/cli/command-list.rst deleted file mode 100644 index 9044f693..00000000 --- a/doc/source/cli/command-list.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _command-list: - -============ -Command List -============ - -.. toctree:: - :glob: - :maxdepth: 2 - - command-objects/* diff --git a/doc/source/cli/command-objects/access-token.rst b/doc/source/cli/command-objects/access-token.rst deleted file mode 100644 index b1400412..00000000 --- a/doc/source/cli/command-objects/access-token.rst +++ /dev/null @@ -1,42 +0,0 @@ -============ -access token -============ - -Identity v3 - -`Requires: OS-OAUTH1 extension` - -access token create -------------------- - -Create an access token - -.. program:: access token create -.. code:: bash - - openstack access token create - --consumer-key - --consumer-secret - --request-key - --request-secret - --verifier - -.. option:: --consumer-key - - Consumer key (required) - -.. option:: --consumer-secret - - Consumer secret (required) - -.. option:: --request-key - - Request token to exchange for access token (required) - -.. option:: --request-secret - - Secret associated with (required) - -.. option:: --verifier - - Verifier associated with (required) diff --git a/doc/source/cli/command-objects/address-scope.rst b/doc/source/cli/command-objects/address-scope.rst deleted file mode 100644 index 9155d09e..00000000 --- a/doc/source/cli/command-objects/address-scope.rst +++ /dev/null @@ -1,149 +0,0 @@ -============= -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 - -address scope create --------------------- - -Create new address scope - -.. program:: address scope create -.. code:: bash - - openstack address scope create - [--project [--project-domain ]] - [--ip-version ] - [--share | --no-share] - - -.. option:: --project - - Owner's project (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. - -.. option:: --ip-version - - IP version (4 or 6, default is 4) - -.. option:: --share - - Share the address scope between projects - -.. option:: --no-share - - Do not share the address scope between projects (default) - -.. _address_scope_create-name: -.. describe:: - - New address scope name - -address scope delete --------------------- - -Delete address scope(s) - -.. program:: address scope delete -.. code:: bash - - openstack address scope delete - [ ...] - -.. _address_scope_delete-address-scope: -.. describe:: - - Address scope(s) to delete (name or ID) - -address scope list ------------------- - -List address scopes - -.. program:: address scope list -.. code:: bash - - openstack address scope list - [--name ] - [--ip-version ] - [--project [--project-domain ]] - [--share | --no-share] - -.. option:: --name - - List only address scopes of given name in output - -.. option:: --ip-version - - List address scopes of given IP version networks (4 or 6) - -.. option:: --project - - List address scopes according to their project (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. - -.. option:: --share - - List address scopes shared between projects - -.. option:: --no-share - - List address scopes not shared between projects - -address scope set ------------------ - -Set address scope properties - -.. program:: address scope set -.. code:: bash - - openstack address scope set - [--name ] - [--share | --no-share] - - -.. option:: --name - - Set address scope name - -.. option:: --share - - Share the address scope between projects - -.. option:: --no-share - - Do not share the address scope between projects - -.. _address_scope_set-address-scope: -.. describe:: - - Address scope to modify (name or ID) - -address scope show ------------------- - -Display address scope details - -.. program:: address scope show -.. code:: bash - - openstack address scope show - - -.. _address_scope_show-address-scope: -.. describe:: - - Address scope to display (name or ID) diff --git a/doc/source/cli/command-objects/aggregate.rst b/doc/source/cli/command-objects/aggregate.rst deleted file mode 100644 index 2029a6c8..00000000 --- a/doc/source/cli/command-objects/aggregate.rst +++ /dev/null @@ -1,186 +0,0 @@ -========= -aggregate -========= - -Host aggregates provide a mechanism to group hosts according to certain -criteria. - -Compute v2 - -aggregate add host ------------------- - -Add host to aggregate - -.. program:: aggregate add host -.. code:: bash - - openstack aggregate add host - - - -.. _aggregate_add_host-aggregate: -.. describe:: - - Aggregate (name or ID) - -.. _aggregate_add_host-host: -.. describe:: - - Host to add to :ref:`\ ` - -aggregate create ----------------- - -Create a new aggregate - -.. program:: aggregate create -.. code:: bash - - openstack aggregate create - [--zone ] - [--property [...] ] - - -.. option:: --zone - - Availability zone name - -.. option:: --property - - Property to add to this aggregate (repeat option to set multiple properties) - -.. _aggregate_create-name: -.. describe:: - - New aggregate name - -aggregate delete ----------------- - -Delete existing aggregate(s) - -.. program:: aggregate delete -.. code:: bash - - openstack aggregate delete - [ ...] - -.. _aggregate_delete-aggregate: -.. describe:: - - Aggregate(s) to delete (name or ID) - -aggregate list --------------- - -List all aggregates - -.. program:: aggregate list -.. code:: bash - - openstack aggregate list - [--long] - -.. option:: --long - - List additional fields in output - -aggregate remove host ---------------------- - -Remove host from aggregate - -.. program:: aggregate remove host -.. code:: bash - - openstack aggregate remove host - - - -.. _aggregate_remove_host-aggregate: -.. describe:: - - Aggregate (name or ID) - -.. _aggregate_remove_host-host: -.. describe:: - - Host to remove from :ref:`\ ` - -aggregate set -------------- - -Set aggregate properties - -.. program:: aggregate set -.. code:: bash - - openstack aggregate set - [--name ] - [--zone ] - [--property [...] ] - [--no-property] - - -.. option:: --name - - Set aggregate name - -.. option:: --zone - - Set availability zone name - -.. option:: --property - - Property to set on :ref:`\ ` - (repeat option to set multiple properties) - -.. option:: --no-property - - Remove all properties from :ref:`\ ` - (specify both :option:`--property` and :option:`--no-property` to - overwrite the current properties) - -.. _aggregate_set-aggregate: -.. describe:: - - Aggregate to modify (name or ID) - -aggregate show --------------- - -Display aggregate details - -.. program:: aggregate show -.. code:: bash - - openstack aggregate show - - -.. _aggregate_show-aggregate: -.. describe:: - - Aggregate to display (name or ID) - -aggregate unset ---------------- - -Unset aggregate properties - -.. program:: aggregate unset -.. code-block:: bash - - openstack aggregate unset - [--property [...] ] - - -.. option:: --property - - Property to remove from :ref:`\ ` - (repeat option to remove multiple properties) - -.. _aggregate_unset-aggregate: -.. describe:: - - Aggregate to modify (name or ID) diff --git a/doc/source/cli/command-objects/availability-zone.rst b/doc/source/cli/command-objects/availability-zone.rst deleted file mode 100644 index d4c117a0..00000000 --- a/doc/source/cli/command-objects/availability-zone.rst +++ /dev/null @@ -1,38 +0,0 @@ -================= -availability zone -================= - -An **availability zone** is a logical partition of cloud block storage, -compute and network services. - -Block Storage v2, Compute v2, Network v2 - -availability zone list ----------------------- - -List availability zones and their status - -.. program availability zone list -.. code:: bash - - openstack availability zone list - [--compute] - [--network] - [--volume] - [--long] - -.. option:: --compute - - List compute availability zones - -.. option:: --network - - List network availability zones - -.. option:: --volume - - List volume availability zones - -.. option:: --long - - List additional fields in output diff --git a/doc/source/cli/command-objects/backup.rst b/doc/source/cli/command-objects/backup.rst deleted file mode 100644 index f8923276..00000000 --- a/doc/source/cli/command-objects/backup.rst +++ /dev/null @@ -1,137 +0,0 @@ -====== -backup -====== - -Block Storage v1, v2 - -backup create -------------- - -Create new backup -(Deprecated, please use ``volume backup create`` instead) - -.. program:: backup create -.. code:: bash - - openstack backup create - [--container ] - [--name ] - [--description ] - [--snapshot ] - [--force] - [--incremental] - - -.. option:: --container - - Optional backup container name - -.. option:: --name - - Name of the backup - -.. option:: --description - - Description of the backup - -.. option:: --snapshot - - Snapshot to backup (name or ID) - - *Volume version 2 only* - -.. option:: --force - - Allow to back up an in-use volume - - *Volume version 2 only* - -.. option:: --incremental - - Perform an incremental backup - - *Volume version 2 only* - -.. _backup_create-backup: -.. describe:: - - Volume to backup (name or ID) - -backup delete -------------- - -Delete backup(s) -(Deprecated, please use ``volume backup delete`` instead) - -.. program:: backup delete -.. code:: bash - - openstack backup delete - [--force] - [ ...] - -.. option:: --force - - Allow delete in state other than error or available - - *Volume version 2 only* - -.. _backup_delete-backup: -.. describe:: - - Backup(s) to delete (name or ID) - -backup list ------------ - -List backups -(Deprecated, please use ``volume backup list`` instead) - -.. program:: backup list -.. code:: bash - - openstack backup list - -.. _backup_list-backup: -.. option:: --long - - List additional fields in output - -backup restore --------------- - -Restore backup -(Deprecated, please use ``volume backup restore`` instead) - -.. program:: backup restore -.. code:: bash - - openstack backup restore - - - -.. _backup_restore-backup: -.. describe:: - - Backup to restore (name or ID) - -.. describe:: - - Volume to restore to (name or ID) - -backup show ------------ - -Display backup details -(Deprecated, please use ``volume backup show`` instead) - -.. program:: backup show -.. code:: bash - - openstack backup show - - -.. _backup_show-backup: -.. describe:: - - Backup to display (name or ID) diff --git a/doc/source/cli/command-objects/catalog.rst b/doc/source/cli/command-objects/catalog.rst deleted file mode 100644 index dccf7801..00000000 --- a/doc/source/cli/command-objects/catalog.rst +++ /dev/null @@ -1,30 +0,0 @@ -======= -catalog -======= - -Identity v2, v3 - -catalog list ------------- - -List services in the service catalog - -.. program:: catalog list -.. code:: bash - - openstack catalog list - -catalog show ------------- - -Display service catalog details - -.. program:: catalog show -.. code:: bash - - openstack catalog show - - -.. describe:: - - Service to display (type or name) diff --git a/doc/source/cli/command-objects/command.rst b/doc/source/cli/command-objects/command.rst deleted file mode 100644 index 918fd959..00000000 --- a/doc/source/cli/command-objects/command.rst +++ /dev/null @@ -1,23 +0,0 @@ -======= -command -======= - -Internal - -Installed commands in the OSC process. - -command list ------------- - -List recognized commands by group - -.. program:: command list -.. code:: bash - - openstack command list - [--group ] - -.. option:: --group - - Show commands filtered by a command group, for example: identity, volume, - compute, image, network and other keywords diff --git a/doc/source/cli/command-objects/complete.rst b/doc/source/cli/command-objects/complete.rst deleted file mode 100644 index 20e5c41d..00000000 --- a/doc/source/cli/command-objects/complete.rst +++ /dev/null @@ -1,25 +0,0 @@ -======== -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 - -If installing ``python-openstackclient`` from a package (``apt-get`` or ``yum``), -then this command will likely be run for you. - -complete --------- - -print bash completion command - -.. program:: complete -.. code:: bash - - openstack complete diff --git a/doc/source/cli/command-objects/compute-agent.rst b/doc/source/cli/command-objects/compute-agent.rst deleted file mode 100644 index e8317b48..00000000 --- a/doc/source/cli/command-objects/compute-agent.rst +++ /dev/null @@ -1,102 +0,0 @@ -============= -compute agent -============= - -Compute v2 - -compute agent create --------------------- - -Create compute agent - -.. program:: compute agent create -.. code:: bash - - openstack compute agent create - - - -.. _compute_agent-create: -.. describe:: - - Type of OS - -.. describe:: - - Type of architecture - -.. describe:: - - Version - -.. describe:: - - URL - -.. describe:: - - MD5 hash - -.. describe:: - - Type of hypervisor - -compute agent delete --------------------- - -Delete compute agent(s) - -.. program:: compute agent delete -.. code:: bash - - openstack compute agent delete [ ...] - -.. _compute_agent-delete: -.. describe:: - - ID of agent(s) to delete - -compute agent list ------------------- - -List compute agents - -.. program:: compute agent list -.. code:: bash - - openstack compute agent list [--hypervisor ] - -.. option:: --hypervisor - - Type of hypervisor - -compute agent set ------------------ - -Set compute agent properties - -.. program:: agent set -.. code:: bash - - openstack compute agent set - [--agent-version ] - [--url ] - - -.. _compute_agent-set: -.. option:: --agent-version - - Version of the agent - -.. option:: --url - - URL of the agent - -.. option:: --md5hash - - MD5 hash of the agent - -.. describe:: - - Agent to modify (ID only) diff --git a/doc/source/cli/command-objects/compute-service.rst b/doc/source/cli/command-objects/compute-service.rst deleted file mode 100644 index ba624ea0..00000000 --- a/doc/source/cli/command-objects/compute-service.rst +++ /dev/null @@ -1,89 +0,0 @@ -=============== -compute service -=============== - -Compute v2 - -compute service delete ----------------------- - -Delete compute service(s) - -.. program:: compute service delete -.. code:: bash - - openstack compute service delete - [ ...] - -.. _compute_service_delete-service: -.. describe:: - - Compute service(s) to delete (ID only) - -compute service list --------------------- - -List compute services - -.. program:: compute service list -.. code:: bash - - openstack compute 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 - -compute service set -------------------- - -Set compute service properties - -.. program:: compute service set -.. code:: bash - - openstack compute service set - [--enable | --disable] - [--disable-reason ] - [--up | --down] - - -.. option:: --enable - - Enable service - -.. option:: --disable - - Disable service - -.. option:: --disable-reason - - Reason for disabling the service (in quotes). Should be used with :option:`--disable` option. - -.. option:: --up - - Force up service - -.. option:: --down - - Force down service - -.. _compute_service_set-host: -.. describe:: - - Name of host - -.. describe:: - - Name of service (Binary name) diff --git a/doc/source/cli/command-objects/configuration.rst b/doc/source/cli/command-objects/configuration.rst deleted file mode 100644 index 6e704d2d..00000000 --- a/doc/source/cli/command-objects/configuration.rst +++ /dev/null @@ -1,29 +0,0 @@ -============= -configuration -============= - -Available for all services - -.. _configuration-show: - -configuration show ------------------- - -Show the current openstack client configuration. This command is a little -different from other show commands because it does not take a resource name -or id to show. The command line options, such as --os-cloud, can be used to -show different configurations. - -.. program:: configuration show -.. code:: bash - - openstack configuration show - [--mask | --unmask] - -.. option:: --mask - - Attempt to mask passwords (default) - -.. option:: --unmask - - Show password in clear text diff --git a/doc/source/cli/command-objects/consistency-group-snapshot.rst b/doc/source/cli/command-objects/consistency-group-snapshot.rst deleted file mode 100644 index 29d50656..00000000 --- a/doc/source/cli/command-objects/consistency-group-snapshot.rst +++ /dev/null @@ -1,96 +0,0 @@ -========================== -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) diff --git a/doc/source/cli/command-objects/consistency-group.rst b/doc/source/cli/command-objects/consistency-group.rst deleted file mode 100644 index 57082c6d..00000000 --- a/doc/source/cli/command-objects/consistency-group.rst +++ /dev/null @@ -1,173 +0,0 @@ -================= -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) diff --git a/doc/source/cli/command-objects/console-log.rst b/doc/source/cli/command-objects/console-log.rst deleted file mode 100644 index bcb23e70..00000000 --- a/doc/source/cli/command-objects/console-log.rst +++ /dev/null @@ -1,27 +0,0 @@ -=========== -console log -=========== - -Server console text dump - -Compute v2 - -console log show ----------------- - -Show server's console output - -.. program:: console log show -.. code:: bash - - openstack console log show - [--lines ] - - -.. option:: --lines - - Number of lines to display from the end of the log (default=all) - -.. describe:: - - Server to show log console log (name or ID) diff --git a/doc/source/cli/command-objects/console-url.rst b/doc/source/cli/command-objects/console-url.rst deleted file mode 100644 index 8a5807b6..00000000 --- a/doc/source/cli/command-objects/console-url.rst +++ /dev/null @@ -1,48 +0,0 @@ -=========== -console url -=========== - -Server remote console URL - -Compute v2 - -console url show ----------------- - -Show server's remote console URL - -.. program:: console url show -.. code:: bash - - openstack console url show - [--novnc | --xvpvnc | --spice] - [--rdp | --serial | --mks] - - -.. option:: --novnc - - Show noVNC console URL (default) - -.. option:: --xvpvnc - - Show xvpvnc console URL - -.. option:: --spice - - Show SPICE console URL - -.. option:: --rdp - - Show RDP console URL - -.. option:: --serial - - Show serial console URL - -.. option:: --mks - - Show WebMKS console URL - -.. describe:: - - Server to show URL (name or ID) diff --git a/doc/source/cli/command-objects/consumer.rst b/doc/source/cli/command-objects/consumer.rst deleted file mode 100644 index d4ce5dc5..00000000 --- a/doc/source/cli/command-objects/consumer.rst +++ /dev/null @@ -1,83 +0,0 @@ -======== -consumer -======== - -Identity v3 - -`Requires: OS-OAUTH1 extension` - -consumer create ---------------- - -Create new consumer - -.. program:: consumer create -.. code:: bash - - openstack consumer create - [--description ] - -.. option:: --description - - New consumer description - -consumer delete ---------------- - -Delete consumer(s) - -.. program:: consumer delete -.. code:: bash - - openstack consumer delete - [ ...] - -.. describe:: - - Consumer(s) to delete - -consumer list -------------- - -List consumers - -.. program:: consumer list -.. code:: bash - - openstack consumer list - -consumer set ------------- - -Set consumer properties - -.. program:: consumer set -.. code:: bash - - openstack consumer set - [--description ] - - -.. option:: --description - - New consumer description - -.. describe:: - - Consumer to modify - -consumer show -------------- - -Display consumer details - -.. program:: consumer show -.. code:: bash - - openstack consumer show - - -.. _consumer_show-consumer: -.. describe:: - - Consumer to display diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst deleted file mode 100644 index e68955ad..00000000 --- a/doc/source/cli/command-objects/container.rst +++ /dev/null @@ -1,150 +0,0 @@ -========= -container -========= - -Object Storage v1 - -container create ----------------- - -Create new container - -.. program:: container create -.. code:: bash - - openstack container create - [ ...] - -.. describe:: - - New container name(s) - -container delete ----------------- - -Delete container - -.. program:: container delete -.. code:: bash - - openstack container delete - [-r] | [--recursive] - [ ...] - -.. option:: --recursive, -r - - Recursively delete objects in container before container delete - -.. describe:: - - Container(s) to delete - -container list --------------- - -List containers - -.. program:: container list -.. code:: bash - - openstack container list - [--prefix ] - [--marker ] - [--end-marker ] - [--limit ] - [--long] - [--all] - -.. option:: --prefix - - Filter list using - -.. option:: --marker - - Anchor for paging - -.. option:: --end-marker - - End anchor for paging - -.. option:: --limit - - Limit the number of containers returned - -.. option:: --long - - List additional fields in output - -.. option:: --all - - List all containers (default is 10000) - -container save --------------- - -Save container contents locally - -.. program:: container save -.. code:: bash - - openstack container save - - -.. describe:: - - Container to save - -container set -------------- - -Set container properties - -.. program:: container set -.. code:: bash - - openstack container set - [--property [...] ] - - -.. option:: --property - - Set a property on this container (repeat option to set multiple properties) - -.. describe:: - - Container to modify - -container show --------------- - -Display container details - -.. program:: container show -.. code:: bash - - openstack container show - - -.. describe:: - - Container to display - -container unset ---------------- - -Unset container properties - -.. program:: container unset -.. code:: bash - - openstack container unset - [--property ] - - -.. option:: --property - - Property to remove from container (repeat option to remove multiple properties) - -.. describe:: - - Container to modify diff --git a/doc/source/cli/command-objects/credential.rst b/doc/source/cli/command-objects/credential.rst deleted file mode 100644 index 47c847c8..00000000 --- a/doc/source/cli/command-objects/credential.rst +++ /dev/null @@ -1,128 +0,0 @@ -========== -credential -========== - -Identity v3 - -credential create ------------------ - -Create new credential - -.. program:: credential create -.. code:: bash - - openstack credential create - [--type ] - [--project ] - - -.. option:: --type - - New credential type: cert, ec2 - -.. option:: --project - - Project which limits the scope of the credential (name or ID) - -.. _credential_create: -.. describe:: - - User that owns the credential (name or ID) - -.. describe:: - - New credential data - -credential delete ------------------ - -Delete credential(s) - -.. program:: credential delete -.. code:: bash - - openstack credential delete - [ ...] - -.. _credential_delete: -.. describe:: - - ID(s) of credential to delete - -credential list ---------------- - -List credentials - -.. program:: credential list -.. code:: bash - - openstack credential list - [--user [--user-domain ]] - [--type ] - -.. option:: --user - - Filter credentials by (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. - -.. option:: --type - - Filter credentials by type: cert, ec2 - -credential set --------------- - -Set credential properties - -.. program:: credential set -.. code:: bash - - openstack credential set - [--user ] - [--type ] - [--data ] - [--project ] - - -.. option:: --user - - User that owns the credential (name or ID) - -.. option:: --type - - New credential type: cert, ec2 - -.. option:: --data - - New credential data - -.. option:: --project - - Project which limits the scope of the credential (name or ID) - -.. _credential_set: -.. describe:: - - ID of credential to change - -credential show ---------------- - -Display credential details - -.. program:: credential show -.. code:: bash - - openstack credential show - - -.. _credential_show: -.. describe:: - - ID of credential to display diff --git a/doc/source/cli/command-objects/domain.rst b/doc/source/cli/command-objects/domain.rst deleted file mode 100644 index 70a3e733..00000000 --- a/doc/source/cli/command-objects/domain.rst +++ /dev/null @@ -1,115 +0,0 @@ -====== -domain -====== - -Identity v3 - -domain create -------------- - -Create new domain - -.. program:: domain create -.. code:: bash - - openstack domain create - [--description ] - [--enable | --disable] - [--or-show] - - -.. option:: --description - - New domain description - -.. option:: --enable - - Enable domain (default) - -.. option:: --disable - - Disable domain - -.. option:: --or-show - - Return existing domain - - If the domain already exists, return the existing domain data and do not fail. - -.. describe:: - - New domain name - -domain delete -------------- - -Delete domain(s) - -.. program:: domain delete -.. code:: bash - - openstack domain delete - [ ...] - -.. describe:: - - Domain(s) to delete (name or ID) - -domain list ------------ - -List domains - -.. program:: domain list -.. code:: bash - - openstack domain list - -domain set ----------- - -Set domain properties - -.. program:: domain set -.. code:: bash - - openstack domain set - [--name ] - [--description ] - [--enable | --disable] - - -.. option:: --name - - New domain name - -.. option:: --description - - New domain description - -.. option:: --enable - - Enable domain - -.. option:: --disable - - Disable domain - -.. describe:: - - Domain to modify (name or ID) - -domain show ------------ - -Display domain details - -.. program:: domain show -.. code:: bash - - openstack domain show - - -.. describe:: - - Domain to display (name or ID) diff --git a/doc/source/cli/command-objects/ec2-credentials.rst b/doc/source/cli/command-objects/ec2-credentials.rst deleted file mode 100644 index 9174b041..00000000 --- a/doc/source/cli/command-objects/ec2-credentials.rst +++ /dev/null @@ -1,138 +0,0 @@ -=============== -ec2 credentials -=============== - -Identity v2 - -ec2 credentials create ----------------------- - -Create EC2 credentials - -.. program:: ec2 credentials create -.. code-block:: bash - - openstack ec2 credentials create - [--project ] - [--user ] - [--user-domain ] - [--project-domain ] - -.. option:: --project - - Create credentials in project (name or ID; default: current authenticated project) - -.. option:: --user - - Create credentials for user (name or ID; default: current authenticated user) - -.. 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:: --project-domain - - Domain the project belongs to (name or ID). This can be - used in case collisions between user names exist. - - .. versionadded:: 3 - -The :option:`--project` and :option:`--user` options are typically only -useful for admin users, but may be allowed for other users depending on -the policy of the cloud and the roles granted to the user. - -ec2 credentials delete ----------------------- - -Delete EC2 credentials - -.. program:: ec2 credentials delete -.. code-block:: bash - - openstack ec2 credentials delete - [--user ] - [--user-domain ] - [ ...] - -.. option:: --user - - Delete credentials for user (name or ID) - -.. option:: --user-domain - - Select user from a specific domain (name or ID) - This can be used in case collisions between user names exist. - - .. versionadded:: 3 - -.. _ec2_credentials_delete-access-key: -.. describe:: access-key - - Credentials access key(s) - -The :option:`--user` option is typically only useful for admin users, but -may be allowed for other users depending on the policy of the cloud and -the roles granted to the user. - -ec2 credentials list --------------------- - -List EC2 credentials - -.. program:: ec2 credentials list -.. code-block:: bash - - openstack ec2 credentials list - [--user ] - [--user-domain ] - -.. option:: --user - - Filter list by (name or ID) - -.. option:: --user-domain - - Select user from a specific domain (name or ID) - This can be used in case collisions between user names exist. - - .. versionadded:: 3 - -The :option:`--user` option is typically only useful for admin users, but -may be allowed for other users depending on the policy of the cloud and -the roles granted to the user. - -ec2 credentials show --------------------- - -Display EC2 credentials details - -.. program:: ec2 credentials show -.. code-block:: bash - - openstack ec2 credentials show - [--user ] - [--user-domain ] - - -.. option:: --user - - Show credentials for user (name or ID) - -.. option:: --user-domain - - Select user from a specific domain (name or ID) - This can be used in case collisions between user names exist. - - .. versionadded:: 3 - -.. _ec2_credentials_show-access-key: -.. describe:: access-key - - Credentials access key - -The :option:`--user` option is typically only useful for admin users, but -may be allowed for other users depending on the policy of the cloud and -the roles granted to the user. diff --git a/doc/source/cli/command-objects/endpoint.rst b/doc/source/cli/command-objects/endpoint.rst deleted file mode 100644 index 02a75bea..00000000 --- a/doc/source/cli/command-objects/endpoint.rst +++ /dev/null @@ -1,196 +0,0 @@ -======== -endpoint -======== - -Identity v2, v3 - -endpoint create ---------------- - -Create new endpoint - -*Identity version 2 only* - -.. program:: endpoint create (v2) -.. code:: bash - - openstack endpoint create - --publicurl - [--adminurl ] - [--internalurl ] - [--region ] - - -.. option:: --publicurl - - New endpoint public URL (required) - -.. option:: --adminurl - - New endpoint admin URL - -.. option:: --internalurl - - New endpoint internal URL - -.. option:: --region - - New endpoint region ID - -.. _endpoint_create-endpoint: -.. describe:: - - Service to be associated with new endpoint (name or ID) - -*Identity version 3 only* - -.. program:: endpoint create (v3) -.. code:: bash - - openstack endpoint create - [--region ] - [--enable | --disable] - - - - -.. option:: --region - - New endpoint region ID - -.. option:: --enable - - Enable endpoint (default) - -.. option:: --disable - - Disable endpoint - -.. describe:: - - Service to be associated with new endpoint(name or ID) - -.. describe:: - - New endpoint interface type (admin, public or internal) - -.. describe:: - - New endpoint URL - -endpoint delete ---------------- - -Delete endpoint(s) - -.. program:: endpoint delete -.. code:: bash - - openstack endpoint delete - [ ...] - -.. _endpoint_delete-endpoint: -.. describe:: - - Endpoint(s) to delete (ID only) - -endpoint list -------------- - -List endpoints - -.. program:: endpoint list -.. code:: bash - - openstack endpoint list - [--service ] - [--interface ] - [--region ] - [--long] - -.. option:: --service - - Filter by service (type, name or ID) - - *Identity version 3 only* - -.. option:: --interface - - Filter by interface type (admin, public or internal) - - *Identity version 3 only* - -.. option:: --region - - Filter by region ID - - *Identity version 3 only* - -.. option:: --long - - List additional fields in output - - *Identity version 2 only* - -endpoint set ------------- - -Set endpoint properties - -*Identity version 3 only* - -.. program:: endpoint set -.. code:: bash - - openstack endpoint set - [--region ] - [--interface ] - [--url ] - [--service ] - [--enable | --disable] - - -.. option:: --region - - New endpoint region ID - -.. option:: --interface - - New endpoint interface type (admin, public or internal) - -.. option:: --url - - New endpoint URL - -.. option:: --service - - New endpoint service (name or ID) - -.. option:: --enable - - Enable endpoint - -.. option:: --disable - - Disable endpoint - -.. _endpoint_set-endpoint: -.. describe:: - - Endpoint to modify (ID only) - -endpoint show -------------- - -Display endpoint details - -.. program:: endpoint show -.. code:: bash - - openstack endpoint show - - -.. _endpoint_show-endpoint: -.. describe:: - - Endpoint to display (endpoint ID, service ID, service name, service type) diff --git a/doc/source/cli/command-objects/extension.rst b/doc/source/cli/command-objects/extension.rst deleted file mode 100644 index 36cf418b..00000000 --- a/doc/source/cli/command-objects/extension.rst +++ /dev/null @@ -1,58 +0,0 @@ -========= -extension -========= - -Many OpenStack server APIs include API extensions that enable -additional functionality. - -extension list --------------- - -List API extensions - -.. program:: extension list -.. code:: bash - - openstack extension list - [--compute] - [--identity] - [--network] - [--volume] - [--long] - -.. option:: --compute - - List extensions for the Compute API - -.. option:: --identity - - List extensions for the Identity API - -.. option:: --network - - List extensions for the Network API - -.. option:: --volume - - List extensions for the Block Storage API - -.. option:: --long - - List additional fields in output - -extension show --------------- - -Show API extension - -.. program:: extension show -.. code:: bash - - openstack extension show - - -.. _extension_show: -.. describe:: - - Extension to display. Currently, only network extensions are supported. - (Name or Alias) diff --git a/doc/source/cli/command-objects/federation-protocol.rst b/doc/source/cli/command-objects/federation-protocol.rst deleted file mode 100644 index e1f98174..00000000 --- a/doc/source/cli/command-objects/federation-protocol.rst +++ /dev/null @@ -1,112 +0,0 @@ -=================== -federation protocol -=================== - -Identity v3 - -`Requires: OS-FEDERATION extension` - -federation protocol create --------------------------- - -Create new federation protocol - -.. program:: federation protocol create -.. code:: bash - - openstack federation protocol create - --identity-provider - --mapping - - -.. option:: --identity-provider - - Identity provider that will support the new federation protocol (name or ID) (required) - -.. option:: --mapping - - Mapping that is to be used (name or ID) (required) - -.. describe:: - - New federation protocol name (must be unique per identity provider) - -federation protocol delete --------------------------- - -Delete federation protocol(s) - -.. program:: federation protocol delete -.. code:: bash - - openstack federation protocol delete - --identity-provider - [ ...] - -.. option:: --identity-provider - - Identity provider that supports (name or ID) (required) - -.. describe:: - - Federation protocol(s) to delete (name or ID) - -federation protocol list ------------------------- - -List federation protocols - -.. program:: federation protocol list -.. code:: bash - - openstack federation protocol list - --identity-provider - -.. option:: --identity-provider - - Identity provider to list (name or ID) (required) - -federation protocol set ------------------------ - -Set federation protocol properties - -.. program:: federation protocol set -.. code:: bash - - openstack federation protocol set - --identity-provider - [--mapping ] - - -.. option:: --identity-provider - - Identity provider that supports (name or ID) (required) - -.. option:: --mapping - - Mapping that is to be used (name or ID) - -.. describe:: - - Federation protocol to modify (name or ID) - -federation protocol show ------------------------- - -Display federation protocol details - -.. program:: federation protocol show -.. code:: bash - - openstack federation protocol show - --identity-provider - - -.. option:: --identity-provider - - Identity provider that supports (name or ID) (required) - -.. describe:: - - Federation protocol to display (name or ID) diff --git a/doc/source/cli/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst deleted file mode 100644 index 6feb4498..00000000 --- a/doc/source/cli/command-objects/flavor.rst +++ /dev/null @@ -1,220 +0,0 @@ -====== -flavor -====== - -Compute v2 - -flavor create -------------- - -Create new flavor - -.. program:: flavor create -.. code:: bash - - openstack flavor create - [--id ] - [--ram ] - [--disk ] - [--ephemeral-disk ] - [--swap ] - [--vcpus ] - [--rxtx-factor ] - [--public | --private] - [--property [...] ] - [--project ] - [--project-domain ] - - -.. option:: --id - - Unique flavor ID; 'auto' creates a UUID (default: auto) - -.. option:: --ram - - Memory size in MB (default 256M) - -.. option:: --disk - - Disk size in GB (default 0G) - -.. option:: --ephemeral-disk - - Ephemeral disk size in GB (default 0G) - -.. option:: --swap - - Swap space size in MB (default 0M) - -.. option:: --vcpus - - Number of vcpus (default 1) - -.. option:: --rxtx-factor - - RX/TX factor (default 1.0) - -.. option:: --public - - Flavor is available to other projects (default) - -.. option:: --private - - Flavor is not available to other projects - -.. option:: --property - - Property to add for this flavor (repeat option to set multiple properties) - -.. option:: --project - - Allow to access private flavor (name or ID) - (Must be used with :option:`--private` option) - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _flavor_create-flavor-name: -.. describe:: - - New flavor name - -flavor delete -------------- - -Delete flavor(s) - -.. program:: flavor delete -.. code:: bash - - openstack flavor delete - [ ...] - -.. _flavor_delete-flavor: -.. describe:: - - Flavor(s) to delete (name or ID) - -flavor list ------------ - -List flavors - -.. program:: flavor list -.. code:: bash - - openstack flavor list - [--public | --private | --all] - [--long] - [--marker ] - [--limit ] - -.. option:: --public - - List only public flavors (default) - -.. option:: --private - - List only private flavors - -.. option:: --all - - List all flavors, whether public or private - -.. option:: --long - - List additional fields in output - -.. option:: --marker - - The last flavor ID of the previous page - -.. option:: --limit - - Maximum number of flavors to display - -flavor set ----------- - -Set flavor properties - -.. program:: flavor set -.. code:: bash - - openstack flavor set - [--no-property] - [--property [...] ] - [--project ] - [--project-domain ] - - -.. option:: --property - - Property to add or modify for this flavor (repeat option to set multiple properties) - -.. option:: --project - - Set flavor access to project (name or ID) (admin only) - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --no-property - - Remove all properties from this flavor (specify both --no-property and --property - to remove the current properties before setting new properties.) - -.. describe:: - - Flavor to modify (name or ID) - -flavor show ------------ - -Display flavor details - -.. program:: flavor show -.. code:: bash - - openstack flavor show - - -.. _flavor_show-flavor: -.. describe:: - - Flavor to display (name or ID) - -flavor unset ------------- - -Unset flavor properties - -.. program:: flavor unset -.. code:: bash - - openstack flavor unset - [--property [...] ] - [--project ] - [--project-domain ] - - -.. option:: --property - - Property to remove from flavor (repeat option to remove multiple properties) - -.. option:: --project - - Remove flavor access from project (name or ID) (admin only) - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. describe:: - - Flavor to modify (name or ID) diff --git a/doc/source/cli/command-objects/floating-ip-pool.rst b/doc/source/cli/command-objects/floating-ip-pool.rst deleted file mode 100644 index 9213b86d..00000000 --- a/doc/source/cli/command-objects/floating-ip-pool.rst +++ /dev/null @@ -1,15 +0,0 @@ -================ -floating ip pool -================ - -Compute v2, Network v2 - -floating ip pool list ---------------------- - -List pools of floating IP addresses - -.. program:: floating ip pool list -.. code:: bash - - openstack floating ip pool list diff --git a/doc/source/cli/command-objects/floating-ip.rst b/doc/source/cli/command-objects/floating-ip.rst deleted file mode 100644 index f2f101d3..00000000 --- a/doc/source/cli/command-objects/floating-ip.rst +++ /dev/null @@ -1,205 +0,0 @@ -=========== -floating ip -=========== - -Compute v2, Network v2 - -floating ip create ------------------- - -Create floating IP - -.. program:: floating ip create -.. code:: bash - - openstack floating ip create - [--subnet ] - [--port ] - [--floating-ip-address ] - [--fixed-ip-address ] - [--description ] - [--project [--project-domain ]] - - -.. option:: --subnet - - Subnet on which you want to create the floating IP (name or ID) - *Network version 2 only* - -.. option:: --port - - Port to be associated with the floating IP (name or ID) - *Network version 2 only* - -.. option:: --floating-ip-address - - Floating IP address - *Network version 2 only* - -.. option:: --fixed-ip-address - - Fixed IP address mapped to the floating IP - *Network version 2 only* - -.. option:: --description - - Set floating IP description - *Network version 2 only* - -.. option:: --project - - Owner's project (name or ID) - - *Network 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. - - *Network version 2 only* - -.. describe:: - - Network to allocate floating IP from (name or ID) - -floating ip delete ------------------- - -Delete floating IP(s) - -.. program:: floating ip delete -.. code:: bash - - openstack floating ip delete [ ...] - -.. describe:: - - Floating IP(s) to delete (IP address or ID) - -floating ip list ----------------- - -List floating IP(s) - -.. program:: floating ip list -.. code:: bash - - openstack floating ip list - [--network ] - [--port ] - [--fixed-ip-address ] - [--long] - [--status ] - [--project [--project-domain ]] - [--router ] - -.. option:: --network - - List floating IP(s) according to given network (name or ID) - - *Network version 2 only* - -.. option:: --port - - List floating IP(s) according to given port (name or ID) - - *Network version 2 only* - -.. option:: --fixed-ip-address - - List floating IP(s) according to given fixed IP address - - *Network version 2 only* - -.. option:: --long - - List additional fields in output - - *Network version 2 only* - -.. option:: --status - - List floating IP(s) according to given status ('ACTIVE', 'DOWN') - - *Network version 2 only* - -.. option:: --project - - List floating IP(s) according to given project (name or ID) - - *Network 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. - - *Network version 2 only* - -.. option:: --router - - List floating IP(s) according to given router (name or ID) - - *Network version 2 only* - -floating ip set ---------------- - -Set floating IP properties - -.. program:: floating ip set -.. code:: bash - - openstack floating ip set - --port - [--fixed-ip-address ] - - -.. option:: --port - - Assocaite the floating IP with port (name or ID) - -.. option:: --fixed-ip-address - - Fixed IP of the port (required only if port has multiple IPs) - -.. _floating_ip_set-floating-ip: -.. describe:: - - Floating IP to associate (IP address or ID) - -floating ip show ----------------- - -Display floating IP details - -.. program:: floating ip show -.. code:: bash - - openstack floating ip show - -.. describe:: - - Floating IP to display (IP address or ID) - -floating ip unset ------------------ - -Unset floating IP Properties - -.. program:: floating ip unset -.. code:: bash - - openstack floating ip unset - --port - - -.. option:: --port - - Disassociate any port associated with the floating IP - -.. _floating_ip_unset-floating-ip: -.. describe:: - - Floating IP to disassociate (IP address or ID) diff --git a/doc/source/cli/command-objects/group.rst b/doc/source/cli/command-objects/group.rst deleted file mode 100644 index ac938efd..00000000 --- a/doc/source/cli/command-objects/group.rst +++ /dev/null @@ -1,249 +0,0 @@ -===== -group -===== - -Identity v3 - -group add user --------------- - -Add user to group - -.. program:: group add user -.. code:: bash - - openstack group add user - [--group-domain ] - [--user-domain ] - - [ ...] - -.. 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:: --user-domain - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - - .. versionadded:: 3 - -.. describe:: - - Group to contain (name or ID) - -.. describe:: - - User(s) to add to (name or ID) - (repeat option to add multiple users) - -group contains user -------------------- - -Check user membership in group - -.. program:: group contains user -.. code:: bash - - openstack group contains user - [--group-domain ] - [--user-domain ] - - - -.. 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:: --user-domain - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - - .. versionadded:: 3 - -.. describe:: - - Group to check (name or ID) - -.. describe:: - - User to check (name or ID) - -group create ------------- - -Create new group - -.. program:: group create -.. code:: bash - - openstack group create - [--domain ] - [--description ] - [--or-show] - - -.. option:: --domain - - Domain to contain new group (name or ID) - -.. option:: --description - - New group description - -.. option:: --or-show - - Return existing group - - If the group already exists, return the existing group data and do not fail. - -.. describe:: - - New group name - -group delete ------------- - -Delete group - -.. program:: group delete -.. code:: bash - - openstack group delete - [--domain ] - [ ...] - -.. option:: --domain - - Domain containing group(s) (name or ID) - -.. describe:: - - Group(s) to delete (name or ID) - -group list ----------- - -List groups - -.. program:: group list -.. code:: bash - - openstack group list - [--domain ] - [--user [--user-domain ]] - [--long] - -.. option:: --domain - - Filter group list by (name or ID) - -.. option:: --user - - Filter group list by (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:: --long - - List additional fields in output - -group remove user ------------------ - -Remove user from group - -.. program:: group remove user -.. code:: bash - - openstack group remove user - [--group-domain ] - [--user-domain ] - - [ ...] - -.. 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:: --user-domain - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - - .. versionadded:: 3 - -.. describe:: - - Group containing (name or ID) - -.. describe:: - - User(s) to remove from (name or ID) - (repeat option to remove multiple users) - -group set ---------- - -Set group properties - -.. program:: group set -.. code:: bash - - openstack group set - [--domain ] - [--name ] - [--description ] - - -.. option:: --domain - - Domain containing (name or ID) - -.. option:: --name - - New group name - -.. option:: --description - - New group description - -.. describe:: - - Group to modify (name or ID) - -group show ----------- - -Display group details - -.. program:: group show -.. code:: bash - - openstack group show - [--domain ] - - -.. option:: --domain - - Domain containing (name or ID) - -.. describe:: - - Group to display (name or ID) diff --git a/doc/source/cli/command-objects/host.rst b/doc/source/cli/command-objects/host.rst deleted file mode 100644 index cbf34398..00000000 --- a/doc/source/cli/command-objects/host.rst +++ /dev/null @@ -1,72 +0,0 @@ -==== -host -==== - -Compute v2 - -The physical computer running a hypervisor. - -host list ---------- - -List hosts - -.. program:: host list -.. code:: bash - - openstack host list - [--zone ] - -.. option:: --zone - - Only return hosts in the availability zone - -host set --------- - -Set host properties - -.. program:: host set -.. code:: bash - - openstack host set - [--enable | --disable] - [--enable-maintenance | --disable-maintenance] - - -.. _host-set: -.. option:: --enable - - Enable the host - -.. option:: --disable - - Disable the host - -.. _maintenance-set: -.. option:: --enable-maintenance - - Enable maintenance mode for the host - -.. option:: --disable-maintenance - - Disable maintenance mode for the host - -.. describe:: - - Host to modify (name only) - -host show ---------- - -Display host details - -.. program:: host show -.. code:: bash - - openstack host show - - -.. describe:: - - Name of host diff --git a/doc/source/cli/command-objects/hypervisor-stats.rst b/doc/source/cli/command-objects/hypervisor-stats.rst deleted file mode 100644 index 89faf135..00000000 --- a/doc/source/cli/command-objects/hypervisor-stats.rst +++ /dev/null @@ -1,16 +0,0 @@ -================ -hypervisor stats -================ - -Compute v2 - -hypervisor stats show ---------------------- - -Display hypervisor stats details - -.. program:: hypervisor stats show -.. code:: bash - - openstack hypervisor stats show - diff --git a/doc/source/cli/command-objects/hypervisor.rst b/doc/source/cli/command-objects/hypervisor.rst deleted file mode 100644 index 9db384a2..00000000 --- a/doc/source/cli/command-objects/hypervisor.rst +++ /dev/null @@ -1,41 +0,0 @@ -========== -hypervisor -========== - -Compute v2 - -hypervisor list ---------------- - -List hypervisors - -.. program:: hypervisor list -.. code:: bash - - openstack hypervisor list - [--matching ] - [--long] - -.. option:: --matching - - Filter hypervisors using substring - -.. option:: --long - - List additional fields in output - -hypervisor show ---------------- - -Display hypervisor details - -.. program:: hypervisor show -.. code:: bash - - openstack hypervisor show - - -.. _hypervisor_show-flavor: -.. describe:: - - Hypervisor to display (name or ID) diff --git a/doc/source/cli/command-objects/identity-provider.rst b/doc/source/cli/command-objects/identity-provider.rst deleted file mode 100644 index d96b814a..00000000 --- a/doc/source/cli/command-objects/identity-provider.rst +++ /dev/null @@ -1,133 +0,0 @@ -================= -identity provider -================= - -Identity v3 - -`Requires: OS-FEDERATION extension` - -identity provider create ------------------------- - -Create new identity provider - -.. program:: identity provider create -.. code:: bash - - openstack identity provider create - [--remote-id [...] | --remote-id-file ] - [--description ] - [--domain ] - [--enable | --disable] - - -.. option:: --remote-id - - Remote IDs to associate with the Identity Provider - (repeat option to provide multiple values) - -.. option:: --remote-id-file - - Name of a file that contains many remote IDs to associate with the identity - provider, one per line - -.. option:: --description - - New identity provider description - -.. option:: --domain - - Name or ID of the domain to associate with the identity provider. If not - specified, one will be created automatically - -.. option:: --enable - - Enable the identity provider (default) - -.. option:: --disable - - Disable the identity provider - -.. describe:: - - New identity provider name (must be unique) - -identity provider delete ------------------------- - -Delete identity provider(s) - -.. program:: identity provider delete -.. code:: bash - - openstack identity provider delete - [ ...] - -.. describe:: - - Identity provider(s) to delete - -identity provider list ----------------------- - -List identity providers - -.. program:: identity provider list -.. code:: bash - - openstack identity provider list - -identity provider set ---------------------- - -Set identity provider properties - -.. program:: identity provider set -.. code:: bash - - openstack identity provider set - [--remote-id [...] | --remote-id-file ] - [--description ] - [--enable | --disable] - - -.. option:: --remote-id - - Remote IDs to associate with the Identity Provider - (repeat option to provide multiple values) - -.. option:: --remote-id-file - - Name of a file that contains many remote IDs to associate with the identity - provider, one per line - -.. option:: --description - - Set identity provider description - -.. option:: --enable - - Enable the identity provider - -.. option:: --disable - - Disable the identity provider - -.. describe:: - - Identity provider to modify - -identity provider show ----------------------- - -Display identity provider details - -.. program:: identity provider show -.. code:: bash - - openstack identity provider show - - -.. describe:: - - Identity provider to display diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst deleted file mode 100644 index 92efd0a5..00000000 --- a/doc/source/cli/command-objects/image.rst +++ /dev/null @@ -1,604 +0,0 @@ -===== -image -===== - -Image v1, v2 - -image add project ------------------ - -*Only supported for Image v2* - -Associate project with image - -.. program:: image add project -.. code:: bash - - openstack image add project - [--project-domain ] - - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _image_add_project-image: -.. describe:: - - Image to share (name or ID). - -.. _image_add_project-project: -.. describe:: - - Project to associate with image (name or ID) - -image create ------------- - -*Image v1, v2* - -Create/upload an image - -.. program:: image create -.. code:: bash - - openstack image create - [--id ] - [--store ] - [--container-format ] - [--disk-format ] - [--size ] - [--min-disk ] - [--min-ram ] - [--location ] - [--copy-from ] - [--file | --volume ] - [--force] - [--checksum ] - [--protected | --unprotected] - [--public | --private | --community | --shared] - [--property [...] ] - [--tag [...] ] - [--project [--project-domain ]] - - -.. option:: --id - - Image ID to reserve - -.. option:: --store - - Upload image to this store - - *Image version 1 only.* - -.. option:: --container-format - - Image container format. The supported options are: ami, ari, aki, - bare, docker, ova, ovf. The default format is: bare - -.. option:: --disk-format - - Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, - raw, qcow2, vhdx, vdi, iso, and ploop. The default format is: raw - -.. option:: --size - - Image size, in bytes (only used with :option:`--location` and :option:`--copy-from`) - - *Image version 1 only.* - -.. option:: --min-disk - - Minimum disk size needed to boot image, in gigabytes - -.. option:: --min-ram - - Minimum RAM size needed to boot image, in megabytes - -.. option:: --location - - Download image from an existing URL - - *Image version 1 only.* - -.. option:: --copy-from - - Copy image from the data store (similar to :option:`--location`) - - *Image version 1 only.* - -.. option:: --file - - Upload image from local file - -.. option:: --volume - - Create image from a volume - -.. option:: --force - - Force image creation if volume is in use (only meaningful with :option:`--volume`) - -.. option:: --checksum - - Image hash used for verification - - *Image version 1 only.* - -.. option:: --protected - - Prevent image from being deleted - -.. option:: --unprotected - - Allow image to be deleted (default) - -.. option:: --public - - Image is accessible to the public - -.. option:: --private - - Image is inaccessible to the public (default) - -.. option:: --community - - Image is accessible to the community - -.. option:: --shared - - Image can be shared - -.. option:: --property - - Set a property on this image (repeat for multiple values) - -.. option:: --tag - - Set a tag on this image (repeat for multiple values) - - .. versionadded:: 2 - -.. option:: --project - - Set an alternate project on this image (name or ID). - Previously known as `--owner`. - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - - .. versionadded:: 2 - -.. _image_create-image-name: -.. describe:: - - New image name - -image delete ------------- - -Delete image(s) - -.. program:: image delete -.. code:: bash - - openstack image delete - - -.. _image_delete-image: -.. describe:: - - Image(s) to delete (name or ID) - -image list ----------- - -List available images - -.. program:: image list -.. code:: bash - - openstack image list - [--public | --private | --shared] - [--property ] - [--long] - [--sort [:]] - [--limit ] - [--marker ] - [--name ] - [--status ] - - -.. option:: --public - - List only public images - -.. option:: --private - - List only private images - -.. option:: --shared - - List only shared images - - *Image version 2 only.* - -.. option:: --property - - Filter output based on property - -.. option:: --long - - List additional fields in output - -.. option:: --sort [:] - - Sort output by selected keys and directions(asc or desc) (default: name:asc), - multiple keys and directions can be specified separated by comma - -.. option:: --limit - - Maximum number of images to display. - - *Image version 2 only* - -.. option:: --marker - - The last image of the previous page. Display list of images - after marker. Display all images if not specified. (name or ID) - -.. option:: --name - - Filter images based on name - -.. option:: --status - - Filter images based on status - - - *Image version 2 only* - -image remove project --------------------- - -*Only supported for Image v2* - -Disassociate project with image - -.. program:: image remove project -.. code:: bash - - openstack image remove remove - [--project-domain ] - - - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _image_remove_project: -.. describe:: - - Image to unshare (name or ID). - -.. describe:: - - Project to disassociate with image (name or ID) - -image save ----------- - -Save an image locally - -.. program:: image save -.. code:: bash - - openstack image save - --file - - -.. option:: --file - - Downloaded image save filename (default: stdout) - -.. _image_save-image: -.. describe:: - - Image to save (name or ID) - -image set ---------- - -*Image v1, v2* - -Set image properties - -.. program:: image set -.. code:: bash - - openstack image set - [--name ] - [--min-disk ] - [--min-ram ] - [--container-format ] - [--disk-format ] - [--size ] - [--protected | --unprotected] - [--public | --private | --community | --shared] - [--store ] - [--location ] - [--copy-from ] - [--file ] - [--volume ] - [--force] - [--checksum ] - [--stdin] - [--property [...] ] - [--tag [...] ] - [--architecture ] - [--instance-id ] - [--kernel-id ] - [--os-distro ] - [--os-version ] - [--ramdisk-id ] - [--activate|--deactivate] - [--project [--project-domain ]] - [--accept | --reject | --pending] - - -.. option:: --name - - New image name - -.. option:: --min-disk - - Minimum disk size needed to boot image, in gigabytes - -.. option:: --min-ram - - Minimum RAM size needed to boot image, in megabytes - -.. option:: --container-format - - Image container format. The supported options are: ami, ari, aki, - bare, docker, ova, ovf. - -.. option:: --disk-format - - Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, - raw, qcow2, vhdx, vdi, iso, and ploop. - -.. option:: --size - - Size of image data (in bytes) - - *Image version 1 only.* - -.. option:: --protected - - Prevent image from being deleted - -.. option:: --unprotected - - Allow image to be deleted (default) - -.. option:: --public - - Image is accessible to the public - -.. option:: --private - - Image is inaccessible to the public (default) - -.. option:: --community - - Image is accessible to the community - -.. option:: --shared - - Image can be shared - -.. option:: --store - - Upload image to this store - - *Image version 1 only.* - -.. option:: --location - - Download image from an existing URL - - *Image version 1 only.* - -.. option:: --copy-from - - Copy image from the data store (similar to :option:`--location`) - - *Image version 1 only.* - -.. option:: --file - - Upload image from local file - - *Image version 1 only.* - -.. option:: --volume - - Update image with a volume - - *Image version 1 only.* - -.. option:: --force - - Force image update if volume is in use (only meaningful with :option:`--volume`) - - *Image version 1 only.* - -.. option:: --checksum - - Image hash used for verification - - *Image version 1 only.* - -.. option:: --stdin - - Allow to read image data from standard input - - *Image version 1 only.* - -.. option:: --property - - Set a property on this image (repeat option to set multiple properties) - - .. versionadded:: 2 - -.. option:: --tag - - Set a tag on this image (repeat for multiple values) - - .. versionadded:: 2 - -.. option:: --architecture - - Operating system architecture - - .. versionadded:: 2 - -.. option:: --instance-id - - ID of server instance used to create this image - - .. versionadded:: 2 - -.. option:: --kernel-id - - ID of kernel image used to boot this disk image - - .. versionadded:: 2 - -.. option:: --os-distro - - Operating system distribution name - - .. versionadded:: 2 - -.. option:: --os-version - - Operating system distribution version - - .. versionadded:: 2 - -.. option:: --ramdisk-id - - ID of ramdisk image used to boot this disk image - - .. versionadded:: 2 - -.. option:: --activate - - Activate the image. - - .. versionadded:: 2 - -.. option:: --deactivate - - Deactivate the image. - - .. versionadded:: 2 - -.. option:: --project - - Set an alternate project on this image (name or ID). - Previously known as `--owner`. - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - - .. versionadded:: 2 - -.. option:: --accept - - Accept the image membership. - - If `--project` is passed, this will update the membership status for the - given project, otherwise `--project` will default to the project the user - is authenticated to. - - .. versionadded:: 2 - -.. option:: --reject - - Reject the image membership. - - If `--project` is passed, this will update the membership status for the - given project, otherwise `--project` will default to the project the user - is authenticated to. - - .. versionadded:: 2 - -.. option:: --pending - - Reset the image membership to 'pending'. - - If `--project` is passed, this will update the membership status for the - given project, otherwise `--project` will default to the project the user - is authenticated to. - - .. versionadded:: 2 - -.. _image_set-image: -.. describe:: - - Image to modify (name or ID) - -image show ----------- - -Display image details - -.. program:: image show -.. code:: bash - - openstack image show - - -.. _image_show-image: -.. describe:: - - Image to display (name or ID) - -image unset ------------ - -*Only supported for Image v2* - -Unset image tags or properties - -.. program:: image unset -.. code:: bash - - openstack image set - [--tag ] - [--property ] - - -.. option:: --tag - - Unset a tag on this image (repeat option to unset multiple tags) - -.. option:: --property - - Unset a property on this image (repeat option to unset multiple properties) - -.. _image_unset-image: -.. describe:: - - Image to modify (name or ID) diff --git a/doc/source/cli/command-objects/ip-availability.rst b/doc/source/cli/command-objects/ip-availability.rst deleted file mode 100644 index dd39e649..00000000 --- a/doc/source/cli/command-objects/ip-availability.rst +++ /dev/null @@ -1,60 +0,0 @@ -=============== -ip availability -=============== - -Network v2 - -ip availability list --------------------- - -List IP availability for network - -This command retrieves information about IP availability. -Useful for admins who need a quick way to check the -IP availability for all associated networks. -List specifically returns total IP capacity and the -number of allocated IP addresses from that pool. - -.. program:: ip availability list -.. code:: bash - - openstack ip availability list - [--ip-version {4,6}] - [--project ] - -.. option:: --ip-version {4,6} - - List IP availability of given IP version networks - (default is 4) - -.. option:: --project - - List IP availability of given project - (name or ID) - -ip availability show --------------------- - -Show network IP availability details - -This command retrieves information about IP availability. -Useful for admins who need a quick way to -check the IP availability and details for a -specific network. - -This command will return information about -IP availability for the network as a whole, and -return availability information for each individual -subnet within the network as well. - - -.. program:: ip availability show -.. code:: bash - - openstack ip availability show - - -.. _ip_availability_show-network: -.. describe:: - - Show IP availability for a specific network (name or ID) diff --git a/doc/source/cli/command-objects/ip-fixed.rst b/doc/source/cli/command-objects/ip-fixed.rst deleted file mode 100644 index f5b11dc6..00000000 --- a/doc/source/cli/command-objects/ip-fixed.rst +++ /dev/null @@ -1,47 +0,0 @@ -======== -ip fixed -======== - -Compute v2 - -ip fixed add ------------- - -Add fixed IP address to server -(Deprecated, please use ``server add fixed ip`` instead) - -.. program:: ip fixed add -.. code:: bash - - openstack ip fixed add - - - -.. describe:: - - Network to fetch an IP address from (name or ID) - -.. describe:: - - Server to receive the IP address (name or ID) - -ip fixed remove ---------------- - -Remove fixed IP address from server -(Deprecated, please use ``server remove fixed ip`` instead) - -.. program:: ip fixed remove -.. code:: bash - - openstack ip fixed remove - - - -.. describe:: - - IP address to remove from server (name only) - -.. describe:: - - Server to remove the IP address from (name or ID) diff --git a/doc/source/cli/command-objects/ip-floating-pool.rst b/doc/source/cli/command-objects/ip-floating-pool.rst deleted file mode 100644 index 6d00355a..00000000 --- a/doc/source/cli/command-objects/ip-floating-pool.rst +++ /dev/null @@ -1,16 +0,0 @@ -================ -ip floating pool -================ - -Compute v2 - -ip floating pool list ---------------------- - -List pools of floating IP addresses -(Deprecated, please use ``floating ip pool list`` instead) - -.. program:: ip floating pool list -.. code:: bash - - openstack ip floating pool list diff --git a/doc/source/cli/command-objects/ip-floating.rst b/doc/source/cli/command-objects/ip-floating.rst deleted file mode 100644 index 4e5f7b00..00000000 --- a/doc/source/cli/command-objects/ip-floating.rst +++ /dev/null @@ -1,129 +0,0 @@ -=========== -ip floating -=========== - -Compute v2, Network v2 - -ip floating add ---------------- - -Add floating IP address to server -(Deprecated, please use ``server add floating ip`` instead) - -.. program:: ip floating add -.. code:: bash - - openstack ip floating add - - - -.. describe:: - - IP address to add to server (name only) - -.. describe:: - - Server to receive the IP address (name or ID) - -ip floating create ------------------- - -Create new floating IP address -(Deprecated, please use ``floating ip create`` instead) - -.. program:: ip floating create -.. code:: bash - - openstack ip floating create - [--subnet ] - [--port ] - [--floating-ip-address ] - [--fixed-ip-address ] - - -.. option:: --subnet - - Subnet on which you want to create the floating IP (name or ID) - (Network v2 only) - -.. option:: --port - - Port to be associated with the floating IP (name or ID) - (Network v2 only) - -.. option:: --floating-ip-address - - Floating IP address - (Network v2 only) - -.. option:: --fixed-ip-address - - Fixed IP address mapped to the floating IP - (Network v2 only) - -.. describe:: - - Network to allocate floating IP from (name or ID) - -ip floating delete ------------------- - -Delete floating IP(s) -(Deprecated, please use ``floating ip delete`` instead) - -.. program:: ip floating delete -.. code:: bash - - openstack ip floating delete - [ ...] - -.. describe:: - - Floating IP(s) to delete (IP address or ID) - -ip floating list ----------------- - -List floating IP addresses -(Deprecated, please use ``floating ip list`` instead) - -.. program:: ip floating list -.. code:: bash - - openstack ip floating list - -ip floating remove ------------------- - -Remove floating IP address from server -(Deprecated, please use ``server remove floating ip`` instead) - -.. program:: ip floating remove -.. code:: bash - - openstack ip floating remove - - - -.. describe:: - - IP address to remove from server (name only) - -.. describe:: - - Server to remove the IP address from (name or ID) - -ip floating show ----------------- - -Display floating IP details -(Deprecated, please use ``floating ip show`` instead) - -.. program:: ip floating show -.. code:: bash - - openstack ip floating show - -.. describe:: - - Floating IP to display (IP address or ID) diff --git a/doc/source/cli/command-objects/keypair.rst b/doc/source/cli/command-objects/keypair.rst deleted file mode 100644 index a539f0a2..00000000 --- a/doc/source/cli/command-objects/keypair.rst +++ /dev/null @@ -1,80 +0,0 @@ -======= -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 - -keypair create --------------- - -Create new public or private key for server ssh access - -.. program:: keypair create -.. code:: bash - - openstack keypair create - [--public-key | --private-key ] - - -.. option:: --public-key - - Filename for public key to add. If not used, creates a private key. - -.. option:: --private-key - - Filename for private key to save. If not used, print private key in - console. - -.. describe:: - - New public or private key name - -keypair delete --------------- - -Delete public or private key(s) - -.. program:: keypair delete -.. code:: bash - - openstack keypair delete - [ ...] - -.. describe:: - - Name of key(s) to delete (name only) - -keypair list ------------- - -List key fingerprints - -.. program:: keypair list -.. code:: bash - - openstack keypair list - -keypair show ------------- - -Display key details - -.. program:: keypair show -.. code:: bash - - openstack keypair show - [--public-key] - - -.. option:: --public-key - - Show only bare public key paired with the generated key - -.. describe:: - - Public or private key to display (name only) diff --git a/doc/source/cli/command-objects/limits.rst b/doc/source/cli/command-objects/limits.rst deleted file mode 100644 index 92614209..00000000 --- a/doc/source/cli/command-objects/limits.rst +++ /dev/null @@ -1,41 +0,0 @@ -====== -limits -====== - -The Compute and Block Storage APIs have resource usage limits. - -Compute v2, Block Storage v1 - -limits show ------------ - -Show compute and block storage limits - -.. program:: limits show -.. code:: bash - - openstack limits show - --absolute | --rate - [--reserved] - [--project ] - [--domain ] - -.. option:: --absolute - - Show absolute limits - -.. option:: --rate - - Show rate limits - -.. option:: --reserved - - Include reservations count [only valid with :option:`--absolute`] - -.. option:: --project - - Show limits for a specific project (name or ID) [only valid with :option:`--absolute`] - -.. option:: --domain - - Domain the project belongs to (name or ID) [only valid with :option:`--absolute`] diff --git a/doc/source/cli/command-objects/mapping.rst b/doc/source/cli/command-objects/mapping.rst deleted file mode 100644 index 1f657ed2..00000000 --- a/doc/source/cli/command-objects/mapping.rst +++ /dev/null @@ -1,91 +0,0 @@ -======= -mapping -======= - -Identity v3 - -`Requires: OS-FEDERATION extension` - -mapping create --------------- - -Create new mapping - -.. program:: mapping create -.. code:: bash - - openstack mapping create - --rules - - -.. option:: --rules - - Filename that contains a set of mapping rules (required) - -.. _mapping_create-mapping: -.. describe:: - - New mapping name (must be unique) - -mapping delete --------------- - -Delete mapping(s) - -.. program:: mapping delete -.. code:: bash - - openstack mapping delete - [ ...] - -.. _mapping_delete-mapping: -.. describe:: - - Mapping(s) to delete - -mapping list ------------- - -List mappings - -.. program:: mapping list -.. code:: bash - - openstack mapping list - -mapping set ------------ - -Set mapping properties - -.. program:: mapping set -.. code:: bash - - openstack mapping set - [--rules ] - - -.. option:: --rules - - Filename that contains a new set of mapping rules - -.. _mapping_set-mapping: -.. describe:: - - Mapping to modify - -mapping show ------------- - -Display mapping details - -.. program:: mapping show -.. code:: bash - - openstack mapping show - - -.. _mapping_show-mapping: -.. describe:: - - Mapping to display diff --git a/doc/source/cli/command-objects/module.rst b/doc/source/cli/command-objects/module.rst deleted file mode 100644 index f4b32e75..00000000 --- a/doc/source/cli/command-objects/module.rst +++ /dev/null @@ -1,22 +0,0 @@ -====== -module -====== - -Internal - -Installed Python modules in the OSC process. - -module list ------------ - -List module versions - -.. program:: module list -.. code:: bash - - openstack module list - [--all] - -.. option:: --all - - Show all modules that have version information diff --git a/doc/source/cli/command-objects/network-agent.rst b/doc/source/cli/command-objects/network-agent.rst deleted file mode 100644 index 9f02cb6b..00000000 --- a/doc/source/cli/command-objects/network-agent.rst +++ /dev/null @@ -1,216 +0,0 @@ -============= -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 - -network agent add network -------------------------- - -Add network to an agent - -.. program:: network agent add network -.. code:: bash - - openstack network agent add network - [--dhcp] - - - -.. option:: --dhcp - - Add a network to DHCP agent - -.. describe:: - - Agent to which a network is added (ID only) - -.. describe:: - - Network to be added to an agent (name or ID) - -network agent add router ------------------------- - -Add router to an agent - -.. program:: network agent add router -.. code:: bash - - openstack network agent add router - [--l3] - - - -.. option:: --l3 - - Add router to an L3 agent - -.. _network_agent_add_router-agent-id: -.. describe:: - - Agent to which a router is added (ID only) - -.. _network_agent_add_router-router: -.. describe:: - - Router to be added to an agent (name or ID) - -network agent delete --------------------- - -Delete network agent(s) - -.. program:: network agent delete -.. code:: bash - - openstack network agent delete - [ ...] - -.. _network_agent_delete-network-agent: -.. describe:: - - Network agent(s) to delete (ID only) - -network agent list ------------------- - -List network agents - -.. program:: network agent list -.. code:: bash - - openstack network agent list - [--agent-type ] - [--host ] - [--network | --router ] - [--long] - -.. option:: --agent-type - - List only agents with the specified agent type. - The supported agent types are: dhcp, open-vswitch, - linux-bridge, ofa, l3, loadbalancer, metering, - metadata, macvtap, nic. - -.. option:: --host - - List only agents running on the specified host - -.. option:: --network - - List agents hosting a network (name or ID) - -.. option:: --router - - List agents hosting this router (name or ID) - -.. option:: --long - - List additional fields in output - -network agent remove network ----------------------------- - -Remove network from an agent - -.. program:: network agent remove network -.. code:: bash - - openstack network agent remove network - [--dhcp] - - - -.. option:: --dhcp - - Remove network from DHCP agent - -.. _network_agent_remove_network-agent-id: -.. describe:: - - Agent to which a network is removed (ID only) - -.. _network_agent_remove_network-network: -.. describe:: - - Network to be removed from an agent (name or ID) - -network agent remove router ---------------------------- - -Remove router from an agent - -.. program:: network agent remove router -.. code:: bash - - openstack agent remove router - [--l3] - - - -.. option:: --l3 - - Remove router from an L3 agent - -.. _network_agent_remove_router-agent-id: -.. describe:: - - Agent from which router will be removed (ID only) - -.. _network_agent_remove_router-router: -.. describe:: - - Router to be removed from an agent (name or ID) - -network agent set ------------------ - -Set network agent properties - -.. program:: network agent set -.. code:: bash - - openstack network agent set - [--description ] - [--enable | --disable] - - -.. option:: --description - - Set network agent description - -.. option:: --enable - - Enable network agent - -.. option:: --disable - - Disable network agent - -.. _network_agent_set-network-agent: -.. describe:: - - Network agent to modify (ID only) - -network agent show ------------------- - -Display network agent details - -.. program:: network agent show -.. code:: bash - - openstack network agent show - - -.. _network_agent_show-network-agent: -.. describe:: - - Network agent to display (ID only) diff --git a/doc/source/cli/command-objects/network-auto-allocated-topology.rst b/doc/source/cli/command-objects/network-auto-allocated-topology.rst deleted file mode 100644 index 4ed68cda..00000000 --- a/doc/source/cli/command-objects/network-auto-allocated-topology.rst +++ /dev/null @@ -1,69 +0,0 @@ -=============================== -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 the documentation at: -http://docs.openstack.org/newton/networking-guide/config-auto-allocation.html - -Network v2 - -network auto allocated topology create --------------------------------------- - -Create the auto allocated topology for project - -.. program:: network auto allocated topology create -.. code:: bash - - openstack network auto allocated topology create - [--or-show] - [--check-resources] - [--project [--project-domain ]] - -.. option:: --or-show - - If topology exists returns the topologies information (Default). - -.. option:: --check-resources - - Validate the requirements for auto allocated topology. - Does not return a topology. - -.. option:: --project - - Return the auto allocated topology for a given project. - Default is current project. - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _network_auto_allocated_topology_create: - - -network auto allocated topology delete --------------------------------------- - -Delete auto allocated topology for project - -.. program:: network auto allocated topology delete -.. code:: bash - - openstack network auto allocated topology delete - [--project [--project-domain ]] - -.. option:: --project - - Delete auto allocated topology for a given project. - Default is the current project. - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _network_auto_allocated_topology_delete: diff --git a/doc/source/cli/command-objects/network-flavor-profile.rst b/doc/source/cli/command-objects/network-flavor-profile.rst deleted file mode 100644 index fdb95059..00000000 --- a/doc/source/cli/command-objects/network-flavor-profile.rst +++ /dev/null @@ -1,145 +0,0 @@ -====================== -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 - -network flavor profile create ------------------------------ - -Create a new network flavor profile - -.. program:: network flavor profile create -.. code:: bash - - openstack network flavor profile create - [--project [--project-domain ]] - [--description ] - [--enable | --disable] - (--driver | --metainfo | --driver --metainfo ) - -.. option:: --project - - Owner's project (name or ID) - - *Network 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:: --description - - Description for the flavor profile - - *Network version 2 only* - -.. option:: --enable - - Enable the flavor profile (default) - -.. option:: --disable - - Disable the flavor profile - -.. option:: --driver - - Python module path to driver - - *Network version 2 only* - -.. option:: --metainfo - - Metainfo for the flavor profile - - *Network version 2 only* - - -network flavor profile delete ------------------------------ - -Delete network flavor profile - -.. program:: network flavor profile delete -.. code:: bash - - openstack network flavor profile delete - [ ...] - -.. describe:: - - Flavor profile(s) to delete (ID only) - -network flavor profile list ---------------------------- - -List network flavor profiles - -.. program:: network flavor profile list -.. code:: bash - - openstack network flavor profile list - -network flavor profile set --------------------------- - -Set network flavor profile properties - -.. program:: network flavor profile set -.. code:: bash - - openstack network flavor profile set - [--description ] - [--driver ] - [--enable | --disable] - [--metainfo ] - - - -.. option:: --description - - Description of the flavor profile - -.. option:: --driver - - Python module path to driver - -.. option:: --enable (Default) - - Enable the flavor profile - -.. option:: --disable - - Disable the flavor profile - -.. option:: --metainfo - - Metainfo for the flavor profile - -.. describe:: - - Flavor profile to update (ID only) - -network flavor profile show ---------------------------- - -Show network flavor profile - -.. program:: network flavor profile show -.. code:: bash - - openstack network flavor profile show - - -.. describe:: - - Flavor profile to display (ID only) diff --git a/doc/source/cli/command-objects/network-flavor.rst b/doc/source/cli/command-objects/network-flavor.rst deleted file mode 100644 index 2d23bf05..00000000 --- a/doc/source/cli/command-objects/network-flavor.rst +++ /dev/null @@ -1,183 +0,0 @@ -============== -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 - -network flavor add profile --------------------------- - -Add network flavor to service profile - -.. program:: network flavor add profile -.. code:: bash - - openstack network flavor add profile - - - -.. describe:: - - Flavor to which service profile is added. (Name or ID) - -.. describe:: - - Service profile to be added to flavor. (ID only) - -.. _network_flavor_add_profile: - -network flavor create ---------------------- - -Create network flavor - -.. program:: network flavor create -.. code:: bash - - openstack network flavor create - --service-type - [--description ] - [--enable | --disable] - [--project [--project-domain ]] - - -.. option:: --service-type - - Service type to which the flavor applies to: e.g. VPN. - (See openstack :ref:`\ `) (required) - -.. option:: --description - - Description for the flavor - -.. option:: --enable - - Enable the flavor (default) - -.. option:: --disable - - Disable the flavor - -.. option:: --project - - Owner's project (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. - -.. describe:: - - Name for the flavor - -.. _network_flavor_create: - -network flavor delete ---------------------- - -Delete network flavor(s) - -.. program:: network flavor delete -.. code:: bash - - openstack network flavor delete - [ ...] - -.. describe:: - - Flavor(s) to delete (name or ID) - -.. _network_flavor_delete: - -network flavor list -------------------- - -List network flavors - -.. program:: network flavor list -.. code:: bash - - openstack network flavor list - -.. _network_flavor_list: - -network flavor remove profile ------------------------------ - -Remove network flavor from service profile - -.. program:: network flavor remove profile -.. code:: bash - - openstack network flavor remove profile - - - -.. describe:: - - Flavor from which service profile is removed. (Name or ID) - -.. describe:: - - Service profile to be removed from flavor. (ID only) - -.. _network_flavor_remove_profile: - -network flavor set ------------------- - -Set network flavor properties - -.. program:: network flavor set -.. code:: bash - - openstack network flavor set - [--name ] - [--description ] - [--enable | --disable] - - -.. option:: --name - - Set flavor name - -.. option:: --description - - Set network flavor description - -.. option:: --enable - - Enable network flavor - -.. option:: --disable - - Disable network flavor - -.. describe:: - - Flavor to update (name or ID) - -.. _network_flavor_set: - -network flavor show -------------------- - -Show network flavor - -.. program:: network flavor show -.. code:: bash - - openstack network flavor show - - -.. describe:: - - Flavor to display (name or ID) - -.. _network_flavor_show: diff --git a/doc/source/cli/command-objects/network-meter-rule.rst b/doc/source/cli/command-objects/network-meter-rule.rst deleted file mode 100644 index 22d50aa9..00000000 --- a/doc/source/cli/command-objects/network-meter-rule.rst +++ /dev/null @@ -1,101 +0,0 @@ -================== -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 - -network meter rule create -------------------------- - -Create meter rule - -.. program:: network meter rule create -.. code:: bash - - openstack network meter rule create - --remote-ip-prefix - [--ingress | --egress] - [--exclude | --include] - [--project [--project-domain ]] - - -.. option:: --project - - Owner's project (name or ID) - -.. option:: --project-domain - - Domain the project belongs to (name of ID). - This can be used in case collisions between project names exist. - -.. option:: --ingress - - Rule is applied to incoming traffic (default) - -.. option:: --egress - - Rule is applied to outgoing traffic - -.. option:: --exclude - - Exclude remote_ip_prefix from count of the traffic of IP addresses - -.. option:: --include - - Include remote_ip_prefix into count of the traffic of IP addresses - (default) - -.. option:: --remote-ip-prefix - - The remote IP prefix to associate with this metering rule packet - -.. _network_meter_rule_create: -.. describe:: - - Meter to associate with this meter rule (name or ID) - - -network meter rule delete -------------------------- - -Delete meter rule(s) - -.. program:: network meter rule delete -.. code:: bash - - openstack network meter rule delete [ ...] - -.. _network_meter_rule_delete: -.. describe:: - - ID of meter rule(s) to delete - -network meter rule list ------------------------ - -List meter rules - -.. program:: network meter rule list -.. code:: bash - - openstack network meter rule list - -network meter rule show ------------------------ - -Show meter rule - -.. program:: network meter rule show -.. code:: bash - - openstack network meter rule show - -.. _network_meter_show: -.. describe:: - - Meter rule to display (ID only) diff --git a/doc/source/cli/command-objects/network-meter.rst b/doc/source/cli/command-objects/network-meter.rst deleted file mode 100644 index 6077ce92..00000000 --- a/doc/source/cli/command-objects/network-meter.rst +++ /dev/null @@ -1,91 +0,0 @@ -============= -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 - -network meter create --------------------- - -Create network meter - -.. program:: network meter create -.. code:: bash - - openstack network meter create - [--project [--project-domain ]] - [--description ] - [--share | --no-share] - - -.. option:: --project - - Owner's project (name of ID) - - *Network version 2 only* - -.. option:: --description - - Description of meter - - *Network version 2 only* - -.. option:: --share - - Share the meter between projects - -.. option:: --no-share - - Do not share the meter between projects (Default) - -.. _network_meter_create: -.. describe:: - - New meter name - -network meter delete --------------------- - -Delete network meter(s) - -.. program:: network meter delete -.. code:: bash - - openstack network meter delete - [ ...] - -.. _network_meter_delete: -.. describe:: - - Meter(s) to delete (name or ID) - -network meter list ------------------- - -List network meters - -.. program:: network meter list -.. code:: bash - - openstack network meter list - - -network meter show ------------------- - -Show network meter - -.. program:: network meter show -.. code:: bash - - openstack network meter show - - -.. _network_meter_show: -.. describe:: - - Meter to display (name or ID) diff --git a/doc/source/cli/command-objects/network-qos-policy.rst b/doc/source/cli/command-objects/network-qos-policy.rst deleted file mode 100644 index 2e86f8f3..00000000 --- a/doc/source/cli/command-objects/network-qos-policy.rst +++ /dev/null @@ -1,163 +0,0 @@ -================== -network qos policy -================== - -A **Network QoS policy** groups a number of Network QoS rules, applied to a -network or a port. - -Network v2 - -network qos policy create -------------------------- - -Create new Network QoS policy - -.. program:: network qos policy create -.. code:: bash - - openstack network qos policy create - [--description ] - [--share | --no-share] - [--project ] - [--project-domain ] - [--default | --no-default] - - -.. option:: --description - - Description of the QoS policy - -.. option:: --share - - Make the QoS policy accessible by other projects - -.. option:: --no-share - - Make the QoS policy not accessible by other projects (default) - -.. option:: --project - - Owner's project (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. - -.. option:: --default - - Set this as a default network QoS policy - -.. option:: --no-default - - Set this as a non-default network QoS policy - -.. _network_qos_policy_create-name: -.. describe:: - - New QoS policy specification name - -network qos policy delete -------------------------- - -Delete Network QoS policy - -.. program:: network qos policy delete -.. code:: bash - - openstack network qos policy delete - [ ...] - -.. _network_qos_policy_delete-qos-policy: -.. describe:: - - Network QoS policy(s) to delete (name or ID) - -network qos policy list ------------------------ - -List Network QoS policies - -.. program:: network qos policy list -.. code:: bash - - openstack network qos policy list - [--project [--project-domain ]] - [--share | --no-share] - -.. option:: --project - - List qos policies according to their project (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. - -.. option:: --share - - List qos policies shared between projects - -.. option:: --no-share - - List qos policies not shared between projects - -network qos policy set ----------------------- - -Set Network QoS policy properties - -.. program:: network qos policy set -.. code:: bash - - openstack network qos policy set - [--name ] - [--description ] - [--share | --no-share] - [--default | --no-default] - - -.. option:: --name - - Name of the QoS policy - -.. option:: --description - - Description of the QoS policy - -.. option:: --share - - Make the QoS policy accessible by other projects - -.. option:: --no-share - - Make the QoS policy not accessible by other projects - -.. option:: --default - - Set this as a default network QoS policy - -.. option:: --no-default - - Set this as a non-default network QoS policy - -.. _network_qos_policy_set-qos-policy: -.. describe:: - - Network QoS policy to modify (name or ID) - -network qos policy show ------------------------ - -Display Network QoS policy details - -.. program:: network qos policy show -.. code:: bash - - openstack network qos policy show - - -.. _network_qos_policy_show-qos-policy: -.. describe:: - - Network QoS policy to display (name or ID) diff --git a/doc/source/cli/command-objects/network-qos-rule-type.rst b/doc/source/cli/command-objects/network-qos-rule-type.rst deleted file mode 100644 index ee53e30b..00000000 --- a/doc/source/cli/command-objects/network-qos-rule-type.rst +++ /dev/null @@ -1,18 +0,0 @@ -===================== -network qos rule type -===================== - -A **Network QoS rule type** is a specific Network QoS rule type available to be -used. - -Network v2 - -network qos rule type list --------------------------- - -List Network QoS rule types - -.. program:: network qos rule type list -.. code:: bash - - openstack network qos rule type list diff --git a/doc/source/cli/command-objects/network-qos-rule.rst b/doc/source/cli/command-objects/network-qos-rule.rst deleted file mode 100644 index 1baf5dbf..00000000 --- a/doc/source/cli/command-objects/network-qos-rule.rst +++ /dev/null @@ -1,165 +0,0 @@ -================ -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 - -network qos rule create ------------------------ - -Create new Network QoS rule - -.. program:: network qos rule create -.. code:: bash - - openstack network qos rule create - --type - [--max-kbps ] - [--max-burst-kbits ] - [--dscp-marks ] - [--min-kbps ] - [--ingress | --egress] - - -.. option:: --type - - QoS rule type (minimum-bandwidth, dscp-marking, bandwidth-limit) - -.. option:: --max-kbps - - Maximum bandwidth in kbps - -.. option:: --max-burst-kbits - - Maximum burst in kilobits, 0 means automatic - -.. option:: --dscp-mark - - DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, - 52, and 54 - -.. option:: --min-kbps - - Minimum guaranteed bandwidth in kbps - -.. option:: --ingress - - Ingress traffic direction from the project point of view - -.. option:: --egress - - Egress traffic direction from the project point of view - -.. describe:: - - QoS policy that contains the rule (name or ID) - -network qos rule delete ------------------------ - -Delete Network QoS rule - -.. program:: network qos rule delete -.. code:: bash - - openstack network qos rule delete - - - -.. describe:: - - QoS policy that contains the rule (name or ID) - -.. describe:: - - Network QoS rule to delete (ID) - -network qos rule list ---------------------- - -List Network QoS rules - -.. program:: network qos rule list -.. code:: bash - - openstack network qos rule list - - -.. describe:: - - QoS policy that contains the rule (name or ID) - -network qos rule set --------------------- - -Set Network QoS rule properties - -.. program:: network qos rule set -.. code:: bash - - openstack network qos rule set - [--max-kbps ] - [--max-burst-kbits ] - [--dscp-marks ] - [--min-kbps ] - [--ingress | --egress] - - - -.. option:: --max-kbps - - Maximum bandwidth in kbps - -.. option:: --max-burst-kbits - - Maximum burst in kilobits, 0 means automatic - -.. option:: --dscp-mark - - DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, - 52, and 54 - -.. option:: --min-kbps - - Minimum guaranteed bandwidth in kbps - -.. option:: --ingress - - Ingress traffic direction from the project point of view - -.. option:: --egress - - Egress traffic direction from the project point of view - -.. describe:: - - QoS policy that contains the rule (name or ID) - -.. describe:: - - Network QoS rule to delete (ID) - -network qos rule show ---------------------- - -Display Network QoS rule details - -.. program:: network qos rule show -.. code:: bash - - openstack network qos rule show - - - -.. describe:: - - QoS policy that contains the rule (name or ID) - -.. describe:: - - Network QoS rule to delete (ID) diff --git a/doc/source/cli/command-objects/network-rbac.rst b/doc/source/cli/command-objects/network-rbac.rst deleted file mode 100644 index c49f29bb..00000000 --- a/doc/source/cli/command-objects/network-rbac.rst +++ /dev/null @@ -1,138 +0,0 @@ -============ -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 - -network rbac create -------------------- - -Create network RBAC policy - -.. program:: network rbac create -.. code:: bash - - openstack network rbac create - --type - --action - --target-project [--target-project-domain ] - [--project [--project-domain ]] - - -.. option:: --type - - Type of the object that RBAC policy affects ("qos_policy" or "network") (required) - -.. option:: --action - - Action for the RBAC policy ("access_as_external" or "access_as_shared") (required) - -.. option:: --target-project - - The project to which the RBAC policy will be enforced (name or ID) (required) - -.. option:: --target-project-domain - - Domain the target project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --project - - The owner project (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. - -.. _network_rbac_create-rbac-policy: -.. describe:: - - The object to which this RBAC policy affects (name or ID) - -network rbac delete -------------------- - -Delete network RBAC policy(s) - -.. program:: network rbac delete -.. code:: bash - - openstack network rbac delete - [ ...] - -.. _network_rbac_delete-rbac-policy: -.. describe:: - - RBAC policy(s) to delete (ID only) - -network rbac list ------------------ - -List network RBAC policies - -.. program:: network rbac list -.. code:: bash - - openstack network rbac list - [--type ] - [--action ] - [--long] - -.. option:: --type - - List network RBAC policies according to given object type ("qos_policy" or "network") - -.. option:: --action - - List network RBAC policies according to given action ("access_as_external" or "access_as_shared") - -.. option:: --long - - List additional fields in output - -network rbac set ----------------- - -Set network RBAC policy properties - -.. program:: network rbac set -.. code:: bash - - openstack network rbac set - [--target-project [--target-project-domain ]] - - -.. option:: --target-project - - The project to which the RBAC policy will be enforced (name or ID) - -.. option:: --target-project-domain - - Domain the target project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. _network_rbac_set-rbac-policy: -.. describe:: - - RBAC policy to be modified (ID only) - -network rbac show ------------------ - -Display network RBAC policy details - -.. program:: network rbac show -.. code:: bash - - openstack network rbac show - - -.. _network_rbac_show-rbac-policy: -.. describe:: - - RBAC policy (ID only) diff --git a/doc/source/cli/command-objects/network-segment.rst b/doc/source/cli/command-objects/network-segment.rst deleted file mode 100644 index d6a66aa0..00000000 --- a/doc/source/cli/command-objects/network-segment.rst +++ /dev/null @@ -1,133 +0,0 @@ -=============== -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 - -network segment create ----------------------- - -Create new network segment - -.. program:: network segment create -.. code:: bash - - openstack network segment create - [--description ] - [--physical-network ] - [--segment ] - --network - --network-type - - -.. option:: --description - - Network segment description - -.. option:: --physical-network - - Physical network name of this network segment - -.. option:: --segment - - Segment identifier for this network segment which is - based on the network type, VLAN ID for vlan network - type and tunnel ID for geneve, gre and vxlan network - types - -.. option:: --network - - Network this network segment belongs to (name or ID) - -.. option:: --network-type - - Network type of this network segment - (flat, geneve, gre, local, vlan or vxlan) - -.. _network_segment_create-name: -.. describe:: - - New network segment name - -network segment delete ----------------------- - -Delete network segment(s) - -.. program:: network segment delete -.. code:: bash - - openstack network segment delete - [ ...] - -.. _network_segment_delete-segment: -.. describe:: - - Network segment(s) to delete (name or ID) - -network segment list --------------------- - -List network segments - -.. program:: network segment list -.. code:: bash - - openstack network segment list - [--long] - [--network ] - -.. option:: --long - - List additional fields in output - -.. option:: --network - - List network segments that belong to this network (name or ID) - -network segment set -------------------- - -Set network segment properties - -.. program:: network segment set -.. code:: bash - - openstack network segment set - [--description ] - [--name ] - - -.. option:: --description - - Set network segment description - -.. option:: --name - - Set network segment name - -.. _network_segment_set-segment: -.. describe:: - - Network segment to modify (name or ID) - -network segment show --------------------- - -Display network segment details - -.. program:: network segment show -.. code:: bash - - openstack network segment show - - -.. _network_segment_show-segment: -.. describe:: - - Network segment to display (name or ID) diff --git a/doc/source/cli/command-objects/network-service-provider.rst b/doc/source/cli/command-objects/network-service-provider.rst deleted file mode 100644 index f46073f6..00000000 --- a/doc/source/cli/command-objects/network-service-provider.rst +++ /dev/null @@ -1,20 +0,0 @@ -======================== -network service provider -======================== - -A **network service provider** is a particular driver that implements a -networking service - -Network v2 - -.. _network_service_provider_list: - -network service provider list ------------------------------ - -List service providers - -.. program:: network service provider list -.. code:: bash - - openstack network service provider list diff --git a/doc/source/cli/command-objects/network.rst b/doc/source/cli/command-objects/network.rst deleted file mode 100644 index 5f20dc38..00000000 --- a/doc/source/cli/command-objects/network.rst +++ /dev/null @@ -1,493 +0,0 @@ -======= -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 - -network create --------------- - -Create new network - -.. program:: network create -.. code:: bash - - openstack network create - [--project [--project-domain ]] - [--enable | --disable] - [--share | --no-share] - [--description ] - [--availability-zone-hint ] - [--enable-port-security | --disable-port-security] - [--external [--default | --no-default] | --internal] - [--provider-network-type ] - [--provider-physical-network ] - [--provider-segment ] - [--qos-policy ] - [--transparent-vlan | --no-transparent-vlan] - [--tag | --no-tag] - - -.. option:: --project - - Owner's project (name or ID) - - *Network 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. - - *Network version 2 only* - -.. option:: --enable - - Enable network (default) - - *Network version 2 only* - -.. option:: --disable - - Disable network - - *Network version 2 only* - -.. option:: --share - - Share the network between projects - -.. option:: --no-share - - Do not share the network between projects - -.. option:: --description - - Set network description - - *Network version 2 only* - -.. option:: --availability-zone-hint - - Availability Zone in which to create this network - (Network Availability Zone extension required, - repeat option to set multiple availability zones) - - *Network version 2 only* - -.. option:: --enable-port-security - - Enable port security by default for ports created on - this network (default) - - *Network version 2 only* - -.. option:: --disable-port-security - - Disable port security by default for ports created on - this network - - *Network version 2 only* - -.. option:: --subnet - - IPv4 subnet for fixed IPs (in CIDR notation) - - *Compute version 2 only* - -.. option:: --external - - Set this network as an external network - (external-net extension required) - - *Network version 2 only* - -.. option:: --internal - - Set this network as an internal network (default) - - *Network version 2 only* - -.. option:: --default - - Specify if this network should be used as - the default external network - - *Network version 2 only* - -.. option:: --no-default - - Do not use the network as the default external network - (default) - - *Network version 2 only* - -.. option:: --provider-network-type - - The physical mechanism by which the virtual network is implemented. - The supported options are: flat, geneve, gre, local, vlan, vxlan. - - *Network version 2 only* - -.. option:: --provider-physical-network - - Name of the physical network over which the virtual network is implemented - - *Network version 2 only* - -.. option:: --provider-segment - - VLAN ID for VLAN networks or Tunnel ID for GENEVE/GRE/VXLAN networks - - *Network version 2 only* - -.. option:: --qos-policy - - QoS policy to attach to this network (name or ID) - - *Network version 2 only* - -.. option:: --transparent-vlan - - Make the network VLAN transparent - - *Network version 2 only* - -.. option:: --no-transparent-vlan - - Do not make the network VLAN transparent - - *Network version 2 only* - -.. option:: --tag - - Tag to be added to the network (repeat option to set multiple tags) - - *Network version 2 only* - -.. option:: --no-tag - - No tags associated with the network - - *Network version 2 only* - -.. _network_create-name: -.. describe:: - - New network name - -network delete --------------- - -Delete network(s) - -.. program:: network delete -.. code:: bash - - openstack network delete - [ ...] - -.. _network_delete-network: -.. describe:: - - Network(s) to delete (name or ID) - -network list ------------- - -List networks - -.. program:: network list -.. code:: bash - - openstack network list - [--external | --internal] - [--long] - [--name ] - [--enable | --disable] - [--project [--project-domain ]] - [--share | --no-share] - [--status ] - [--provider-network-type ] - [--provider-physical-network ] - [--provider-segment ] - [--agent ] - [--tags [,,...]] [--any-tags [,,...]] - [--not-tags [,,...]] [--not-any-tags [,,...]] - -.. option:: --external - - List external networks - - *Network version 2 only* - -.. option:: --internal - - List internal networks - - *Network version 2 only* - -.. option:: --long - - List additional fields in output - - *Network version 2 only* - -.. option:: --name - - List networks according to their name - - *Network version 2 only* - -.. option:: --enable - - List enabled networks - - *Network version 2 only* - -.. option:: --disable - - List disabled networks - - *Network version 2 only* - -.. option:: --project - - List networks according to their project (name or ID) - - *Network 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. - - *Network version 2 only* - -.. option:: --share - - List networks shared between projects - - *Network version 2 only* - -.. option:: --no-share - - List networks not shared between projects - - *Network version 2 only* - -.. option:: --status - - List networks according to their status - ('ACTIVE', 'BUILD', 'DOWN', 'ERROR') - -.. option:: --provider-network-type - - List networks according to their physical mechanisms. - The supported options are: flat, geneve, gre, local, vlan, vxlan. - - *Network version 2 only* - -.. option:: --provider-physical-network - - List networks according to name of the physical network - - *Network version 2 only* - -.. option:: --provider-segment - - List networks according to VLAN ID for VLAN networks - or Tunnel ID for GENEVE/GRE/VXLAN networks - - *Network version 2 only* - -.. option:: --agent - - List networks hosted by agent (ID only) - - *Network version 2 only* - -.. option:: --tags [,,...] - - List networks which have all given tag(s) - - *Network version 2 only* - -.. option:: --any-tags [,,...] - - List networks which have any given tag(s) - - *Network version 2 only* - -.. option:: --not-tags [,,...] - - Exclude networks which have all given tag(s) - - *Network version 2 only* - -.. option:: --not-any-tags [,,...] - - Exclude networks which have any given tag(s) - - *Network version 2 only* - -network set ------------ - -Set network properties - -*Network version 2 only* - -.. program:: network set -.. code:: bash - - openstack network set - [--name ] - [--enable | --disable] - [--share | --no-share] - [--description ] - [--enable-port-security | --disable-port-security] - [--external [--default | --no-default] | --internal] - [--provider-network-type ] - [--provider-physical-network ] - [--provider-segment ] - [--qos-policy | --no-qos-policy] - [--tag ] [--no-tag] - - -.. option:: --name - - Set network name - -.. option:: --enable - - Enable network - -.. option:: --disable - - Disable network - -.. option:: --share - - Share the network between projects - -.. option:: --no-share - - Do not share the network between projects - -.. option:: --description - - Set network description - -.. option:: --enable-port-security - - Enable port security by default for ports created on - this network - -.. option:: --disable-port-security - - Disable port security by default for ports created on - this network - -.. option:: --external - - Set this network as an external network. - (external-net extension required) - -.. option:: --internal - - Set this network as an internal network - -.. option:: --default - - Set the network as the default external network - -.. option:: --no-default - - Do not use the network as the default external network. - -.. option:: --provider-network-type - - The physical mechanism by which the virtual network is implemented. - The supported options are: flat, gre, local, vlan, vxlan. - -.. option:: --provider-physical-network - - Name of the physical network over which the virtual network is implemented - -.. option:: --provider-segment - - VLAN ID for VLAN networks or Tunnel ID for GRE/VXLAN networks - -.. option:: --qos-policy - - QoS policy to attach to this network (name or ID) - -.. option:: --no-qos-policy - - Remove the QoS policy attached to this network - -.. option:: --tag - - Tag to be added to the network (repeat option to set multiple tags) - -.. option:: --no-tag - - Clear tags associated with the network. Specify both --tag - and --no-tag to overwrite current tags - -.. _network_set-network: -.. describe:: - - Network to modify (name or ID) - -network show ------------- - -Display network details - -.. program:: network show -.. code:: bash - - openstack network show - - -.. _network_show-network: -.. describe:: - - Network to display (name or ID) - -network unset -------------- - -Unset network properties - -*Network version 2 only* - -.. program:: network unset -.. code:: bash - - openstack network unset - [--tag | --all-tag] - - -.. option:: --tag - - Tag to be removed from the network - (repeat option to remove multiple tags) - -.. option:: --all-tag - - Clear all tags associated with the network - -.. _network_unset-network: -.. describe:: - - Network to modify (name or ID) diff --git a/doc/source/cli/command-objects/object-store-account.rst b/doc/source/cli/command-objects/object-store-account.rst deleted file mode 100644 index e8f09d45..00000000 --- a/doc/source/cli/command-objects/object-store-account.rst +++ /dev/null @@ -1,45 +0,0 @@ -==================== -object store account -==================== - -Object Storage v1 - -object store account set ------------------------- - -Set account properties - -.. program:: object store account set -.. code:: bash - - openstack object store account set - [--property [...] ] - -.. option:: --property - - Set a property on this account (repeat option to set multiple properties) - -object store account show -------------------------- - -Display account details - -.. program:: object store account show -.. code:: bash - - openstack object store account show - -object store account unset --------------------------- - -Unset account properties - -.. program:: object store account unset -.. code:: bash - - openstack object store account unset - [--property ] - -.. option:: --property - - Property to remove from account (repeat option to remove multiple properties) diff --git a/doc/source/cli/command-objects/object.rst b/doc/source/cli/command-objects/object.rst deleted file mode 100644 index 4cba38ee..00000000 --- a/doc/source/cli/command-objects/object.rst +++ /dev/null @@ -1,196 +0,0 @@ -====== -object -====== - -Object Storage v1 - -object create -------------- - -Upload object to container - -.. program:: object create -.. code:: bash - - openstack object create - [--name ] - - [ ...] - -.. option:: --name - - Upload a file and rename it. Can only be used when uploading a single object - -.. describe:: - - Container for new object - -.. describe:: - - Local filename(s) to upload - -object delete -------------- - -Delete object from container - -.. program:: object delete -.. code:: bash - - openstack object delete - - [ ...] - -.. describe:: - - Delete object(s) from - -.. describe:: - - Object(s) to delete - -object list ------------ - -List objects - -.. program object list -.. code:: bash - - openstack object list - [--prefix ] - [--delimiter ] - [--marker ] - [--end-marker ] - [--limit ] - [--long] - [--all] - - -.. option:: --prefix - - Filter list using - -.. option:: --delimiter - - Roll up items with - -.. option:: --marker - - Anchor for paging - -.. option:: --end-marker - - End anchor for paging - -.. option:: --limit - - Limit number of objects returned - -.. option:: --long - - List additional fields in output - -.. option:: --all - - List all objects in (default is 10000) - -.. describe:: - - Container to list - -object save ------------ - -Save object locally - -.. program:: object save -.. code:: bash - - openstack object save - [--file ] - - - -.. option:: --file - - Destination filename (defaults to object name); - using - as the filename will print the file to stdout - -.. describe:: - - Download from - -.. describe:: - - Object to save - -object set ----------- - -Set object properties - -.. program:: object set -.. code:: bash - - openstack object set - [--property [...] ] - - - -.. option:: --property - - Set a property on this object (repeat option to set multiple properties) - -.. describe:: - - Modify from - -.. describe:: - - Object to modify - -object show ------------ - -Display object details - -.. program:: object show -.. code:: bash - - openstack object show - - - -.. describe:: - - Display from - -.. describe:: - - Object to display - -object unset ------------- - -Unset object properties - -.. program:: object unset -.. code:: bash - - openstack object unset - [--property ] - - - -.. option:: --property - - Property to remove from object (repeat option to remove multiple properties) - -.. describe:: - - Modify from - -.. describe:: - - Object to modify diff --git a/doc/source/cli/command-objects/policy.rst b/doc/source/cli/command-objects/policy.rst deleted file mode 100644 index deddf2c4..00000000 --- a/doc/source/cli/command-objects/policy.rst +++ /dev/null @@ -1,95 +0,0 @@ -====== -policy -====== - -Identity v3 - -policy create -------------- - -Create new policy - -.. program:: policy create -.. code:: bash - - openstack policy create - [--type ] - - -.. option:: --type - - New MIME type of the policy rules file (defaults to application/json) - -.. describe:: - - New serialized policy rules file - -policy delete -------------- - -Delete policy(s) - -.. program:: policy delete -.. code:: bash - - openstack policy delete - [ ...] - -.. describe:: - - Policy(s) to delete - -policy list ------------ - -List policies - -.. program:: policy list -.. code:: bash - - openstack policy list - [--long] - -.. option:: --long - - List additional fields in output - -policy set ----------- - -Set policy properties - -.. program:: policy set -.. code:: bash - - openstack policy set - [--type ] - [--rules ] - - -.. option:: --type - - New MIME type of the policy rules file - -.. describe:: --rules - - New serialized policy rules file - -.. describe:: - - Policy to modify - -policy show ------------ - -Display policy details - -.. program:: policy show -.. code:: bash - - openstack policy show - - -.. describe:: - - Policy to display diff --git a/doc/source/cli/command-objects/port.rst b/doc/source/cli/command-objects/port.rst deleted file mode 100644 index c2da09b3..00000000 --- a/doc/source/cli/command-objects/port.rst +++ /dev/null @@ -1,463 +0,0 @@ -==== -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 - -port create ------------ - -Create new port - -.. program:: port create -.. code:: bash - - openstack port create - --network - [--description ] - [--fixed-ip subnet=,ip-address=] - [--device ] - [--device-owner ] - [--vnic-type ] - [--binding-profile ] - [--host ] - [--enable | --disable] - [--mac-address ] - [--security-group | --no-security-group] - [--dns-name ] - [--allowed-address ip-address=[,mac-address=]] - [--qos-policy ] - [--project [--project-domain ]] - [--enable-port-security | --disable-port-security] - [--tag | --no-tag] - - -.. option:: --network - - Network this port belongs to (name or ID) - -.. option:: --description - - Description of this port - -.. option:: --fixed-ip subnet=,ip-address= - - Desired IP and/or subnet for this port (name or ID): - subnet=,ip-address= - (repeat option to set multiple fixed IP addresses) - -.. option:: --device - - Port device ID - -.. option:: --device-owner - - Device owner of this port. This is the entity that uses - the port (for example, network:dhcp). - -.. option:: --vnic-type - - VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal | - virtio-forwarder, default: normal) - -.. option:: --binding-profile - - Custom data to be passed as binding:profile. Data may - be passed as = or JSON. - (repeat option to set multiple binding:profile data) - -.. option:: --host - - Allocate port on host ```` (ID only) - -.. option:: --enable - - Enable port (default) - -.. option:: --disable - - Disable port - -.. option:: --mac-address - - MAC address of this port - -.. option:: --security-group - - Security group to associate with this port (name or ID) - (repeat option to set multiple security groups) - -.. option:: --no-security-group - - Associate no security groups with this port - -.. option:: --dns-name - - Set DNS name to this port - (requires DNS integration extension) - -.. option:: --allowed-address ip-address=[,mac-address=] - - Add allowed-address pair associated with this port: - ip-address=[,mac-address=] - (repeat option to set multiple allowed-address pairs) - -.. option:: --qos-policy - - Attach QoS policy to this port (name or ID) - -.. option:: --project - - Owner's project (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. - -.. option:: --enable-port-security - - Enable port security for this port (Default) - -.. option:: --disable-port-security - - Disable port security for this port - -.. option:: --tag - - Tag to be added to the port (repeat option to set multiple tags) - -.. option:: --no-tag - - No tags associated with the port - -.. _port_create-name: -.. describe:: - - Name of this port - -port delete ------------ - -Delete port(s) - -.. program:: port delete -.. code:: bash - - openstack port delete - [ ...] - -.. _port_delete-port: -.. describe:: - - Port(s) to delete (name or ID) - -port list ---------- - -List ports - -.. program:: port list -.. code:: bash - - openstack port list - [--device-owner ] - [--router | --server ] - [--network ] - [--mac-address ] - [--fixed-ip subnet=,ip-address=] - [--long] - [--project [--project-domain ]] - [--tags [,,...]] [--any-tags [,,...]] - [--not-tags [,,...]] [--not-any-tags [,,...]] - -.. option:: --device-owner - - List only ports with the specified device owner. This is - the entity that uses the port (for example, network:dhcp). - -.. option:: --router - - List only ports attached to this router (name or ID) - -.. option:: --server - - List only ports attached to this server (name or ID) - -.. option:: --network - - List only ports attached to this network (name or ID) - -.. option:: --mac-address - - List only ports with this MAC address - -.. option:: --fixed-ip subnet=,ip-address= - - Desired IP and/or subnet for filtering ports (name or ID): - subnet=,ip-address= - (repeat option to set multiple fixed IP addresses) - -.. option:: --long - - List additional fields in output - -.. option:: --project - - List ports according to their project (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. - -.. option:: --tags [,,...] - - List ports which have all given tag(s) - -.. option:: --any-tags [,,...] - - List ports which have any given tag(s) - -.. option:: --not-tags [,,...] - - Exclude ports which have all given tag(s) - -.. option:: --not-any-tags [,,...] - - Exclude ports which have any given tag(s) - -port set --------- - -Set port properties - -.. program:: port set -.. code:: bash - - openstack port set - [--description ] - [--fixed-ip subnet=,ip-address=] - [--no-fixed-ip] - [--device ] - [--device-owner ] - [--vnic-type ] - [--binding-profile ] - [--no-binding-profile] - [--host ] - [--qos-policy ] - [--enable | --disable] - [--name ] - [--mac-address ] - [--security-group ] - [--no-security-group] - [--enable-port-security | --disable-port-security] - [--dns-name ] - [--allowed-address ip-address=[,mac-address=]] - [--no-allowed-address] - [--data-plane-status ] - [--tag ] [--no-tag] - - -.. option:: --description - - Description of this port - -.. option:: --fixed-ip subnet=,ip-address= - - Desired IP and/or subnet for this port (name or ID): - subnet=,ip-address= - (repeat option to set multiple fixed IP addresses) - -.. option:: --no-fixed-ip - - Clear existing information of fixed IP addresses. - Specify both :option:`--fixed-ip` and :option:`--no-fixed-ip` - to overwrite the current fixed IP addresses. - -.. option:: --device - - Port device ID - -.. option:: --device-owner - - Device owner of this port. This is the entity that uses - the port (for example, network:dhcp). - -.. option:: --vnic-type - - VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal | - virtio-forwarder, default: normal) - -.. option:: --binding-profile - - Custom data to be passed as binding:profile. Data may - be passed as = or JSON. - (repeat option to set multiple binding:profile data) - -.. option:: --no-binding-profile - - Clear existing information of binding:profile. - Specify both :option:`--binding-profile` and :option:`--no-binding-profile` - to overwrite the current binding:profile information. - -.. option:: --host - - Allocate port on host ```` (ID only) - -.. option:: --qos-policy - - Attach QoS policy to this port (name or ID) - -.. option:: --enable - - Enable port - -.. option:: --disable - - Disable port - -.. option:: --name - - Set port name - -.. option:: --mac-address - - Set port's MAC address (admin only) - -.. option:: --security-group - - Security group to associate with this port (name or ID) - (repeat option to set multiple security groups) - -.. option:: --no-security-group - - Clear existing security groups associated with this port - -.. option:: --enable-port-security - - Enable port security for this port - -.. option:: --disable-port-security - - Disable port security for this port - -.. option:: --dns-name - - Set DNS name to this port - (requires DNS integration extension) - -.. option:: --allowed-address ip-address=[,mac-address=] - - Add allowed-address pair associated with this port: - ip-address=[,mac-address=] - (repeat option to set multiple allowed-address pairs) - -.. option:: --no-allowed-address - - Clear existing allowed-address pairs associated - with this port. - (Specify both --allowed-address and --no-allowed-address - to overwrite the current allowed-address pairs) - -.. option:: --data-plane-status - - Set data plane status of this port (ACTIVE | DOWN). - Unset it to None with the 'port unset' command - (requires data plane status extension) - -.. option:: --tag - - Tag to be added to the port (repeat option to set multiple tags) - -.. option:: --no-tag - - Clear tags associated with the port. Specify both --tag - and --no-tag to overwrite current tags - -.. _port_set-port: -.. describe:: - - Port to modify (name or ID) - -port show ---------- - -Display port details - -.. program:: port show -.. code:: bash - - openstack port show - - -.. _port_show-port: -.. describe:: - - Port to display (name or ID) - -port unset ----------- - -Unset port properties - -.. program:: port unset -.. code:: bash - - openstack port unset - [--fixed-ip subnet=,ip-address= [...]] - [--binding-profile [...]] - [--security-group [...]] - [--allowed-address ip-address=[,mac-address=] [...]] - [--qos-policy] - [--data-plane-status] - [--tag | --all-tag] - - -.. option:: --fixed-ip subnet=,ip-address= - - Desired IP and/or subnet which should be removed - from this port (name or ID): subnet=,ip-address= - (repeat option to unset multiple fixed IP addresses) - -.. option:: --binding-profile - - Desired key which should be removed from binding-profile - (repeat option to unset multiple binding:profile data) - -.. option:: --security-group - - Security group which should be removed from this port (name or ID) - (repeat option to unset multiple security groups) - -.. option:: --allowed-address ip-address=[,mac-address=] - - Desired allowed-address pair which should be removed from this port: - ip-address=[,mac-address=] - (repeat option to unset multiple allowed-address pairs) - -.. option:: --qos-policy - - Remove the QoS policy attached to the port - -.. option:: --data-plane-status - - Clear existing information of data plane status - -.. option:: --tag - - Tag to be removed from the port - (repeat option to remove multiple tags) - -.. option:: --all-tag - - Clear all tags associated with the port - -.. _port_unset-port: -.. describe:: - - Port to modify (name or ID) diff --git a/doc/source/cli/command-objects/project-purge.rst b/doc/source/cli/command-objects/project-purge.rst deleted file mode 100644 index 0ad0bbf9..00000000 --- a/doc/source/cli/command-objects/project-purge.rst +++ /dev/null @@ -1,42 +0,0 @@ -============= -project purge -============= - -Clean resources associated with a specific project. - -Block Storage v1, v2; Compute v2; Image v1, v2 - -project purge -------------- - -Clean resources associated with a project - -.. program:: project purge -.. code:: bash - - openstack project purge - [--dry-run] - [--keep-project] - [--auth-project | --project ] - [--project-domain ] - -.. option:: --dry-run - - List a project's resources - -.. option:: --keep-project - - Clean project resources, but don't delete the project. - -.. option:: --auth-project - - Delete resources of the project used to authenticate - -.. option:: --project - - Project to clean (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. diff --git a/doc/source/cli/command-objects/project.rst b/doc/source/cli/command-objects/project.rst deleted file mode 100644 index cb0941ca..00000000 --- a/doc/source/cli/command-objects/project.rst +++ /dev/null @@ -1,235 +0,0 @@ -======= -project -======= - -Identity v2, v3 - -project create --------------- - -Create new project - -.. program:: project create -.. code:: bash - - openstack project create - [--domain ] - [--parent ] - [--description ] - [--enable | --disable] - [--property ] - [--or-show] - - -.. option:: --domain - - Domain owning the project (name or ID) - - .. versionadded:: 3 - -.. option:: --parent - - Parent of the project (name or ID) - - .. versionadded:: 3 - -.. option:: --description - - Project description - -.. option:: --enable - - Enable project (default) - -.. option:: --disable - - Disable project - -.. option:: --property - - Add a property to :ref:`\ ` - (repeat option to set multiple properties) - -.. option:: --or-show - - Return existing project - - If the project already exists return the existing project data and do not fail. - -.. _project_create-name: -.. describe:: - - New project name - -project delete --------------- - -Delete project(s) - -.. program:: project delete -.. code:: bash - - openstack project delete - [--domain ] - [ ...] - -.. option:: --domain - - Domain owning :ref:`\ ` (name or ID) - - .. versionadded:: 3 - -.. _project_delete-project: -.. describe:: - - Project to delete (name or ID) - -project list ------------- - -List projects - -.. program:: project list -.. code:: bash - - openstack project list - [--domain ] - [--user ] - [--my-projects] - [--long] - [--sort [:,:,..]] - -.. option:: --domain - - Filter projects by :option:`\ <--domain>` (name or ID) - - .. versionadded:: 3 - -.. option:: --user - - Filter projects by :option:`\ <--user>` (name or ID) - - .. versionadded:: 3 - -.. option:: --my-projects - - List projects for the authenticated user. Supersedes other filters. - - .. versionadded:: 3 - -.. option:: --long - - List additional fields in output - -.. option:: --sort [:,:,..] - - Sort output by selected keys and directions (asc or desc) (default: asc), - multiple keys and directions can be specified --sort - [:,:,..] - -project set ------------ - -Set project properties - -.. program:: project set -.. code:: bash - - openstack project set - [--name ] - [--domain ] - [--description ] - [--enable | --disable] - [--property ] - - -.. option:: --name - - Set project name - -.. option:: --domain - - Domain owning :ref:`\ ` (name or ID) - - .. versionadded:: 3 - -.. option:: --description - - Set project description - -.. option:: --enable - - Enable project (default) - -.. option:: --disable - - Disable project - -.. option:: --property - - Set a property on :ref:`\ ` - (repeat option to set multiple properties) - - *Identity version 2 only* - -.. _project_set-project: -.. describe:: - - Project to modify (name or ID) - -project show ------------- - -Display project details - -.. program:: project show -.. code:: bash - - openstack project show - [--domain ] - - -.. option:: --domain - - Domain owning :ref:`\ ` (name or ID) - - .. versionadded:: 3 - -.. option:: --parents - - Show the project\'s parents as a list - - .. versionadded:: 3 - -.. option:: --children - - Show project\'s subtree (children) as a list - - .. versionadded:: 3 - -.. _project_show-project: -.. describe:: - - Project to display (name or ID) - -project unset -------------- - -Unset project properties - -*Identity version 2 only* - -.. program:: project unset -.. code:: bash - - openstack project unset - --property [--property ...] - - -.. option:: --property - - Property key to remove from project (repeat option to remove multiple properties) - -.. describe:: - - Project to modify (name or ID) diff --git a/doc/source/cli/command-objects/quota.rst b/doc/source/cli/command-objects/quota.rst deleted file mode 100644 index f39536af..00000000 --- a/doc/source/cli/command-objects/quota.rst +++ /dev/null @@ -1,269 +0,0 @@ -===== -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 - -quota list ----------- - -List quotas for all projects with non-default quota values - -.. program:: quota list -.. code:: bash - - openstack quota list - --compute | --network | --volume - -.. option:: --network - - List network quotas - -.. option:: --compute - - List compute quotas - -.. option:: --volume - - List volume quotas - -quota set ---------- - -Set quotas for project - -.. program:: quota set -.. code:: bash - - openstack quota set - # Compute settings - [--cores ] - [--fixed-ips ] - [--floating-ips ] - [--injected-file-size ] - [--injected-files ] - [--instances ] - [--key-pairs ] - [--properties ] - [--ram ] - [--server-groups ] - [--server-group-members ] - - # Block Storage settings - [--backups ] - [--backup-gigabytes ] - [--gigabytes ] - [--per-volume-gigabytes ] - [--snapshots ] - [--volumes ] - [--volume-type ] - - # Network settings - [--floating-ips ] - [--secgroup-rules ] - [--secgroups ] - [--networks ] - [--subnets ] - [--ports ] - [--routers ] - [--rbac-policies ] - [--vips ] - [--subnetpools ] - [--members ] - [--health-monitors ] - - - -Set quotas for class - -.. code:: bash - - openstack quota set - --class - # Compute settings - [--cores ] - [--fixed-ips ] - [--floating-ips ] - [--injected-file-size ] - [--injected-files ] - [--instances ] - [--key-pairs ] - [--properties ] - [--ram ] - [--server-groups ] - [--server-group-members ] - - # Block Storage settings - [--backups ] - [--backup-gigabytes ] - [--gigabytes ] - [--per-volume-gigabytes ] - [--snapshots ] - [--volumes ] - - - -.. option:: --class - - Set quotas for ```` - -.. option:: --properties - - New value for the properties quota - -.. option:: --ram - - New value for the ram quota - -.. option:: --secgroup-rules - - New value for the secgroup-rules quota - -.. option:: --instances - - New value for the instances quota - -.. option:: --key-pairs - - New value for the key-pairs quota - -.. option:: --fixed-ips - - New value for the fixed-ips quota - -.. option:: --secgroups - - New value for the secgroups quota - -.. option:: --injected-file-size - - New value for the injected-file-size quota - -.. option:: --server-groups - - New value for the server-groups quota - -.. option:: --server-group-members - - New value for the server-group-members quota - -.. option:: --floating-ips - - New value for the floating-ips quota - -.. option:: --injected-files - - New value for the injected-files quota - -.. option:: --cores - - New value for the cores quota - -.. option:: --injected-path-size - - New value for the injected-path-size quota - -.. option:: --backups - - New value for the backups quota - -.. option:: --backup-gigabytes - - New value for the backup gigabytes quota - -.. option:: --gigabytes - - New value for the gigabytes quota - -.. option:: --per-volume-gigabytes - - New value for the gigabytes quota of per volume - -.. option:: --volumes - - New value for the volumes quota - -.. option:: --snapshots - - New value for the snapshots quota - -.. option:: --volume-type - - Set quotas for a specific . The supported quotas are: - gigabytes, snapshots, volumes. - -.. option:: --networks - - New value for the networks quota - -.. option:: --subnets - - New value for the subnets quota - -.. option:: --ports - - New value for the ports quota - -.. option:: --routers - - New value for the routers quota - -.. option:: --rbac-policies - - New value for the rbac-policies quota - -.. option:: --vips - - New value for the vips quota - -.. option:: --subnetpools - - New value for the subnetpools quota - -.. option:: --members - - New value for the members quota - -.. option:: --health-monitors - - New value for the health-monitors quota - -quota show ----------- - -Show quotas for project or class - -.. program:: quota show -.. code:: bash - - openstack quota show - [--default] - [] - - -.. option:: --default - - Show default quotas for :ref:`\ ` - -.. _quota_show-project: -.. describe:: - - Show quotas for this project (name or ID) - -.. code:: bash - - openstack quota show - --class - [] - -.. option:: --class - - Show quotas for :ref:`\ ` - -.. _quota_show-class: -.. describe:: - - Show quotas for this class (name or ID) diff --git a/doc/source/cli/command-objects/region.rst b/doc/source/cli/command-objects/region.rst deleted file mode 100644 index d2c63c1b..00000000 --- a/doc/source/cli/command-objects/region.rst +++ /dev/null @@ -1,104 +0,0 @@ -====== -region -====== - -Identity v3 - -region create -------------- - -Create new region - -.. program:: region create -.. code:: bash - - openstack region create - [--parent-region ] - [--description ] - - -.. option:: --parent-region - - Parent region ID - -.. option:: --description - - New region description - -.. _region_create-region-id: -.. describe:: - - New region ID - -region delete -------------- - -Delete region(s) - -.. program:: region delete -.. code:: bash - - openstack region delete - [ ...] - -.. _region_delete-region-id: -.. describe:: - - Region ID(s) to delete - -region list ------------ - -List regions - -.. program:: region list -.. code:: bash - - openstack region list - [--parent-region ] - -.. option:: --parent-region - - Filter by parent region ID - -region set ----------- - -Set region properties - -.. program:: region set -.. code:: bash - - openstack region set - [--parent-region ] - [--description ] - - -.. option:: --parent-region - - New parent region ID - -.. option:: --description - - New region description - -.. _region_set-region-id: -.. describe:: - - Region to modify - -region show ------------ - -Display region details - -.. program:: region show -.. code:: bash - - openstack region show - - -.. _region_show-region-id: -.. describe:: - - Region to display diff --git a/doc/source/cli/command-objects/request-token.rst b/doc/source/cli/command-objects/request-token.rst deleted file mode 100644 index 3c80780f..00000000 --- a/doc/source/cli/command-objects/request-token.rst +++ /dev/null @@ -1,58 +0,0 @@ -============= -request token -============= - -Identity v3 - -`Requires: OS-OAUTH1 extension` - -request token authorize ------------------------ - -Authorize a request token - -.. program:: request token authorize -.. code:: bash - - openstack request token authorize - --request-key - --role - -.. option:: --request-key - - Request token to authorize (ID only) (required) - -.. option:: --role - - Roles to authorize (name or ID) - (repeat option to set multiple values) (required) - -request token create --------------------- - -Create a request token - -.. program:: request token create -.. code:: bash - - openstack request token create - --consumer-key - --consumer-secret - --project - [--domain ] - -.. option:: --consumer-key - - Consumer key (required) - -.. option:: --description - - Consumer secret (required) - -.. option:: --project - - Project that consumer wants to access (name or ID) (required) - -.. option:: --domain - - Domain owning (name or ID) diff --git a/doc/source/cli/command-objects/role-assignment.rst b/doc/source/cli/command-objects/role-assignment.rst deleted file mode 100644 index b29f32c6..00000000 --- a/doc/source/cli/command-objects/role-assignment.rst +++ /dev/null @@ -1,106 +0,0 @@ -=============== -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. diff --git a/doc/source/cli/command-objects/role.rst b/doc/source/cli/command-objects/role.rst deleted file mode 100644 index fe3126c0..00000000 --- a/doc/source/cli/command-objects/role.rst +++ /dev/null @@ -1,326 +0,0 @@ -==== -role -==== - -Identity v2, v3 - -role add --------- - -Add role assignment to a user or group in a project or domain - -.. program:: role add -.. code:: bash - - openstack role add - --domain | --project [--project-domain ] - --user [--user-domain ] | --group [--group-domain ] - --role-domain - --inherited - - -.. option:: --domain - - Include (name or ID) - - .. versionadded:: 3 - -.. option:: --project - - Include (name or ID) - -.. option:: --user - - Include (name or ID) - -.. option:: --group - - Include (name or ID) - - .. versionadded:: 3 - -.. 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-domain - - Domain the group belongs to (name or ID). - This can be used in case collisions between group names exist. - - .. versionadded:: 3 - -.. 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:: --inherited - - Specifies if the role grant is inheritable to the sub projects. - - .. versionadded:: 3 - -.. option:: --role-domain - - Domain the role belongs to (name or ID). - This must be specified when the name of a domain specific role is used. - - .. versionadded:: 3 - -.. describe:: - - Role to add to : (name or ID) - -role create ------------ - -Create new role - -.. program:: role create -.. code:: bash - - openstack role create - [--or-show] - [--domain ] - - -.. option:: --domain - - Domain the role belongs to (name or ID). - - .. versionadded:: 3 - -.. option:: --or-show - - Return existing role - - If the role already exists return the existing role data and do not fail. - -.. describe:: - - New role name - -role delete ------------ - -Delete role(s) - -.. program:: role delete -.. code:: bash - - openstack role delete - [ ...] - [--domain ] - -.. describe:: - - Role to delete (name or ID) - -.. option:: --domain - - Domain the role belongs to (name or ID). - - .. versionadded:: 3 - -role list ---------- - -List roles - -.. program:: role list -.. code:: bash - - openstack role list - --domain | --project [--project-domain ] - --user [--user-domain ] | --group [--group-domain ] - --inherited - -.. option:: --domain - - Filter roles by (name or ID) - - (Deprecated if being used to list assignments in conjunction with the - ``--user ``, option, please use ``role assignment list`` instead) - -.. option:: --project - - Filter roles by (name or ID) - - (Deprecated, please use ``role assignment list`` instead) - -.. option:: --user - - Filter roles by (name or ID) - - (Deprecated, please use ``role assignment list`` instead) - -.. option:: --group - - Filter roles by (name or ID) - - (Deprecated, please use ``role assignment list`` instead) - -.. option:: --user-domain - - Domain the user belongs to (name or ID). - This can be used in case collisions between user names exist. - - (Deprecated, please use ``role assignment list`` instead) - - .. versionadded:: 3 - -.. option:: --group-domain - - Domain the group belongs to (name or ID). - This can be used in case collisions between group names exist. - - (Deprecated, please use ``role assignment list`` instead) - - .. versionadded:: 3 - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - - (Deprecated, please use ``role assignment list`` instead) - - .. versionadded:: 3 - -.. option:: --inherited - - Specifies if the role grant is inheritable to the sub projects. - - (Deprecated, please use ``role assignment list`` instead) - - .. versionadded:: 3 - -role remove ------------ - -Remove role assignment from domain/project : user/group - -.. program:: role remove -.. code:: bash - - openstack role remove - --domain | --project [--project-domain ] - --user [--user-domain ] | --group [--group-domain ] - --role-domain - --inherited - - -.. option:: --domain - - Include (name or ID) - - .. versionadded:: 3 - -.. option:: --project - - Include (name or ID) - -.. option:: --user - - Include (name or ID) - -.. option:: --group - - Include (name or ID) - - .. versionadded:: 3 - -.. 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-domain - - Domain the group belongs to (name or ID). - This can be used in case collisions between group names exist. - - .. versionadded:: 3 - -.. 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:: --inherited - - Specifies if the role grant is inheritable to the sub projects. - - .. versionadded:: 3 - -.. option:: --role-domain - - Domain the role belongs to (name or ID). - This must be specified when the name of a domain specific role is used. - - .. versionadded:: 3 - -.. describe:: - - Role to remove (name or ID) - -role set --------- - -Set role properties - -.. versionadded:: 3 - -.. program:: role set -.. code:: bash - - openstack role set - [--name ] - [--domain ] - - -.. option:: --name - - Set role name - -.. option:: --domain - - Domain the role belongs to (name or ID). - - .. versionadded:: 3 - -.. describe:: - - Role to modify (name or ID) - -role show ---------- - -Display role details - -.. program:: role show -.. code:: bash - - openstack role show - [--domain ] - - -.. option:: --domain - - Domain the role belongs to (name or ID). - - .. versionadded:: 3 - -.. describe:: - - Role to display (name or ID) diff --git a/doc/source/cli/command-objects/router.rst b/doc/source/cli/command-objects/router.rst deleted file mode 100644 index 9c9364bc..00000000 --- a/doc/source/cli/command-objects/router.rst +++ /dev/null @@ -1,409 +0,0 @@ -====== -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 - -router add port ---------------- - -Add a port to a router - -.. program:: router add port -.. code:: bash - - openstack router add port - - - -.. _router_add_port: - -.. describe:: - - Router to which port will be added (name or ID) - -.. describe:: - - Port to be added (name or ID) - -router add subnet ------------------ - -Add a subnet to a router - -.. program:: router add subnet -.. code:: bash - - openstack router add subnet - - - -.. _router_add_subnet: - -.. describe:: - - Router to which subnet will be added (name or ID) - -.. describe:: - - Subnet to be added (name or ID) - -router create -------------- - -Create new router - -.. program:: router create -.. code:: bash - - openstack router create - [--project [--project-domain ]] - [--enable | --disable] - [--distributed | --centralized] - [--ha | --no-ha] - [--description ] - [--availability-zone-hint ] - [--tag | --no-tag] - - -.. option:: --project - - Owner's project (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. - -.. option:: --enable - - Enable router (default) - -.. option:: --disable - - Disable router - -.. option:: --distributed - - Create a distributed router - - The default router type (distributed vs centralized) is determined by a - configuration setting in the OpenStack deployment. Since we are unable - to know that default wihtout attempting to actually create a router it - is suggested to use either :option:`--distributed` or :option:`--centralized` - in situations where multiple cloud deployments may be used. - -.. option:: --centralized - - Create a centralized router - - See the note in :option:`--distributed` regarding the default used when - creating a new router. - -.. option:: --ha - - Create a highly available router - -.. option:: --no-ha - - Create a legacy router - -.. option:: --description - - Set router description - -.. option:: --availability-zone-hint - - Availability Zone in which to create this router - (Router Availability Zone extension required, - repeat option to set multiple availability zones) - -.. option:: --tag - - Tag to be added to the router (repeat option to set multiple tags) - -.. option:: --no-tag - - No tags associated with the router - -.. _router_create-name: -.. describe:: - - New router name - -router delete -------------- - -Delete router(s) - -.. program:: router delete -.. code:: bash - - openstack router delete - [ ...] - -.. _router_delete-router: -.. describe:: - - Router(s) to delete (name or ID) - -router list ------------ - -List routers - -.. program:: router list -.. code:: bash - - openstack router list - [--name ] - [--enable | --disable] - [--long] - [--project [--project-domain ]] - [--agent ] - [--tags [,,...]] [--any-tags [,,...]] - [--not-tags [,,...]] [--not-any-tags [,,...]] - -.. option:: --agent - - List routers hosted by an agent (ID only) - -.. option:: --long - - List additional fields in output - -.. option:: --name - - List routers according to their name - -.. option:: --enable - - List enabled routers - -.. option:: --disable - - List disabled routers - -.. option:: --project - - List routers according to their project (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. - -.. option:: --tags [,,...] - - List routers which have all given tag(s) - -.. option:: --any-tags [,,...] - - List routers which have any given tag(s) - -.. option:: --not-tags [,,...] - - Exclude routers which have all given tag(s) - -.. option:: --not-any-tags [,,...] - - Exclude routers which have any given tag(s) - -router remove port ------------------- - -Remove a port from a router - -.. program:: router remove port -.. code:: bash - - openstack router remove port - - - -.. _router_remove_port: - -.. describe:: - - Router from which port will be removed (name or ID) - -.. describe:: - - Port to be removed and deleted (name or ID) - -router remove subnet --------------------- - -Remove a subnet from a router - -.. program:: router remove subnet -.. code:: bash - - openstack router remove subnet - - - -.. _router_remove_subnet: - -.. describe:: - - Router from which subnet will be removed (name or ID) - -.. describe:: - - Subnet to be removed (name or ID) - -router set ----------- - -Set router properties - -.. program:: router set -.. code:: bash - - openstack router set - [--name ] - [--enable | --disable] - [--distributed | --centralized] - [--description ] - [--route destination=,gateway= | --no-route] - [--ha | --no-ha] - [--external-gateway [--enable-snat|--disable-snat] [--fixed-ip subnet=,ip-address=]] - [--tag ] [--no-tag] - - -.. option:: --name - - Set router name - -.. option:: --enable - - Enable router - -.. option:: --disable - - Disable router - -.. option:: --distributed - - Set router to distributed mode (disabled router only) - -.. option:: --centralized - - Set router to centralized mode (disabled router only) - -.. option:: --description - - Set router description - -.. option:: --route destination=,gateway= - - Routes associated with the router - destination: destination subnet (in CIDR notation) - gateway: nexthop IP address - (repeat option to set multiple routes) - -.. option:: --no-route - - Clear routes associated with the router. - Specify both --route and --no-route to overwrite - current value of route. - -.. option:: --ha - - Set the router as highly available (disabled router only) - -.. option:: --no-ha - - Clear high availablability attribute of the router (disabled router only) - -.. option:: --external-gateway - - External Network used as router's gateway (name or ID) - -.. option:: --enable-snat - - Enable Source NAT on external gateway - -.. option:: --disable-snat - - Disable Source NAT on external gateway - -.. option:: --fixed-ip subnet=,ip-address= - - Desired IP and/or subnet (name or ID) on external gateway: - subnet=,ip-address= - (repeat option to set multiple fixed IP addresses) - -.. option:: --tag - - Tag to be added to the router (repeat option to set multiple tags) - -.. option:: --no-tag - - Clear tags associated with the router. Specify both --tag - and --no-tag to overwrite current tags - -.. _router_set-router: -.. describe:: - - Router to modify (name or ID) - -router show ------------ - -Display router details - -.. program:: router show -.. code:: bash - - openstack router show - - -.. _router_show-router: -.. describe:: - - Router to display (name or ID) - -router unset ------------- - -Unset router properties - -.. program:: router unset -.. code:: bash - - openstack router unset - [--route destination=,gateway=] - [--external-gateway] - [--tag | --all-tag] - - -.. option:: --route destination=,gateway= - - Routes to be removed from the router - destination: destination subnet (in CIDR notation) - gateway: nexthop IP address - (repeat option to unset multiple routes) - -.. option:: --external-gateway - - Remove external gateway information from the router - -.. option:: --tag - - Tag to be removed from the router - (repeat option to remove multiple tags) - -.. option:: --all-tag - - Clear all tags associated with the router - -.. _router_unset-router: -.. describe:: - - Router to modify (name or ID) diff --git a/doc/source/cli/command-objects/security-group-rule.rst b/doc/source/cli/command-objects/security-group-rule.rst deleted file mode 100644 index 1dbf16d2..00000000 --- a/doc/source/cli/command-objects/security-group-rule.rst +++ /dev/null @@ -1,193 +0,0 @@ -=================== -security group rule -=================== - -A **security group rule** specifies the network access rules for servers -and other resources on the network. - -Compute v2, Network v2 - -security group rule create --------------------------- - -Create a new security group rule - -.. program:: security group rule create -.. code:: bash - - openstack security group rule create - [--remote-ip | --remote-group ] - [--dst-port | [--icmp-type [--icmp-code ]]] - [--protocol ] - [--ingress | --egress] - [--ethertype ] - [--project [--project-domain ]] - [--description ] - - -.. option:: --remote-ip - - Remote IP address block - (may use CIDR notation; default for IPv4 rule: 0.0.0.0/0) - -.. option:: --remote-group - - Remote security group (name or ID) - -.. option:: --dst-port - - Destination port, may be a single port or a starting and - ending port range: 137:139. Required for IP protocols TCP - and UDP. Ignored for ICMP IP protocols. - -.. option:: --icmp-type - - ICMP type for ICMP IP protocols - - *Network version 2 only* - -.. option:: --icmp-code - - ICMP code for ICMP IP protocols - - *Network version 2 only* - -.. option:: --protocol - - IP protocol (icmp, tcp, udp; default: tcp) - - *Compute version 2* - - IP protocol (ah, dccp, egp, esp, gre, icmp, igmp, - ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, - ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, - udp, udplite, vrrp and integer representations [0-255]; - default: tcp) - - *Network version 2* - -.. option:: --ingress - - Rule applies to incoming network traffic (default) - - *Network version 2 only* - -.. option:: --egress - - Rule applies to outgoing network traffic - - *Network version 2 only* - -.. option:: --ethertype - - Ethertype of network traffic - (IPv4, IPv6; default: based on IP protocol) - - *Network version 2 only* - -.. option:: --project - - Owner's project (name or ID) - - *Network 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. - - *Network version 2 only* - -.. option:: --description - - Set security group rule description - - *Network version 2 only* - -.. describe:: - - Create rule in this security group (name or ID) - -security group rule delete --------------------------- - -Delete security group rule(s) - -.. program:: security group rule delete -.. code:: bash - - openstack security group rule delete - [ ...] - -.. describe:: - - Security group rule(s) to delete (ID only) - -security group rule list ------------------------- - -List security group rules - -.. program:: security group rule list -.. code:: bash - - openstack security group rule list - [--all-projects] - [--protocol ] - [--ingress | --egress] - [--long] - [] - -.. option:: --all-projects - - Display information from all projects (admin only) - - *Network version 2 ignores this option and will always display information* - *for all projects (admin only).* - -.. option:: --long - - List additional fields in output - - *Compute version 2 does not have additional fields to display.* - - -.. option:: --protocol - - List rules by the IP protocol (ah, dhcp, egp, esp, gre, icmp, igmp, - ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt,ipv6-opts, ipv6-route, - ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp and integer - representations [0-255]) - - *Network version 2* - -.. option:: --ingress - - List rules applied to incoming network traffic - - *Network version 2 only* - -.. option:: --egress - - List rules applied to outgoing network traffic - - *Network version 2 only* - -.. describe:: - - List all rules in this security group (name or ID) - -security group rule show ------------------------- - -Display security group rule details - -.. program:: security group rule show -.. code:: bash - - openstack security group rule show - - -.. describe:: - - Security group rule to display (ID only) diff --git a/doc/source/cli/command-objects/security-group.rst b/doc/source/cli/command-objects/security-group.rst deleted file mode 100644 index a95a96f4..00000000 --- a/doc/source/cli/command-objects/security-group.rst +++ /dev/null @@ -1,130 +0,0 @@ -============== -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 - -security group create ---------------------- - -Create a new security group - -.. program:: security group create -.. code:: bash - - openstack security group create - [--description ] - [--project [--project-domain ]] - - -.. option:: --description - - Security group description - -.. option:: --project - - Owner's project (name or ID) - - *Network 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. - - *Network version 2 only* - -.. describe:: - - New security group name - -security group delete ---------------------- - -Delete security group(s) - -.. program:: security group delete -.. code:: bash - - openstack security group delete - [ ...] - -.. describe:: - - Security group(s) to delete (name or ID) - -security group list -------------------- - -List security groups - -.. program:: security group list -.. code:: bash - - openstack security group list - [--all-projects] - [--project [--project-domain ]] - -.. option:: --all-projects - - Display information from all projects (admin only) - - *Network version 2 ignores this option and will always display information* - *for all projects (admin only).* - -.. option:: --project - - List security groups according to the project (name or ID) - - *Network 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. - - *Network version 2 only* - -security group set ------------------- - -Set security group properties - -.. program:: security group set -.. code:: bash - - openstack security group set - [--name ] - [--description ] - - -.. option:: --name - - New security group name - -.. option:: --description - - New security group description - -.. describe:: - - Security group to modify (name or ID) - -security group show -------------------- - -Display security group details - -.. program:: security group show -.. code:: bash - - openstack security group show - - -.. describe:: - - Security group to display (name or ID) diff --git a/doc/source/cli/command-objects/server-backup.rst b/doc/source/cli/command-objects/server-backup.rst deleted file mode 100644 index 9ddb2cdf..00000000 --- a/doc/source/cli/command-objects/server-backup.rst +++ /dev/null @@ -1,44 +0,0 @@ -============= -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 - -server backup create --------------------- - -Create a server backup image - -.. program:: server create -.. code:: bash - - openstack server backup create - [--name ] - [--type ] - [--rotate ] - [--wait] - - -.. option:: --name - - Name of the backup image (default: server name) - -.. option:: --type - - Used to populate the ``backup_type`` property of the backup - image (default: empty) - -.. option:: --rotate - - Number of backup images to keep (default: 1) - -.. option:: --wait - - Wait for operation to complete - -.. describe:: - - Server to back up (name or ID) diff --git a/doc/source/cli/command-objects/server-event.rst b/doc/source/cli/command-objects/server-event.rst deleted file mode 100644 index ef4685f8..00000000 --- a/doc/source/cli/command-objects/server-event.rst +++ /dev/null @@ -1,45 +0,0 @@ -============ -server event -============ - -Server event is the event record that had been done on a server, include: event -type(create, delete, reboot and so on), event result(success, error), start -time, finish time and so on. These are important information for server -maintains. - -Compute v2 - -server event list ------------------ - -List recent events of a server - -.. program:: server event list -.. code:: bash - - openstack server event list - - -.. describe:: - - Server to list events (name or ID) - -server event show ------------------ - -Show server event details - -.. program:: server event show -.. code:: bash - - openstack server event show - - - -.. describe:: - - Server to show event details (name or ID) - -.. describe:: - - Request ID of the event to show (ID only) diff --git a/doc/source/cli/command-objects/server-group.rst b/doc/source/cli/command-objects/server-group.rst deleted file mode 100644 index 97696350..00000000 --- a/doc/source/cli/command-objects/server-group.rst +++ /dev/null @@ -1,80 +0,0 @@ -============ -server group -============ - -Server group provides a mechanism to group servers according to certain policy. - -Compute v2 - -server group create -------------------- - -Create a new server group - -.. program:: server group create -.. code-block:: bash - - openstack server group create - --policy - - -.. option:: --policy - - Add a policy to :ref:`\ ` - ('affinity' or 'anti-affinity', default to 'affinity') - -.. _server_group_create-name: -.. describe:: - - New server group name - -server group delete -------------------- - -Delete existing server group(s) - -.. program:: server group delete -.. code-block:: bash - - openstack server group delete - [ ...] - -.. describe:: - - Server group(s) to delete (name or ID) - (repeat to delete multiple server groups) - -server group list ------------------ - -List all server groups - -.. program:: server group list -.. code-block:: bash - - openstack server group list - [--all-projects] - [--long] - -.. option:: --all-projects - - Display information from all projects (admin only) - -.. option:: --long - - List additional fields in output - -server group show ------------------ - -Display server group details - -.. program:: server group show -.. code-block:: bash - - openstack server group show - - -.. describe:: - - Server group to display (name or ID) diff --git a/doc/source/cli/command-objects/server-image.rst b/doc/source/cli/command-objects/server-image.rst deleted file mode 100644 index 7e625d9e..00000000 --- a/doc/source/cli/command-objects/server-image.rst +++ /dev/null @@ -1,33 +0,0 @@ -============ -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 - -server image create -------------------- - -Create a new server disk image from an existing server - -.. program:: server image create -.. code:: bash - - openstack server image create - [--name ] - [--wait] - - -.. option:: --name - - Name of new disk image (default: server name) - -.. option:: --wait - - Wait for operation to complete - -.. describe:: - - Server to create image (name or ID) diff --git a/doc/source/cli/command-objects/server.rst b/doc/source/cli/command-objects/server.rst deleted file mode 100644 index a7fef257..00000000 --- a/doc/source/cli/command-objects/server.rst +++ /dev/null @@ -1,86 +0,0 @@ -====== -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 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 diff --git a/doc/source/cli/command-objects/service-provider.rst b/doc/source/cli/command-objects/service-provider.rst deleted file mode 100644 index 63ef44e1..00000000 --- a/doc/source/cli/command-objects/service-provider.rst +++ /dev/null @@ -1,125 +0,0 @@ -================ -service provider -================ - -Identity v3 - -`Requires: OS-FEDERATION extension` - -service provider create ------------------------ - -Create new service provider - -.. program:: service provider create -.. code:: bash - - openstack service provider create - [--description ] - [--enable | --disable] - --auth-url - --service-provider-url - - -.. option:: --auth-url - - Authentication URL of remote federated service provider (required) - -.. option:: --service-provider-url - - A service URL where SAML assertions are being sent (required) - -.. option:: --description - - New service provider description - -.. option:: --enable - - Enable the service provider (default) - -.. option:: --disable - - Disable the service provider - -.. describe:: - - New service provider name (must be unique) - -service provider delete ------------------------ - -Delete service provider(s) - -.. program:: service provider delete -.. code:: bash - - openstack service provider delete - [ ...] - -.. describe:: - - Service provider(s) to delete - -service provider list ---------------------- - -List service providers - -.. program:: service provider list -.. code:: bash - - openstack service provider list - -service provider set --------------------- - -Set service provider properties - -.. program:: service provider set -.. code:: bash - - openstack service provider set - [--enable | --disable] - [--description ] - [--auth-url ] - [--service-provider-url ] - - -.. option:: --service-provider-url - - New service provider URL, where SAML assertions are sent - -.. option:: --auth-url - - New Authentication URL of remote federated service provider - -.. option:: --description - - New service provider description - -.. option:: --enable - - Enable the service provider - -.. option:: --disable - - Disable the service provider - -.. describe:: - - Service provider to modify - -service provider show ---------------------- - -Display service provider details - -.. program:: service provider show -.. code:: bash - - openstack service provider show - - -.. describe:: - - Service provider to display diff --git a/doc/source/cli/command-objects/service.rst b/doc/source/cli/command-objects/service.rst deleted file mode 100644 index a69c6950..00000000 --- a/doc/source/cli/command-objects/service.rst +++ /dev/null @@ -1,143 +0,0 @@ -======= -service -======= - -Identity v2, v3 - -service create --------------- - -Create new service - -.. program:: service create -.. code-block:: bash - - openstack service create - [--name ] - [--description ] - [--enable | --disable] - - -.. option:: --name - - New service name - -.. option:: --description - - New service description - -.. option:: --enable - - Enable service (default) - - *Identity version 3 only* - -.. option:: --disable - - Disable service - - *Identity version 3 only* - -.. _service_create-type: -.. describe:: - - New service type (compute, image, identity, volume, etc) - -service delete --------------- - -Delete service(s) - -.. program:: service delete -.. code-block:: bash - - openstack service delete - [ ...] - -.. _service_delete-service: -.. describe:: - - Service(s) to delete (type, name or ID) - -service list ------------- - -List services - -.. program:: service list -.. code-block:: bash - - openstack service list - [--long] - -.. option:: --long - - List additional fields in output - -Returns service fields ID, Name and Type. :option:`--long` adds Description -and Enabled (*Identity version 3 only*) to the output. - -service set ------------ - -Set service properties - -* Identity version 3 only* - -.. program:: service set -.. code-block:: bash - - openstack service set - [--type ] - [--name ] - [--description ] - [--enable | --disable] - - -.. option:: --type - - New service type (compute, image, identity, volume, etc) - -.. option:: --name - - New service name - -.. option:: --description - - New service description - -.. option:: --enable - - Enable service - -.. option:: --disable - - Disable service - -.. _service_set-service: -.. describe:: - - Service to modify (type, name or ID) - -service show ------------- - -Display service details - -.. program:: service show -.. code-block:: bash - - openstack service show - [--catalog] - - -.. option:: --catalog - - Show service catalog information - - *Identity version 2 only* - -.. _service_show-service: -.. describe:: - - Service to display (type, name or ID) diff --git a/doc/source/cli/command-objects/snapshot.rst b/doc/source/cli/command-objects/snapshot.rst deleted file mode 100644 index fc516067..00000000 --- a/doc/source/cli/command-objects/snapshot.rst +++ /dev/null @@ -1,176 +0,0 @@ -======== -snapshot -======== - -Block Storage v1, v2 - -snapshot create ---------------- - -Create new snapshot -(Deprecated, please use ``volume snapshot create`` instead) - -.. program:: snapshot create -.. code:: bash - - openstack snapshot create - [--name ] - [--description ] - [--force] - [--property [...] ] - - -.. option:: --name - - Name of the snapshot - -.. 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* - -.. _snapshot_create-snapshot: -.. describe:: - - Volume to snapshot (name or ID) - -snapshot delete ---------------- - -Delete snapshot(s) -(Deprecated, please use ``volume snapshot delete`` instead) - -.. program:: snapshot delete -.. code:: bash - - openstack snapshot delete - [ ...] - -.. _snapshot_delete-snapshot: -.. describe:: - - Snapshot(s) to delete (name or ID) - -snapshot list -------------- - -List snapshots -(Deprecated, please use ``volume snapshot list`` instead) - -.. program:: snapshot list -.. code:: bash - - openstack snapshot list - [--all-projects] - [--long] - [--limit ] - [--marker ] - -.. option:: --all-projects - - Include all projects (admin only) - -.. option:: --long - - List additional fields in output - -.. 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* - -snapshot set ------------- - -Set snapshot properties -(Deprecated, please use ``volume snapshot set`` instead) - -.. program:: snapshot set -.. code:: bash - - openstack snapshot set - [--name ] - [--description ] - [--property [...] ] - [--state ] - - -.. _snapshot_restore-snapshot: -.. option:: --name - - New snapshot name - -.. option:: --description - - New snapshot description - -.. 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* - -.. describe:: - - Snapshot to modify (name or ID) - -snapshot show -------------- - -Display snapshot details -(Deprecated, please use ``volume snapshot show`` instead) - -.. program:: snapshot show -.. code:: bash - - openstack snapshot show - - -.. _snapshot_show-snapshot: -.. describe:: - - Snapshot to display (name or ID) - -snapshot unset --------------- - -Unset snapshot properties -(Deprecated, please use ``volume snapshot unset`` instead) - -.. program:: snapshot unset -.. code:: bash - - openstack snapshot unset - [--property ] - - -.. option:: --property - - Property to remove from snapshot (repeat option to remove multiple properties) - -.. describe:: - - Snapshot to modify (name or ID) diff --git a/doc/source/cli/command-objects/subnet-pool.rst b/doc/source/cli/command-objects/subnet-pool.rst deleted file mode 100644 index 0cff4d7f..00000000 --- a/doc/source/cli/command-objects/subnet-pool.rst +++ /dev/null @@ -1,316 +0,0 @@ -=========== -subnet pool -=========== - -A **subnet pool** contains a collection of prefixes in CIDR notation -that are available for IP address allocation. - -Network v2 - -subnet pool create ------------------- - -Create subnet pool - -.. program:: subnet pool create -.. code:: bash - - openstack subnet pool create - [--default-prefix-length ] - [--min-prefix-length ] - [--max-prefix-length ] - [--description ] - [--project [--project-domain ]] - [--address-scope ] - [--default | --no-default] - [--share | --no-share] - [--default-quota ] - [--tag | --no-tag] - --pool-prefix [...] - - -.. option:: --default-prefix-length - - Set subnet pool default prefix length - -.. option:: --min-prefix-length - - Set subnet pool minimum prefix length - -.. option:: --max-prefix-length - - Set subnet pool maximum prefix length - -.. option:: --description - - Set subnet pool description - -.. option:: --project - - Owner's project (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. - -.. option:: --address-scope - - Set address scope associated with the subnet pool (name or ID), - prefixes must be unique across address scopes - -.. option:: --default - - Set this as a default subnet pool - -.. option:: --no-default - - Set this as a non-default subnet pool - -.. option:: --share - - Set this subnet pool as shared - -.. option:: --no-share - - Set this subnet pool as not shared - -.. option:: --default-quota - - Set default quota for subnet pool as the number of - IP addresses allowed in a subnet - -.. option:: --tag - - Tag to be added to the subnet pool (repeat option to set multiple tags) - -.. option:: --no-tag - - No tags associated with the subnet pool - -.. option:: --pool-prefix - - Set subnet pool prefixes (in CIDR notation) - (repeat option to set multiple prefixes) - -.. _subnet_pool_create-name: -.. describe:: - - Name of the new subnet pool - -subnet pool delete ------------------- - -Delete subnet pool(s) - -.. program:: subnet pool delete -.. code:: bash - - openstack subnet pool delete - [ ...] - -.. _subnet_pool_delete-subnet-pool: -.. describe:: - - Subnet pool(s) to delete (name or ID) - -subnet pool list ----------------- - -List subnet pools - -.. program:: subnet pool list -.. code:: bash - - openstack subnet pool list - [--long] - [--share | --no-share] - [--default | --no-default] - [--project [--project-domain ]] - [--name ] - [--address-scope ] - [--tags [,,...]] [--any-tags [,,...]] - [--not-tags [,,...]] [--not-any-tags [,,...]] - -.. option:: --long - - List additional fields in output - -.. option:: --share - - List subnet pools shared between projects - -.. option:: --no-share - - List subnet pools not shared between projects - -.. option:: --default - - List subnet pools used as the default external subnet pool - -.. option:: --no-default - - List subnet pools not used as the default external subnet pool - -.. option:: --project - - List subnet pools according to their project (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. - -.. option:: --name - - List only subnet pools of given name in output - -.. option:: --address-scope - - List only subnet pools of given address scope in output (name or ID) - -.. option:: --tags [,,...] - - List subnet pools which have all given tag(s) - -.. option:: --any-tags [,,...] - - List subnet pools which have any given tag(s) - -.. option:: --not-tags [,,...] - - Exclude subnet pools which have all given tag(s) - -.. option:: --not-any-tags [,,...] - - Exclude subnet pools which have any given tag(s) - -subnet pool set ---------------- - -Set subnet pool properties - -.. program:: subnet pool set -.. code:: bash - - openstack subnet pool set - [--name ] - [--pool-prefix [...]] - [--default-prefix-length ] - [--min-prefix-length ] - [--max-prefix-length ] - [--address-scope | --no-address-scope] - [--default | --no-default] - [--description ] - [--default-quota ] - [--tag ] [--no-tag] - - -.. option:: --name - - Set subnet pool name - -.. option:: --pool-prefix - - Set subnet pool prefixes (in CIDR notation) - (repeat option to set multiple prefixes) - -.. option:: --default-prefix-length - - Set subnet pool default prefix length - -.. option:: --min-prefix-length - - Set subnet pool minimum prefix length - -.. option:: --max-prefix-length - - Set subnet pool maximum prefix length - -.. option:: --address-scope - - Set address scope associated with the subnet pool (name or ID), - prefixes must be unique across address scopes - -.. option:: --no-address-scope - - Remove address scope associated with the subnet pool - -.. option:: --default - - Set this as a default subnet pool - -.. option:: --no-default - - Set this as a non-default subnet pool - -.. option:: --description - - Set subnet pool description - -.. option:: --default-quota - - Set default quota for subnet pool as the number of - IP addresses allowed in a subnet - -.. option:: --tag - - Tag to be added to the subnet pool (repeat option to set multiple tags) - -.. option:: --no-tag - - Clear tags associated with the subnet pool. Specify both --tag - and --no-tag to overwrite current tags - -.. _subnet_pool_set-subnet-pool: -.. describe:: - - Subnet pool to modify (name or ID) - -subnet pool show ----------------- - -Display subnet pool details - -.. program:: subnet pool show -.. code:: bash - - openstack subnet pool show - - -.. _subnet_pool_show-subnet-pool: -.. describe:: - - Subnet pool to display (name or ID) - -subnet pool unset ------------------ - -Unset subnet pool properties - -.. program:: subnet pool unset -.. code:: bash - - openstack subnet pool unset - [--pool-prefix [...]] - [--tag | --all-tag] - - -.. option:: --pool-prefix - - Remove subnet pool prefixes (in CIDR notation). - (repeat option to unset multiple prefixes). - -.. option:: --tag - - Tag to be removed from the subnet pool - (repeat option to remove multiple tags) - -.. option:: --all-tag - - Clear all tags associated with the subnet pool - -.. _subnet_pool_unset-subnet-pool: -.. describe:: - - Subnet pool to modify (name or ID) diff --git a/doc/source/cli/command-objects/subnet.rst b/doc/source/cli/command-objects/subnet.rst deleted file mode 100644 index c228dc20..00000000 --- a/doc/source/cli/command-objects/subnet.rst +++ /dev/null @@ -1,421 +0,0 @@ -====== -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 - -subnet create -------------- - -Create new subnet - -.. program:: subnet create -.. code:: bash - - openstack subnet create - [--project [--project-domain ]] - [--subnet-pool | --use-default-subnet-pool [--prefix-length ]] - [--subnet-range ] - [--allocation-pool start=,end=] - [--dhcp | --no-dhcp] - [--dns-nameserver ] - [--gateway ] - [--host-route destination=,gateway=] - [--ip-version {4,6}] - [--description ] - [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] - [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] - [--network-segment ] - [--service-type ] - [--tag | --no-tag] - --network - - -.. option:: --project - - Owner's project (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. - -.. option:: --subnet-pool - - Subnet pool from which this subnet will obtain a CIDR (name or ID) - -.. option:: --use-default-subnet-pool - - Use default subnet pool for :option:`--ip-version` - -.. option:: --prefix-length - - Prefix length for subnet allocation from subnet pool - -.. option:: --subnet-range - - Subnet range in CIDR notation - (required if :option:`--subnet-pool` is not specified, optional otherwise) - -.. option:: --allocation-pool start=,end= - - Allocation pool IP addresses for this subnet e.g.: - ``start=192.168.199.2,end=192.168.199.254`` - (repeat option to add multiple IP addresses) - -.. option:: --dhcp - - Enable DHCP (default) - -.. option:: --no-dhcp - - Disable DHCP - -.. option:: --dns-nameserver - - DNS server for this subnet (repeat option to set multiple DNS servers) - -.. option:: --gateway - - Specify a gateway for the subnet. The three options are: - : Specific IP address to use as the gateway, - 'auto': Gateway address should automatically be chosen from - within the subnet itself, 'none': This subnet will not use - a gateway, e.g.: ``--gateway 192.168.9.1``, ``--gateway auto``, - ``--gateway none`` (default is 'auto'). - -.. option:: --host-route destination=,gateway= - - Additional route for this subnet e.g.: - ``destination=10.10.0.0/16,gateway=192.168.71.254`` - destination: destination subnet (in CIDR notation) - gateway: nexthop IP address - (repeat option to add multiple routes) - -.. option:: --ip-version {4,6} - - IP version (default is 4). Note that when subnet pool is specified, - IP version is determined from the subnet pool and this option - is ignored. - -.. option:: --description - - Set subnet description - -.. option:: --ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} - - IPv6 RA (Router Advertisement) mode, - valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] - -.. option:: --ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} - - IPv6 address mode, valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] - -.. option:: --network-segment - - Network segment to associate with this subnet (name or ID) - -.. option:: --service-type - - Service type for this subnet e.g.: - ``network:floatingip_agent_gateway``. - Must be a valid device owner value for a network port - (repeat option to set multiple service types) - -.. option:: --tag - - Tag to be added to the subnet (repeat option to set multiple tags) - -.. option:: --no-tag - - No tags associated with the subnet - -.. option:: --network - - Network this subnet belongs to (name or ID) - -.. _subnet_create-name: -.. describe:: - - Name of subnet to create - -subnet delete -------------- - -Delete subnet(s) - -.. program:: subnet delete -.. code:: bash - - openstack subnet delete - [ ...] - -.. _subnet_delete-subnet: -.. describe:: - - Subnet(s) to delete (name or ID) - -subnet list ------------ - -List subnets - -.. program:: subnet list -.. code:: bash - - openstack subnet list - [--long] - [--ip-version {4,6}] - [--dhcp | --no-dhcp] - [--project [--project-domain ]] - [--network ] - [--gateway ] - [--name ] - [--subnet-range ] - [--tags [,,...]] [--any-tags [,,...]] - [--not-tags [,,...]] [--not-any-tags [,,...]] - -.. option:: --long - - List additional fields in output - -.. option:: --ip-version {4, 6} - - List only subnets of given IP version in output. - Allowed values for IP version are 4 and 6. - -.. option:: --dhcp - - List subnets which have DHCP enabled - -.. option:: --no-dhcp - - List subnets which have DHCP disabled - -.. option:: --service-type - - List only subnets of a given service type in output - e.g.: ``network:floatingip_agent_gateway``. - Must be a valid device owner value for a network port - (repeat option to list multiple service types) - -.. option:: --project - - List only subnets which belong to a given project in output (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. - -.. option:: --network - - List only subnets which belong to a given network in output (name or ID) - -.. option:: --gateway - - List only subnets of given gateway IP in output - -.. option:: --name - - List only subnets of given name in output - -.. option:: --subnet-range - - List only subnets of given subnet range (in CIDR notation) in output - e.g.: ``--subnet-range 10.10.0.0/16`` - -.. option:: --tags [,,...] - - List subnets which have all given tag(s) - -.. option:: --any-tags [,,...] - - List subnets which have any given tag(s) - -.. option:: --not-tags [,,...] - - Exclude subnets which have all given tag(s) - -.. option:: --not-any-tags [,,...] - - Exclude subnets which have any given tag(s) - -subnet set ----------- - -Set subnet properties - -.. program:: subnet set -.. code:: bash - - openstack subnet set - [--allocation-pool start=,end=] - [--no-allocation-pool] - [--dhcp | --no-dhcp] - [--dns-nameserver ] - [--no-dns-nameserver] - [--gateway ] - [--host-route destination=,gateway=] - [--no-host-route] - [--service-type ] - [--name ] - [--description ] - [--tag ] [--no-tag] - - -.. option:: --allocation-pool start=,end= - - Allocation pool IP addresses for this subnet e.g.: - ``start=192.168.199.2,end=192.168.199.254`` - (repeat option to add multiple IP addresses) - -.. option:: --no-allocation-pool - - Clear associated allocation pools from this subnet. - Specify both :option:`--allocation-pool` and :option:`--no-allocation-pool` - to overwrite the current allocation pool information. - -.. option:: --dhcp - - Enable DHCP - -.. option:: --no-dhcp - - Disable DHCP - -.. option:: --dns-nameserver - - DNS server for this subnet (repeat option to set multiple DNS servers) - -.. option:: --no-dns-nameservers - - Clear existing information of DNS servers. - Specify both :option:`--dns-nameserver` and :option:`--no-dns-nameservers` - to overwrite the current DNS server information. - -.. option:: --gateway - - Specify a gateway for the subnet. The options are: - : Specific IP address to use as the gateway, - 'none': This subnet will not use a gateway, - e.g.: ``--gateway 192.168.9.1``, ``--gateway none``. - -.. option:: --host-route destination=,gateway= - - Additional route for this subnet e.g.: - ``destination=10.10.0.0/16,gateway=192.168.71.254`` - destination: destination subnet (in CIDR notation) - gateway: nexthop IP address - -.. option:: --no-host-route - - Clear associated host routes from this subnet. - Specify both :option:`--host-route` and :option:`--no-host-route` - to overwrite the current host route information. - -.. option:: --service-type - - Service type for this subnet e.g.: - ``network:floatingip_agent_gateway``. - Must be a valid device owner value for a network port - (repeat option to set multiple service types) - -.. option:: --description - - Set subnet description - -.. option:: --name - - Updated name of the subnet - -.. option:: --tag - - Tag to be added to the subnet (repeat option to set multiple tags) - -.. option:: --no-tag - - Clear tags associated with the subnet. Specify both --tag - and --no-tag to overwrite current tags - -.. _subnet_set-subnet: -.. describe:: - - Subnet to modify (name or ID) - - -subnet show ------------ - -Display subnet details - -.. program:: subnet show -.. code:: bash - - openstack subnet show - - -.. _subnet_show-subnet: -.. describe:: - - Subnet to display (name or ID) - -subnet unset ------------- - -Unset subnet properties - -.. program:: subnet unset -.. code:: bash - - openstack subnet unset - [--allocation-pool start=,end= [...]] - [--dns-nameserver [...]] - [--host-route destination=,gateway= [...]] - [--service-type ] - [--tag | --all-tag] - - -.. option:: --dns-nameserver - - DNS server to be removed from this subnet - (repeat option to unset multiple DNS servers) - -.. option:: --allocation-pool start=,end= - - Allocation pool IP addresses to be removed from this - subnet e.g.: ``start=192.168.199.2,end=192.168.199.254`` - (repeat option to unset multiple allocation pools) - -.. option:: --host-route destination=,gateway= - - Route to be removed from this subnet e.g.: - ``destination=10.10.0.0/16,gateway=192.168.71.254`` - destination: destination subnet (in CIDR notation) - gateway: nexthop IP address - (repeat option to unset multiple host routes) - -.. option:: --service-type - - Service type to be removed from this subnet e.g.: - ``network:floatingip_agent_gateway``. - Must be a valid device owner value for a network port - (repeat option to unset multiple service types) - -.. option:: --tag - - Tag to be removed from the subnet - (repeat option to remove multiple tags) - -.. option:: --all-tag - - Clear all tags associated with the subnet - -.. _subnet_unset-subnet: -.. describe:: - - Subnet to modify (name or ID) diff --git a/doc/source/cli/command-objects/token.rst b/doc/source/cli/command-objects/token.rst deleted file mode 100644 index b4b14cd9..00000000 --- a/doc/source/cli/command-objects/token.rst +++ /dev/null @@ -1,30 +0,0 @@ -===== -token -===== - -Identity v2, v3 - -token issue ------------ - -Issue new token - -.. program:: token issue -.. code:: bash - - openstack token issue - -token revoke ------------- - -Revoke existing token - -.. program:: token revoke -.. code:: bash - - openstack token revoke - - -.. describe:: - - Token to be deleted diff --git a/doc/source/cli/command-objects/trust.rst b/doc/source/cli/command-objects/trust.rst deleted file mode 100644 index 28459bca..00000000 --- a/doc/source/cli/command-objects/trust.rst +++ /dev/null @@ -1,102 +0,0 @@ -===== -trust -===== - -Identity v3 - -trust create ------------- - -Create new trust - -.. program:: trust create -.. code:: bash - - openstack trust create - --project - --role - [--impersonate] - [--expiration ] - [--project-domain ] - [--trustor-domain ] - [--trustee-domain ] - - - -.. option:: --project - - Project being delegated (name or ID) (required) - -.. option:: --role - - Roles to authorize (name or ID) (repeat option to set multiple values, required) - -.. option:: --impersonate - - Tokens generated from the trust will represent (defaults to False) - -.. option:: --expiration - - Sets an expiration date for the trust (format of YYYY-mm-ddTHH:MM:SS) - -.. option:: --project-domain - - Domain the project belongs to (name or ID). This can be - used in case collisions between user names exist. - -.. option:: --trustor-domain - - Domain that contains (name or ID) - -.. option:: --trustee-domain - - Domain that contains (name or ID) - -.. describe:: - - User that is delegating authorization (name or ID) - -.. describe:: - - User that is assuming authorization (name or ID) - - -trust delete ------------- - -Delete trust(s) - -.. program:: trust delete -.. code:: bash - - openstack trust delete - [ ...] - -.. describe:: - - Trust(s) to delete - -trust list ----------- - -List trusts - -.. program:: trust list -.. code:: bash - - openstack trust list - -trust show ----------- - -Display trust details - -.. program:: trust show -.. code:: bash - - openstack trust show - - -.. describe:: - - Trust to display diff --git a/doc/source/cli/command-objects/usage.rst b/doc/source/cli/command-objects/usage.rst deleted file mode 100644 index 9cd0f70e..00000000 --- a/doc/source/cli/command-objects/usage.rst +++ /dev/null @@ -1,50 +0,0 @@ -===== -usage -===== - -Compute v2 - -usage list ----------- - -List resource usage per project - -.. program:: usage list -.. code:: bash - - openstack usage list - [--start ] - [--end ] - -.. option:: --start - - Usage range start date, ex 2012-01-20 (default: 4 weeks ago) - -.. option:: --end - - Usage range end date, ex 2012-01-20 (default: tomorrow) - -usage show ----------- - -Show resource usage for a single project - -.. program:: usage show -.. code:: bash - - openstack usage show - [--project ] - [--start ] - [--end ] - -.. option:: --project - - Name or ID of project to show usage for - -.. option:: --start - - Usage range start date, ex 2012-01-20 (default: 4 weeks ago) - -.. option:: --end - - Usage range end date, ex 2012-01-20 (default: tomorrow) diff --git a/doc/source/cli/command-objects/user-role.rst b/doc/source/cli/command-objects/user-role.rst deleted file mode 100644 index 4f443f31..00000000 --- a/doc/source/cli/command-objects/user-role.rst +++ /dev/null @@ -1,27 +0,0 @@ -========= -user role -========= - -Identity v2 - -user role list --------------- - -List user-role assignments - -*Removed in version 3.* - -.. program:: user role list -.. code:: bash - - openstack user role list - [--project ] - [] - -.. option:: --project - - Filter users by `` (name or ID) - -.. describe:: - - User to list (name or ID) diff --git a/doc/source/cli/command-objects/user.rst b/doc/source/cli/command-objects/user.rst deleted file mode 100644 index 632d0e25..00000000 --- a/doc/source/cli/command-objects/user.rst +++ /dev/null @@ -1,223 +0,0 @@ -==== -user -==== - -Identity v2, v3 - -user create ------------ - -Create new user - -.. program:: user create -.. code:: bash - - openstack user create - [--domain ] - [--project [--project-domain ]] - [--password ] - [--password-prompt] - [--email ] - [--description ] - [--enable | --disable] - [--or-show] - - -.. option:: --domain - - Default domain (name or ID) - - .. versionadded:: 3 - -.. option:: --project - - Default project (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. - -.. option:: --password - - Set user password - -.. option:: --password-prompt - - Prompt interactively for password - -.. option:: --email - - Set user email address - -.. option:: --description - - User description - - .. versionadded:: 3 - -.. option:: --enable - - Enable user (default) - -.. option:: --disable - - Disable user - -.. option:: --or-show - - Return existing user - - If the username already exist return the existing user data and do not fail. - -.. describe:: - - New user name - -user delete ------------ - -Delete user(s) - -.. program:: user delete -.. code:: bash - - openstack user delete - [--domain ] - [ ...] - -.. option:: --domain - - Domain owning :ref:`\ ` (name or ID) - - .. versionadded:: 3 - -.. _user_delete-user: -.. describe:: - - User(s) to delete (name or ID) - -user list ---------- - -List users - -.. program:: user list -.. code:: bash - - openstack user list - [--project ] - [--domain ] - [--group | --project ] - [--long] - -.. option:: --project - - Filter users by `` (name or ID) - -.. option:: --domain - - Filter users by `` (name or ID) - - *Identity version 3 only* - -.. option:: --group - - Filter users by `` membership (name or ID) - - *Identity version 3 only* - -.. option:: --long - - List additional fields in output - -user set --------- - -Set user properties - -.. program:: user set -.. code:: bash - - openstack user set - [--name ] - [--project [--project-domain ]] - [--password ] - [--password-prompt] - [--email ] - [--description ] - [--enable|--disable] - - -.. option:: --name - - Set user name - -.. option:: --domain - - Domain the user belongs to (name or ID). - This can be used in case collisions between user names exist. - - .. versionadded:: 3 - -.. option:: --project - - Set default project (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. - -.. option:: --password - - Set user password - -.. option:: --password-prompt - - Prompt interactively for password - -.. option:: --email - - Set user email address - -.. option:: --description - - Set user description - - .. versionadded:: 3 - -.. option:: --enable - - Enable user (default) - -.. option:: --disable - - Disable user - -.. describe:: - - User to modify (name or ID) - -user show ---------- - -Display user details - -.. program:: user show -.. code:: bash - - openstack user show - [--domain ] - - -.. option:: --domain - - Domain owning :ref:`\ ` (name or ID) - - .. versionadded:: 3 - -.. _user_show-user: -.. describe:: - - User to display (name or ID) diff --git a/doc/source/cli/command-objects/volume-backup.rst b/doc/source/cli/command-objects/volume-backup.rst deleted file mode 100644 index 585f47d4..00000000 --- a/doc/source/cli/command-objects/volume-backup.rst +++ /dev/null @@ -1,201 +0,0 @@ -============= -volume backup -============= - -Block Storage v1, v2 - -volume backup create --------------------- - -Create new volume backup - -.. program:: volume backup create -.. code:: bash - - openstack volume backup create - [--container ] - [--name ] - [--description ] - [--snapshot ] - [--force] - [--incremental] - - -.. option:: --container - - Optional backup container name - -.. option:: --name - - Name of the backup - -.. option:: --description - - Description of the backup - -.. option:: --snapshot - - Snapshot to backup (name or ID) - - *Volume version 2 only* - -.. option:: --force - - Allow to back up an in-use volume - - *Volume version 2 only* - -.. option:: --incremental - - Perform an incremental backup - - *Volume version 2 only* - -.. _volume_backup_create-backup: -.. describe:: - - Volume to backup (name or ID) - -volume backup delete --------------------- - -Delete volume backup(s) - -.. program:: volume backup delete -.. code:: bash - - openstack volume backup delete - [--force] - [ ...] - -.. option:: --force - - Allow delete in state other than error or available - - *Volume version 2 only* - -.. _volume_backup_delete-backup: -.. describe:: - - Backup(s) to delete (name or ID) - -volume backup list ------------------- - -List volume backups - -.. program:: volume backup list -.. code:: bash - - openstack volume backup list - [--long] - [--name ] - [--status ] - [--volume ] - [--marker ] - [--limit ] - [--all-projects] - -.. _volume_backup_list-backup: -.. option:: --long - - List additional fields in output - -.. option:: --name - - Filters results by the backup name - -.. option:: --status - - Filters results by the backup status - ('creating', 'available', 'deleting', 'error', 'restoring' or 'error_restoring') - -.. option:: --volume - - Filters results by the volume which they backup (name or ID)" - -.. option:: --marker - - The last backup of the previous page (name or ID) - - *Volume version 2 only* - -.. option:: --limit - - Maximum number of backups to display - - *Volume version 2 only* - -.. option:: --all-projects - - Include all projects (admin only) - -volume backup restore ---------------------- - -Restore volume backup - -.. program:: volume backup restore -.. code:: bash - - openstack volume backup restore - - - -.. _volume_backup_restore-backup: -.. describe:: - - Backup to restore (name or ID) - -.. describe:: - - Volume to restore to (name or ID) - -volume backup set ------------------ - -Set volume backup properties - -.. program:: volume backup set -.. code:: bash - - openstack volume backup set - [--name ] - [--description ] - [--state ] - - -.. option:: --name - - New backup name - -.. option:: --description - - New backup description - -.. option:: --state - - New backup state ("available" or "error") (admin only) - (This option simply changes the state of the backup in the database with - no regard to actual status, exercise caution when using) - -.. _backup_set-volume-backup: -.. describe:: - - Backup to modify (name or ID) - -volume backup show ------------------- - -Display volume backup details - -.. program:: volume backup show -.. code:: bash - - openstack volume backup show - - -.. _volume_backup_show-backup: -.. describe:: - - Backup to display (name or ID) diff --git a/doc/source/cli/command-objects/volume-host.rst b/doc/source/cli/command-objects/volume-host.rst deleted file mode 100644 index 1e513cb7..00000000 --- a/doc/source/cli/command-objects/volume-host.rst +++ /dev/null @@ -1,52 +0,0 @@ -=========== -volume host -=========== - -Volume 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 diff --git a/doc/source/cli/command-objects/volume-qos.rst b/doc/source/cli/command-objects/volume-qos.rst deleted file mode 100644 index 8fdbc122..00000000 --- a/doc/source/cli/command-objects/volume-qos.rst +++ /dev/null @@ -1,166 +0,0 @@ -========== -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) diff --git a/doc/source/cli/command-objects/volume-service.rst b/doc/source/cli/command-objects/volume-service.rst deleted file mode 100644 index 2ad23240..00000000 --- a/doc/source/cli/command-objects/volume-service.rst +++ /dev/null @@ -1,66 +0,0 @@ -============== -volume service -============== - -Volume 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) diff --git a/doc/source/cli/command-objects/volume-snapshot.rst b/doc/source/cli/command-objects/volume-snapshot.rst deleted file mode 100644 index 30cc77cc..00000000 --- a/doc/source/cli/command-objects/volume-snapshot.rst +++ /dev/null @@ -1,223 +0,0 @@ -=============== -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) diff --git a/doc/source/cli/command-objects/volume-transfer-request.rst b/doc/source/cli/command-objects/volume-transfer-request.rst deleted file mode 100644 index 23cd3d3e..00000000 --- a/doc/source/cli/command-objects/volume-transfer-request.rst +++ /dev/null @@ -1,96 +0,0 @@ -======================= -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) diff --git a/doc/source/cli/command-objects/volume-type.rst b/doc/source/cli/command-objects/volume-type.rst deleted file mode 100644 index afa293d7..00000000 --- a/doc/source/cli/command-objects/volume-type.rst +++ /dev/null @@ -1,291 +0,0 @@ -=========== -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 class that provides encryption support for this volume type - (e.g "LuksEncryptor") (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 class that provides encryption support for this volume type - (e.g "LuksEncryptor") (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) diff --git a/doc/source/cli/command-objects/volume.rst b/doc/source/cli/command-objects/volume.rst deleted file mode 100644 index a06a5d40..00000000 --- a/doc/source/cli/command-objects/volume.rst +++ /dev/null @@ -1,403 +0,0 @@ -====== -volume -====== - -Block Storage v1, v2 - -volume create -------------- - -Create new volume - -.. program:: volume create -.. code:: bash - - openstack volume create - [--size ] - [--type ] - [--image | --snapshot | --source | --source-replicated ] - [--description ] - [--user ] - [--project ] - [--availability-zone ] - [--consistency-group ] - [--property [...] ] - [--hint [...] ] - [--multi-attach] - [--bootable | --non-bootable] - [--read-only | --read-write] - - -.. option:: --size - - Volume size in GB - (Required unless --snapshot or --source or --source-replicated 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:: --source-replicated - - Replicated volume to clone (name or ID) - -.. option:: --description - - Volume description - -.. option:: --user - - Specify an alternate user (name or ID) - -.. option:: --project - - Specify an alternate project (name or ID) - -.. 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:: --multi-attach - - Allow volume to be attached more than once (default to False) - -.. 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 - -The :option:`--project` and :option:`--user` options are typically only -useful for admin users, but may be allowed for other users depending on -the policy of the cloud and the roles granted to the user. - -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 | --unlock-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* - -.. option:: --unlock-volume - - If specified, the volume state will not be locked and the a - migration can be aborted (default) (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 ] - [--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* - -.. _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) diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst deleted file mode 100644 index 5a7977e4..00000000 --- a/doc/source/cli/commands.rst +++ /dev/null @@ -1,325 +0,0 @@ -.. _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 -* ``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**, **Network**) - an internal IP address assigned to a server -* ``floating ip``: (**Compute**, **Network**) - a public IP address that can be mapped to a server -* ``floating ip pool``: (**Compute**, **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 -* ``ip availability``: (**Network**) - details of IP usage of a network -* ``ip fixed``: (**Compute**, **Network**) - an internal IP address assigned to a server -* ``ip floating``: (**Compute**, **Network**) - a public IP address that can be mapped to a server -* ``ip floating pool``: (**Compute**, **Network**) - a pool of public IP addresses -* ``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 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 backup``: (**Volume**) backup for volumes -* ``volume host``: (**Volume**) the physical computer for volumes -* ``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)**) -* ``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)**) -* ``congress datasource``: (**Policy (Congress)**) -* ``congress driver``: (**Policy (Congress)**) -* ``congress policy``: (**Policy (Congress)**) -* ``congress policy rule``: (**Policy (Congress)**) -* ``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)**) -* ``data protection plan``: (**Data Protection (Karbor)**) -* ``data protection restore``: (**Data Protection (Karbor)**) -* ``data protection provider``: (**Data Protection (Karbor)**) -* ``data protection protectable``: (**Data Protection (Karbor)**) -* ``data protection protectable instance``: (**Data Protection (Karbor)**) -* ``data protection trigger``: (**Data Protection (Karbor)**) -* ``data protection checkpoint``: (**Data Protection (Karbor)**) -* ``data protection scheduledoperation``: (**Data Protection (Karbor)**) -* ``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)**) -* ``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 -* ``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 ``setuptools`` entry points. 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 - # ... diff --git a/doc/source/cli/data/cinder.csv b/doc/source/cli/data/cinder.csv deleted file mode 100644 index 5c89e086..00000000 --- a/doc/source/cli/data/cinder.csv +++ /dev/null @@ -1,104 +0,0 @@ -absolute-limits,limits show --absolute,Lists absolute limits for a user. -availability-zone-list,availability zone list --volume,Lists all availability zones. -backup-create,volume backup create,Creates a volume backup. -backup-delete,volume backup delete,Removes a backup. -backup-export,volume backup export,Export backup metadata record. -backup-import,volume backup 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. -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. -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. -credentials,WONTFIX,Shows user credentials returned from auth. -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). -endpoints,catalog list,Discovers endpoints registered by authentication service. -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,,Show backend volume stats and properties. Admin only. -get-pools,,Show pool information for backends. Admin only. -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. -manage,volume create --remote-source k=v,Manage an existing volume. -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. -replication-promote,WONTFIX,Promote a secondary volume to primary for a relationship -replication-reenable,WONTFIX,Sync the secondary volume with primary for a relationship -reset-state,volume set --state,Explicitly updates the volume state. -retype,volume type set --type,Changes the volume type for a volume. -service-disable,volume service set --disable,Disables the service. -service-enable,volume service set --enable,Enables the service. -service-list,volume service list,Lists all services. Filter by host and service binary. -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-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. -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. -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. diff --git a/doc/source/cli/data/glance.csv b/doc/source/cli/data/glance.csv deleted file mode 100644 index 2985e307..00000000 --- a/doc/source/cli/data/glance.csv +++ /dev/null @@ -1,24 +0,0 @@ -explain,WONTFIX,Describe a specific model. -image-create,image create,Create a new image. -image-deactivate,image set --deactivate,Deactivate specified image. -image-delete,image delete,Delete specified image. -image-download,image save,Download a specific image. -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-tag-delete,image set --tag ,Delete the tag associated with the given image. -image-tag-update,image unset --tag ,Update an image with the given tag. -image-update,image set,Update an existing image. -image-upload,,Upload data for a specific image. -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. -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. -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. \ No newline at end of file diff --git a/doc/source/cli/data/keystone.csv b/doc/source/cli/data/keystone.csv deleted file mode 100644 index 03c34704..00000000 --- a/doc/source/cli/data/keystone.csv +++ /dev/null @@ -1,37 +0,0 @@ -catalog,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,proejct 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. diff --git a/doc/source/cli/data/neutron.csv b/doc/source/cli/data/neutron.csv deleted file mode 100644 index a276cf89..00000000 --- a/doc/source/cli/data/neutron.csv +++ /dev/null @@ -1,244 +0,0 @@ -address-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,,List Dynamic Routing agents hosting a BGP speaker. -bgp-dragent-speaker-add,,Add a BGP speaker to a Dynamic Routing agent. -bgp-dragent-speaker-remove,,Removes a BGP speaker from a Dynamic Routing agent. -bgp-peer-create,,Create a BGP Peer. -bgp-peer-delete,,Delete a BGP peer. -bgp-peer-list,,List BGP peers. -bgp-peer-show,,Show information of a given BGP peer. -bgp-peer-update,,Update BGP Peer's information. -bgp-speaker-advertiseroute-list,,List routes advertised by a given BGP speaker. -bgp-speaker-create,,Create a BGP Speaker. -bgp-speaker-delete,,Delete a BGP speaker. -bgp-speaker-list,,List BGP speakers. -bgp-speaker-list-on-dragent,,List BGP speakers hosted by a Dynamic Routing agent. -bgp-speaker-network-add,,Add a network to the BGP speaker. -bgp-speaker-network-remove,,Remove a network from the BGP speaker. -bgp-speaker-peer-add,,Add a peer to the BGP speaker. -bgp-speaker-peer-remove,,Remove a peer from the BGP speaker. -bgp-speaker-show,,Show information of a given BGP speaker. -bgp-speaker-update,,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. -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,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,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,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. -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 -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. diff --git a/doc/source/cli/data/nova.csv b/doc/source/cli/data/nova.csv deleted file mode 100644 index 74f76c77..00000000 --- a/doc/source/cli/data/nova.csv +++ /dev/null @@ -1,140 +0,0 @@ -add-fixed-ip,server add fixed ip,Add new IP address on a network to server. -add-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-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. -cell-capacities,,Get cell capacities for all cells or a given cell. -cell-show,,Show details of a given cell. -clear-password,server set --root-password,Clear the admin password for a server from the metadata server. -cloudpipe-configure,WONTFIX,Update the VPN IP/port of a cloudpipe instance. -cloudpipe-create,WONTFIX,Create a cloudpipe instance for the given project. -cloudpipe-list,WONTFIX,Print a list of all cloudpipe instances. -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,,Evacuate server from failed host. -flavor-access-add,,Add flavor access for the given tenant. -flavor-access-list,,Print access information about the given flavor. -flavor-access-remove,,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,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. -floating-ip-associate,server add floating ip,Associate a floating IP address to a server. -floating-ip-disassociate,server remove floating ip,Disassociate a floating IP address from a server. -force-delete,server delete,Force delete a server. -get-mks-console,console url show --mks,Get an MKS console to a server. -get-password,WONTFIX,Get the admin password for a server. -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 | --xvpvnc,Get a vnc console to a server. -host-action,,Perform a power action on a host. -host-describe,host show,Describe a specific host. -host-evacuate,,Evacuate all instances from failed host. -host-evacuate-live,,Live migrate all instances of the specified host to other available hosts. -host-list,host list,List all hosts by service. -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. -host-update,host set,Update host settings. -hypervisor-list,hypervisor list,List hypervisors. -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,,Show an action. -instance-action-list,,List actions on a server. -interface-attach,,Attach a network interface to a server. -interface-detach,,Detach a network interface from a server. -interface-list,,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-extensions,extension list,List all the os-api extensions that are available. -list-secgroup,security group list,List Security Group(s) of a server. -live-migration,,Migrate running server to a new machine. -live-migration-abort,,Abort an on-going live migration. -live-migration-force-comp,,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,,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-fixed-ip,server remove fixed ip,Remove an IP address from a server. -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,,Get the migrations list of specified server. -server-migration-show,,Get the migration of specified server. -server-tag-add,,Add one or more tags to a server. -server-tag-delete,,Delete one or more tags from a server. -server-tag-delete-all,,Delete all tags from a server. -server-tag-list,,Get list of tags from a server. -server-tag-set,,Set list of tags to a server. -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,,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. -virtual-interface-list,,Show virtual interface info about the given server. -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. -x509-create-cert,WONTFIX,Create x509 cert for a user in tenant. -x509-get-root-cert,WONTFIX,Fetch the x509 root cert. -bash-completion,complete,Prints all of the commands and options to -help,help,Display help about this program or one of its subcommands. \ No newline at end of file diff --git a/doc/source/cli/data/swift.csv b/doc/source/cli/data/swift.csv deleted file mode 100644 index 68147412..00000000 --- a/doc/source/cli/data/swift.csv +++ /dev/null @@ -1,10 +0,0 @@ -delete,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. diff --git a/doc/source/cli/decoder.rst b/doc/source/cli/decoder.rst deleted file mode 100644 index 16810a4c..00000000 --- a/doc/source/cli/decoder.rst +++ /dev/null @@ -1,56 +0,0 @@ -============= -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 diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst deleted file mode 100644 index e9aab0af..00000000 --- a/doc/source/cli/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -==================== - User Documentation -==================== - -.. toctree:: - :maxdepth: 2 - - Manual Page - command-list - commands - plugin-commands - authentication - interactive - decoder - backwards-incompatible diff --git a/doc/source/cli/interactive.rst b/doc/source/cli/interactive.rst deleted file mode 100644 index 4822d89f..00000000 --- a/doc/source/cli/interactive.rst +++ /dev/null @@ -1,111 +0,0 @@ -================ -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. diff --git a/doc/source/cli/man/openstack.rst b/doc/source/cli/man/openstack.rst deleted file mode 100644 index ab990979..00000000 --- a/doc/source/cli/man/openstack.rst +++ /dev/null @@ -1,509 +0,0 @@ -.. _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 - -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. - -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 - -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:35357/ - project_name: demo - username: demo - password: 0penstack - region_name: RegionOne - ds-admin: - auth: - auth_url: http://192.168.122.10:35357/ - 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 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_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`. - -.. NOTE:: - If you switch to openstackclient from project specified clients, like: - novaclient, neutronclient and so on, please use `OS_INTERFACE` instead of - `OS_ENDPOINT_TYPE`. - -BUGS -==== - -Bug reports are accepted at the python-openstackclient LaunchPad project -"https://bugs.launchpad.net/python-openstackclient/+bugs". - - -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. diff --git a/doc/source/cli/plugin-commands.rst b/doc/source/cli/plugin-commands.rst deleted file mode 100644 index 90c14b87..00000000 --- a/doc/source/cli/plugin-commands.rst +++ /dev/null @@ -1,128 +0,0 @@ -.. _plugin-commands: - -=============== -Plugin Commands -=============== - -.. list-plugins:: openstack.cli.extension - -aodh ----- - -.. list-plugins:: openstack.alarming.v2 - :detailed: - -barbican --------- - -.. list-plugins:: openstack.key_manager.v1 - :detailed: - -congress --------- - -.. list-plugins:: openstack.congressclient.v1 - :detailed: - -.. cue -.. # cueclient is not in global-requirements -.. # list-plugins:: openstack.mb.v1 -.. # :detailed: - -designate ---------- - -.. list-plugins:: openstack.dns.v1 - :detailed: - -gnocchi -------- -.. list-plugins:: openstack.metric.v1 - :detailed: - -heat ----- - -.. list-plugins:: openstack.orchestration.v1 - :detailed: - -ironic ------- - -.. list-plugins:: openstack.baremetal.v1 - :detailed: - -ironic-inspector ----------------- - -.. list-plugins:: openstack.baremetal_introspection.v1 - :detailed: - -.. karbor -.. ------ -.. bug 1705258: Exclude karborclient 0.4.0 until a fixed version is released. -.. .. list-plugins:: openstack.data_protection.v1 -.. :detailed: - -mistral -------- - -.. list-plugins:: openstack.workflow_engine.v2 - :detailed: - -.. murano -.. # the murano docs cause warnings and a broken docs build -.. # .. list-plugins:: openstack.application_catalog.v1 -.. # :detailed: - -neutron -------- - -.. list-plugins:: openstack.neutronclient.v2 - :detailed: - -octavia -------- - -.. list-plugins:: openstack.load_balancer.v2 - :detailed: - -sahara ------- - -.. list-plugins:: openstack.data_processing.v1 - :detailed: - -searchlight ------------ - -.. list-plugins:: openstack.search.v1 - :detailed: - -senlin ------- - -.. list-plugins:: openstack.clustering.v1 - :detailed: - -.. tripleo -.. # tripleoclient is not in global-requirements -.. # list-plugins:: openstack.tripleoclient.v1 -.. # :detailed: - -trove ------- - -.. list-plugins:: openstack.database.v1 - :detailed: - -.. watcher -.. # watcherclient is not in global-requirements -.. # list-plugins:: openstack.infra_optim.v1 -.. # :detailed: - -zaqar ------ - -.. list-plugins:: openstack.messaging.v2 - :detailed: diff --git a/doc/source/conf.py b/doc/source/conf.py deleted file mode 100644 index bd4fa730..00000000 --- a/doc/source/conf.py +++ /dev/null @@ -1,281 +0,0 @@ -# -*- 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. - -import os -import sys - -import pbr.version - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))) - -# -- 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', - ] - -# openstackdocstheme options -repository_name = 'openstack/python-openstackclient' -bug_project = 'python-openstackclient' -bug_tag = '' - -# 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 version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -version_info = pbr.version.VersionInfo('python-openstackclient') -# -# The short X.Y version. -version = version_info.version_string() -# The full version, including alpha/beta/rc tags. -release = version_info.release_string() - -# 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 = 'sphinx' - -# 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 not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' -html_last_updated_fmt = '%Y-%m-%d %H:%M' - -# 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' - - -# -- 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'] diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst deleted file mode 100644 index d2b273d7..00000000 --- a/doc/source/configuration/index.rst +++ /dev/null @@ -1,290 +0,0 @@ -.. _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:35357/ - project_name: demo - username: demo - password: 0penstack - region_name: RegionOne - ds-admin: - auth: - auth_url: http://192.168.122.10:35357/ - 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:35357/ - 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:35357/ - 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:35357/ - 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 diff --git a/doc/source/contributor/command-beta.rst b/doc/source/contributor/command-beta.rst deleted file mode 100644 index 40ede671..00000000 --- a/doc/source/contributor/command-beta.rst +++ /dev/null @@ -1,108 +0,0 @@ -.. _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") - ) diff --git a/doc/source/contributor/command-errors.rst b/doc/source/contributor/command-errors.rst deleted file mode 100644 index c4adb7d1..00000000 --- a/doc/source/contributor/command-errors.rst +++ /dev/null @@ -1,202 +0,0 @@ -============== -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) diff --git a/doc/source/contributor/command-logs.rst b/doc/source/contributor/command-logs.rst deleted file mode 100644 index 62126510..00000000 --- a/doc/source/contributor/command-logs.rst +++ /dev/null @@ -1,73 +0,0 @@ -============ -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: - http://docs.openstack.org/developer/oslo.i18n/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 - - ## ... diff --git a/doc/source/contributor/command-options.rst b/doc/source/contributor/command-options.rst deleted file mode 100644 index 06623445..00000000 --- a/doc/source/contributor/command-options.rst +++ /dev/null @@ -1,312 +0,0 @@ -=============== -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 guildelines 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", - ) diff --git a/doc/source/contributor/command-wrappers.rst b/doc/source/contributor/command-wrappers.rst deleted file mode 100644 index 2a5d9223..00000000 --- a/doc/source/contributor/command-wrappers.rst +++ /dev/null @@ -1,52 +0,0 @@ -====================== -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 ``setuptools`` entry points 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) diff --git a/doc/source/contributor/developing.rst b/doc/source/contributor/developing.rst deleted file mode 100644 index 2981ba4d..00000000 --- a/doc/source/contributor/developing.rst +++ /dev/null @@ -1,209 +0,0 @@ -=============================== -Developing with OpenStackClient -=============================== - -Communication -------------- - -Meetings -======== -The OpenStackClient team meets regularly on every Thursday. For details -please refer to the `OpenStack IRC meetings`_ page. - -.. _`OpenStack IRC meetings`: http://eavesdrop.openstack.org/#OpenStackClient_Team_Meeting - -Testing -------- - -Tox prerequisites and installation -================================== - -Install the prerequisites for Tox: - -* On Ubuntu or Debian: - - .. code-block:: bash - - $ apt-get install gcc gettext python-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 python-devel libxml2-devel libxslt-devel - -* On openSUSE or SUSE linux Enterprise: - - .. code-block:: bash - - $ zypper install gcc python-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 -Python 2.7 and PEP-8), list the environments with the ``-e`` option, separated by spaces: - -.. code-block:: bash - - $ tox -e py27,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 functional.tests.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 -rather than ``py27``. 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 - - -Building the 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 -========================= - -.. _`Import Order Guide`: http://docs.openstack.org/developer/hacking/#imports - -The import order shows below: - -* {{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 mock - import os - - from osc_lib.api import auth - from osc_lib import utils - import six - - from openstackclient import shell - from openstackclient.tests import utils - diff --git a/doc/source/contributor/humaninterfaceguide.rst b/doc/source/contributor/humaninterfaceguide.rst deleted file mode 100644 index a7db3800..00000000 --- a/doc/source/contributor/humaninterfaceguide.rst +++ /dev/null @@ -1,368 +0,0 @@ -.. _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:`--