diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/address-scope.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/endpoint.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 27 | ||||
| -rw-r--r-- | doc/source/command-objects/network-segment.rst | 54 | ||||
| -rw-r--r-- | doc/source/command-objects/server-backup.rst | 44 | ||||
| -rw-r--r-- | doc/source/command-objects/server-group.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 5 |
7 files changed, 137 insertions, 7 deletions
diff --git a/doc/source/command-objects/address-scope.rst b/doc/source/command-objects/address-scope.rst index a2ab566c..7481ed53 100644 --- a/doc/source/command-objects/address-scope.rst +++ b/doc/source/command-objects/address-scope.rst @@ -50,18 +50,18 @@ Create new address scope address scope delete -------------------- -Delete an address scope +Delete address scope(s) .. program:: address scope delete .. code:: bash os address scope delete - <address-scope> + <address-scope> [<address-scope> ...] .. _address_scope_delete-address-scope: .. describe:: <address-scope> - Address scope to delete (name or ID) + Address scope(s) to delete (name or ID) address scope list ------------------ diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst index 074f20a0..9872a587 100644 --- a/doc/source/command-objects/endpoint.rst +++ b/doc/source/command-objects/endpoint.rst @@ -188,9 +188,9 @@ Display endpoint details .. code:: bash os endpoint show - <endpoint-id> + <endpoint> .. _endpoint_show-endpoint: -.. describe:: <endpoint-id> +.. describe:: <endpoint> - Endpoint ID to display + Endpoint to display (endpoint ID, service ID, service name, service type) diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 942c03d5..d6451af7 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -499,3 +499,30 @@ Display image details .. describe:: <image> Image to display (name or ID) + +image unset +----------- + +*Only supported for Image v2* + +Unset image tags or properties + +.. program:: image unset +.. code:: bash + + os image set + [--tag <tag>] + [--property <property>] + <image> + +.. option:: --tag <tag> + + Unset a tag on this image (repeat option to unset multiple tags) + +.. option:: --property <property> + + Unset a property on this image (repeat option to unset multiple properties) + +.. describe:: <image> + + Image to modify (name or ID) diff --git a/doc/source/command-objects/network-segment.rst b/doc/source/command-objects/network-segment.rst new file mode 100644 index 00000000..8e177d6a --- /dev/null +++ b/doc/source/command-objects/network-segment.rst @@ -0,0 +1,54 @@ +=============== +network segment +=============== + +A **network segment** is an isolated Layer 2 segment within a network. +A network may contain multiple network segments. Depending on the +network configuration, Layer 2 connectivity between network segments +within a network may not be guaranteed. + +Network v2 + +network segment list +-------------------- + +List network segments + +.. caution:: This is a beta command and subject to change. + Use global option ``--enable-beta-commands`` to + enable this command. + +.. program:: network segment list +.. code:: bash + + os network segment list + [--long] + [--network <network>] + +.. option:: --long + + List additional fields in output + +.. option:: --network <network> + + List network segments that belong to this network (name or ID) + +network segment show +-------------------- + +Display network segment details + +.. caution:: This is a beta command and subject to change. + Use global option ``--enable-beta-commands`` to + enable this command. + +.. program:: network segment show +.. code:: bash + + os network segment show + <network-segment> + +.. _network_segment_show-segment: +.. describe:: <network-segment> + + Network segment to display (ID only) diff --git a/doc/source/command-objects/server-backup.rst b/doc/source/command-objects/server-backup.rst new file mode 100644 index 00000000..23e17d5f --- /dev/null +++ b/doc/source/command-objects/server-backup.rst @@ -0,0 +1,44 @@ +============= +server backup +============= + +A server backup is a disk image created in the Image store from a running server +instance. The backup command manages the number of archival copies to retain. + +Compute v2 + +server backup create +-------------------- + +Create a server backup image + +.. program:: server create +.. code:: bash + + os server backup create + [--name <image-name>] + [--type <backup-type>] + [--rotate <count>] + [--wait] + <server> + +.. option:: --name <image-name> + + Name of the backup image (default: server name) + +.. option:: --type <backup-type> + + Used to populate the ``backup_type`` property of the backup + image (default: empty) + +.. option:: --rotate <count> + + Number of backup images to keep (default: 1) + +.. option:: --wait + + Wait for operation to complete + +.. describe:: <server> + + Server to back up (name or ID) diff --git a/doc/source/command-objects/server-group.rst b/doc/source/command-objects/server-group.rst index 55d789c7..414f49b1 100644 --- a/doc/source/command-objects/server-group.rst +++ b/doc/source/command-objects/server-group.rst @@ -31,7 +31,7 @@ Create a new server group server group delete ------------------- -Delete an existing server group +Delete existing server group(s) .. program:: server group delete .. code-block:: bash diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index bf972986..f11355b6 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -559,6 +559,7 @@ Set server properties --property <key=value> [--property <key=value>] ... --root-password + --state <state> <server> .. option:: --name <new-name> @@ -574,6 +575,10 @@ Set server properties Property to add/change for this server (repeat option to set multiple properties) +.. option:: --state <state> + + New server state (valid value: active, error) + .. describe:: <server> Server (name or ID) |
