diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/availability-zone.rst | 17 | ||||
| -rw-r--r-- | doc/source/command-objects/backup.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/compute-service.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/extension.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 60 | ||||
| -rw-r--r-- | doc/source/command-objects/limits.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 14 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 37 | ||||
| -rw-r--r-- | doc/source/command-objects/project.rst | 24 | ||||
| -rw-r--r-- | doc/source/command-objects/quota.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/router.rst | 137 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 12 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/snapshot.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 20 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-qos.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-type.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/volume.rst | 2 |
19 files changed, 320 insertions, 36 deletions
diff --git a/doc/source/command-objects/availability-zone.rst b/doc/source/command-objects/availability-zone.rst index 37435230..1f568438 100644 --- a/doc/source/command-objects/availability-zone.rst +++ b/doc/source/command-objects/availability-zone.rst @@ -2,7 +2,7 @@ availability zone ================= -Compute v2 +Block Storage v2, Compute v2, Network v2 availability zone list ---------------------- @@ -13,8 +13,23 @@ List availability zones and their status .. code:: bash os availability zone list + [--compute] + [--network] + [--volume] [--long] +.. option:: --compute + + List compute availability zones + +.. option:: --network + + List network availability zones + +.. option:: --volume + + List volume availability zones + .. option:: --long List additional fields in output diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst index ec201aa3..9d7fb95d 100644 --- a/doc/source/command-objects/backup.rst +++ b/doc/source/command-objects/backup.rst @@ -2,7 +2,7 @@ backup ====== -Volume v1 +Block Storage v1 backup create ------------- diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst index 95a77bdf..7bcab4d6 100644 --- a/doc/source/command-objects/compute-service.rst +++ b/doc/source/command-objects/compute-service.rst @@ -57,7 +57,7 @@ Set service command .. _compute-service-set: .. describe:: --enable - Enable service + Enable service (default) .. describe:: --disable diff --git a/doc/source/command-objects/extension.rst b/doc/source/command-objects/extension.rst index 8f39a625..dff30fa1 100644 --- a/doc/source/command-objects/extension.rst +++ b/doc/source/command-objects/extension.rst @@ -34,7 +34,7 @@ List API extensions .. option:: --volume - List extensions for the Volume API + List extensions for the Block Storage API .. option:: --long diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index d4b99162..61872ec4 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -19,7 +19,6 @@ Create/upload an image [--store <store>] [--container-format <container-format>] [--disk-format <disk-format>] - [--owner <project>] [--size <size>] [--min-disk <disk-gb>] [--min-ram <ram-mb>] @@ -33,6 +32,7 @@ Create/upload an image [--public | --private] [--property <key=value> [...] ] [--tag <tag> [...] ] + [--project <project> [--project-domain <project-domain>]] <image-name> .. option:: --id <id> @@ -53,10 +53,6 @@ Create/upload an image 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) @@ -127,6 +123,18 @@ Create/upload an image .. versionadded:: 2 +.. option:: --project <project> + + Set an alternate project on this image (name or ID). + Previously known as `--owner`. + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + .. versionadded:: 2 + .. describe:: <image-name> New image name @@ -159,6 +167,8 @@ List available images [--property <key=value>] [--long] [--sort <key>[:<direction>]] + [--limit <limit>] + [--marker <marker>] .. option:: --public @@ -187,6 +197,15 @@ List available images Sort output by selected keys and directions(asc or desc) (default: asc), multiple keys and directions can be specified separated by comma +.. option:: --limit <limit> + + Maximum number of images to display. + +.. option:: --marker <marker> + + The last image (name or ID) of the previous page. Display list of images + after marker. Display all images if not specified. + image save ---------- @@ -219,7 +238,6 @@ Set image properties os image set [--name <name>] - [--owner <project>] [--min-disk <disk-gb>] [--min-ram <disk-ram>] [--container-format <container-format>] @@ -243,16 +261,14 @@ Set image properties [--os-distro <os-distro>] [--os-version <os-version>] [--ramdisk-id <ramdisk-id>] + [--activate|--deactivate] + [--project <project> [--project-domain <project-domain>]] <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 @@ -387,6 +403,30 @@ Set image properties .. versionadded:: 2 +.. option:: --activate + + Activate the image. + + .. versionadded:: 2 + +.. option:: --deactivate + + Deactivate the image. + + .. versionadded:: 2 + +.. option:: --project <project> + + Set an alternate project on this image (name or ID). + Previously known as `--owner`. + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + .. versionadded:: 2 + .. describe:: <image> Image to modify (name or ID) diff --git a/doc/source/command-objects/limits.rst b/doc/source/command-objects/limits.rst index 0d466af6..6a7509f2 100644 --- a/doc/source/command-objects/limits.rst +++ b/doc/source/command-objects/limits.rst @@ -2,14 +2,14 @@ limits ====== -The Compute and Volume APIs have resource usage limits. +The Compute and Block Storage APIs have resource usage limits. -Compute v2, Volume v1 +Compute v2, Block Storage v1 limits show ----------- -Show compute and volume limits +Show compute and block storage limits .. program:: limits show .. code:: bash diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 6199d024..bb366672 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -16,6 +16,7 @@ Create new network [--project <project> [--project-domain <project-domain>]] [--enable | --disable] [--share | --no-share] + [--availability-zone-hint <availability-zone>] <name> .. option:: --project <project> @@ -43,6 +44,11 @@ Create new network Do not share the network between projects +.. option:: --availability-zone-hint <availability-zone> + + Availability Zone in which to create this network (requires the Network + Availability Zone extension, this option can be repeated). + .. _network_create-name: .. describe:: <name> @@ -59,10 +65,10 @@ Delete network(s) os network delete <network> [<network> ...] -.. _network_delete-project: +.. _network_delete-network: .. describe:: <network> - Network to delete (name or ID) + Network(s) to delete (name or ID) network list ------------ @@ -118,7 +124,7 @@ Set network properties Do not share the network between projects -.. _network_set-name: +.. _network_set-network: .. describe:: <network> Network to modify (name or ID) @@ -134,7 +140,7 @@ Display network details os network show <network> -.. _network_show-name: +.. _network_show-network: .. describe:: <network> Network to display (name or ID) diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst new file mode 100644 index 00000000..414b7437 --- /dev/null +++ b/doc/source/command-objects/port.rst @@ -0,0 +1,37 @@ +==== +port +==== + +Network v2 + +port delete +----------- + +Delete port(s) + +.. program:: port delete +.. code:: bash + + os port delete + <port> [<port> ...] + +.. _port_delete-port: +.. describe:: <port> + + Port(s) to delete (name or ID) + +port show +--------- + +Display port details + +.. program:: port show +.. code:: bash + + os port show + <port> + +.. _port_show-port: +.. describe:: <port> + + Port to display (name or ID) diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index a342115d..f76f79ff 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -156,6 +156,8 @@ Set project properties Set a property on :ref:`\<project\> <project_set-project>` (repeat option to set multiple properties) + *Identity version 2 only* + .. _project_set-project: .. describe:: <project> @@ -195,3 +197,25 @@ Display project details .. describe:: <project> Project to display (name or ID) + +project unset +------------- + +Unset project properties + +*Identity version 2 only* + +.. program:: project unset +.. code:: bash + + os project unset + --property <key> [--property <key> ...] + <project> + +.. option:: --property <key> + + Property key to remove from project (repeat option to remove multiple properties) + +.. describe:: <project> + + Project to modify (name or ID) diff --git a/doc/source/command-objects/quota.rst b/doc/source/command-objects/quota.rst index 5ea49f8c..98e6df33 100644 --- a/doc/source/command-objects/quota.rst +++ b/doc/source/command-objects/quota.rst @@ -4,7 +4,7 @@ quota Resource quotas appear in multiple APIs, OpenStackClient presents them as a single object with multiple properties. -Compute v2, Volume v1 +Compute v2, Block Storage v1 quota set --------- @@ -26,7 +26,7 @@ Set quotas for project [--properties <num-properties>] [--ram <ram-mb>] - # Volume settings + # Block Storage settings [--gigabytes <new-gigabytes>] [--snapshots <new-snapshots>] [--volumes <new-volumes>] @@ -51,7 +51,7 @@ Set quotas for class [--properties <num-properties>] [--ram <ram-mb>] - # Volume settings + # Block Storage settings [--gigabytes <new-gigabytes>] [--snapshots <new-snapshots>] [--volumes <new-volumes>] @@ -161,4 +161,4 @@ Show quotas for project .. _quota_show-class: .. describe:: <class> - Class to show
\ No newline at end of file + Class to show diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst new file mode 100644 index 00000000..2a5bf053 --- /dev/null +++ b/doc/source/command-objects/router.rst @@ -0,0 +1,137 @@ +====== +router +====== + +Network v2 + +router create +------------- + +Create new router + +.. program:: router create +.. code:: bash + + os router create + [--project <project> [--project-domain <project-domain>]] + [--enable | --disable] + [--distributed] + [--availability-zone-hint <availability-zone>] + <name> + +.. option:: --project <project> + + Owner's project (name or ID) + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --enable + + Enable router (default) + +.. option:: --disable + + Disable router + +.. option:: --distributed + + Create a distributed router + +.. option:: --availability-zone-hint <availability-zone> + + Availability Zone in which to create this router (requires the Router + Availability Zone extension, this option can be repeated). + +.. _router_create-name: +.. describe:: <name> + + New router name + +router delete +------------- + +Delete router(s) + +.. program:: router delete +.. code:: bash + + os router delete + <router> [<router> ...] + +.. _router_delete-router: +.. describe:: <router> + + Router(s) to delete (name or ID) + +router list +----------- + +List routers + +.. program:: router list +.. code:: bash + + os router list + [--long] + +.. option:: --long + + List additional fields in output + +router set +---------- + +Set router properties + +.. program:: router set +.. code:: bash + + os router set + [--name <name>] + [--enable | --disable] + [--distributed | --centralized] + <router> + +.. option:: --name <name> + + Set router name + +.. option:: --enable + + Enable router + +.. option:: --disable + + Disable router + +.. option:: --distributed + + Set router to distributed mode (disabled router only) + +.. option:: --centralized + + Set router to centralized mode (disabled router only) + +.. _router_set-router: +.. describe:: <router> + + Router to modify (name or ID) + +router show +----------- + +Display router details + +.. program:: router show +.. code:: bash + + os router show + <router> + +.. _router_show-router: +.. describe:: <router> + + Router to display (name or ID) diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index 8bd0d061..50bc64aa 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -2,7 +2,7 @@ security group rule =================== -Compute v2 +Compute v2, Network v2 security group rule create -------------------------- @@ -14,7 +14,7 @@ Create a new security group rule os security group rule create [--proto <proto>] - [--src-ip <ip-address>] + [--src-ip <ip-address> | --src-group <group>] [--dst-port <port-range>] <group> @@ -24,7 +24,11 @@ Create a new security group rule .. option:: --src-ip <ip-address> - Source IP (may use CIDR notation; default: 0.0.0.0/0) + Source IP address block (may use CIDR notation; default: 0.0.0.0/0) + +.. option:: --src-group <group> + + Source security group (ID only) .. option:: --dst-port <port-range> @@ -58,7 +62,7 @@ List security group rules .. code:: bash os security group rule list - <group> + [<group>] .. describe:: <group> diff --git a/doc/source/command-objects/security-group.rst b/doc/source/command-objects/security-group.rst index 60de41d8..cf86bda6 100644 --- a/doc/source/command-objects/security-group.rst +++ b/doc/source/command-objects/security-group.rst @@ -2,7 +2,7 @@ security group ============== -Compute v2 +Compute v2, Network v2 security group create --------------------- diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index fd487b8e..fc275971 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -375,14 +375,15 @@ Rebuild server .. code:: bash os server rebuild - --image <image> + [--image <image>] [--password <password>] [--wait] <server> .. option:: --image <image> - Recreate server from this image + Recreate server from the specified image (name or ID). Defaults to the + currently used one. .. option:: --password <password> diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst index e05673b8..b4838684 100644 --- a/doc/source/command-objects/snapshot.rst +++ b/doc/source/command-objects/snapshot.rst @@ -2,7 +2,7 @@ snapshot ======== -Volume v1 +Block Storage v1 snapshot create --------------- diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst new file mode 100644 index 00000000..70a0eedf --- /dev/null +++ b/doc/source/command-objects/subnet.rst @@ -0,0 +1,20 @@ +====== +subnet +====== + +Network v2 + +subnet list +----------- + +List subnets + +.. program:: subnet list +.. code:: bash + + os subnet list + [--long] + +.. option:: --long + + List additional fields in output diff --git a/doc/source/command-objects/volume-qos.rst b/doc/source/command-objects/volume-qos.rst index d0fe36f9..2d9d14a4 100644 --- a/doc/source/command-objects/volume-qos.rst +++ b/doc/source/command-objects/volume-qos.rst @@ -2,7 +2,7 @@ volume qos ========== -volume v1, v2 +Block Storage v1, v2 volume qos associate -------------------- diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst index 0edd742a..8a113847 100644 --- a/doc/source/command-objects/volume-type.rst +++ b/doc/source/command-objects/volume-type.rst @@ -2,7 +2,7 @@ volume type =========== -Volume v1, v2 +Block Storage v1, v2 volume type create ------------------ diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index cb52c560..bf89dc44 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -2,7 +2,7 @@ volume ====== -Volume v1, v2 +Block Storage v1, v2 volume create ------------- |
