python-openstackclient/doc/source/command-objects/flavor.rst
Dean Troyer 1686dc54f0 Help/docs cleanups: marker, limit, ip-address metavars
Cleanup help strings and docs for clarity and to keep things consistent:
* --limit metavar should be <num-resource> to indicate what is being counted
* --marker metavar should be <resource> or <resource-id> to indicate the
  type of value being specified
* <*-ip-address> metavars should be just <ip-address> as there is no difference
  in format between fixed and floating IPs
* Move all occurances of '(name or ID)' to end of help text

Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
2017-04-04 03:56:19 +00:00

221 lines
4.2 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 <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)