summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/flavor.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/flavor.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/flavor.rst')
-rw-r--r--doc/source/cli/command-objects/flavor.rst220
1 files changed, 220 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst
new file mode 100644
index 00000000..6feb4498
--- /dev/null
+++ b/doc/source/cli/command-objects/flavor.rst
@@ -0,0 +1,220 @@
+======
+flavor
+======
+
+Compute v2
+
+flavor create
+-------------
+
+Create new flavor
+
+.. program:: flavor create
+.. code:: bash
+
+ openstack flavor create
+ [--id <id>]
+ [--ram <size-mb>]
+ [--disk <size-gb>]
+ [--ephemeral-disk <size-gb>]
+ [--swap <size-mb>]
+ [--vcpus <num-cpu>]
+ [--rxtx-factor <factor>]
+ [--public | --private]
+ [--property <key=value> [...] ]
+ [--project <project>]
+ [--project-domain <project-domain>]
+ <flavor-name>
+
+.. option:: --id <id>
+
+ Unique flavor ID; 'auto' creates a UUID (default: auto)
+
+.. option:: --ram <size-mb>
+
+ Memory size in MB (default 256M)
+
+.. option:: --disk <size-gb>
+
+ Disk size in GB (default 0G)
+
+.. option:: --ephemeral-disk <size-gb>
+
+ Ephemeral disk size in GB (default 0G)
+
+.. option:: --swap <size-mb>
+
+ Swap space size in MB (default 0M)
+
+.. option:: --vcpus <num-cpu>
+
+ Number of vcpus (default 1)
+
+.. option:: --rxtx-factor <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 <key=value>
+
+ Property to add for this flavor (repeat option to set multiple properties)
+
+.. option:: --project <project>
+
+ Allow <project> to access private flavor (name or ID)
+ (Must be used with :option:`--private` option)
+
+.. option:: --project-domain <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:: <flavor-name>
+
+ New flavor name
+
+flavor delete
+-------------
+
+Delete flavor(s)
+
+.. program:: flavor delete
+.. code:: bash
+
+ openstack flavor delete
+ <flavor> [<flavor> ...]
+
+.. _flavor_delete-flavor:
+.. describe:: <flavor>
+
+ Flavor(s) to delete (name or ID)
+
+flavor list
+-----------
+
+List flavors
+
+.. program:: flavor list
+.. code:: bash
+
+ openstack flavor list
+ [--public | --private | --all]
+ [--long]
+ [--marker <flavor-id>]
+ [--limit <num-flavors>]
+
+.. 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 <flavor-id>
+
+ The last flavor ID of the previous page
+
+.. option:: --limit <num-flavors>
+
+ Maximum number of flavors to display
+
+flavor set
+----------
+
+Set flavor properties
+
+.. program:: flavor set
+.. code:: bash
+
+ openstack flavor set
+ [--no-property]
+ [--property <key=value> [...] ]
+ [--project <project>]
+ [--project-domain <project-domain>]
+ <flavor>
+
+.. option:: --property <key=value>
+
+ Property to add or modify for this flavor (repeat option to set multiple properties)
+
+.. option:: --project <project>
+
+ Set flavor access to project (name or ID) (admin only)
+
+.. option:: --project-domain <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>
+
+ Flavor to modify (name or ID)
+
+flavor show
+-----------
+
+Display flavor details
+
+.. program:: flavor show
+.. code:: bash
+
+ openstack flavor show
+ <flavor>
+
+.. _flavor_show-flavor:
+.. describe:: <flavor>
+
+ Flavor to display (name or ID)
+
+flavor unset
+------------
+
+Unset flavor properties
+
+.. program:: flavor unset
+.. code:: bash
+
+ openstack flavor unset
+ [--property <key> [...] ]
+ [--project <project>]
+ [--project-domain <project-domain>]
+ <flavor>
+
+.. option:: --property <key>
+
+ Property to remove from flavor (repeat option to remove multiple properties)
+
+.. option:: --project <project>
+
+ Remove flavor access from project (name or ID) (admin only)
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID).
+ This can be used in case collisions between project names exist.
+
+.. describe:: <flavor>
+
+ Flavor to modify (name or ID)