diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2017-09-14 11:06:51 -0500 |
|---|---|---|
| committer | Dean Troyer <dtroyer@gmail.com> | 2017-09-14 11:16:11 -0500 |
| commit | 5309bf5f873aba4e994c9011a893987c40d56eda (patch) | |
| tree | 9e1bf90f6bb27cc6e0a5f9b4ef81ef8431d21599 /doc/source/cli/command-objects | |
| parent | 5e5239d5eb635470b0c3bc63c4a6263808c41c9b (diff) | |
| parent | f63bb180036c0f2d096eefaaaf2fbdd60a427343 (diff) | |
| download | python-openstackclient-5309bf5f873aba4e994c9011a893987c40d56eda.tar.gz | |
Merge remote-tracking branch 'origin/master' into f4-merge-branch
Change-Id: Ie6c321e67aa9338334e4649879e60847a5d1eb56
Diffstat (limited to 'doc/source/cli/command-objects')
| -rw-r--r-- | doc/source/cli/command-objects/container.rst | 154 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/image.rst | 64 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/implied_role.rst | 57 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/object-store-account.rst | 46 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/object.rst | 201 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/subnet.rst | 7 |
6 files changed, 139 insertions, 390 deletions
diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst index e68955ad..83deeb81 100644 --- a/doc/source/cli/command-objects/container.rst +++ b/doc/source/cli/command-objects/container.rst @@ -2,149 +2,25 @@ container ========= -Object Storage v1 +A **container** defines a namespace for **objects**. Applies to Object Storage v1 -container create ----------------- +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container create -Create new container +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container delete -.. program:: container create -.. code:: bash +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container list - openstack container create - <container-name> [<container-name> ...] +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container save -.. describe:: <container-name> +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container set - New container name(s) +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container show -container delete ----------------- - -Delete container - -.. program:: container delete -.. code:: bash - - openstack container delete - [-r] | [--recursive] - <container> [<container> ...] - -.. option:: --recursive, -r - - Recursively delete objects in container before container delete - -.. describe:: <container> - - Container(s) to delete - -container list --------------- - -List containers - -.. program:: container list -.. code:: bash - - openstack container list - [--prefix <prefix>] - [--marker <marker>] - [--end-marker <end-marker>] - [--limit <num-containers>] - [--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 <num-containers> - - 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 - - openstack container save - <container> - -.. describe:: <container> - - Container to save - -container set -------------- - -Set container properties - -.. program:: container set -.. code:: bash - - openstack container set - [--property <key=value> [...] ] - <container> - -.. option:: --property <key=value> - - Set a property on this container (repeat option to set multiple properties) - -.. describe:: <container> - - Container to modify - -container show --------------- - -Display container details - -.. program:: container show -.. code:: bash - - openstack container show - <container> - -.. describe:: <container> - - Container to display - -container unset ---------------- - -Unset container properties - -.. program:: container unset -.. code:: bash - - openstack container unset - [--property <key>] - <container> - -.. option:: --property <key> - - Property to remove from container (repeat option to remove multiple properties) - -.. describe:: <container> - - Container to modify +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container unset diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst index 92efd0a5..e2257bbb 100644 --- a/doc/source/cli/command-objects/image.rst +++ b/doc/source/cli/command-objects/image.rst @@ -16,7 +16,8 @@ Associate project with image openstack image add project [--project-domain <project-domain>] - <image> <project> + <image> + <project> .. option:: --project-domain <project-domain> @@ -60,7 +61,8 @@ Create/upload an image [--public | --private | --community | --shared] [--property <key=value> [...] ] [--tag <tag> [...] ] - [--project <project> [--project-domain <project-domain>]] + [--project <project>] + [--project-domain <project-domain>] <image-name> .. option:: --id <id> @@ -153,11 +155,11 @@ Create/upload an image .. option:: --property <key=value> - Set a property on this image (repeat for multiple values) + Set a property on this image (repeat option to set multiple properties) .. option:: --tag <tag> - Set a tag on this image (repeat for multiple values) + Set a tag on this image (repeat option to set multiple tags) .. versionadded:: 2 @@ -205,13 +207,12 @@ List available images openstack image list [--public | --private | --shared] [--property <key=value>] + [--name <name>] + [--status <status>] [--long] [--sort <key>[:<direction>]] [--limit <num-images>] [--marker <image>] - [--name <name>] - [--status <status>] - .. option:: --public @@ -231,6 +232,18 @@ List available images Filter output based on property +.. option:: --name <name> + + Filter images based on name + + *Image version 2 only.* + +.. option:: --status <status> + + Filter images based on status + + *Image version 2 only* + .. option:: --long List additional fields in output @@ -251,15 +264,6 @@ List available images The last image of the previous page. Display list of images after marker. Display all images if not specified. (name or ID) -.. option:: --name <name> - - Filter images based on name - -.. option:: --status <status> - - Filter images based on status - - *Image version 2 only* image remove project @@ -272,7 +276,7 @@ Disassociate project with image .. program:: image remove project .. code:: bash - openstack image remove remove + openstack image remove project [--project-domain <project-domain>] <image> <project> @@ -347,8 +351,9 @@ Set image properties [--os-distro <os-distro>] [--os-version <os-version>] [--ramdisk-id <ramdisk-id>] - [--activate|--deactivate] - [--project <project> [--project-domain <project-domain>]] + [--deactivate | --activate] + [--project <project>] + [--project-domain <project-domain>] [--accept | --reject | --pending] <image> @@ -460,7 +465,7 @@ Set image properties .. option:: --tag <tag> - Set a tag on this image (repeat for multiple values) + Set a tag on this image (repeat option to set multiple tags) .. versionadded:: 2 @@ -500,15 +505,15 @@ Set image properties .. versionadded:: 2 -.. option:: --activate +.. option:: --deactivate - Activate the image. + Deactivate the image. .. versionadded:: 2 -.. option:: --deactivate +.. option:: --activate - Deactivate the image. + Activate the image. .. versionadded:: 2 @@ -568,8 +573,13 @@ Display image details .. code:: bash openstack image show + [--human-readable] <image> +.. option:: --human-readable + + Print image size in a human-friendly format. + .. _image_show-image: .. describe:: <image> @@ -585,16 +595,16 @@ Unset image tags or properties .. program:: image unset .. code:: bash - openstack image set + openstack image unset [--tag <tag>] - [--property <property>] + [--property <property-key>] <image> .. option:: --tag <tag> Unset a tag on this image (repeat option to unset multiple tags) -.. option:: --property <property> +.. option:: --property <property-key> Unset a property on this image (repeat option to unset multiple properties) diff --git a/doc/source/cli/command-objects/implied_role.rst b/doc/source/cli/command-objects/implied_role.rst new file mode 100644 index 00000000..e43c9ea3 --- /dev/null +++ b/doc/source/cli/command-objects/implied_role.rst @@ -0,0 +1,57 @@ +============ +implied role +============ + +Identity v3 + + +implied role create +------------------- + +Creates an association between prior and implied roles + +.. program:: implied role create +.. code:: bash + + openstack implied role create + <role> + --implied-role <role> + +.. option:: <role> + + Prior role <role> (name or ID) implies another role + +.. option:: --implied-role <role> + + <role> (name or ID) implied by another role + + +implied role delete +------------------- + +Deletes an association between prior and implied roles + +.. program:: implied role delete +.. code:: bash + + openstack implied role delete + <role> + --implied-role <role> + +.. option:: <role> + + Prior role <role> (name or ID) implies another role + +.. option:: --implied-role <role> + + <role> (name or ID) implied by another role + +implied role list +----------------- + +List implied roles + +.. program:: implied role list +.. code:: bash + + openstack implied role list diff --git a/doc/source/cli/command-objects/object-store-account.rst b/doc/source/cli/command-objects/object-store-account.rst index e8f09d45..6beb63af 100644 --- a/doc/source/cli/command-objects/object-store-account.rst +++ b/doc/source/cli/command-objects/object-store-account.rst @@ -2,44 +2,14 @@ object store account ==================== -Object Storage v1 +An **object store account** represents the top-level of the hierarchy that +is comprised of **containers** and **objects**. Applies to Object Storage v1. -object store account set ------------------------- +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object store account set -Set account properties +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object store account show -.. program:: object store account set -.. code:: bash - - openstack object store account set - [--property <key=value> [...] ] - -.. option:: --property <key=value> - - Set a property on this account (repeat option to set multiple properties) - -object store account show -------------------------- - -Display account details - -.. program:: object store account show -.. code:: bash - - openstack object store account show - -object store account unset --------------------------- - -Unset account properties - -.. program:: object store account unset -.. code:: bash - - openstack object store account unset - [--property <key>] - -.. option:: --property <key> - - Property to remove from account (repeat option to remove multiple properties) +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object store account unset diff --git a/doc/source/cli/command-objects/object.rst b/doc/source/cli/command-objects/object.rst index 4cba38ee..8b328bd5 100644 --- a/doc/source/cli/command-objects/object.rst +++ b/doc/source/cli/command-objects/object.rst @@ -2,195 +2,26 @@ object ====== -Object Storage v1 +An **object** stores data content, such as documents, images, and so on. They +can also store custom metadata with an object. Applies to Object Storage v1. -object create -------------- +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object create -Upload object to container +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object delete -.. program:: object create -.. code:: bash +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object list - openstack object create - [--name <name>] - <container> - <filename> [<filename> ...] +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object save -.. option:: --name <name> +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object set - Upload a file and rename it. Can only be used when uploading a single object +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object show -.. describe:: <container> - - Container for new object - -.. describe:: <filename> - - Local filename(s) to upload - -object delete -------------- - -Delete object from container - -.. program:: object delete -.. code:: bash - - openstack object delete - <container> - <object> [<object> ...] - -.. describe:: <container> - - Delete object(s) from <container> - -.. describe:: <object> - - Object(s) to delete - -object list ------------ - -List objects - -.. program object list -.. code:: bash - - openstack object list - [--prefix <prefix>] - [--delimiter <delimiter>] - [--marker <marker>] - [--end-marker <end-marker>] - [--limit <num-objects>] - [--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 <num-objects> - - 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 - - openstack object save - [--file <filename>] - <container> - <object> - -.. option:: --file <filename> - - Destination filename (defaults to object name); - using - as the filename will print the file to stdout - -.. describe:: <container> - - Download <object> from <container> - -.. describe:: <object> - - Object to save - -object set ----------- - -Set object properties - -.. program:: object set -.. code:: bash - - openstack object set - [--property <key=value> [...] ] - <container> - <object> - -.. option:: --property <key=value> - - Set a property on this object (repeat option to set multiple properties) - -.. describe:: <container> - - Modify <object> from <container> - -.. describe:: <object> - - Object to modify - -object show ------------ - -Display object details - -.. program:: object show -.. code:: bash - - openstack object show - <container> - <object> - -.. describe:: <container> - - Display <object> from <container> - -.. describe:: <object> - - Object to display - -object unset ------------- - -Unset object properties - -.. program:: object unset -.. code:: bash - - openstack object unset - [--property <key>] - <container> - <object> - -.. option:: --property <key> - - Property to remove from object (repeat option to remove multiple properties) - -.. describe:: <container> - - Modify <object> from <container> - -.. describe:: <object> - - Object to modify +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object unset diff --git a/doc/source/cli/command-objects/subnet.rst b/doc/source/cli/command-objects/subnet.rst index c228dc20..0a56ccf1 100644 --- a/doc/source/cli/command-objects/subnet.rst +++ b/doc/source/cli/command-objects/subnet.rst @@ -18,7 +18,7 @@ Create new subnet openstack subnet create [--project <project> [--project-domain <project-domain>]] - [--subnet-pool <subnet-pool> | --use-default-subnet-pool [--prefix-length <prefix-length>]] + [--subnet-pool <subnet-pool> | --use-default-subnet-pool [--prefix-length <prefix-length>] | --use-prefix-delegation] [--subnet-range <subnet-range>] [--allocation-pool start=<ip-address>,end=<ip-address>] [--dhcp | --no-dhcp] @@ -48,6 +48,11 @@ Create new subnet Subnet pool from which this subnet will obtain a CIDR (name or ID) +.. option:: --use-prefix-delegation + + Use 'prefix-delegation' if IP is IPv6 format and IP would be delegated + externally + .. option:: --use-default-subnet-pool Use default subnet pool for :option:`--ip-version` |
