+python-openstackclient (1.0.2-1) experimental; urgency=medium

+

+ * New upstream release.

+

+ -- gustavo panizzo <gfa@zumbi.com.ar> Tue, 27 Jan 2015 13:50:06 +0800

+

+ python-glanceclient (>= 1:0.15.0),

+ python-oslo.config (>= 1.6.0),

+ python-glanceclient (>= 1:0.15.0),

+ python-oslo.config (>= 1.6.0),

+Description: Allow python-oslo.serialization older than 1.2.0

+ We have an older version than 1.2.0 on Debian. That's the reason for this change.

+ Same applies to python-oslo.utils.

+ .

+Author: gustavo panizzo <gfa@zumbi.com.ar>

+

+---

+Origin: vendor

+Forwarded: not-needed

+Reviewed-By: gustavo panizzo <gfa@zumbi.com.ar>

+Last-Update: <2015-01-27>

+

+--- a/requirements.txt

++++ b/requirements.txt

+@@ -9,8 +9,8 @@

+ cliff-tablib>=1.0

+ oslo.config>=1.6.0 # Apache-2.0

+ oslo.i18n>=1.0.0 # Apache-2.0

+-oslo.utils>=1.2.0 # Apache-2.0

+-oslo.serialization>=1.2.0 # Apache-2.0

++oslo.utils>=1.0.0 # Apache-2.0

++oslo.serialization>=1.0.0 # Apache-2.0

+ python-glanceclient>=0.15.0

+ python-keystoneclient>=0.11.1

+ python-novaclient>=2.18.0

+003-python-oslo-libs-requirements.patch

+@@ -17,4 +17,4 @@

+============

+access token

+============

+

+Identity v3

+

+`Requires: OS-OAUTH1 extension`

+

+access token create

+-------------------

+

+Create an access token

+

+.. program:: access token create

+.. code:: bash

+

+ os access token create

+ --consumer-key <consumer-key>

+ --consumer-secret <consumer-secret>

+ --request-key <request-key>

+ --request-secret <request-secret>

+ --verifier <verifier>

+

+.. option:: --consumer-key <consumer-key>

+

+ Consumer key (required)

+

+.. option:: --consumer-secret <consumer-secret>

+

+ Consumer secret (required)

+

+.. option:: --request-key <request-key>

+

+ Request token to exchange for access token (required)

+

+.. option:: --request-secret <request-secret>

+

+ Secret associated with <request-key> (required)

+

+.. option:: --verifier <verifier>

+

+ Verifier associated with <request-key> (required)

+Compute v2

+

+.. program:: aggregate add host

+.. program:: aggregate create

+.. program:: aggregate delete

+.. program:: aggregate list

+.. program:: aggregate remove host

+.. describe:: <host>

+.. program:: aggregate set

+Display aggregate details

+.. program:: aggregate show

+ Aggregate to display (name or ID)

+=================

+availability zone

+=================

+

+Compute v2

+

+availability zone list

+----------------------

+

+List availability zones and their status

+

+.. program availability zone list

+.. code:: bash

+

+ os availability zone list

+ [--long]

+

+.. option:: --long

+

+ List additional fields in output

+======

+backup

+======

+

+Volume v1

+

+backup create

+-------------

+

+Create new backup

+

+.. program:: backup create

+.. code:: bash

+

+ os backup create

+ [--container <container>]

+ [--name <name>]

+ [--description <description>]

+ <volume>

+

+.. option:: --container <container>

+

+ Optional backup container name

+

+.. option:: --name <name>

+

+ Name of the backup

+

+.. option:: --description <description>

+

+ Description of the backup

+

+.. _backup_create-backup:

+.. describe:: <volume>

+

+ Volume to backup (name or ID)

+

+backup delete

+-------------

+

+Delete backup(s)

+

+.. program:: backup delete

+.. code:: bash

+

+ os backup delete

+ <backup> [<backup> ...]

+

+.. _backup_delete-backup:

+.. describe:: <backup>

+

+ Backup(s) to delete (ID only)

+

+backup list

+-----------

+

+List backups

+

+.. program:: backup list

+.. code:: bash

+

+ os backup list

+

+.. _backup_list-backup:

+.. option:: --long

+

+ List additional fields in output

+

+backup restore

+--------------

+

+Restore backup

+

+.. program:: backup restore

+.. code:: bash

+

+ os backup restore

+ <backup>

+ <volume>

+

+.. _backup_restore-backup:

+.. describe:: <backup>

+

+ Backup to restore (ID only)

+

+.. describe:: <volume>

+

+ Volume to restore to (name or ID)

+

+backup show

+-----------

+

+Display backup details

+

+.. program:: backup show

+.. code:: bash

+

+ os backup show

+ <backup>

+

+.. _backup_show-backup:

+.. describe:: <backup>

+

+ Backup to display (ID only)

+List services in the service catalog

+

+.. program:: catalog list

+Display service catalog details

+

+.. program:: catalog show

+

+.. describe:: <service>

+

+ Service to display (type or name)

+Compute v2

+

+Compute v2

+

+========

+consumer

+========

+

+Identity v3

+

+`Requires: OS-OAUTH1 extension`

+

+consumer create

+---------------

+

+Create new consumer

+

+.. program:: consumer create

+.. code:: bash

+

+ os consumer create

+ [--description <description>]

+

+.. option:: --description <description>

+

+ New consumer description

+

+consumer delete

+---------------

+

+Delete consumer

+

+.. program:: consumer delete

+.. code:: bash

+

+ os consumer delete

+ <consumer>

+

+.. describe:: <consumer>

+

+ Consumer to delete

+

+consumer list

+-------------

+

+List consumers

+

+.. program:: consumer list

+.. code:: bash

+

+ os consumer list

+

+consumer set

+------------

+

+Set consumer properties

+

+.. program:: consumer set

+.. code:: bash

+

+ os consumer set

+ [--description <description>]

+ <consumer>

+

+.. option:: --description <description>

+

+ New consumer description

+

+.. describe:: <consumer>

+

+ Consumer to modify

+

+consumer show

+-------------

+

+Display consumer details

+

+.. program:: consumer show

+.. code:: bash

+

+ os consumer show

+ <consumer>

+

+.. _consumer_show-consumer:

+.. describe:: <consumer>

+

+ Consumer to display

+=========

+container

+=========

+

+Object Store v1

+

+container create

+----------------

+

+Create new container

+

+.. program:: container create

+.. code:: bash

+

+ os container create

+ <container-name> [<container-name> ...]

+

+.. describe:: <container-name>

+

+ New container name(s)

+

+container delete

+----------------

+

+Delete container

+

+.. program:: container delete

+.. code:: bash

+

+ os container delete

+ <container> [<container> ...]

+

+.. describe:: <container>

+

+ Container(s) to delete

+

+container list

+--------------

+

+List containers

+

+.. program:: container list

+.. code::bash

+

+ os container list

+ [--prefix <prefix>]

+ [--marker <marker>]

+ [--end-marker <end-marker>]

+ [--limit <limit>]

+ [--long]

+ [--all]

+

+.. option:: --prefix <prefix>

+

+ Filter list using <prefix>

+

+.. option:: --marker <marker>

+

+ Anchor for paging

+

+.. option:: --end-marker <end-marker>

+

+ End anchor for paging

+

+.. option:: --limit <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

+

+ os container save

+ <container>

+

+.. describe:: <container>

+

+ Container to save

+

+container show

+--------------

+

+Display container details

+

+.. program:: container show

+.. code:: bash

+

+ os container show

+ [<container>]

+

+.. describe:: <container>

+

+ Container to display

+Identity v3

+

+======

+domain

+======

+

+Identity v3

+

+domain create

+-------------

+

+Create new domain

+

+.. program:: domain create

+.. code:: bash

+

+ os domain create

+ [--description <description>]

+ [--enable | --disable]

+ [--or-show]

+ <domain-name>

+

+.. option:: --description <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:: <domain-name>

+

+ New domain name

+

+domain delete

+-------------

+

+Delete domain

+

+.. program:: domain delete

+.. code:: bash

+

+ os domain delete

+ <domain>

+

+.. describe:: <domain>

+

+ Domain to delete (name or ID)

+

+domain list

+-----------

+

+List domains

+

+.. program:: domain list

+.. code:: bash

+

+ os domain list

+

+domain set

+----------

+

+Set domain properties

+

+.. program:: domain set

+.. code:: bash

+

+ os domain set

+ [--name <name>]

+ [--description <description>]

+ [--enable | --disable]

+ <domain>

+

+.. option:: --name <name>

+

+ New domain name

+

+.. option:: --description <description>

+

+ New domain description

+

+.. option:: --enable

+

+ Enable domain

+

+.. option:: --disable

+

+ Disable domain

+

+.. describe:: <domain>

+

+ Domain to modify (name or ID)

+

+domain show

+-----------

+

+Display domain details

+

+.. program:: domain show

+.. code:: bash

+

+ os domain show

+ <domain>

+

+.. describe:: <domain>

+

+ Domain to display (name or ID)

+===============

+ec2 credentials

+===============

+

+Identity v2

+

+ec2 credentials create

+----------------------

+

+Create EC2 credentials

+

+.. program:: ec2 credentials create

+.. code-block:: bash

+

+ os ec2 credentials create

+ [--project <project>]

+ [--user <user>]

+

+.. option:: --project <project>

+

+ Specify an alternate project (default: current authenticated project)

+

+.. option:: --user <user>

+

+ Specify an alternate user (default: current authenticated user)

+

+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

+

+ os ec2 credentials delete

+ [--user <user>]

+ <access-key>

+

+.. option:: --user <user>

+

+ Specify a user

+

+.. _ec2_credentials_delete-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.

+

+ec2 credentials list

+--------------------

+

+List EC2 credentials

+

+.. program:: ec2 credentials list

+.. code-block:: bash

+

+ os ec2 credentials list

+ [--user <user>]

+

+.. option:: --user <user>

+

+ Filter list by <user>

+

+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

+

+ os ec2 credentials show

+ [--user <user>]

+ <access-key>

+

+.. option:: --user <user>

+

+ Specify a user

+

+.. _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.

+Create new endpoint

+

+*Identity version 2 only*

+

+.. program:: endpoint create

+.. code:: bash

+

+ os endpoint create

+ --publicurl <url>

+ [--adminurl <url>]

+ [--internalurl <url>]

+ [--region <region-id>]

+ <service>

+

+.. option:: --publicurl <url>

+

+ New endpoint public URL (required)

+

+.. option:: --adminurl <url>

+

+ New endpoint admin URL

+

+.. option:: --internalurl <url>

+

+ New endpoint internal URL

+

+.. option:: --region <region-id>

+

+ New endpoint region ID

+

+.. _endpoint_create-endpoint:

+.. describe:: <service>

+

+ New endpoint service (name or ID)

+

+*Identity version 3 only*

+

+ [--region <region-id>

+ [--enable | --disable]

+ <interface>

+ <url>

+

+.. option:: --region <region-id>

+

+ New endpoint region ID

+

+.. option:: --enable

+

+ Enable endpoint (default)

+

+.. option:: --disable

+

+ Disable endpoint

+

+.. describe:: <service>

+

+ New endpoint service (name or ID)

+

+.. describe:: <interface>

+

+ New endpoint interface type (admin, public or internal)

+

+.. describe:: <url>

+

+ New endpoint URL

+Delete endpoint

+

+.. _endpoint_delete-endpoint:

+.. describe:: <endpoint-id>

+

+ Endpoint ID to delete

+

+List endpoints

+

+ [--service <service]

+ [--interface <interface>]

+ [--region <region-id>]

+.. option:: --service <service>

+

+ Filter by service

+

+ *Identity version 3 only*

+

+.. option:: --interface <interface>

+

+ Filter by interface type (admin, public or internal)

+

+ *Identity version 3 only*

+

+.. option:: --region <region-id>

+

+ 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

+

+ os endpoint set

+ [--region <region-id>]

+ [--interface <interface>]

+ [--url <url>]

+ [--service <service>]

+ [--enable | --disable]

+ <endpoint-id>

+

+.. option:: --region <region-id>

+

+ New endpoint region ID

+

+.. option:: --interface <interface>

+

+ New endpoint interface type (admin, public or internal)

+

+.. option:: --url <url>

+

+ New endpoint URL

+

+.. option:: --service <service>

+

+ New endpoint service (name or ID)

+

+.. option:: --enable

+

+ Enable endpoint

+

+.. option:: --disable

+

+ Disable endpoint

+

+.. _endpoint_set-endpoint:

+.. describe:: <endpoint-id>

+

+ Endpoint ID to modify

+

+Display endpoint details

+

+ <endpoint-id>

+

+.. _endpoint_show-endpoint:

+.. describe:: <endpoint-id>

+

+ Endpoint ID to display

+===================

+federation protocol

+===================

+

+Identity v3

+

+`Requires: OS-FEDERATION extension`

+

+federation protocol create

+--------------------------

+

+Create new federation protocol

+

+.. program:: federation protocol create

+.. code:: bash

+

+ os federation protocol create

+ --identity-provider <identity-provider>

+ --mapping <mapping>

+ <name>

+

+.. option:: --identity-provider <identity-provider>

+

+ Identity provider that will support the new federation protocol (name or ID) (required)

+

+.. option:: --mapping <mapping>

+

+ Mapping that is to be used (name or ID) (required)

+

+.. describe:: <name>

+

+ New federation protocol name (must be unique per identity provider)

+

+federation protocol delete

+--------------------------

+

+Delete federation protocol

+

+.. program:: federation protocol delete

+.. code:: bash

+

+ os federation protocol delete

+ --identity-provider <identity-provider>

+ <federation-protocol>

+

+.. option:: --identity-provider <identity-provider>

+

+ Identity provider that supports <federation-protocol> (name or ID) (required)

+

+.. describe:: <federation-protocol>

+

+ Federation protocol to delete (name or ID)

+

+federation protocol list

+------------------------

+

+List federation protocols

+

+.. program:: federation protocol list

+.. code:: bash

+

+ os federation protocol list

+ --identity-provider <identity-provider>

+

+.. option:: --identity-provider <identity-provider>

+

+ Identity provider to list (name or ID) (required)

+

+federation protocol set

+-----------------------

+

+Set federation protocol properties

+

+.. program:: federation protocol set

+.. code:: bash

+

+ os federation protocol set

+ --identity-provider <identity-provider>

+ [--mapping <mapping>]

+ <federation-protocol>

+

+.. option:: --identity-provider <identity-provider>

+

+ Identity provider that supports <federation-protocol> (name or ID) (required)

+

+.. option:: --mapping <mapping>

+

+ Mapping that is to be used (name or ID)

+

+.. describe:: <federation-protocol>

+

+ Federation protocol to modify (name or ID)

+

+federation protocol show

+------------------------

+

+Display federation protocol details

+

+.. program:: federation protocol show

+.. code:: bash

+

+ os federation protocol show

+ --identity-provider <identity-provider>

+ <federation-protocol>

+

+.. option:: --identity-provider <identity-provider>

+

+ Identity provider that supports <federation-protocol> (name or ID) (required)

+

+.. describe:: <federation-protocol>

+

+ Federation protocol to display (name or ID)

+======

+flavor

+======

+

+Compute v2

+

+flavor create

+-------------

+

+Create new flavor

+

+.. program:: flavor create

+.. code:: bash

+

+ os 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]

+ <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-gb>

+

+ Swap space size in GB (default 0G)

+

+.. option:: --vcpus <num-cpu>

+

+ Number of vcpus (default 1)

+

+.. option:: --rxtx-factor <factor>

+

+ RX/TX factor (default 1)

+

+.. option:: --public

+

+ Flavor is available to other projects (default)

+

+.. option:: --private

+

+ Flavor is not available to other projects

+

+.. _flavor_create-flavor-name:

+.. describe:: <flavor-name>

+

+ New flavor name

+

+flavor delete

+-------------

+

+Delete flavor

+

+.. program:: flavor delete

+.. code:: bash

+

+ os flavor delete

+ <flavor>

+

+.. _flavor_delete-flavor:

+.. describe:: <flavor>

+

+ Flavor to delete (name or ID)

+

+flavor list

+-----------

+

+List flavors

+

+.. program:: flavor list

+.. code:: bash

+

+ os flavor list

+

+flavor show

+-----------

+

+Display flavor details

+

+.. program:: flavor show

+.. code:: bash

+

+ os flavor show

+ <flavor>

+

+.. _flavor_show-flavor:

+.. describe:: <flavor>

+

+ Flavor to display (name or ID)

+=====

+group

+=====

+

+Identity v3

+

+group add user

+--------------

+

+Add user to group

+

+.. program:: group add user

+.. code:: bash

+

+ os group add user

+ <group>

+ <user>

+

+.. describe:: <group>

+

+ Group to contain <user> (name or ID)

+

+.. describe:: <user>

+

+ User to add to <group> (name or ID)

+

+group contains user

+-------------------

+

+Check user membership in group

+

+.. program:: group contains user

+.. code:: bash

+

+ os group contains user

+ <group>

+ <user>

+

+.. describe:: <group>

+

+ Group to check (name or ID)

+

+.. describe:: <user>

+

+ User to check (name or ID)

+

+group create

+------------

+

+Create new group

+

+.. program:: group create

+.. code:: bash

+

+ os group create

+ [--domain <domain>]

+ [--description <description>]

+ [--or-show]

+ <group-name>

+

+.. option:: --domain <domain>

+

+ Domain to contain new group (name or ID)

+

+.. option:: --description <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:: <group-name>

+

+ New group name

+

+group delete

+------------

+

+Delete group

+

+.. program:: group delete

+.. code:: bash

+

+ os group delete

+ [--domain <domain>]

+ <group> [<group> ...]

+

+.. option:: --domain <domain>

+

+ Domain containing group(s) (name or ID)

+

+.. describe:: <group>

+

+ Group(s) to delete (name or ID)

+

+group list

+----------

+

+List groups

+

+.. program:: group list

+.. code:: bash

+

+ os group list

+ [--domain <domain>]

+ [--user <user>]

+ [--long]

+

+.. option:: --domain <domain>

+

+ Filter group list by <domain> (name or ID)

+

+.. option:: --user <user>

+

+ Filter group list by <user> (name or ID)

+

+.. option:: --long

+

+ List additional fields in output

+

+group remove user

+-----------------

+

+Remove user from group

+

+.. program:: group remove user

+.. code:: bash

+

+ os group remove user

+ <group>

+ <user>

+

+.. describe:: <group>

+

+ Group containing <user> (name or ID)

+

+.. describe:: <user>

+

+ User to remove from <group> (name or ID)

+

+group set

+---------

+

+Set group properties

+

+.. program:: group set

+.. code:: bash

+

+ os group set

+ [--name <name>]

+ [--domain <domain>]

+ [--description <description>]

+ <group>

+

+.. option:: --name <name>

+

+ New group name

+

+.. option:: --domain <domain>

+

+ New domain to contain <group> (name or ID)

+

+.. option:: --description <description>

+

+ New group description

+

+.. describe:: <group>

+

+ Group to modify (name or ID)

+

+group show

+----------

+

+Display group details

+

+.. program:: group show

+.. code:: bash

+

+ os group show

+ [--domain <domain>]

+ <group>

+

+.. option:: --domain <domain>

+

+ Domain containing <group> (name or ID)

+

+.. describe:: <group>

+

+ Group to display (name or ID)

+=================

+identity provider

+=================

+

+Identity v3

+

+`Requires: OS-FEDERATION extension`

+

+identity provider create

+------------------------

+

+Create new identity provider

+

+.. program:: identity provider create

+.. code:: bash

+

+ os identity provider create

+ [--description <description>]

+ [--enable | --disable]

+ <name>

+

+.. option:: --description

+

+ New identity provider description

+

+.. option:: --enable

+

+ Enable the identity provider (default)

+

+.. option:: --disable

+

+ Disable the identity provider

+

+.. describe:: <name>

+

+ New identity provider name (must be unique)

+

+identity provider delete

+------------------------

+

+Delete identity provider

+

+.. program:: identity provider delete

+.. code:: bash

+

+ os identity provider delete

+ <identity-provider>

+

+.. describe:: <identity-provider>

+

+ Identity provider to delete

+

+identity provider list

+----------------------

+

+List identity providers

+

+.. program:: identity provider list

+.. code:: bash

+

+ os identity provider list

+

+identity provider set

+---------------------

+

+Set identity provider properties

+

+.. program:: identity provider set

+.. code:: bash

+

+ os identity provider set

+ [--enable | --disable]

+ <identity-provider>

+

+.. option:: --enable

+

+ Enable the identity provider

+

+.. option:: --disable

+

+ Disable the identity provider

+

+.. describe:: <identity-provider>

+

+ Identity provider to modify

+

+identity provider show

+----------------------

+

+Display identity provider details

+

+.. program:: identity provider show

+.. code:: bash

+

+ os identity provider show

+ <identity-provider>

+

+.. describe:: <identity-provider>

+

+ Identity provider to display

+======

+image

+======

+

+Image v1, v2

+

+image create

+------------

+

+*Only supported for Image v1*

+

+Create/upload an image

+

+.. program:: image create

+.. code:: bash

+

+ os image create

+ [--id <id>]

+ [--store <store>]

+ [--container-format <container-format>]

+ [--disk-format <disk-format>]

+ [--owner <project>]

+ [--size <size>]

+ [--min-disk <disk-gb>]

+ [--min-ram <ram-mb>]

+ [--location <image-url>]

+ [--copy-from <image-url>]

+ [--file <file>]

+ [--volume <volume>]

+ [--force]

+ [--checksum <checksum>]

+ [--protected | --unprotected]

+ [--public | --private]

+ [--property <key=value> [...] ]

+ <image-name>

+

+.. option:: --id <id>

+

+ Image ID to reserve

+

+.. option:: --store <store>

+

+ Upload image to this store

+

+.. option:: --container-format <container-format>

+

+ Image container format (default: bare)

+

+.. option:: --disk-format <disk-format>

+

+ Image disk format (default: raw)

+

+.. option:: --owner <project>

+

+ Image owner project name or ID

+

+.. option:: --size <size>

+

+ Image size, in bytes (only used with --location and --copy-from)

+

+.. option:: --min-disk <disk-gb>

+

+ Minimum disk size needed to boot image, in gigabytes

+

+.. option:: --min-ram <disk-ram>

+

+ Minimum RAM size needed to boot image, in megabytes

+

+.. option:: --location <image-url>

+

+ Download image from an existing URL

+

+.. option:: --copy-from <image-url>

+

+ Copy image from the data store (similar to --location)

+

+.. option:: --file <file>

+

+ Upload image from local file

+

+.. option:: --volume <volume>

+

+ Create image from a volume

+

+.. option:: --force

+

+ Force image creation if volume is in use (only meaningful with --volume)

+

+.. option:: --checksum <checksum>

+

+ Image hash used for verification

+

+.. 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:: --property <key=value>

+

+ Set a property on this image (repeat for multiple values)

+

+.. describe:: <image-name>

+

+ New image name

+

+image delete

+------------

+

+Delete image(s)

+

+.. program:: image delete

+.. code:: bash

+

+ os image delete

+ <image>

+

+.. describe:: <image>

+

+ Image(s) to delete (name or ID)

+

+image list

+----------

+

+List available images

+

+.. program:: image list

+.. code:: bash

+

+ os image list

+ [--page-size <size>]

+ [--long]

+

+.. option:: --page-size <size>

+

+ Number of images to request in each paginated request

+

+.. option:: --long

+

+ List additional fields in output

+

+image save

+----------

+

+Save an image locally

+

+.. program:: image save

+.. code:: bash

+

+ os image save

+ --file <filename>

+ <image>

+

+.. option:: --file <filename>

+

+ Downloaded image save filename (default: stdout)

+

+.. describe:: <image>

+

+ Image to save (name or ID)

+

+image set

+---------

+

+*Only supported for Image v1*

+

+Set image properties

+

+.. program:: image set

+.. code:: bash

+

+ os image set

+ [--name <name>]

+ [--owner <project>]

+ [--min-disk <disk-gb>]

+ [--min-ram <disk-ram>]

+ [--protected | --unprotected]

+ [--public | --private]

+ [--property <key=value> [...] ]

+ <image>

+

+.. option:: --name <name>

+

+ New image name

+

+.. option:: --owner <project>

+

+ New image owner project (name or ID)

+

+.. option:: --min-disk <disk-gb>

+

+ Minimum disk size needed to boot image, in gigabytes

+

+.. option:: --min-ram <disk-ram>

+

+ Minimum RAM size needed to boot image, in megabytes

+

+.. 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:: --property <key=value>

+

+ Set a property on this image (repeat for multiple values)

+

+.. describe:: <image>

+

+ Image to modify (name or ID)

+

+image show

+----------

+

+Display image details

+

+.. program:: image show

+.. code:: bash

+

+ os image show

+ <image>

+

+.. describe:: <image>

+

+ Image to display (name or ID)

+Compute v2

+

+Delete public key

+Display public key details

+ Public key to display

+Compute v2, Volume v1

+

+=======

+mapping

+=======

+

+Identity v3

+

+`Requires: OS-FEDERATION extension`

+

+mapping create

+--------------

+

+Create new mapping

+

+.. program:: mapping create

+.. code:: bash

+

+ os mapping create

+ --rules <filename>

+ <name>

+

+.. option:: --rules <filename>

+

+ Filename that contains a set of mapping rules (required)

+

+.. _mapping_create-mapping:

+.. describe:: <name>

+

+ New mapping name (must be unique)

+

+mapping delete

+--------------

+

+Delete mapping

+

+.. program:: mapping delete

+.. code:: bash

+

+ os mapping delete

+ <mapping>

+

+.. _mapping_delete-mapping:

+.. describe:: <mapping>

+

+ Mapping to delete

+

+mapping list

+------------

+

+List mappings

+

+.. program:: mapping list

+.. code:: bash

+

+ os mapping list

+

+mapping set

+-----------

+

+Set mapping properties

+

+.. program:: mapping set

+.. code:: bash

+

+ os mapping set

+ [--rules <filename>]

+ <mapping>

+

+.. option:: --rules <filename>

+

+ Filename that contains a new set of mapping rules

+

+.. _mapping_set-mapping:

+.. describe:: <mapping>

+

+ Mapping to modify

+

+mapping show

+------------

+

+Display mapping details

+

+.. program:: mapping show

+.. code:: bash

+

+ os mapping show

+ <mapping>

+

+.. _mapping_show-mapping:

+.. describe:: <mapping>

+

+ Mapping to display

+======

+object

+======

+

+Object Store v1

+

+object create

+-------------

+

+Upload object to container

+

+.. program:: object create

+.. code:: bash

+

+ os object create

+ <container>

+ <filename> [<filename> ...]

+

+.. describe:: <container>

+

+ Container for new object

+

+.. describe:: <filename>

+

+ Local filename(s) to upload

+

+object delete

+-------------

+

+Delete object from container

+

+.. program:: object delete

+.. code:: bash

+

+ os object delete

+ <container>

+ <object> [<object> ...]

+

+.. describe:: <container>

+

+ Delete object(s) from <container>

+

+.. describe:: <object>

+

+ Object(s) to delete

+

+list object

+-----------

+

+List objects

+

+.. program object list

+.. code:: bash

+

+ os object list

+ [--prefix <prefix>]

+ [--delimiter <delimiter>]

+ [--marker <marker>]

+ [--end-marker <end-marker>]

+ [--limit <limit>]

+ [--long]

+ [--all]

+ <container>]

+

+.. option:: --prefix <prefix>

+

+ Filter list using <prefix>

+

+.. option:: --delimiter <delimiter>

+

+ Roll up items with <delimiter>

+

+.. option:: --marker <marker>

+

+ Anchor for paging

+

+.. option:: --end-marker <end-marker>

+

+ End anchor for paging

+

+.. option:: --limit <limit>

+

+ Limit number of objects returned

+

+.. option:: --long

+

+ List additional fields in output

+

+.. option:: --all

+

+ List all objects in <container> (default is 10000)

+

+.. describe:: <container>

+

+ Container to list

+

+object save

+-----------

+

+Save object locally

+

+.. program:: object save

+.. code:: bash

+

+ os object save

+ [--file <filename>]

+ [<container>]

+ [<object>]

+

+.. option:: --file <filename>

+

+ Destination filename (defaults to object name)

+

+.. describe:: <container>

+

+ Download <object> from <container>

+

+.. describe:: <object>

+

+ Object to save

+

+object show

+-----------

+

+Display object details

+

+.. program:: object show

+.. code:: bash

+

+ os object show

+ <container>

+ <object>

+

+.. describe:: <container>

+

+ Display <object> from <container>

+

+.. describe:: <object>

+

+ Object to display

+======

+policy

+======

+

+Identity v3

+

+policy create

+-------------

+

+Create new policy

+

+.. program:: policy create

+.. code:: bash

+

+ os policy create

+ [--type <type>]

+ <filename>

+

+.. option:: --type <type>

+

+ New MIME type of the policy rules file (defaults to application/json)

+

+.. describe:: <filename>

+

+ New serialized policy rules file

+

+policy delete

+-------------

+

+Delete policy

+

+.. program:: policy delete

+.. code:: bash

+

+ os policy delete

+ <policy>

+

+.. describe:: <policy>

+

+ Policy to delete

+

+policy list

+-----------

+

+List policies

+

+.. program:: policy list

+.. code:: bash

+

+ os policy list

+ [--long]

+

+.. option:: --long

+

+ List additional fields in output

+

+policy set

+----------

+

+Set policy properties

+

+.. program:: policy set

+.. code:: bash

+

+ os policy set

+ [--type <type>]

+ [--rules <filename>]

+ <policy>

+

+.. option:: --type <type>

+

+ New MIME type of the policy rules file

+

+.. describe:: --rules <filename>

+

+ New serialized policy rules file

+

+.. describe:: <policy>

+

+ Policy to modify

+

+policy show

+-----------

+

+Display policy details

+

+.. program:: policy show

+.. code:: bash

+

+ os policy show

+ <policy>

+

+.. describe:: <policy>

+

+ Policy to display

+Delete project(s)

+ <project> [<project> ...]

+Display project details

+

+ Project to display (name or ID)

+Compute v2, Volume v1

+

+.. program:: region create

+ [--description <description>]

+ [--url <url>]

+.. option:: --parent-region <region-id>

+

+ Parent region ID

+

+.. option:: --description <description>

+.. option:: --url <url>

+

+.. _region_create-region-id:

+.. describe:: <region-id>

+

+.. program:: region delete

+ <region-id>

+

+.. _region_delete-region-id:

+.. describe:: <region-id>

+ Region ID to delete

+.. program:: region list

+.. option:: --parent-region <region-id>

+

+ Filter by parent region ID

+.. program:: region set

+ [--description <description>]

+ [--url <url>]

+ <region-id>

+

+.. option:: --parent-region <region-id>

+ New parent region ID

+

+.. option:: --description <description>

+.. option:: --url <url>

+

+.. _region_set-region-id:

+.. describe:: <region-id>

+

+ Region to modify

+Display region details

+.. program:: region show

+ <region-id>

+

+.. _region_show-region-id:

+.. describe:: <region-id>

+ Region to display

+=============

+request token

+=============

+

+Identity v3

+

+`Requires: OS-OAUTH1 extension`

+

+request token authorize

+-----------------------

+

+Authorize a request token

+

+.. program:: request token authorize

+.. code:: bash

+

+ os request token authorize

+ --request-key <consumer-key>

+ --role <role>

+

+.. option:: --request-key <request-key>

+

+ Request token to authorize (ID only) (required)

+

+.. option:: --role <role>

+

+ Roles to authorize (name or ID) (repeat to set multiple values) (required)

+

+request token create

+--------------------

+

+Create a request token

+

+.. program:: request token create

+.. code:: bash

+

+ os request token create

+ --consumer-key <consumer-key>

+ --consumer-secret <consumer-secret>

+ --project <project>

+ [--domain <domain>]

+

+.. option:: --consumer-key <consumer-key>

+

+ Consumer key (required)

+

+.. option:: --description <description>

+

+ Consumer secret (required)

+

+.. option:: --project <project>

+

+ Project that consumer wants to access (name or ID) (required)

+

+.. option:: --domain <domain>

+

+ Domain owning <project> (name or ID)

+Delete role(s)

+ <role> [<role> ...]

+.. describe:: <role>

+ Role to remove (name or ID)

+Display role details

+

+ Role to display (name or ID)

+===============

+role assignment

+===============

+

+Identity v3

+

+role assignment list

+--------------------

+

+List role assignments

+

+.. program:: role assignment list

+.. code:: bash

+

+ os role assignment list

+ [--role <role>]

+ [--user <user>]

+ [--group <group>]

+ [--domain <domain>]

+ [--project <project>]

+ [--effective]

+

+.. option:: --role <role>

+

+ Role to filter (name or ID)

+

+.. option:: --user <user>

+

+ User to filter (name or ID)

+

+.. option:: --group <group>

+

+ Group to filter (name or ID)

+

+.. option:: --domain <domain>

+

+ Domain to filter (name or ID)

+

+.. option:: --project <project>

+

+ Project to filter (name or ID)

+

+.. option:: --effective

+

+ Returns only effective role assignments (defaults to False)

+Compute v2

+

+.. program:: server image create

+.. option:: --name <image-name>

+

+.. option:: --wait

+

+.. describe:: <server>

+

+Compute v2

+.. program:: server add security group

+.. describe:: <server>

+

+.. describe:: <group>

+

+.. program:: server add volume

+.. option:: --device <device>

+

+.. describe:: <server>

+

+.. describe:: <volume>

+

+.. program:: server create

+.. option:: --image <image>

+

+.. option:: --volume <volume>

+

+.. option:: --flavor <flavor>

+

+.. option:: --security-group <security-group-name>

+

+.. option:: --key-name <key-name>

+

+.. option:: --property <key=value>

+

+.. option:: --file <dest-filename=source-filename>

+

+.. option:: --user-data <user-data>

+

+.. option:: --availability-zone <zone-name>

+

+.. option:: --block-device-mapping <dev-name=mapping>

+

+.. option:: --nic <nic-config-string>

+

+.. option:: --hint <key=value>

+

+.. option:: --config-drive <config-drive-volume>|True

+

+.. option:: --min <count>

+

+.. option:: --max <count>

+

+.. option:: --wait

+

+.. describe:: <server-name>

+

+Delete server(s)

+.. program:: server delete

+ <server> [<server> ...]

+.. describe:: <server>

+

+ Server to delete (name or ID)

+ [--ip <ip-address-regex>]

+ [--ip6 <ip6-address-regex>]

+.. option:: --reservation-id <reservation-id>

+

+.. option:: --ip <ip-address-regex>

+

+.. option:: --ip6 <ip-address-regex>

+

+.. option:: --name <name-regex>

+

+.. option:: --instance-name <server-name-regex>

+

+.. option:: --status <status>

+

+.. option:: --flavor <flavor>

+

+.. option:: --image <image>

+

+.. option:: --host <hostname>

+

+.. option:: --all-projects

+

+.. option:: --long

+

+.. program:: server lock

+.. describe:: <server>

+

+.. program:: server migrate

+.. option:: --live <hostname>

+.. option:: --shared-migration

+

+.. option:: --block-migration

+

+.. option:: --disk-overcommit

+

+.. option:: --no-disk-overcommit

+

+.. option:: --wait

+

+ Wait for resize to complete

+

+.. describe:: <server>

+

+.. program:: server pause

+.. describe:: <server>

+

+.. program:: server reboot

+.. option:: --hard

+

+.. option:: --soft

+

+.. option:: --wait

+

+.. describe:: <server>

+

+.. program:: server rebuild

+.. option:: --image <image>

+

+.. option:: --password <password>

+

+.. option:: --wait

+

+.. describe:: <server>

+

+.. program:: server remove security group

+.. describe:: <server>

+

+.. describe:: <group>

+

+.. program:: server remove volume

+.. describe:: <server>

+

+.. describe:: <volume>

+

+.. program:: server rescure

+.. describe:: <server>

+

+.. program:: server resize

+.. option:: --flavor <flavor>

+

+.. option:: --verify

+

+.. option:: --revert

+

+.. option:: --wait

+

+.. describe:: <server>

+

+.. program:: server resume

+.. describe:: <server>

+

+.. program:: server set

+.. option:: --name <new-name>

+

+.. option:: --root-password

+

+.. option:: --property <key=value>

+

+.. describe:: <server>

+

+.. program:: server show

+.. option:: --diagnostics

+

+.. describe:: <server>

+

+.. program:: server ssh

+.. option:: --login <login-name>

+

+.. option:: --port <port>

+

+.. option:: --identity <keyfile>

+

+.. option:: --option <config-options>

+

+.. option:: --public

+

+.. option:: --private

+

+.. option:: --address-type <address-type>

+

+.. describe:: <server>

+

+.. program:: server suspend

+.. describe:: <server>

+

+.. program:: server unlock

+.. describe:: <server>

+

+.. program:: server unpause

+.. describe:: <server>

+

+.. program:: server unrescue

+.. describe:: <server>

+

+.. program:: server unset

+.. option:: --property <key>

+

+.. describe:: <server>

+

+=======

+service

+=======

+

+Identity v2, v3

+

+service create

+--------------

+

+Create new service

+

+.. program:: service create

+.. code-block:: bash

+

+ os service create

+ [--name <name>]

+ [--description <description>]

+ [--enable | --disable]

+ <type>

+

+.. option:: --name <name>

+

+ New service name

+

+.. option:: --description <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:: <type>

+

+ New service type (compute, image, identity, volume, etc)

+

+service delete

+--------------

+

+Delete service

+

+.. program:: service delete

+.. code-block:: bash

+

+ os service delete

+ <service>

+

+.. _service_delete-type:

+.. describe:: <service>

+

+ Service to delete (type, name or ID)

+

+service list

+------------

+

+List services

+

+.. program:: service list

+.. code-block:: bash

+

+ os 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

+

+ os service set

+ [--type <type>]

+ [--name <name>]

+ [--description <description>]

+ [--enable | --disable]

+ <service>

+

+.. option:: --type <type>

+

+ New service type (compute, image, identity, volume, etc)

+

+.. option:: --name <name>

+

+ New service name

+

+.. option:: --description <description>

+

+ New service description

+

+.. option:: --enable

+

+ Enable service

+

+.. option:: --disable

+

+ Disable service

+

+.. _service_set-service:

+.. describe:: <service>

+

+ Service to update (type, name or ID)

+

+service show

+------------

+

+Display service details

+

+.. program:: service show

+.. code-block:: bash

+

+ os service show

+ [--catalog]

+ <service>

+

+.. option:: --catalog

+

+ Show service catalog information

+

+ *Identity version 2 only*

+

+.. _service_show-service:

+.. describe:: <service>

+

+ Service to display (type, name or ID)

+========

+snapshot

+========

+

+Volume v1

+

+snapshot create

+---------------

+

+Create new snapshot

+

+.. program:: snapshot create

+.. code:: bash

+

+ os snapshot create

+ [--name <name>]

+ [--description <description>]

+ [--force]

+ <volume>

+

+.. option:: --name <name>

+

+ Name of the snapshot

+

+.. option:: --description <description>

+

+ Description of the snapshot

+

+.. option:: --force

+

+ Create a snapshot attached to an instance. Default is False

+

+.. _snapshot_create-snapshot:

+.. describe:: <volume>

+

+ Volume to snapshot (name or ID)

+

+snapshot delete

+---------------

+

+Delete snapshot(s)

+

+.. program:: snapshot delete

+.. code:: bash

+

+ os snapshot delete

+ <snapshot> [<snapshot> ...]

+

+.. _snapshot_delete-snapshot:

+.. describe:: <snapshot>

+

+ Snapshot(s) to delete (name or ID)

+

+snapshot list

+-------------

+

+List snapshots

+

+.. program:: snapshot list

+.. code:: bash

+

+ os snapshot list

+

+.. option:: --long

+

+ List additional fields in output

+

+snapshot set

+------------

+

+Set snapshot properties

+

+.. program:: snapshot set

+.. code:: bash

+

+ os snapshot set

+ [--name <name>]

+ [--description <description>]

+ [--property <key=value> [...] ]

+ <snapshot>

+

+.. _snapshot_restore-snapshot:

+.. option:: --name <name>

+

+ New snapshot name

+

+.. option:: --description <description>

+

+ New snapshot description

+

+.. option:: --property <key=value>

+

+ Property to add or modify for this snapshot (repeat option to set multiple properties)

+

+.. describe:: <snapshot>

+

+ Snapshot to modify (name or ID)

+

+snapshot show

+-------------

+

+Display snapshot details

+

+.. program:: snapshot show

+.. code:: bash

+

+ os snapshot show

+ <snapshot>

+

+.. _snapshot_show-snapshot:

+.. describe:: <snapshot>

+

+ Snapshot to display (name or ID)

+

+snapshot unset

+--------------

+

+Unset snapshot properties

+

+.. program:: snapshot unset

+.. code:: bash

+

+ os snapshot unset

+ [--property <key>]

+ <snapshot>

+

+.. option:: --property <key>

+

+ Property to remove from snapshot (repeat option to remove multiple properties)

+

+.. describe:: <snapshot>

+

+ Snapshot to modify (name or ID)

+Issue new token

+

+.. program:: token issue

+*Identity version 2 only.*

+

+Revoke existing token

+

+.. program:: token revoke

+ <token>

+

+.. describe:: <token>

+

+ Token to be deleted

+=====

+usage

+=====

+

+Compute v2

+

+usage list

+----------

+

+List resource usage per project

+

+.. program:: usage list

+.. code:: bash

+

+ os usage list

+ --start <start>

+ --end <end>

+

+.. option:: --start <start>

+

+ Usage range start date, ex 2012-01-20 (default: 4 weeks ago)

+

+.. option:: --end <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

+

+ os usage show

+ --project <project>

+ --start <start>

+ --end <end>

+

+.. option:: --project <project>

+

+ Name or ID of project to show usage for

+

+.. option:: --start <start>

+

+ Usage range start date, ex 2012-01-20 (default: 4 weeks ago)

+

+.. option:: --end <end>

+

+ Usage range end date, ex 2012-01-20 (default: tomorrow)

+Identity v2

+

+Delete user(s)

+ <user> [<user> ...]

+ [--domain <domain>]

+ [--group <group> | --project <project>]

+.. option:: --domain <domain>

+

+ Filter users by `<domain>` (name or ID)

+

+ *Identity version 3 only*

+ *Identity version 3 only*

+Display user details

+

+ User to display (name or ID)

+===========

+volume type

+===========

+

+Volume v1

+

+volume type create

+------------------

+

+Create new volume type

+

+.. program:: volume type create

+.. code:: bash

+

+ os volume type create

+ [--property <key=value> [...] ]

+ <name>

+

+.. option:: --property <key=value>

+

+ Set a property on this volume type (repeat option to set multiple properties)

+

+.. describe:: <name>

+

+ New volume type name

+

+volume type delete

+------------------

+

+Delete volume type

+

+.. program:: volume type delete

+.. code:: bash

+

+ os volume type delete

+ <volume-type>

+

+.. describe:: <volume-type>

+

+ Volume type to delete (name or ID)

+

+volume type list

+----------------

+

+List volume types

+

+.. program:: volume type list

+.. code:: bash

+

+ os volume type list

+ [--long]

+

+.. option:: --long

+

+ List additional fields in output

+

+volume type set

+---------------

+

+Set volume type properties

+

+.. program:: volume type set

+.. code:: bash

+

+ os volume type set

+ [--property <key=value> [...] ]

+ <volume-type>

+

+.. option:: --property <key=value>

+

+ Property to add or modify for this volume type (repeat option to set multiple properties)

+

+.. describe:: <volume-type>

+

+ Volume type to modify (name or ID)

+

+volume type unset

+-----------------

+

+Unset volume type properties

+

+.. program:: volume type unset

+.. code:: bash

+

+ os volume type unset

+ [--property <key>]

+ <volume-type>

+

+.. option:: --property <key>

+

+ Property to remove from volume type (repeat option to remove multiple properties)

+

+.. describe:: <volume-type>

+

+ Volume type to modify (name or ID)

+======

+volume

+======

+

+Volume v1

+

+volume create

+-------------

+

+Create new volume

+

+.. program:: volume create

+.. code:: bash

+

+ os volume create

+ --size <size>

+ [--snapshot-id <snapshot-id>]

+ [--description <description>]

+ [--type <volume-type>]

+ [--user <user>]

+ [--project <project>]

+ [--availability-zone <availability-zone>]

+ [--image <image>]

+ [--source <volume>]

+ [--property <key=value> [...] ]

+ <name>

+

+.. option:: --size <size> (required)

+

+ New volume size in GB

+

+.. option:: --snapshot-id <snapshot-id>

+

+ Use <snapshot-id> as source of new volume

+

+.. option:: --description <description>

+

+ New volume description

+

+.. option:: --type <volume-type>

+

+ Use <volume-type> as the new volume type

+

+.. option:: --user <user>

+

+ Specify an alternate user (name or ID)

+

+.. option:: --project <project>

+

+ Specify an alternate project (name or ID)

+

+.. option:: --availability-zone <availability-zone>

+

+ Create new volume in <availability-zone>

+

+.. option:: --image <image>

+

+ Use <image> as source of new volume (name or ID)

+

+.. option:: --source <source>

+

+ Volume to clone (name or ID)

+

+.. option:: --property <key=value>

+

+ Set a property on this volume (repeat option to set multiple properties)

+

+.. describe:: <name>

+

+ New 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

+

+ os volume delete

+ [--force]

+ <volume> [<volume> ...]

+

+.. option:: --force

+

+ Attempt forced removal of volume(s), regardless of state (defaults to False)

+

+.. describe:: <volume>

+

+ Volume(s) to delete (name or ID)

+

+volume list

+-----------

+

+List volumes

+

+.. program:: volume list

+.. code:: bash

+

+ os volume list

+ [--status <status>]

+ [--name <name>]

+ [--all-projects]

+ [--long]

+

+.. option:: --status <status>

+

+ Filter results by status

+

+.. option:: --name <name>

+

+ Filter results by name

+

+.. option:: --all-projects

+

+ Include all projects (admin only)

+

+.. option:: --long

+

+ List additional fields in output

+

+volume set

+----------

+

+Set volume properties

+

+.. program:: volume set

+.. code:: bash

+

+ os volume set

+ [--name <name>]

+ [--description <description>]

+ [--property <key=value> [...] ]

+ <volume>

+

+.. option:: --name <name>

+

+ New volume name

+

+.. option:: --description <description>

+

+ New volume description

+

+.. option:: --property <key=value>

+

+ Property to add or modify for this volume (repeat option to set multiple properties)

+

+.. describe:: <volume>

+

+ Volume to modify (name or ID)

+

+volume show

+-----------

+

+Show volume details

+

+.. program:: volume show

+.. code:: bash

+

+ os volume show

+ <volume>

+

+.. describe:: <volume>

+

+ Volume to display (name or ID)

+

+volume unset

+------------

+

+Unset volume properties

+

+.. program:: volume unset

+.. code:: bash

+

+ os volume unset

+ [--property <key>]

+ <volume>

+

+.. option:: --property <key>

+

+ Property to remove from volume (repeat option to remove multiple properties)

+

+.. describe:: <volume>

+

+ Volume to modify (name or ID)

+* ``access token``: (**Identity**) long-lived OAuth-based token

+* ``availability zone``: (**Compute**) a logical partition of hosts or volume services

+* ``backup``: (**Volume**) a volume copy

+* ``consumer``: (**Identity**) OAuth-based delegatee

+* ``container``: (**Object Store**) a grouping of objects

+* ``domain``: (**Identity**) a grouping of projects

+* ``ec2 cedentials``: (**Identity**) AWS EC2-compatible credentials

+* ``federation protocol``: (**Identity**) the underlying protocol used while federating identities

+* ``flavor``: (**Compute**) predefined server configurations: ram, root disk, etc

+* ``group``: (**Identity**) a grouping of users

+* ``identity provider``: (**Identity**) a source of users and authentication

+* ``image``: (**Image**) a disk image

+* ``mapping``: (**Identity**) a definition to translate identity provider attributes to Identity concepts

+* ``object``: (**Object Store**) a single file in the Object Store

+* ``policy``: (**Identity**) determines authorization

+* ``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

+* ``service``: (**Identity**) a cloud service

+* ``snapshot``: (**Volume**) a point-in-time copy of a volume

+* ``usage``: (**Compute**) display host resources being consumed

+* ``volume``: (**Volume**) block volumes

+* ``volume type``: (**Volume**) deployment-specific types of volumes available

+=====================

+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, etc. 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 [<global-options>] <object-1> <action> [<object-2>] [<command-arguments>]

+

+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

+

+Notes:

+

+* 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

+ :doc:`authentication`.

+

+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, :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)."

+

+ <object-1> <action> [<object-2>]

+

+Examples:

+

+* :code:`group add user <group> <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.

+

+Option Forms

+++++++++++++

+

+* **boolean**: boolean options shall use a form of :code:`--<true>|--<false>`

+ (preferred) or :code:`--<option>|--no-<option>`. For example, the

+ :code:`enabled` state of a project is set with :code:`--enable|--disable`.

+

+Command Output

+--------------

+

+The default command output is pretty-printed using the Python

+:code:`prettytable` module.

+

+Machine-parsable output format may be specified with the :code:`--format`

+option to :code:`list` and :code:`show` commands. :code:`list` commands

+have an option (:code:`--format csv`) for CSV output and :code:`show` commands

+have an option (:code:`--format shell`) for the shell variable assignment

+syntax of :code:`var="value"`. In both cases, all data fields are quoted with `"`

+

+Help Commands

+-------------

+

+The help system is considered separately due to its special status

+among the commands. Rather than performing tasks against a system, it

+provides information about the commands available to perform those

+tasks. The format of the :code:`help` command therefore varies from the

+form for other commands in that the :code:`help` command appears in front

+of the first object in the command.

+

+The options :code:`--help` and :code:`-h` display the global options and a

+list of the supported commands. Note that the commands shown depend on the API

+versions that are in effect; i.e. if :code:`--os-identity-api-version=3` is

+present Identity API v3 commands are shown.

+

+Examples

+========

+

+The following examples depict common command and output formats expected to be produces by the OpenStack client.

+

+Authentication

+--------------

+

+Using global options:

+

+.. code-block:: bash

+

+ $ openstack --os-tenant-name ExampleCo --os-username demo --os-password secrete --os-auth-url http://localhost:5000:/v2.0 server show appweb01

+ +------------------------+-----------------------------------------------------+

+ | Property | Value |

+ +------------------------+-----------------------------------------------------+

+ | OS-DCF:diskConfig | MANUAL |

+ | OS-EXT-STS:power_state | 1 |

+ | flavor | m1.small |

+ | id | dcbc2185-ba17-4f81-95a9-c3fae9b2b042 |

+ | image | Ubuntu 12.04 (754c231e-ade2-458c-9f91-c8df107ff7ef) |

+ | keyname | demo-key |

+ | name | appweb01 |

+ | private_address | 10.4.128.13 |

+ | status | ACTIVE |

+ | user | demo |

+ +------------------------+-----------------------------------------------------+

+

+Using environment variables:

+

+.. code-block:: bash

+

+ $ export OS_TENANT_NAME=ExampleCo

+ $ export OS_USERNAME=demo

+ $ export OS_PASSWORD=secrete

+ $ export OS_AUTH_URL=http://localhost:5000:/v2.0

+ $ openstack server show appweb01

+ +------------------------+-----------------------------------------------------+

+ | Property | Value |

+ +------------------------+-----------------------------------------------------+

+ | OS-DCF:diskConfig | MANUAL |

+ | OS-EXT-STS:power_state | 1 |

+ | flavor | m1.small |

+ | id | dcbc2185-ba17-4f81-95a9-c3fae9b2b042 |

+ | image | Ubuntu 12.04 (754c231e-ade2-458c-9f91-c8df107ff7ef) |

+ | keyname | demo-key |

+ | name | appweb01 |

+ | private_address | 10.4.128.13 |

+ | status | ACTIVE |

+ | user | demo |

+ +------------------------+-----------------------------------------------------+

+

+Machine Output Format

+---------------------

+

+Using the csv output format with a list command:

+

+.. code-block:: bash

+

+ $ openstack server list --format csv

+ "ID","Name","Status","Private_Address"

+ "ead97d84-6988-47fc-9637-3564fc36bc4b","appweb01","ACTIVE","10.4.128.13"

+

+Using the show command options of shell output format and adding a prefix of

+:code:`my_` to avoid collisions with existing environment variables:

+

+.. code-block:: bash

+

+ $ openstack server show --format shell --prefix my_ appweb01

+ my_OS-DCF:diskConfig="MANUAL"

+ my_OS-EXT-STS:power_state="1"

+ my_flavor="m1.small"

+ my_id="dcbc2185-ba17-4f81-95a9-c3fae9b2b042"

+ my_image="Ubuntu 12.04 (754c231e-ade2-458c-9f91-c8df107ff7ef)"

+ my_keyname="demo-key"

+ my_name="appweb01"

+ my_private_address="10.4.128.13"

+ my_status="ACTIVE"

+ my_user="demo"

+ humaninterfaceguide

+ releases

+* Try :doc:`some commands <command-list>`

+* Install OpenStackClient from `PyPi`_ or a `tarball`_

+

+

+Project Goals

+-------------

+* Use the OpenStack Python API libraries, extending or replacing them as required

+* Use a consistent naming and structure for commands and arguments

+* Provide consistent output formats with optional machine parseable formats

+* Use a single-binary approach that also contains an embedded shell that can execute

+ multiple commands on a single authentication (see libvirt's virsh for an example)

+* Independence from the OpenStack project names; only API names are referenced (to

+ the extent possible)

+OpenStackClient utilizes all of the usual OpenStack processes and requirements for

+contributions. The code is hosted `on OpenStack's Git server`_. `Bug reports`_

+and `blueprints`_ may be submitted to the :code:`python-openstackclient` project

+on `Launchpad`_. Code may be submitted to the

+:code:`openstack/python-openstackclient` project using `Gerrit`_.

+.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/python-openstackclient/tree

+.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs

+.. _blueprints: https://blueprints.launchpad.net/python-openstackclient

+.. _PyPi: https://pypi.python.org/pypi/python-openstackclient

+.. _tarball: http://tarballs.openstack.org/python-openstackclient

+1.0.2 (19 Jan 2015)

+===================

+

+* The OpenStackClient content from the OpenStack Wiki has been migrated into

+ the OSC source repo. This includes the :doc:`commands`, :doc:`command-list`

+ and :doc:`humaninterfaceguide` documents.

+

+* Set a default domain ID when both ``OS_USER_DOMAIN_ID`` and

+ ``OS_USER_DOMAIN_NAME`` are not set. This is also done for

+ ``OS_PROJECT_DOMAIN_ID`` and ``OS_PROJECT_DOMAIN_NAME`.

+ (*Identity API v3 only*).

+ Bug 1385338_: Improve domain related defaults when using v3 identity

+

+* Add new ``usage show`` command to display project resource usage information.

+ Bug 1400796_: Quick usage report - nova usage

+

+* Add ``--project`` option to ``user list`` command to filter users by project

+ (*Identity API v3 only*).

+ Bug 1397251_: allow `openstack user list` to use other filters

+

+* Add ``--user`` to ``project list`` command to filter projects by user

+ (*Identity API v3 only*).

+ Bug 1394793_: support the keystone api /v3/users/$userid/projects

+

+* Add ``--project`` and ``--user`` options to ``role list`` to filter roles

+ by project and/or user. This makes the v2 command very similar to the

+ v3 command.

+ (*Identity API v2 only*).

+ Bug 1409179_: `user role list` command should be worked into `role list`

+

+* Bug 1390507_: Quota show requires cinder in keystone catalog

+* Bug 1400531_: Authentication failure results in useless error message

+* Bug 1400597_: delete multiple objects

+* Bug 1400795_: No list availability zones option

+* Bug 1404073_: type should be required for v2.0 service create

+* Bug 1404434_: add missing docs for service command

+* Bug 1404931_: volume list does not show attached servers

+* Bug 1404997_: Allow description to be set for service create/update

+* Bug 1405416_: Compute region selection broken

+* Bug 1406654_: Remove deprecated commands from help

+* Bug 1406737_: v3 endpoint related commands access service.name without check

+* Bug 1408585_: Backup list doesn't show backup's name

+* Bug 1410364_: Version discovery fails with default Keystone config

+* Bug 1411179_: network client don't use session

+* Bug 1411337_: identity v3 service list should have "description" column

+

+.. _1385338: https://bugs.launchpad.net/bugs/1385338

+.. _1406654: https://bugs.launchpad.net/bugs/1406654

+.. _1411337: https://bugs.launchpad.net/bugs/1411337

+.. _1400531: https://bugs.launchpad.net/bugs/1400531

+.. _1406737: https://bugs.launchpad.net/bugs/1406737

+.. _1409179: https://bugs.launchpad.net/bugs/1409179

+.. _1408585: https://bugs.launchpad.net/bugs/1408585

+.. _1405416: https://bugs.launchpad.net/bugs/1405416

+.. _1404931: https://bugs.launchpad.net/bugs/1404931

+.. _1404434: https://bugs.launchpad.net/bugs/1404434

+.. _1404073: https://bugs.launchpad.net/bugs/1404073

+.. _1400796: https://bugs.launchpad.net/bugs/1400796

+.. _1400795: https://bugs.launchpad.net/bugs/1400795

+.. _1400597: https://bugs.launchpad.net/bugs/1400597

+.. _1397251: https://bugs.launchpad.net/bugs/1397251

+.. _1394793: https://bugs.launchpad.net/bugs/1394793

+.. _1390507: https://bugs.launchpad.net/bugs/1390507

+.. _1410364: https://bugs.launchpad.net/bugs/1410364

+.. _1404997: https://bugs.launchpad.net/bugs/1404997

+.. _1411179: https://bugs.launchpad.net/bugs/1411179

+

+

+ parser.add_argument(

+ '--os-default-domain',

+ metavar='<auth-domain>',

+ default='default',

+ help='Default domain ID, default=default (Env: OS_DEFAULT_DOMAIN)',

+ )

+from keystoneclient import exceptions as ksc_exceptions

+from six.moves.urllib import parse as urlparse

+from keystoneclient.auth.identity.generic import password as ksc_password

+from openstackclient.i18n import _

+ auth_plugin_name = 'osc_password'

+def check_valid_auth_options(options, auth_plugin_name):

+ """Perform basic option checking, provide helpful error messages"""

+

+ msg = ''

+ if auth_plugin_name.endswith('password'):

+ if not options.os_username:

+ msg += _('Set a username with --os-username or OS_USERNAME\n')

+ if not options.os_auth_url:

+ msg += _('Set an authentication URL, with --os-auth-url or'

+ ' OS_AUTH_URL\n')

+ if (not options.os_project_id and not options.os_domain_id and not

+ options.os_domain_name and not options.os_project_name):

+ msg += _('Set a scope, such as a project or domain, with '

+ '--os-project-name or OS_PROJECT_NAME')

+

+ if msg:

+ raise exc.CommandError('Missing parameter(s): \n%s' % msg)

+

+

+ # make sure we catch old v2.0 env values

+

+

+class OSCGenericPassword(ksc_password.Password):

+ """Auth plugin hack to work around broken Keystone configurations

+

+ The default Keystone configuration uses http://localhost:xxxx in

+ admin_endpoint and public_endpoint and are returned in the links.href

+ attribute by the version routes. Deployments that do not set these

+ are unusable with newer keystoneclient version discovery.

+

+ """

+

+ def create_plugin(self, session, version, url, raw_status=None):

+ """Handle default Keystone endpoint configuration

+

+ Build the actual API endpoint from the scheme, host and port of the

+ original auth URL and the rest from the returned version URL.

+ """

+

+ ver_u = urlparse.urlparse(url)

+

+ # Only hack this if it is the default setting

+ if ver_u.netloc.startswith('localhost'):

+ auth_u = urlparse.urlparse(self.auth_url)

+ # from original auth_url: scheme, netloc

+ # from api_url: path, query (basically, the rest)

+ url = urlparse.urlunparse((

+ auth_u.scheme,

+ auth_u.netloc,

+ ver_u.path,

+ ver_u.params,

+ ver_u.query,

+ ver_u.fragment,

+ ))

+ LOG.debug('Version URL updated: %s' % url)

+

+ return super(OSCGenericPassword, self).create_plugin(

+ session=session,

+ version=version,

+ url=url,

+ raw_status=raw_status,

+ )

+ returns a string containing the password

+ # Basic option checking to avoid unhelpful error messages

+ auth.check_valid_auth_options(auth_options, self.auth_plugin_name)

+

+ default_domain = auth_options.os_default_domain

+ # NOTE(stevemar): If PROJECT_DOMAIN_ID or PROJECT_DOMAIN_NAME is

+ # present, then do not change the behaviour. Otherwise, set the

+ # PROJECT_DOMAIN_ID to 'OS_DEFAULT_DOMAIN' for better usability.

+ if (self._api_version.get('identity') == '3' and

+ not self._auth_params.get('project_domain_id') and

+ not self._auth_params.get('project_domain_name')):

+ self._auth_params['project_domain_id'] = default_domain

+

+ # NOTE(stevemar): If USER_DOMAIN_ID or USER_DOMAIN_NAME is present,

+ # then do not change the behaviour. Otherwise, set the USER_DOMAIN_ID

+ # to 'OS_DEFAULT_DOMAIN' for better usability.

+ if (self._api_version.get('identity') == '3' and

+ not self._auth_params.get('user_domain_id') and

+ not self._auth_params.get('user_domain_name')):

+ self._auth_params['user_domain_id'] = default_domain

+

+ def get_quota(self, client, parsed_args):

+ try:

+ if parsed_args.quota_class:

+ quota = client.quota_classes.get(parsed_args.project)

+ elif parsed_args.default:

+ quota = client.quotas.defaults(parsed_args.project)

+ else:

+ quota = client.quotas.get(parsed_args.project)

+ except Exception as e:

+ if type(e).__name__ == 'EndpointNotFound':

+ return {}

+ else:

+ raise e

+ return quota._info

+

+ compute_quota_info = self.get_quota(compute_client, parsed_args)

+ volume_quota_info = self.get_quota(volume_client, parsed_args)

+ info.update(compute_quota_info)

+ info.update(volume_quota_info)

+ region_name=instance._region_name,

+ """Display aggregate details"""

+ help='Aggregate to display (name or ID)',

+# Licensed under the Apache License, Version 2.0 (the "License"); you may

+# not use this file except in compliance with the License. You may obtain

+# a copy of the License at

+#

+# http://www.apache.org/licenses/LICENSE-2.0

+#

+# Unless required by applicable law or agreed to in writing, software

+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

+# License for the specific language governing permissions and limitations

+# under the License.

+#

+

+"""Compute v2 Availability Zone action implementations"""

+

+import copy

+import logging

+

+from cliff import lister

+from novaclient import exceptions as nova_exceptions

+import six

+

+from openstackclient.common import utils

+from openstackclient.i18n import _ # noqa

+

+

+def _xform_availability_zone(az, include_extra):

+ result = []

+ zone_info = {}

+ if hasattr(az, 'zoneState'):

+ zone_info['zone_status'] = ('available' if az.zoneState['available']

+ else 'not available')

+ if hasattr(az, 'zoneName'):

+ zone_info['zone_name'] = az.zoneName

+

+ if not include_extra:

+ result.append(zone_info)

+ return result

+

+ if hasattr(az, 'hosts') and az.hosts:

+ for host, services in six.iteritems(az.hosts):

+ host_info = copy.deepcopy(zone_info)

+ host_info['host_name'] = host

+

+ for svc, state in six.iteritems(services):

+ info = copy.deepcopy(host_info)

+ info['service_name'] = svc

+ info['service_status'] = '%s %s %s' % (

+ 'enabled' if state['active'] else 'disabled',

+ ':-)' if state['available'] else 'XXX',

+ state['updated_at'])

+ result.append(info)

+ else:

+ zone_info['host_name'] = ''

+ zone_info['service_name'] = ''

+ zone_info['service_status'] = ''

+ result.append(zone_info)

+ return result

+

+

+class ListAvailabilityZone(lister.Lister):

+ """List availability zones and their status"""

+

+ log = logging.getLogger(__name__ + '.ListAvailabilityZone')

+

+ def get_parser(self, prog_name):

+ parser = super(ListAvailabilityZone, self).get_parser(prog_name)

+ parser.add_argument(

+ '--long',

+ action='store_true',

+ default=False,

+ help=_('List additional fields in output'),

+ )

+ return parser

+

+ def take_action(self, parsed_args):

+ self.log.debug('take_action(%s)', parsed_args)

+

+ if parsed_args.long:

+ columns = ('Zone Name', 'Zone Status',

+ 'Host Name', 'Service Name', 'Service Status')

+ else:

+ columns = ('Zone Name', 'Zone Status')

+

+ compute_client = self.app.client_manager.compute

+ try:

+ data = compute_client.availability_zones.list()

+ except nova_exceptions.Forbidden as e: # policy doesn't allow

+ try:

+ data = compute_client.availability_zones.list(detailed=False)

+ except Exception:

+ raise e

+

+ # Argh, the availability zones are not iterable...

+ result = []

+ for zone in data:

+ result += _xform_availability_zone(zone, parsed_args.long)

+

+ return (columns,

+ (utils.get_dict_properties(

+ s, columns

+ ) for s in result))

+ metavar="<flavor-name>",

+ help="Unique flavor ID; 'auto' creates a UUID "

+ "(default: auto)",

+ )

+ help="Memory size in MB (default 256M)",

+ )

+ help="Disk size in GB (default 0G)",

+ )

+ default=0,

+ )

+ default=0,

+ )

+ help="Number of vcpus (default 1)",

+ )

+ default=1,

+ )

+ help="Flavor is available to other projects (default)",

+ help="Flavor is not available to other projects",

+ """Delete flavor"""

+ """Display flavor details"""

+ """Delete public key"""

+ """Display public key details"""

+ help='Public key to display',

+from keystoneclient import exceptions as ksc_exc

+ """Delete server(s)"""

+ 'servers',

+ nargs="+",

+ help=_('Server(s) to delete (name or ID)'),

+ for server in parsed_args.servers:

+ server_obj = utils.find_resource(

+ compute_client.servers, server)

+ compute_client.servers.delete(server_obj.id)

+from cliff import show

+import six

+ """List resource usage per project"""

+ " (default: 4 weeks ago)"

+ "server_usages",

+ "Servers",

+ usage_list = compute_client.usage.list(start, end, detailed=True)

+ if parsed_args.formatter == 'table' and len(usage_list) > 0:

+ sys.stdout.write("Usage from %s to %s: \n" % (

+ 'server_usages': lambda x: len(x),

+

+

+class ShowUsage(show.ShowOne):

+ """Show resource usage for a single project"""

+

+ log = logging.getLogger(__name__ + ".ShowUsage")

+

+ def get_parser(self, prog_name):

+ parser = super(ShowUsage, self).get_parser(prog_name)

+ parser.add_argument(

+ "--project",

+ metavar="<project>",

+ default=None,

+ help="Name or ID of project to show usage for"

+ )

+ parser.add_argument(

+ "--start",

+ metavar="<start>",

+ default=None,

+ help="Usage range start date, ex 2012-01-20"

+ " (default: 4 weeks ago)"

+ )

+ parser.add_argument(

+ "--end",

+ metavar="<end>",

+ default=None,

+ help="Usage range end date, ex 2012-01-20 (default: tomorrow)"

+ )

+ return parser

+

+ def take_action(self, parsed_args):

+ self.log.debug("take_action(%s)", parsed_args)

+

+ identity_client = self.app.client_manager.identity

+ compute_client = self.app.client_manager.compute

+ dateformat = "%Y-%m-%d"

+ now = datetime.datetime.utcnow()

+

+ if parsed_args.start:

+ start = datetime.datetime.strptime(parsed_args.start, dateformat)

+ else:

+ start = now - datetime.timedelta(weeks=4)

+

+ if parsed_args.end:

+ end = datetime.datetime.strptime(parsed_args.end, dateformat)

+ else:

+ end = now + datetime.timedelta(days=1)

+

+ if parsed_args.project:

+ project = utils.find_resource(

+ identity_client.projects,

+ parsed_args.project,

+ ).id

+ else:

+ # Get the project from the current auth

+ project = self.app.client_manager.auth_ref.project_id

+

+ usage = compute_client.usage.get(project, start, end)

+

+ if parsed_args.formatter == 'table':

+ sys.stdout.write("Usage from %s to %s on project %s: \n" % (

+ start.strftime(dateformat),

+ end.strftime(dateformat),

+ project

+ ))

+

+ info = {}

+ info['Servers'] = len(usage.server_usages)

+ info['RAM MB-Hours'] = float("%.2f" % usage.total_memory_mb_usage)

+ info['CPU Hours'] = float("%.2f" % usage.total_vcpus_usage)

+ info['Disk GB-Hours'] = float("%.2f" % usage.total_local_gb_usage)

+ return zip(*sorted(six.iteritems(info)))

+

+

+# This is out of order due to the subclass, will eventually be removed

+

+class ListProjectUsage(ListUsage):

+ """List resource usage per project"""

+

+ deprecated = True

+

+ log = logging.getLogger('DEPRECATED:')

+

+ def take_action(self, parsed_args):

+ self.log.warning(

+ "%s is deprecated, use 'usage list'",

+ getattr(self, 'cmd_name', 'this command'),

+ )

+ return super(ListProjectUsage, self).take_action(parsed_args)

+ """Display service catalog details"""

+ help=_('Service to display (type or name)'),

+ if (service.get('name') == parsed_args.service or

+ service.get('type') == parsed_args.service):

+ data = service

+ data['endpoints'] = _format_endpoints(data['endpoints'])

+ if 'endpoints_links' in data:

+ data.pop('endpoints_links')

+ break

+

+ if not data:

+ self.app.log.error('service %s not found\n' %

+ parsed_args.service)

+ return ([], [])

+ help=_('Specify an alternate project'

+ ' (default: current authenticated project)'),

+ help=_('Specify an alternate user'

+ ' (default: current authenticated user)'),

+ help=_('Specify a user'),

+ help=_('Specify a user'),

+ """Display EC2 credentials details"""

+ help=_('Specify a user'),

+ """Create new endpoint"""

+ metavar='<service>',

+ help=_('New endpoint service (name or ID)'),

+ )

+ metavar='<url>',

+ help=_('New endpoint public URL (required)'),

+ )

+ metavar='<url>',

+ help=_('New endpoint admin URL'),

+ )

+ metavar='<url>',

+ help=_('New endpoint internal URL'),

+ )

+ parser.add_argument(

+ '--region',

+ metavar='<region-id>',

+ help=_('New endpoint region ID'),

+ )

+ """Delete endpoint"""

+ help=_('Endpoint ID to delete'))

+ """List endpoints"""

+ help=_('List additional fields in output'),

+ )

+ """Display endpoint details"""

+ metavar='<endpoint-id>',

+ help=_('Endpoint ID to display'),

+ )

+from keystoneclient import exceptions as ksc_exc

+ """Delete project(s)"""

+ 'projects',

+ nargs="+",

+ help=_('Project(s) to delete (name or ID)'),

+ for project in parsed_args.projects:

+ project_obj = utils.find_resource(

+ identity_client.tenants,

+ project,

+ )

+ identity_client.tenants.delete(project_obj.id)

+ """Display project details"""

+ help=_('Project to display (name or ID)'))

+from keystoneclient import exceptions as ksc_exc

+ """Delete role(s)"""

+ 'roles',

+ nargs="+",

+ help=_('Role(s) to delete (name or ID)'),

+ for role in parsed_args.roles:

+ role_obj = utils.find_resource(

+ identity_client.roles,

+ role,

+ )

+ identity_client.roles.delete(role_obj.id)

+ def get_parser(self, prog_name):

+ parser = super(ListRole, self).get_parser(prog_name)

+ parser.add_argument(

+ '--project',

+ metavar='<project>',

+ help='Filter roles by <project> (name or ID)',

+ )

+ parser.add_argument(

+ '--user',

+ metavar='<user>',

+ help='Filter roles by <user> (name or ID)',

+ )

+ return parser

+

+ identity_client = self.app.client_manager.identity

+ auth_ref = self.app.client_manager.auth_ref

+

+ # No user or project specified, list all roles in the system

+ if not parsed_args.user and not parsed_args.project:

+ columns = ('ID', 'Name')

+ data = identity_client.roles.list()

+ elif parsed_args.user and parsed_args.project:

+ user = utils.find_resource(

+ identity_client.users,

+ parsed_args.user,

+ )

+ project = utils.find_resource(

+ identity_client.projects,

+ parsed_args.project,

+ )

+ data = identity_client.roles.roles_for_user(user.id, project.id)

+

+ elif parsed_args.user:

+ user = utils.find_resource(

+ identity_client.users,

+ parsed_args.user,

+ )

+ if self.app.client_manager.auth_ref:

+ project = utils.find_resource(

+ identity_client.projects,

+ auth_ref.project_id

+ )

+ else:

+ msg = _("Project must be specified")

+ raise exceptions.CommandError(msg)

+ data = identity_client.roles.roles_for_user(user.id, project.id)

+ elif parsed_args.project:

+ project = utils.find_resource(

+ identity_client.projects,

+ parsed_args.project,

+ )

+ if self.app.client_manager.auth_ref:

+ user = utils.find_resource(

+ identity_client.users,

+ auth_ref.user_id

+ )

+ else:

+ msg = _("User must be specified")

+ raise exceptions.CommandError(msg)

+ data = identity_client.roles.roles_for_user(user.id, project.id)

+

+ if parsed_args.user or parsed_args.project:

+ columns = ('ID', 'Name', 'Project', 'User')

+ for user_role in data:

+ user_role.user = user.name

+ user_role.project = project.name

+

+ """Remove role from project : user"""

+ help=_('Role to remove (name or ID)'),

+ """Display role details"""

+ help=_('Role to display (name or ID)'),

+import argparse

+ 'type_or_name',

+ metavar='<type>',

+ help=_('New service type (compute, image, identity, volume, etc)'),

+ type_or_name_group = parser.add_mutually_exclusive_group()

+ type_or_name_group.add_argument(

+ metavar='<type>',

+ help=argparse.SUPPRESS,

+ )

+ type_or_name_group.add_argument(

+ '--name',

+ metavar='<name>',

+ help=_('New service name'),

+ metavar='<description>',

+ type_or_name = parsed_args.type_or_name

+ name = parsed_args.name

+ type = parsed_args.type

+

+ # If only a single positional is present, it's a <type>.

+ # This is not currently legal so it is considered a new case.

+ if not type and not name:

+ type = type_or_name

+ # If --type option is present then positional is handled as <name>;

+ # display deprecation message.

+ elif type:

+ name = type_or_name

+ self.log.warning(_('The argument --type is deprecated, use service'

+ ' create --name <service-name> type instead.'))

+ # If --name option is present the positional is handled as <type>.

+ # Making --type optional is new, but back-compatible

+ elif name:

+ type = type_or_name

+

+ name,

+ type,

+ help=_('List additional fields in output'),

+ )

+ columns = ('ID', 'Name', 'Type')

+ return (

+ columns,

+ (utils.get_item_properties(s, columns) for s in data),

+ )

+ """Display service details"""

+from keystoneclient import exceptions as ksc_exc

+ """Delete user(s)"""

+ 'users',

+ nargs="+",

+ help=_('User(s) to delete (name or ID)'),

+ for user in parsed_args.users:

+ user_obj = utils.find_resource(

+ identity_client.users,

+ user,

+ )

+ identity_client.users.delete(user_obj.id)

+ """Display user details"""

+ """Create new consumer"""

+ metavar='<description>',

+ """Delete consumer"""

+ help='Consumer to delete',

+ """List consumers"""

+ """Set consumer properties"""

+ help='Consumer to modify',

+ metavar='<description>',

+ sys.stdout.write('Consumer not updated, no arguments present')

+ """Display consumer details"""

+ help='Consumer to display',

+from keystoneclient import exceptions as ksc_exc

+ """Create new domain"""

+ metavar='<description>',

+ help='Enable domain (default)',

+ )

+ action='store_true',

+ help='Disable domain',

+ )

+ enabled = True

+ if parsed_args.disable:

+ enabled = False

+

+ enabled=enabled,

+ """Delete domain"""

+ help='Domain to delete (name or ID)',

+ """List domains"""

+ """Set domain properties"""

+ help='Domain to modify (name or ID)',

+ metavar='<name>',

+ metavar='<description>',

+ help='Enable domain',

+

+ if parsed_args.enable:

+ if parsed_args.disable:

+ """Display domain details"""

+ help='Domain to display (name or ID)',

+def get_service_name(service):

+ if hasattr(service, 'name'):

+ return service.name

+ else:

+ return ''

+

+

+ """Create new endpoint"""

+ help='New endpoint service (name or ID)',

+ )

+ help='New endpoint interface type (admin, public or internal)',

+ )

+ help='New endpoint URL',

+ )

+ metavar='<region-id>',

+ help='New endpoint region ID',

+ )

+ help='Enable endpoint (default)',

+ info['service_name'] = get_service_name(service)

+ """Delete endpoint"""

+ metavar='<endpoint-id>',

+ help='Endpoint ID to delete',

+ )

+ """List endpoints"""