diff options
Diffstat (limited to 'doc/source/command-objects')
33 files changed, 1717 insertions, 111 deletions
diff --git a/doc/source/command-objects/access-token.rst b/doc/source/command-objects/access-token.rst new file mode 100644 index 00000000..fd22e761 --- /dev/null +++ b/doc/source/command-objects/access-token.rst @@ -0,0 +1,42 @@ +============ +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) diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 474d811f..2a40d234 100644 --- a/doc/source/command-objects/aggregate.rst +++ b/doc/source/command-objects/aggregate.rst @@ -5,6 +5,8 @@ aggregate Server aggregates provide a mechanism to group servers according to certain criteria. +Compute v2 + aggregate add host ------------------ @@ -137,7 +139,7 @@ Set aggregate properties aggregate show -------------- -Show a specific aggregate +Display aggregate details .. program aggregate show .. code:: bash @@ -147,4 +149,4 @@ Show a specific aggregate .. describe:: <aggregate> - Aggregate to show (name or ID) + Aggregate to display (name or ID) diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst new file mode 100644 index 00000000..ec201aa3 --- /dev/null +++ b/doc/source/command-objects/backup.rst @@ -0,0 +1,104 @@ +====== +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) diff --git a/doc/source/command-objects/catalog.rst b/doc/source/command-objects/catalog.rst index 99746dd7..89db95d5 100644 --- a/doc/source/command-objects/catalog.rst +++ b/doc/source/command-objects/catalog.rst @@ -7,6 +7,9 @@ Identity v2 catalog list ------------ +List services in the service catalog + +.. program:: catalog list .. code:: bash os catalog list @@ -14,7 +17,14 @@ catalog list catalog show ------------ +Display service catalog details + +.. program:: catalog show .. code:: bash os catalog show <service> + +.. describe:: <service> + + Service to display (type or name) diff --git a/doc/source/command-objects/console-log.rst b/doc/source/command-objects/console-log.rst index 8e56a073..9eafb61a 100644 --- a/doc/source/command-objects/console-log.rst +++ b/doc/source/command-objects/console-log.rst @@ -4,6 +4,8 @@ console log Server console text dump +Compute v2 + console log show ---------------- diff --git a/doc/source/command-objects/console-url.rst b/doc/source/command-objects/console-url.rst index 45a0a527..9cab8798 100644 --- a/doc/source/command-objects/console-url.rst +++ b/doc/source/command-objects/console-url.rst @@ -4,6 +4,8 @@ console url Server remote console URL +Compute v2 + console url show ---------------- diff --git a/doc/source/command-objects/consumer.rst b/doc/source/command-objects/consumer.rst new file mode 100644 index 00000000..91294fa2 --- /dev/null +++ b/doc/source/command-objects/consumer.rst @@ -0,0 +1,83 @@ +======== +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 diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst index 3afaeb92..845933d4 100644 --- a/doc/source/command-objects/container.rst +++ b/doc/source/command-objects/container.rst @@ -92,7 +92,7 @@ Save container contents locally container show -------------- -Show container details +Display container details .. program:: container show .. code:: bash diff --git a/doc/source/command-objects/credentials.rst b/doc/source/command-objects/credentials.rst index ea8fc08f..9f4aabe4 100644 --- a/doc/source/command-objects/credentials.rst +++ b/doc/source/command-objects/credentials.rst @@ -2,6 +2,8 @@ credentials =========== +Identity v3 + credentials create ------------------ diff --git a/doc/source/command-objects/domain.rst b/doc/source/command-objects/domain.rst index 66697ac3..94473570 100644 --- a/doc/source/command-objects/domain.rst +++ b/doc/source/command-objects/domain.rst @@ -102,7 +102,7 @@ Set domain properties domain show ----------- -Show domain details +Display domain details .. program:: domain show .. code:: bash diff --git a/doc/source/command-objects/federation-protocol.rst b/doc/source/command-objects/federation-protocol.rst new file mode 100644 index 00000000..5b4ea48a --- /dev/null +++ b/doc/source/command-objects/federation-protocol.rst @@ -0,0 +1,112 @@ +=================== +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) diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index 4c98e858..0083da0d 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -2,6 +2,8 @@ flavor ====== +Compute v2 + flavor create ------------- @@ -65,7 +67,7 @@ Create new flavor flavor delete ------------- -Delete a flavor +Delete flavor .. program:: flavor delete .. code:: bash diff --git a/doc/source/command-objects/identity-provider.rst b/doc/source/command-objects/identity-provider.rst new file mode 100644 index 00000000..47e274dd --- /dev/null +++ b/doc/source/command-objects/identity-provider.rst @@ -0,0 +1,100 @@ +================= +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 diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst new file mode 100644 index 00000000..d9b77266 --- /dev/null +++ b/doc/source/command-objects/image.rst @@ -0,0 +1,245 @@ +====== +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) diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst index 9ba0ee8f..04c5721f 100644 --- a/doc/source/command-objects/keypair.rst +++ b/doc/source/command-objects/keypair.rst @@ -5,6 +5,8 @@ keypair The badly named keypair is really the public key of an OpenSSH key pair to be used for access to created servers. +Compute v2 + keypair create -------------- @@ -28,7 +30,7 @@ Create new public key keypair delete -------------- -Delete a public key +Delete public key .. program keypair delete .. code:: bash @@ -53,7 +55,7 @@ List public key fingerprints keypair show ------------ -Show public key details +Display public key details .. program keypair show .. code:: bash @@ -68,4 +70,4 @@ Show public key details .. describe:: <key> - Public key to show + Public key to display diff --git a/doc/source/command-objects/limits.rst b/doc/source/command-objects/limits.rst index ac388e0f..1eae4889 100644 --- a/doc/source/command-objects/limits.rst +++ b/doc/source/command-objects/limits.rst @@ -4,6 +4,8 @@ limits The Compute and Volume APIs have resource usage limits. +Compute v2, Volume v1 + limits show ----------- diff --git a/doc/source/command-objects/mapping.rst b/doc/source/command-objects/mapping.rst new file mode 100644 index 00000000..25af4740 --- /dev/null +++ b/doc/source/command-objects/mapping.rst @@ -0,0 +1,91 @@ +======= +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 diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst index 5cbc95d7..c45c1051 100644 --- a/doc/source/command-objects/object.rst +++ b/doc/source/command-objects/object.rst @@ -122,7 +122,7 @@ Save object locally object show ----------- -Show object details +Display object details .. program:: object show .. code:: bash diff --git a/doc/source/command-objects/policy.rst b/doc/source/command-objects/policy.rst new file mode 100644 index 00000000..195a89f2 --- /dev/null +++ b/doc/source/command-objects/policy.rst @@ -0,0 +1,95 @@ +====== +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 diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index 6b55b424..b39edb4d 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -149,6 +149,8 @@ Set project properties project show ------------ +Display project details + .. program:: project show .. code:: bash @@ -165,4 +167,4 @@ project show .. _project_show-project: .. describe:: <project> - Project to show (name or ID) + Project to display (name or ID) diff --git a/doc/source/command-objects/quota.rst b/doc/source/command-objects/quota.rst index ba6712c0..053fb47a 100644 --- a/doc/source/command-objects/quota.rst +++ b/doc/source/command-objects/quota.rst @@ -4,6 +4,8 @@ quota Resource quotas appear in multiple APIs, OpenStackClient presents them as a single object with multiple properties. +Compute v2, Volume v1 + quota set --------- diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst index d1aedb31..cb4a059e 100644 --- a/doc/source/command-objects/region.rst +++ b/doc/source/command-objects/region.rst @@ -95,7 +95,7 @@ Set region properties .. _region_set-region-id: .. describe:: <region-id> - Region ID to modify + Region to modify region show ----------- @@ -111,4 +111,4 @@ Display region details .. _region_show-region-id: .. describe:: <region-id> - Region ID to display + Region to display diff --git a/doc/source/command-objects/request-token.rst b/doc/source/command-objects/request-token.rst new file mode 100644 index 00000000..84081cb1 --- /dev/null +++ b/doc/source/command-objects/request-token.rst @@ -0,0 +1,57 @@ +============= +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) diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst index 19195eb5..57161b06 100644 --- a/doc/source/command-objects/role.rst +++ b/doc/source/command-objects/role.rst @@ -142,7 +142,7 @@ Remove role from domain/project : user/group .. describe:: <role> - Role to remove from `<project>`:`<user>` (name or ID) + Role to remove (name or ID) role set -------- @@ -169,6 +169,8 @@ Set role properties role show --------- +Display role details + .. program:: role show .. code:: bash @@ -177,4 +179,4 @@ role show .. describe:: <role> - Role to show (name or ID) + Role to display (name or ID) diff --git a/doc/source/command-objects/server-image.rst b/doc/source/command-objects/server-image.rst index 4577b25b..8b489342 100644 --- a/doc/source/command-objects/server-image.rst +++ b/doc/source/command-objects/server-image.rst @@ -5,6 +5,8 @@ server image A server image is a disk image created from a running server instance. The image is created in the Image store. +Compute v2 + server image create ------------------- diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 2f5aef10..360ec24e 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -2,6 +2,7 @@ server ====== +Compute v2 server add security group ------------------------- @@ -14,10 +15,12 @@ Add security group to server <server> <group> -:option:`<server>` +.. describe:: <server> + Server (name or ID) -:option:`<group>` +.. describe:: <group> + Security group to add (name or ID) server add volume @@ -32,13 +35,16 @@ Add volume to server <server> <volume> -:option:`--device` <device> +.. option:: --device <device> + Server internal device name for volume -:option:`<server>` +.. describe:: <server> + Server (name or ID) -:option:`<volume>` +.. describe:: <volume> + Volume to add (name or ID) server create @@ -66,55 +72,72 @@ Create a new server [--wait] <server-name> -:option:`--image` <image> +.. option:: --image <image> + Create server from this image -:option:`--volume` <volume> +.. option:: --volume <volume> + Create server from this volume -:option:`--flavor` <flavor> +.. option:: --flavor <flavor> + Create server with this flavor -:option:`--security-group` <security-group-name> +.. option:: --security-group <security-group-name> + Security group to assign to this server (repeat for multiple groups) -:option:`--key-name` <key-name> +.. option:: --key-name <key-name> + Keypair to inject into this server (optional extension) -:option:`--property` <key=value> +.. option:: --property <key=value> + Set a property on this server (repeat for multiple values) -:option:`--file` <dest-filename=source-filename> +.. option:: --file <dest-filename=source-filename> + File to inject into image before boot (repeat for multiple files) -:option:`--user-data` <user-data> +.. option:: --user-data <user-data> + User data file to serve from the metadata server -:option:`--availability-zone` <zone-name> +.. option:: --availability-zone <zone-name> + Select an availability zone for the server -:option:`--block-device-mapping` <dev-name=mapping> +.. option:: --block-device-mapping <dev-name=mapping> + Map block devices; map is <id>:<type>:<size(GB)>:<delete_on_terminate> (optional extension) -:option:`--nic` <nic-config-string> +.. option:: --nic <nic-config-string> + Specify NIC configuration (optional extension) -:option:`--hint` <key=value> +.. option:: --hint <key=value> + Hints for the scheduler (optional extension) -:option:`--config-drive` <config-drive-volume>|True +.. option:: --config-drive <config-drive-volume>|True + Use specified volume as the config drive, or 'True' to use an ephemeral drive -:option:`--min` <count> +.. option:: --min <count> + Minimum number of servers to launch (default=1) -:option:`--max` <count> +.. option:: --max <count> + Maximum number of servers to launch (default=1) -:option:`--wait` +.. option:: --wait + Wait for build to complete -:option:`<server-name>` +.. describe:: <server-name> + New server name server delete @@ -127,7 +150,8 @@ Delete server(s) os server delete <server> [<server> ...] -:option:`<server>` +.. describe:: <server> + Server to delete (name or ID) server list @@ -150,37 +174,48 @@ List servers [--all-projects] [--long] -:option:`--reservation-id` <reservation-id> +.. option:: --reservation-id <reservation-id> + Only return instances that match the reservation -:option:`--ip` <ip-address-regex> +.. option:: --ip <ip-address-regex> + Regular expression to match IP addresses -:option:`--ip6` <ip-address-regex> +.. option:: --ip6 <ip-address-regex> + Regular expression to match IPv6 addresses -:option:`--name` <name-regex> +.. option:: --name <name-regex> + Regular expression to match names -:option:`--instance-name` <server-name-regex> +.. option:: --instance-name <server-name-regex> + Regular expression to match instance name (admin only) -:option:`--status` <status> +.. option:: --status <status> + Search by server status -:option:`--flavor` <flavor> +.. option:: --flavor <flavor> + Search by flavor ID -:option:`--image` <image> +.. option:: --image <image> + Search by image ID -:option:`--host` <hostname> +.. option:: --host <hostname> + Search by hostname -:option:`--all-projects` +.. option:: --all-projects + Include all projects (admin only) -:option:`--long` +.. option:: --long + List additional fields in output server lock @@ -193,7 +228,8 @@ Lock server os server lock <server> -:option:`<server>` +.. describe:: <server> + Server (name or ID) server migrate @@ -210,25 +246,32 @@ Migrate server to different host [--wait] <server> -:option:`--live` <hostname> +.. option:: --live <hostname> + Target hostname -:option:`--shared-migration` +.. option:: --shared-migration + Perform a shared live migration (default) -:option:`--block-migration` +.. option:: --block-migration + Perform a block live migration -:option:`--disk-overcommit` +.. option:: --disk-overcommit + Allow disk over-commit on the destination host -:option:`--no-disk-overcommit` +.. option:: --no-disk-overcommit + Do not over-commit disk on the destination host (default) -:option:`--wait` +.. option:: --wait + Wait for resize to complete -:option:`<server>` +.. describe:: <server> + Server to migrate (name or ID) server pause @@ -241,7 +284,8 @@ Pause server os server pause <server> -:option:`<server>` +.. describe:: <server> + Server (name or ID) server reboot @@ -256,16 +300,20 @@ Perform a hard or soft server reboot [--wait] <server> -:option:`--hard` +.. option:: --hard + Perform a hard reboot -:option:`--soft` +.. option:: --soft + Perform a soft reboot -:option:`--wait` +.. option:: --wait + Wait for reboot to complete -:option:`<server>` +.. describe:: <server> + Server (name or ID) server rebuild @@ -281,16 +329,20 @@ Rebuild server [--wait] <server> -:option:`--image` <image> +.. option:: --image <image> + Recreate server from this image -:option:`--password` <password> +.. option:: --password <password> + Set the password on the rebuilt instance -:option:`--wait` +.. option:: --wait + Wait for rebuild to complete -:option:`<server>` +.. describe:: <server> + Server (name or ID) server remove security group @@ -304,10 +356,12 @@ Remove security group from server <server> <group> -:option:`<server>` +.. describe:: <server> + Name or ID of server to use -:option:`<group>` +.. describe:: <group> + Name or ID of security group to remove from server server remove volume @@ -321,10 +375,12 @@ Remove volume from server <server> <volume> -:option:`<server>` +.. describe:: <server> + Server (name or ID) -:option:`<volume>` +.. describe:: <volume> + Volume to remove (name or ID) server rescue @@ -337,7 +393,8 @@ Put server in rescue mode os server rescue <server> -:option:`<server>` +.. describe:: <server> + Server (name or ID) server resize @@ -356,19 +413,24 @@ Scale server to a new flavor --verify | --revert <server> -:option:`--flavor` <flavor> +.. option:: --flavor <flavor> + Resize server to specified flavor -:option:`--verify` +.. option:: --verify + Verify server resize is complete -:option:`--revert` +.. option:: --revert + Restore server state before resize -:option:`--wait` +.. option:: --wait + Wait for resize to complete -:option:`<server>` +.. describe:: <server> + Server (name or ID) A resize operation is implemented by creating a new server and copying @@ -387,7 +449,8 @@ Resume server os server resume <server> -:option:`<server>` +.. describe:: <server> + Server (name or ID) server set @@ -404,17 +467,21 @@ Set server properties --root-password <server> -:option:`--name` <new-name> +.. option:: --name <new-name> + New server name -:option:`--root-password` +.. option:: --root-password + Set new root password (interactive only) -:option:`--property` <key=value> +.. option:: --property <key=value> + Property to add/change for this server (repeat option to set multiple properties) -:option:`<server>` +.. describe:: <server> + Server (name or ID) server show @@ -428,10 +495,12 @@ Show server details [--diagnostics] <server> -:option:`--diagnostics` +.. option:: --diagnostics + Display server diagnostics information -:option:`<server>` +.. describe:: <server> + Server (name or ID) server ssh @@ -449,28 +518,36 @@ Ssh to server [--public | --private | --address-type <address-type>] <server> -:option:`--login` <login-name> +.. option:: --login <login-name> + Login name (ssh -l option) -:option:`--port` <port> +.. option:: --port <port> + Destination port (ssh -p option) -:option:`--identity` <keyfile> +.. option:: --identity <keyfile> + Private key file (ssh -i option) -:option:`--option` <config-options> +.. option:: --option <config-options> + Options in ssh_config(5) format (ssh -o option) -:option:`--public` +.. option:: --public + Use public IP address -:option:`--private` +.. option:: --private + Use private IP address -:option:`--address-type` <address-type> +.. option:: --address-type <address-type> + Use other IP address (public, private, etc) -:option:`<server>` +.. describe:: <server> + Server (name or ID) server suspend @@ -483,7 +560,8 @@ Suspend server os server suspend <server> -:option:`<server>` +.. describe:: <server> + Server (name or ID) server unlock @@ -496,7 +574,8 @@ Unlock server os server unlock <server> -:option:`<server>` +.. describe:: <server> + Server (name or ID) server unpause @@ -509,7 +588,8 @@ Unpause server os server unpause <server> -:option:`<server>` +.. describe:: <server> + Server (name or ID) server unrescue @@ -522,7 +602,8 @@ Restore server from rescue mode os server unrescue <server> -:option:`<server>` +.. describe:: <server> + Server (name or ID) server unset @@ -537,8 +618,10 @@ Unset server properties [--property <key>] ... <server> -:option:`--property` <key> +.. option:: --property <key> + Property key to remove from server (repeat to set multiple values) -:option:`<server>` +.. describe:: <server> + Server (name or ID) diff --git a/doc/source/command-objects/service.rst b/doc/source/command-objects/service.rst new file mode 100644 index 00000000..352f68a0 --- /dev/null +++ b/doc/source/command-objects/service.rst @@ -0,0 +1,143 @@ +======= +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) diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst new file mode 100644 index 00000000..7bfd1d92 --- /dev/null +++ b/doc/source/command-objects/snapshot.rst @@ -0,0 +1,133 @@ +======== +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) diff --git a/doc/source/command-objects/usage.rst b/doc/source/command-objects/usage.rst index 551176c7..0c866086 100644 --- a/doc/source/command-objects/usage.rst +++ b/doc/source/command-objects/usage.rst @@ -18,7 +18,7 @@ List resource usage per project .. option:: --start <start> - Usage range start date, ex 2012-01-20 (default: 4 weeks ago). + Usage range start date, ex 2012-01-20 (default: 4 weeks ago) .. option:: --end <end> @@ -27,7 +27,7 @@ List resource usage per project usage show ---------- -Show resource usage for a single project. +Show resource usage for a single project .. program:: usage show .. code:: bash @@ -39,11 +39,11 @@ Show resource usage for a single project. .. option:: --project <project> - Name or ID of project to show usage for. + Name or ID of project to show usage for .. option:: --start <start> - Usage range start date, ex 2012-01-20 (default: 4 weeks ago). + Usage range start date, ex 2012-01-20 (default: 4 weeks ago) .. option:: --end <end> diff --git a/doc/source/command-objects/user-role.rst b/doc/source/command-objects/user-role.rst index a25e90ff..8283f911 100644 --- a/doc/source/command-objects/user-role.rst +++ b/doc/source/command-objects/user-role.rst @@ -2,6 +2,8 @@ user role ========= +Identity v2 + user role list -------------- diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst index e54c6567..9c81a403 100644 --- a/doc/source/command-objects/user.rst +++ b/doc/source/command-objects/user.rst @@ -101,28 +101,26 @@ List users .. code:: bash os user list - [--domain <domain>] [--project <project>] - [--group <group>] + [--domain <domain>] + [--group <group> | --project <project>] [--long] -.. option:: --domain <domain> - - Filter users by `<domain>` (name or ID) - - .. versionadded:: 3 - .. option:: --project <project> Filter users by `<project>` (name or ID) - *Removed in version 3.* +.. option:: --domain <domain> + + Filter users by `<domain>` (name or ID) + + *Identity version 3 only* .. option:: --group <group> Filter users by `<group>` membership (name or ID) - .. versionadded:: 3 + *Identity version 3 only* .. option:: --long @@ -193,6 +191,8 @@ Set user properties user show --------- +Display user details + .. program:: user show .. code:: bash @@ -209,4 +209,4 @@ user show .. _user_show-user: .. describe:: <user> - User to show (name or ID) + User to display (name or ID) diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst new file mode 100644 index 00000000..0898df52 --- /dev/null +++ b/doc/source/command-objects/volume-type.rst @@ -0,0 +1,95 @@ +=========== +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) diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst new file mode 100644 index 00000000..2eec2d7b --- /dev/null +++ b/doc/source/command-objects/volume.rst @@ -0,0 +1,189 @@ +====== +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) |