python-openstackclient/doc/source/command-objects/flavor.rst
Pavlo Shchelokovskyy e637e9c6c8 Fix flavor create help re swap size units
nova actually expects and uses swap size in MB, while in openstackclient
currently help states that swap must be specified in GB and passes this
value to nova without changes.

Fix the help string.

Change-Id: I95f46246c072961ce77f818d80d75e6a51f728d0
Closes-Bug: #1656018
2017-01-12 18:27:14 +02:00

215 lines
4.0 KiB
ReStructuredText

======
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 <marker>]
[--limit <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 <marker>
The last flavor ID of the previous page
.. option:: --limit <limit>
Maximum number of flavors to display
flavor set
----------
Set flavor properties
.. program:: flavor set
.. code:: bash
openstack flavor set
[--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.
.. 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)