diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/command.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/endpoint.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 3 | ||||
| -rw-r--r-- | doc/source/command-objects/network-auto-allocated-topology.rst | 69 | ||||
| -rw-r--r-- | doc/source/command-objects/network-flavor.rst | 139 | ||||
| -rw-r--r-- | doc/source/command-objects/network-service-provider.rst | 1 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-host.rst | 26 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-type.rst | 81 |
9 files changed, 325 insertions, 6 deletions
diff --git a/doc/source/command-objects/command.rst b/doc/source/command-objects/command.rst index 34c07da6..918fd959 100644 --- a/doc/source/command-objects/command.rst +++ b/doc/source/command-objects/command.rst @@ -15,3 +15,9 @@ List recognized commands by group .. code:: bash openstack command list + [--group <group-keyword>] + +.. option:: --group <group-keyword> + + Show commands filtered by a command group, for example: identity, volume, + compute, image, network and other keywords diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst index d6eb362a..b98055a1 100644 --- a/doc/source/command-objects/endpoint.rst +++ b/doc/source/command-objects/endpoint.rst @@ -103,14 +103,14 @@ List endpoints .. code:: bash openstack endpoint list - [--service <service] + [--service <service>] [--interface <interface>] [--region <region-id>] [--long] .. option:: --service <service> - Filter by service (name or ID) + Filter by service (type, name or ID) *Identity version 3 only* diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 7a9ead5c..c39d9a28 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -53,8 +53,7 @@ Create/upload an image [--min-ram <ram-mb>] [--location <image-url>] [--copy-from <image-url>] - [--file <file>] - [--volume <volume>] + [--file <file> | --volume <volume>] [--force] [--checksum <checksum>] [--protected | --unprotected] diff --git a/doc/source/command-objects/network-auto-allocated-topology.rst b/doc/source/command-objects/network-auto-allocated-topology.rst new file mode 100644 index 00000000..4ed68cda --- /dev/null +++ b/doc/source/command-objects/network-auto-allocated-topology.rst @@ -0,0 +1,69 @@ +=============================== +network auto allocated topology +=============================== + +An **auto allocated topology** allows admins to quickly set up external +connectivity for end-users. Only one auto allocated topology is allowed per +project. For more information on how to set up the resources required +for auto allocated topology review the documentation at: +http://docs.openstack.org/newton/networking-guide/config-auto-allocation.html + +Network v2 + +network auto allocated topology create +-------------------------------------- + +Create the auto allocated topology for project + +.. program:: network auto allocated topology create +.. code:: bash + + openstack network auto allocated topology create + [--or-show] + [--check-resources] + [--project <project> [--project-domain <project-domain>]] + +.. option:: --or-show + + If topology exists returns the topologies information (Default). + +.. option:: --check-resources + + Validate the requirements for auto allocated topology. + Does not return a topology. + +.. option:: --project <project> + + Return the auto allocated topology for a given project. + Default is current project. + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _network_auto_allocated_topology_create: + + +network auto allocated topology delete +-------------------------------------- + +Delete auto allocated topology for project + +.. program:: network auto allocated topology delete +.. code:: bash + + openstack network auto allocated topology delete + [--project <project> [--project-domain <project-domain>]] + +.. option:: --project <project> + + Delete auto allocated topology for a given project. + Default is the current project. + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _network_auto_allocated_topology_delete: diff --git a/doc/source/command-objects/network-flavor.rst b/doc/source/command-objects/network-flavor.rst new file mode 100644 index 00000000..d5c011f6 --- /dev/null +++ b/doc/source/command-objects/network-flavor.rst @@ -0,0 +1,139 @@ +============== +network flavor +============== + +A **network flavor** extension allows the user selection of operator-curated +flavors during resource creations. It allows administrators to create network +service flavors. + +Network v2 + +network flavor create +--------------------- + +Create network flavor + +.. program:: network flavor create +.. code:: bash + + openstack network flavor create + --service-type <service-type> + [--description <description>] + [--enable | --disable] + [--project <project> [--project-domain <project-domain>]] + <name> + +.. option:: --service-type <service-type> + + Service type to which the flavor applies to: e.g. VPN. + (See openstack :ref:'network_service_provider_list` (required) + +.. option:: --description <description> + + Description for the flavor + +.. option:: --enable + + Enable the flavor (default) + +.. option:: --disable + + Disable the flavor + +.. 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. + +.. describe:: <name> + + Name for the flavor + +.. _network_flavor_create: + +network flavor delete +--------------------- + +Delete network flavor(s) + +.. program:: network flavor delete +.. code:: bash + + openstack network flavor delete + <flavor> [<flavor> ...] + +.. describe:: <flavor> + + Flavor(s) to delete (name or ID) + +.. _network_flavor_delete: + +network flavor list +------------------- + +List network flavors + +.. program:: network flavor list +.. code:: bash + + openstack network flavor list + +.. _network_flavor_list: + +network flavor set +------------------ + +Set network flavor properties + +.. program:: network flavor set +.. code:: bash + + openstack network flavor set + [--name <name>] + [--description <description>] + [--enable | --disable] + <flavor> + +.. option:: --name <name> + + Set flavor name + +.. option:: --description <description> + + Set network flavor description + +.. option:: --enable + + Enable network flavor + +.. option:: --disable + + Disable network flavor + +.. describe:: <flavor> + + Flavor to update (name or ID) + +.. _network_flavor_set: + +network flavor show +------------------- + +Show network flavor + +.. program:: network flavor show +.. code:: bash + + openstack network flavor show + <flavor> + +.. describe:: <flavor> + + Flavor to display (name or ID) + +.. _network_flavor_show: diff --git a/doc/source/command-objects/network-service-provider.rst b/doc/source/command-objects/network-service-provider.rst index 8db2ab44..8ccec455 100644 --- a/doc/source/command-objects/network-service-provider.rst +++ b/doc/source/command-objects/network-service-provider.rst @@ -7,6 +7,7 @@ networking service Network v2 +.. _network_service_provider_list: network service provider list ----------------------------- diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index a5d22f81..b2ae965a 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -173,6 +173,8 @@ Create a new server v6-fixed-ip: IPv6 fixed address for NIC (optional). none: (v2.37+) no network is attached. auto: (v2.37+) the compute service will automatically allocate a network. + Specifying a --nic of auto or none cannot be used with any other + --nic value. .. option:: --hint <key=value> diff --git a/doc/source/command-objects/volume-host.rst b/doc/source/command-objects/volume-host.rst index a225e53e..1e513cb7 100644 --- a/doc/source/command-objects/volume-host.rst +++ b/doc/source/command-objects/volume-host.rst @@ -4,6 +4,28 @@ volume host Volume v2 +volume host failover +-------------------- + +Failover volume host to different backend + +.. program:: volume host failover +.. code:: bash + + openstack volume host failover + --volume-backend <backend-id> + <host-name> + +.. option:: --volume-backend <backend-id> + + The ID of the volume backend replication + target where the host will failover to (required) + +.. _volume_host_failover-host-name: +.. describe:: <host-name> + + Name of volume host + volume host set --------------- @@ -18,13 +40,13 @@ Set volume host properties .. option:: --enable - Thaw and enable the specified volume host + Thaw and enable the specified volume host. .. option:: --disable Freeze and disable the specified volume host -.. _volume-host-set: +.. _volume_host_set-host-name: .. describe:: <host-name> Name of volume host diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst index 40e9825c..afa293d7 100644 --- a/doc/source/command-objects/volume-type.rst +++ b/doc/source/command-objects/volume-type.rst @@ -18,6 +18,10 @@ Create new volume type [--property <key=value> [...] ] [--project <project>] [--project-domain <project-domain>] + [--encryption-provider <provider>] + [--encryption-cipher <cipher>] + [--encryption-key-size <key-size>] + [--encryption-control-location <control-location>] <name> .. option:: --description <description> @@ -56,6 +60,34 @@ Create new volume type *Volume version 2 only* +.. option:: --encryption-provider <provider> + + Set the class that provides encryption support for this volume type + (e.g "LuksEncryptor") (admin only) + + This option is required when setting encryption type of a volume. + Consider using other encryption options such as: :option:`--encryption-cipher`, + :option:`--encryption-key-size` and :option:`--encryption-control-location` + +.. option:: --encryption-cipher <cipher> + + Set the encryption algorithm or mode for this volume type + (e.g "aes-xts-plain64") (admin only) + +.. option:: --encryption-key-size <key-size> + + Set the size of the encryption key of this volume type + (e.g "128" or "256") (admin only) + +.. option:: --encryption-control-location <control-location> + + Set the notional service where the encryption is performed + ("front-end" or "back-end") (admin only) + + The default value for this option is "front-end" when setting encryption type of + a volume. Consider using other encryption options such as: :option:`--encryption-cipher`, + :option:`--encryption-key-size` and :option:`--encryption-provider` + .. _volume_type_create-name: .. describe:: <name> @@ -88,6 +120,7 @@ List volume types openstack volume type list [--long] [--default | --public | --private] + [--encryption-type] .. option:: --long @@ -111,6 +144,10 @@ List volume types *Volume version 2 only* +.. option:: --encryption-type + + Display encryption information for each volume type (admin only) + volume type set --------------- @@ -125,6 +162,10 @@ Set volume type properties [--property <key=value> [...] ] [--project <project>] [--project-domain <project-domain>] + [--encryption-provider <provider>] + [--encryption-cipher <cipher>] + [--encryption-key-size <key-size>] + [--encryption-control-location <control-location>] <volume-type> .. option:: --name <name> @@ -154,6 +195,34 @@ Set volume type properties Set a property on this volume type (repeat option to set multiple properties) +.. option:: --encryption-provider <provider> + + Set the class that provides encryption support for this volume type + (e.g "LuksEncryptor") (admin only) + + This option is required when setting encryption type of a volume for the first time. + Consider using other encryption options such as: :option:`--encryption-cipher`, + :option:`--encryption-key-size` and :option:`--encryption-control-location` + +.. option:: --encryption-cipher <cipher> + + Set the encryption algorithm or mode for this volume type + (e.g "aes-xts-plain64") (admin only) + +.. option:: --encryption-key-size <key-size> + + Set the size of the encryption key of this volume type + (e.g "128" or "256") (admin only) + +.. option:: --encryption-control-location <control-location> + + Set the notional service where the encryption is performed + ("front-end" or "back-end") (admin only) + + The default value for this option is "front-end" when setting encryption type of + a volume for the first time. Consider using other encryption options such as: + :option:`--encryption-cipher`, :option:`--encryption-key-size` and :option:`--encryption-provider` + .. _volume_type_set-volume-type: .. describe:: <volume-type> @@ -168,8 +237,13 @@ Display volume type details .. code:: bash openstack volume type show + [--encryption-type] <volume-type> +.. option:: --encryption-type + + Display encryption information of this volume type (admin only) + .. _volume_type_show-volume-type: .. describe:: <volume-type> @@ -187,6 +261,7 @@ Unset volume type properties [--property <key> [...] ] [--project <project>] [--project-domain <project-domain>] + [--encryption-type] <volume-type> .. option:: --property <key> @@ -204,6 +279,12 @@ Unset volume type properties Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. + *Volume version 2 only* + +.. option:: --encryption-type + + Remove the encryption type for this volume type (admin only) + .. _volume_type_unset-volume-type: .. describe:: <volume-type> |