From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: reorganize existing documentation according to the new standard layout Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann --- doc/source/cli/command-objects/access-token.rst | 42 + doc/source/cli/command-objects/address-scope.rst | 149 ++++ doc/source/cli/command-objects/aggregate.rst | 186 ++++ .../cli/command-objects/availability-zone.rst | 38 + doc/source/cli/command-objects/backup.rst | 137 +++ doc/source/cli/command-objects/catalog.rst | 30 + doc/source/cli/command-objects/command.rst | 23 + doc/source/cli/command-objects/complete.rst | 25 + doc/source/cli/command-objects/compute-agent.rst | 102 +++ doc/source/cli/command-objects/compute-service.rst | 89 ++ doc/source/cli/command-objects/configuration.rst | 29 + .../command-objects/consistency-group-snapshot.rst | 96 ++ .../cli/command-objects/consistency-group.rst | 173 ++++ doc/source/cli/command-objects/console-log.rst | 27 + doc/source/cli/command-objects/console-url.rst | 48 + doc/source/cli/command-objects/consumer.rst | 83 ++ doc/source/cli/command-objects/container.rst | 150 ++++ doc/source/cli/command-objects/credential.rst | 113 +++ doc/source/cli/command-objects/domain.rst | 115 +++ doc/source/cli/command-objects/ec2-credentials.rst | 138 +++ doc/source/cli/command-objects/endpoint.rst | 196 ++++ doc/source/cli/command-objects/extension.rst | 58 ++ .../cli/command-objects/federation-protocol.rst | 112 +++ doc/source/cli/command-objects/flavor.rst | 220 +++++ .../cli/command-objects/floating-ip-pool.rst | 15 + doc/source/cli/command-objects/floating-ip.rst | 205 +++++ doc/source/cli/command-objects/group.rst | 249 ++++++ doc/source/cli/command-objects/host.rst | 72 ++ .../cli/command-objects/hypervisor-stats.rst | 16 + doc/source/cli/command-objects/hypervisor.rst | 41 + .../cli/command-objects/identity-provider.rst | 127 +++ doc/source/cli/command-objects/image.rst | 576 ++++++++++++ doc/source/cli/command-objects/ip-availability.rst | 60 ++ doc/source/cli/command-objects/ip-fixed.rst | 47 + .../cli/command-objects/ip-floating-pool.rst | 16 + doc/source/cli/command-objects/ip-floating.rst | 129 +++ doc/source/cli/command-objects/keypair.rst | 80 ++ doc/source/cli/command-objects/limits.rst | 41 + doc/source/cli/command-objects/mapping.rst | 91 ++ doc/source/cli/command-objects/module.rst | 22 + doc/source/cli/command-objects/network-agent.rst | 151 ++++ .../network-auto-allocated-topology.rst | 69 ++ .../cli/command-objects/network-flavor-profile.rst | 145 +++ doc/source/cli/command-objects/network-flavor.rst | 183 ++++ .../cli/command-objects/network-meter-rule.rst | 101 +++ doc/source/cli/command-objects/network-meter.rst | 91 ++ .../cli/command-objects/network-qos-policy.rst | 145 +++ .../cli/command-objects/network-qos-rule-type.rst | 18 + .../cli/command-objects/network-qos-rule.rst | 165 ++++ doc/source/cli/command-objects/network-rbac.rst | 138 +++ doc/source/cli/command-objects/network-segment.rst | 133 +++ .../command-objects/network-service-provider.rst | 20 + doc/source/cli/command-objects/network.rst | 414 +++++++++ .../cli/command-objects/object-store-account.rst | 45 + doc/source/cli/command-objects/object.rst | 195 ++++ doc/source/cli/command-objects/policy.rst | 95 ++ doc/source/cli/command-objects/port.rst | 404 +++++++++ doc/source/cli/command-objects/project-purge.rst | 42 + doc/source/cli/command-objects/project.rst | 235 +++++ doc/source/cli/command-objects/quota.rst | 269 ++++++ doc/source/cli/command-objects/region.rst | 104 +++ doc/source/cli/command-objects/request-token.rst | 58 ++ doc/source/cli/command-objects/role-assignment.rst | 106 +++ doc/source/cli/command-objects/role.rst | 326 +++++++ doc/source/cli/command-objects/router.rst | 357 ++++++++ .../cli/command-objects/security-group-rule.rst | 193 ++++ doc/source/cli/command-objects/security-group.rst | 130 +++ doc/source/cli/command-objects/server-backup.rst | 44 + doc/source/cli/command-objects/server-event.rst | 45 + doc/source/cli/command-objects/server-group.rst | 80 ++ doc/source/cli/command-objects/server-image.rst | 33 + doc/source/cli/command-objects/server.rst | 986 +++++++++++++++++++++ .../cli/command-objects/service-provider.rst | 125 +++ doc/source/cli/command-objects/service.rst | 143 +++ doc/source/cli/command-objects/snapshot.rst | 176 ++++ doc/source/cli/command-objects/subnet-pool.rst | 269 ++++++ doc/source/cli/command-objects/subnet.rst | 374 ++++++++ doc/source/cli/command-objects/token.rst | 30 + doc/source/cli/command-objects/trust.rst | 102 +++ doc/source/cli/command-objects/usage.rst | 50 ++ doc/source/cli/command-objects/user-role.rst | 27 + doc/source/cli/command-objects/user.rst | 223 +++++ doc/source/cli/command-objects/volume-backup.rst | 201 +++++ doc/source/cli/command-objects/volume-host.rst | 52 ++ doc/source/cli/command-objects/volume-qos.rst | 166 ++++ doc/source/cli/command-objects/volume-service.rst | 66 ++ doc/source/cli/command-objects/volume-snapshot.rst | 223 +++++ .../command-objects/volume-transfer-request.rst | 96 ++ doc/source/cli/command-objects/volume-type.rst | 291 ++++++ doc/source/cli/command-objects/volume.rst | 403 +++++++++ 90 files changed, 12703 insertions(+) create mode 100644 doc/source/cli/command-objects/access-token.rst create mode 100644 doc/source/cli/command-objects/address-scope.rst create mode 100644 doc/source/cli/command-objects/aggregate.rst create mode 100644 doc/source/cli/command-objects/availability-zone.rst create mode 100644 doc/source/cli/command-objects/backup.rst create mode 100644 doc/source/cli/command-objects/catalog.rst create mode 100644 doc/source/cli/command-objects/command.rst create mode 100644 doc/source/cli/command-objects/complete.rst create mode 100644 doc/source/cli/command-objects/compute-agent.rst create mode 100644 doc/source/cli/command-objects/compute-service.rst create mode 100644 doc/source/cli/command-objects/configuration.rst create mode 100644 doc/source/cli/command-objects/consistency-group-snapshot.rst create mode 100644 doc/source/cli/command-objects/consistency-group.rst create mode 100644 doc/source/cli/command-objects/console-log.rst create mode 100644 doc/source/cli/command-objects/console-url.rst create mode 100644 doc/source/cli/command-objects/consumer.rst create mode 100644 doc/source/cli/command-objects/container.rst create mode 100644 doc/source/cli/command-objects/credential.rst create mode 100644 doc/source/cli/command-objects/domain.rst create mode 100644 doc/source/cli/command-objects/ec2-credentials.rst create mode 100644 doc/source/cli/command-objects/endpoint.rst create mode 100644 doc/source/cli/command-objects/extension.rst create mode 100644 doc/source/cli/command-objects/federation-protocol.rst create mode 100644 doc/source/cli/command-objects/flavor.rst create mode 100644 doc/source/cli/command-objects/floating-ip-pool.rst create mode 100644 doc/source/cli/command-objects/floating-ip.rst create mode 100644 doc/source/cli/command-objects/group.rst create mode 100644 doc/source/cli/command-objects/host.rst create mode 100644 doc/source/cli/command-objects/hypervisor-stats.rst create mode 100644 doc/source/cli/command-objects/hypervisor.rst create mode 100644 doc/source/cli/command-objects/identity-provider.rst create mode 100644 doc/source/cli/command-objects/image.rst create mode 100644 doc/source/cli/command-objects/ip-availability.rst create mode 100644 doc/source/cli/command-objects/ip-fixed.rst create mode 100644 doc/source/cli/command-objects/ip-floating-pool.rst create mode 100644 doc/source/cli/command-objects/ip-floating.rst create mode 100644 doc/source/cli/command-objects/keypair.rst create mode 100644 doc/source/cli/command-objects/limits.rst create mode 100644 doc/source/cli/command-objects/mapping.rst create mode 100644 doc/source/cli/command-objects/module.rst create mode 100644 doc/source/cli/command-objects/network-agent.rst create mode 100644 doc/source/cli/command-objects/network-auto-allocated-topology.rst create mode 100644 doc/source/cli/command-objects/network-flavor-profile.rst create mode 100644 doc/source/cli/command-objects/network-flavor.rst create mode 100644 doc/source/cli/command-objects/network-meter-rule.rst create mode 100644 doc/source/cli/command-objects/network-meter.rst create mode 100644 doc/source/cli/command-objects/network-qos-policy.rst create mode 100644 doc/source/cli/command-objects/network-qos-rule-type.rst create mode 100644 doc/source/cli/command-objects/network-qos-rule.rst create mode 100644 doc/source/cli/command-objects/network-rbac.rst create mode 100644 doc/source/cli/command-objects/network-segment.rst create mode 100644 doc/source/cli/command-objects/network-service-provider.rst create mode 100644 doc/source/cli/command-objects/network.rst create mode 100644 doc/source/cli/command-objects/object-store-account.rst create mode 100644 doc/source/cli/command-objects/object.rst create mode 100644 doc/source/cli/command-objects/policy.rst create mode 100644 doc/source/cli/command-objects/port.rst create mode 100644 doc/source/cli/command-objects/project-purge.rst create mode 100644 doc/source/cli/command-objects/project.rst create mode 100644 doc/source/cli/command-objects/quota.rst create mode 100644 doc/source/cli/command-objects/region.rst create mode 100644 doc/source/cli/command-objects/request-token.rst create mode 100644 doc/source/cli/command-objects/role-assignment.rst create mode 100644 doc/source/cli/command-objects/role.rst create mode 100644 doc/source/cli/command-objects/router.rst create mode 100644 doc/source/cli/command-objects/security-group-rule.rst create mode 100644 doc/source/cli/command-objects/security-group.rst create mode 100644 doc/source/cli/command-objects/server-backup.rst create mode 100644 doc/source/cli/command-objects/server-event.rst create mode 100644 doc/source/cli/command-objects/server-group.rst create mode 100644 doc/source/cli/command-objects/server-image.rst create mode 100644 doc/source/cli/command-objects/server.rst create mode 100644 doc/source/cli/command-objects/service-provider.rst create mode 100644 doc/source/cli/command-objects/service.rst create mode 100644 doc/source/cli/command-objects/snapshot.rst create mode 100644 doc/source/cli/command-objects/subnet-pool.rst create mode 100644 doc/source/cli/command-objects/subnet.rst create mode 100644 doc/source/cli/command-objects/token.rst create mode 100644 doc/source/cli/command-objects/trust.rst create mode 100644 doc/source/cli/command-objects/usage.rst create mode 100644 doc/source/cli/command-objects/user-role.rst create mode 100644 doc/source/cli/command-objects/user.rst create mode 100644 doc/source/cli/command-objects/volume-backup.rst create mode 100644 doc/source/cli/command-objects/volume-host.rst create mode 100644 doc/source/cli/command-objects/volume-qos.rst create mode 100644 doc/source/cli/command-objects/volume-service.rst create mode 100644 doc/source/cli/command-objects/volume-snapshot.rst create mode 100644 doc/source/cli/command-objects/volume-transfer-request.rst create mode 100644 doc/source/cli/command-objects/volume-type.rst create mode 100644 doc/source/cli/command-objects/volume.rst (limited to 'doc/source/cli/command-objects') diff --git a/doc/source/cli/command-objects/access-token.rst b/doc/source/cli/command-objects/access-token.rst new file mode 100644 index 00000000..b1400412 --- /dev/null +++ b/doc/source/cli/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 + + openstack access token create + --consumer-key + --consumer-secret + --request-key + --request-secret + --verifier + +.. option:: --consumer-key + + Consumer key (required) + +.. option:: --consumer-secret + + Consumer secret (required) + +.. option:: --request-key + + Request token to exchange for access token (required) + +.. option:: --request-secret + + Secret associated with (required) + +.. option:: --verifier + + Verifier associated with (required) diff --git a/doc/source/cli/command-objects/address-scope.rst b/doc/source/cli/command-objects/address-scope.rst new file mode 100644 index 00000000..9155d09e --- /dev/null +++ b/doc/source/cli/command-objects/address-scope.rst @@ -0,0 +1,149 @@ +============= +address scope +============= + +An **address scope** is a scope of IPv4 or IPv6 addresses that belongs +to a given project and may be shared between projects. + +Network v2 + +address scope create +-------------------- + +Create new address scope + +.. program:: address scope create +.. code:: bash + + openstack address scope create + [--project [--project-domain ]] + [--ip-version ] + [--share | --no-share] + + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --ip-version + + IP version (4 or 6, default is 4) + +.. option:: --share + + Share the address scope between projects + +.. option:: --no-share + + Do not share the address scope between projects (default) + +.. _address_scope_create-name: +.. describe:: + + New address scope name + +address scope delete +-------------------- + +Delete address scope(s) + +.. program:: address scope delete +.. code:: bash + + openstack address scope delete + [ ...] + +.. _address_scope_delete-address-scope: +.. describe:: + + Address scope(s) to delete (name or ID) + +address scope list +------------------ + +List address scopes + +.. program:: address scope list +.. code:: bash + + openstack address scope list + [--name ] + [--ip-version ] + [--project [--project-domain ]] + [--share | --no-share] + +.. option:: --name + + List only address scopes of given name in output + +.. option:: --ip-version + + List address scopes of given IP version networks (4 or 6) + +.. option:: --project + + List address scopes according to their project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --share + + List address scopes shared between projects + +.. option:: --no-share + + List address scopes not shared between projects + +address scope set +----------------- + +Set address scope properties + +.. program:: address scope set +.. code:: bash + + openstack address scope set + [--name ] + [--share | --no-share] + + +.. option:: --name + + Set address scope name + +.. option:: --share + + Share the address scope between projects + +.. option:: --no-share + + Do not share the address scope between projects + +.. _address_scope_set-address-scope: +.. describe:: + + Address scope to modify (name or ID) + +address scope show +------------------ + +Display address scope details + +.. program:: address scope show +.. code:: bash + + openstack address scope show + + +.. _address_scope_show-address-scope: +.. describe:: + + Address scope to display (name or ID) diff --git a/doc/source/cli/command-objects/aggregate.rst b/doc/source/cli/command-objects/aggregate.rst new file mode 100644 index 00000000..2029a6c8 --- /dev/null +++ b/doc/source/cli/command-objects/aggregate.rst @@ -0,0 +1,186 @@ +========= +aggregate +========= + +Host aggregates provide a mechanism to group hosts according to certain +criteria. + +Compute v2 + +aggregate add host +------------------ + +Add host to aggregate + +.. program:: aggregate add host +.. code:: bash + + openstack aggregate add host + + + +.. _aggregate_add_host-aggregate: +.. describe:: + + Aggregate (name or ID) + +.. _aggregate_add_host-host: +.. describe:: + + Host to add to :ref:`\ ` + +aggregate create +---------------- + +Create a new aggregate + +.. program:: aggregate create +.. code:: bash + + openstack aggregate create + [--zone ] + [--property [...] ] + + +.. option:: --zone + + Availability zone name + +.. option:: --property + + Property to add to this aggregate (repeat option to set multiple properties) + +.. _aggregate_create-name: +.. describe:: + + New aggregate name + +aggregate delete +---------------- + +Delete existing aggregate(s) + +.. program:: aggregate delete +.. code:: bash + + openstack aggregate delete + [ ...] + +.. _aggregate_delete-aggregate: +.. describe:: + + Aggregate(s) to delete (name or ID) + +aggregate list +-------------- + +List all aggregates + +.. program:: aggregate list +.. code:: bash + + openstack aggregate list + [--long] + +.. option:: --long + + List additional fields in output + +aggregate remove host +--------------------- + +Remove host from aggregate + +.. program:: aggregate remove host +.. code:: bash + + openstack aggregate remove host + + + +.. _aggregate_remove_host-aggregate: +.. describe:: + + Aggregate (name or ID) + +.. _aggregate_remove_host-host: +.. describe:: + + Host to remove from :ref:`\ ` + +aggregate set +------------- + +Set aggregate properties + +.. program:: aggregate set +.. code:: bash + + openstack aggregate set + [--name ] + [--zone ] + [--property [...] ] + [--no-property] + + +.. option:: --name + + Set aggregate name + +.. option:: --zone + + Set availability zone name + +.. option:: --property + + Property to set on :ref:`\ ` + (repeat option to set multiple properties) + +.. option:: --no-property + + Remove all properties from :ref:`\ ` + (specify both :option:`--property` and :option:`--no-property` to + overwrite the current properties) + +.. _aggregate_set-aggregate: +.. describe:: + + Aggregate to modify (name or ID) + +aggregate show +-------------- + +Display aggregate details + +.. program:: aggregate show +.. code:: bash + + openstack aggregate show + + +.. _aggregate_show-aggregate: +.. describe:: + + Aggregate to display (name or ID) + +aggregate unset +--------------- + +Unset aggregate properties + +.. program:: aggregate unset +.. code-block:: bash + + openstack aggregate unset + [--property [...] ] + + +.. option:: --property + + Property to remove from :ref:`\ ` + (repeat option to remove multiple properties) + +.. _aggregate_unset-aggregate: +.. describe:: + + Aggregate to modify (name or ID) diff --git a/doc/source/cli/command-objects/availability-zone.rst b/doc/source/cli/command-objects/availability-zone.rst new file mode 100644 index 00000000..d4c117a0 --- /dev/null +++ b/doc/source/cli/command-objects/availability-zone.rst @@ -0,0 +1,38 @@ +================= +availability zone +================= + +An **availability zone** is a logical partition of cloud block storage, +compute and network services. + +Block Storage v2, Compute v2, Network v2 + +availability zone list +---------------------- + +List availability zones and their status + +.. program availability zone list +.. code:: bash + + openstack 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/cli/command-objects/backup.rst b/doc/source/cli/command-objects/backup.rst new file mode 100644 index 00000000..f8923276 --- /dev/null +++ b/doc/source/cli/command-objects/backup.rst @@ -0,0 +1,137 @@ +====== +backup +====== + +Block Storage v1, v2 + +backup create +------------- + +Create new backup +(Deprecated, please use ``volume backup create`` instead) + +.. program:: backup create +.. code:: bash + + openstack backup create + [--container ] + [--name ] + [--description ] + [--snapshot ] + [--force] + [--incremental] + + +.. option:: --container + + Optional backup container name + +.. option:: --name + + Name of the backup + +.. option:: --description + + Description of the backup + +.. option:: --snapshot + + Snapshot to backup (name or ID) + + *Volume version 2 only* + +.. option:: --force + + Allow to back up an in-use volume + + *Volume version 2 only* + +.. option:: --incremental + + Perform an incremental backup + + *Volume version 2 only* + +.. _backup_create-backup: +.. describe:: + + Volume to backup (name or ID) + +backup delete +------------- + +Delete backup(s) +(Deprecated, please use ``volume backup delete`` instead) + +.. program:: backup delete +.. code:: bash + + openstack backup delete + [--force] + [ ...] + +.. option:: --force + + Allow delete in state other than error or available + + *Volume version 2 only* + +.. _backup_delete-backup: +.. describe:: + + Backup(s) to delete (name or ID) + +backup list +----------- + +List backups +(Deprecated, please use ``volume backup list`` instead) + +.. program:: backup list +.. code:: bash + + openstack backup list + +.. _backup_list-backup: +.. option:: --long + + List additional fields in output + +backup restore +-------------- + +Restore backup +(Deprecated, please use ``volume backup restore`` instead) + +.. program:: backup restore +.. code:: bash + + openstack backup restore + + + +.. _backup_restore-backup: +.. describe:: + + Backup to restore (name or ID) + +.. describe:: + + Volume to restore to (name or ID) + +backup show +----------- + +Display backup details +(Deprecated, please use ``volume backup show`` instead) + +.. program:: backup show +.. code:: bash + + openstack backup show + + +.. _backup_show-backup: +.. describe:: + + Backup to display (name or ID) diff --git a/doc/source/cli/command-objects/catalog.rst b/doc/source/cli/command-objects/catalog.rst new file mode 100644 index 00000000..dccf7801 --- /dev/null +++ b/doc/source/cli/command-objects/catalog.rst @@ -0,0 +1,30 @@ +======= +catalog +======= + +Identity v2, v3 + +catalog list +------------ + +List services in the service catalog + +.. program:: catalog list +.. code:: bash + + openstack catalog list + +catalog show +------------ + +Display service catalog details + +.. program:: catalog show +.. code:: bash + + openstack catalog show + + +.. describe:: + + Service to display (type or name) diff --git a/doc/source/cli/command-objects/command.rst b/doc/source/cli/command-objects/command.rst new file mode 100644 index 00000000..918fd959 --- /dev/null +++ b/doc/source/cli/command-objects/command.rst @@ -0,0 +1,23 @@ +======= +command +======= + +Internal + +Installed commands in the OSC process. + +command list +------------ + +List recognized commands by group + +.. program:: command list +.. code:: bash + + openstack command list + [--group ] + +.. option:: --group + + Show commands filtered by a command group, for example: identity, volume, + compute, image, network and other keywords diff --git a/doc/source/cli/command-objects/complete.rst b/doc/source/cli/command-objects/complete.rst new file mode 100644 index 00000000..20e5c41d --- /dev/null +++ b/doc/source/cli/command-objects/complete.rst @@ -0,0 +1,25 @@ +======== +complete +======== + +The ``complete`` command is inherited from the `python-cliff` library, it can +be used to generate a bash-completion script. Currently, the command will +generate a script for bash versions 3 or 4. The bash-completion script is +printed directly to standard out. + +Typical usage for this command is:: + + openstack complete | sudo tee /etc/bash_completion.d/osc.bash_completion > /dev/null + +If installing ``python-openstackclient`` from a package (``apt-get`` or ``yum``), +then this command will likely be run for you. + +complete +-------- + +print bash completion command + +.. program:: complete +.. code:: bash + + openstack complete diff --git a/doc/source/cli/command-objects/compute-agent.rst b/doc/source/cli/command-objects/compute-agent.rst new file mode 100644 index 00000000..e8317b48 --- /dev/null +++ b/doc/source/cli/command-objects/compute-agent.rst @@ -0,0 +1,102 @@ +============= +compute agent +============= + +Compute v2 + +compute agent create +-------------------- + +Create compute agent + +.. program:: compute agent create +.. code:: bash + + openstack compute agent create + + + +.. _compute_agent-create: +.. describe:: + + Type of OS + +.. describe:: + + Type of architecture + +.. describe:: + + Version + +.. describe:: + + URL + +.. describe:: + + MD5 hash + +.. describe:: + + Type of hypervisor + +compute agent delete +-------------------- + +Delete compute agent(s) + +.. program:: compute agent delete +.. code:: bash + + openstack compute agent delete [ ...] + +.. _compute_agent-delete: +.. describe:: + + ID of agent(s) to delete + +compute agent list +------------------ + +List compute agents + +.. program:: compute agent list +.. code:: bash + + openstack compute agent list [--hypervisor ] + +.. option:: --hypervisor + + Type of hypervisor + +compute agent set +----------------- + +Set compute agent properties + +.. program:: agent set +.. code:: bash + + openstack compute agent set + [--agent-version ] + [--url ] + + +.. _compute_agent-set: +.. option:: --agent-version + + Version of the agent + +.. option:: --url + + URL of the agent + +.. option:: --md5hash + + MD5 hash of the agent + +.. describe:: + + Agent to modify (ID only) diff --git a/doc/source/cli/command-objects/compute-service.rst b/doc/source/cli/command-objects/compute-service.rst new file mode 100644 index 00000000..ba624ea0 --- /dev/null +++ b/doc/source/cli/command-objects/compute-service.rst @@ -0,0 +1,89 @@ +=============== +compute service +=============== + +Compute v2 + +compute service delete +---------------------- + +Delete compute service(s) + +.. program:: compute service delete +.. code:: bash + + openstack compute service delete + [ ...] + +.. _compute_service_delete-service: +.. describe:: + + Compute service(s) to delete (ID only) + +compute service list +-------------------- + +List compute services + +.. program:: compute service list +.. code:: bash + + openstack compute service list + [--host ] + [--service ] + [--long] + +.. option:: --host + + List services on specified host (name only) + +.. option:: --service + + List only specified service (name only) + +.. option:: --long + + List additional fields in output + +compute service set +------------------- + +Set compute service properties + +.. program:: compute service set +.. code:: bash + + openstack compute service set + [--enable | --disable] + [--disable-reason ] + [--up | --down] + + +.. option:: --enable + + Enable service + +.. option:: --disable + + Disable service + +.. option:: --disable-reason + + Reason for disabling the service (in quotes). Should be used with :option:`--disable` option. + +.. option:: --up + + Force up service + +.. option:: --down + + Force down service + +.. _compute_service_set-host: +.. describe:: + + Name of host + +.. describe:: + + Name of service (Binary name) diff --git a/doc/source/cli/command-objects/configuration.rst b/doc/source/cli/command-objects/configuration.rst new file mode 100644 index 00000000..6e704d2d --- /dev/null +++ b/doc/source/cli/command-objects/configuration.rst @@ -0,0 +1,29 @@ +============= +configuration +============= + +Available for all services + +.. _configuration-show: + +configuration show +------------------ + +Show the current openstack client configuration. This command is a little +different from other show commands because it does not take a resource name +or id to show. The command line options, such as --os-cloud, can be used to +show different configurations. + +.. program:: configuration show +.. code:: bash + + openstack configuration show + [--mask | --unmask] + +.. option:: --mask + + Attempt to mask passwords (default) + +.. option:: --unmask + + Show password in clear text diff --git a/doc/source/cli/command-objects/consistency-group-snapshot.rst b/doc/source/cli/command-objects/consistency-group-snapshot.rst new file mode 100644 index 00000000..29d50656 --- /dev/null +++ b/doc/source/cli/command-objects/consistency-group-snapshot.rst @@ -0,0 +1,96 @@ +========================== +consistency group snapshot +========================== + +Block Storage v2 + +consistency group snapshot create +--------------------------------- + +Create new consistency group snapshot. + +.. program:: consistency group snapshot create +.. code:: bash + + openstack consistency group snapshot create + [--consistency-group ] + [--description ] + [] + +.. option:: --consistency-group + + Consistency group to snapshot (name or ID) + (default to be the same as ) + +.. option:: --description + + Description of this consistency group snapshot + +.. _consistency_group_snapshot_create-snapshot-name: +.. describe:: + + Name of new consistency group snapshot (default to None) + +consistency group snapshot delete +--------------------------------- + +Delete consistency group snapshot(s) + +.. program:: consistency group snapshot delete +.. code:: bash + + openstack consistency group snapshot delete + [ ...] + +.. _consistency_group_snapshot_delete-consistency-group-snapshot: +.. describe:: + + Consistency group snapshot(s) to delete (name or ID) + +consistency group snapshot list +------------------------------- + +List consistency group snapshots. + +.. program:: consistency group snapshot list +.. code:: bash + + openstack consistency group snapshot list + [--all-projects] + [--long] + [--status ] + [--consistency-group ] + +.. option:: --all-projects + + Show detail for all projects. Admin only. + (defaults to False) + +.. option:: --long + + List additional fields in output + +.. option:: --status + + Filters results by a status + ("available", "error", "creating", "deleting" or "error_deleting") + +.. option:: --consistency-group + + Filters results by a consistency group (name or ID) + +consistency group snapshot show +------------------------------- + +Display consistency group snapshot details. + +.. program:: consistency group snapshot show +.. code:: bash + + openstack consistency group snapshot show + + +.. _consistency_group_snapshot_show-consistency-group-snapshot: +.. describe:: + + Consistency group snapshot to display (name or ID) diff --git a/doc/source/cli/command-objects/consistency-group.rst b/doc/source/cli/command-objects/consistency-group.rst new file mode 100644 index 00000000..57082c6d --- /dev/null +++ b/doc/source/cli/command-objects/consistency-group.rst @@ -0,0 +1,173 @@ +================= +consistency group +================= + +Block Storage v2 + +consistency group add volume +---------------------------- + +Add volume(s) to consistency group. + +.. program:: consistency group add volume +.. code:: bash + + openstack consistency group add volume + + [ ...] + +.. _consistency_group_add_volume: +.. describe:: + + Consistency group to contain (name or ID) + +.. describe:: + + Volume(s) to add to (name or ID) + (repeat option to add multiple volumes) + +consistency group create +------------------------ + +Create new consistency group. + +.. program:: consistency group create +.. code:: bash + + openstack consistency group create + --volume-type | --consistency-group-source | --consistency-group-snapshot + [--description ] + [--availability-zone ] + [] + +.. option:: --volume-type + + Volume type of this consistency group (name or ID) + +.. option:: --consistency-group-source + + Existing consistency group (name or ID) + +.. option:: --consistency-group-snapshot + + Existing consistency group snapshot (name or ID) + +.. option:: --description + + Description of this consistency group + +.. option:: --availability-zone + + Availability zone for this consistency group + (not available if creating consistency group from source) + +.. _consistency_group_create-name: +.. describe:: + + Name of new consistency group (default to None) + +consistency group delete +------------------------ + +Delete consistency group(s). + +.. program:: consistency group delete +.. code:: bash + + openstack consistency group delete + [--force] + [ ...] + +.. option:: --force + + Allow delete in state other than error or available + +.. _consistency_group_delete-consistency-group: +.. describe:: + + Consistency group(s) to delete (name or ID) + +consistency group list +---------------------- + +List consistency groups. + +.. program:: consistency group list +.. code:: bash + + openstack consistency group list + [--all-projects] + [--long] + +.. option:: --all-projects + + Show detail for all projects. Admin only. + (defaults to False) + +.. option:: --long + + List additional fields in output + +consistency group remove volume +------------------------------- + +Remove volume(s) from consistency group. + +.. program:: consistency group remove volume +.. code:: bash + + openstack consistency group remove volume + + [ ...] + +.. _consistency_group_remove_volume: +.. describe:: + + Consistency group containing (name or ID) + +.. describe:: + + Volume(s) to remove from (name or ID) + (repeat option to remove multiple volumes) + +consistency group set +--------------------- + +Set consistency group properties. + +.. program:: consistency group set +.. code:: bash + + openstack consistency group set + [--name ] + [--description ] + + +.. option:: --name + + New consistency group name + +.. option:: --description + + New consistency group description + +.. _consistency_group_set-consistency-group: +.. describe:: + + Consistency group to modify (name or ID) + +consistency group show +---------------------- + +Display consistency group details. + +.. program:: consistency group show +.. code:: bash + + openstack consistency group show + + +.. _consistency_group_show-consistency-group: +.. describe:: + + Consistency group to display (name or ID) diff --git a/doc/source/cli/command-objects/console-log.rst b/doc/source/cli/command-objects/console-log.rst new file mode 100644 index 00000000..bcb23e70 --- /dev/null +++ b/doc/source/cli/command-objects/console-log.rst @@ -0,0 +1,27 @@ +=========== +console log +=========== + +Server console text dump + +Compute v2 + +console log show +---------------- + +Show server's console output + +.. program:: console log show +.. code:: bash + + openstack console log show + [--lines ] + + +.. option:: --lines + + Number of lines to display from the end of the log (default=all) + +.. describe:: + + Server to show log console log (name or ID) diff --git a/doc/source/cli/command-objects/console-url.rst b/doc/source/cli/command-objects/console-url.rst new file mode 100644 index 00000000..8a5807b6 --- /dev/null +++ b/doc/source/cli/command-objects/console-url.rst @@ -0,0 +1,48 @@ +=========== +console url +=========== + +Server remote console URL + +Compute v2 + +console url show +---------------- + +Show server's remote console URL + +.. program:: console url show +.. code:: bash + + openstack console url show + [--novnc | --xvpvnc | --spice] + [--rdp | --serial | --mks] + + +.. option:: --novnc + + Show noVNC console URL (default) + +.. option:: --xvpvnc + + Show xvpvnc console URL + +.. option:: --spice + + Show SPICE console URL + +.. option:: --rdp + + Show RDP console URL + +.. option:: --serial + + Show serial console URL + +.. option:: --mks + + Show WebMKS console URL + +.. describe:: + + Server to show URL (name or ID) diff --git a/doc/source/cli/command-objects/consumer.rst b/doc/source/cli/command-objects/consumer.rst new file mode 100644 index 00000000..d4ce5dc5 --- /dev/null +++ b/doc/source/cli/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 + + openstack consumer create + [--description ] + +.. option:: --description + + New consumer description + +consumer delete +--------------- + +Delete consumer(s) + +.. program:: consumer delete +.. code:: bash + + openstack consumer delete + [ ...] + +.. describe:: + + Consumer(s) to delete + +consumer list +------------- + +List consumers + +.. program:: consumer list +.. code:: bash + + openstack consumer list + +consumer set +------------ + +Set consumer properties + +.. program:: consumer set +.. code:: bash + + openstack consumer set + [--description ] + + +.. option:: --description + + New consumer description + +.. describe:: + + Consumer to modify + +consumer show +------------- + +Display consumer details + +.. program:: consumer show +.. code:: bash + + openstack consumer show + + +.. _consumer_show-consumer: +.. describe:: + + Consumer to display diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst new file mode 100644 index 00000000..e68955ad --- /dev/null +++ b/doc/source/cli/command-objects/container.rst @@ -0,0 +1,150 @@ +========= +container +========= + +Object Storage v1 + +container create +---------------- + +Create new container + +.. program:: container create +.. code:: bash + + openstack container create + [ ...] + +.. describe:: + + New container name(s) + +container delete +---------------- + +Delete container + +.. program:: container delete +.. code:: bash + + openstack container delete + [-r] | [--recursive] + [ ...] + +.. option:: --recursive, -r + + Recursively delete objects in container before container delete + +.. describe:: + + Container(s) to delete + +container list +-------------- + +List containers + +.. program:: container list +.. code:: bash + + openstack container list + [--prefix ] + [--marker ] + [--end-marker ] + [--limit ] + [--long] + [--all] + +.. option:: --prefix + + Filter list using + +.. option:: --marker + + Anchor for paging + +.. option:: --end-marker + + End anchor for paging + +.. option:: --limit + + 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 + + +.. describe:: + + Container to save + +container set +------------- + +Set container properties + +.. program:: container set +.. code:: bash + + openstack container set + [--property [...] ] + + +.. option:: --property + + Set a property on this container (repeat option to set multiple properties) + +.. describe:: + + Container to modify + +container show +-------------- + +Display container details + +.. program:: container show +.. code:: bash + + openstack container show + + +.. describe:: + + Container to display + +container unset +--------------- + +Unset container properties + +.. program:: container unset +.. code:: bash + + openstack container unset + [--property ] + + +.. option:: --property + + Property to remove from container (repeat option to remove multiple properties) + +.. describe:: + + Container to modify diff --git a/doc/source/cli/command-objects/credential.rst b/doc/source/cli/command-objects/credential.rst new file mode 100644 index 00000000..0b835c73 --- /dev/null +++ b/doc/source/cli/command-objects/credential.rst @@ -0,0 +1,113 @@ +========== +credential +========== + +Identity v3 + +credential create +----------------- + +Create new credential + +.. program:: credential create +.. code:: bash + + openstack credential create + [--type ] + [--project ] + + +.. option:: --type + + New credential type + +.. option:: --project + + Project which limits the scope of the credential (name or ID) + +.. _credential_create: +.. describe:: + + User that owns the credential (name or ID) + +.. describe:: + + New credential data + +credential delete +----------------- + +Delete credential(s) + +.. program:: credential delete +.. code:: bash + + openstack credential delete + [ ...] + +.. _credential_delete: +.. describe:: + + ID(s) of credential to delete + +credential list +--------------- + +List credentials + +.. program:: credential list +.. code:: bash + + openstack credential list + +credential set +-------------- + +Set credential properties + +.. program:: credential set +.. code:: bash + + openstack credential set + [--user ] + [--type ] + [--data ] + [--project ] + + +.. option:: --user + + User that owns the credential (name or ID) + +.. option:: --type + + New credential type + +.. option:: --data + + New credential data + +.. option:: --project + + Project which limits the scope of the credential (name or ID) + +.. _credential_set: +.. describe:: + + ID of credential to change + +credential show +--------------- + +Display credential details + +.. program:: credential show +.. code:: bash + + openstack credential show + + +.. _credential_show: +.. describe:: + + ID of credential to display diff --git a/doc/source/cli/command-objects/domain.rst b/doc/source/cli/command-objects/domain.rst new file mode 100644 index 00000000..70a3e733 --- /dev/null +++ b/doc/source/cli/command-objects/domain.rst @@ -0,0 +1,115 @@ +====== +domain +====== + +Identity v3 + +domain create +------------- + +Create new domain + +.. program:: domain create +.. code:: bash + + openstack domain create + [--description ] + [--enable | --disable] + [--or-show] + + +.. option:: --description + + New domain description + +.. option:: --enable + + Enable domain (default) + +.. option:: --disable + + Disable domain + +.. option:: --or-show + + Return existing domain + + If the domain already exists, return the existing domain data and do not fail. + +.. describe:: + + New domain name + +domain delete +------------- + +Delete domain(s) + +.. program:: domain delete +.. code:: bash + + openstack domain delete + [ ...] + +.. describe:: + + Domain(s) to delete (name or ID) + +domain list +----------- + +List domains + +.. program:: domain list +.. code:: bash + + openstack domain list + +domain set +---------- + +Set domain properties + +.. program:: domain set +.. code:: bash + + openstack domain set + [--name ] + [--description ] + [--enable | --disable] + + +.. option:: --name + + New domain name + +.. option:: --description + + New domain description + +.. option:: --enable + + Enable domain + +.. option:: --disable + + Disable domain + +.. describe:: + + Domain to modify (name or ID) + +domain show +----------- + +Display domain details + +.. program:: domain show +.. code:: bash + + openstack domain show + + +.. describe:: + + Domain to display (name or ID) diff --git a/doc/source/cli/command-objects/ec2-credentials.rst b/doc/source/cli/command-objects/ec2-credentials.rst new file mode 100644 index 00000000..9174b041 --- /dev/null +++ b/doc/source/cli/command-objects/ec2-credentials.rst @@ -0,0 +1,138 @@ +=============== +ec2 credentials +=============== + +Identity v2 + +ec2 credentials create +---------------------- + +Create EC2 credentials + +.. program:: ec2 credentials create +.. code-block:: bash + + openstack ec2 credentials create + [--project ] + [--user ] + [--user-domain ] + [--project-domain ] + +.. option:: --project + + Create credentials in project (name or ID; default: current authenticated project) + +.. option:: --user + + Create credentials for user (name or ID; default: current authenticated user) + +.. option:: --user-domain + + Domain the user belongs to (name or ID). This can be + used in case collisions between user names exist. + + .. versionadded:: 3 + +.. option:: --project-domain + + Domain the project belongs to (name or ID). This can be + used in case collisions between user names exist. + + .. versionadded:: 3 + +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. + +ec2 credentials delete +---------------------- + +Delete EC2 credentials + +.. program:: ec2 credentials delete +.. code-block:: bash + + openstack ec2 credentials delete + [--user ] + [--user-domain ] + [ ...] + +.. option:: --user + + Delete credentials for user (name or ID) + +.. option:: --user-domain + + Select user from a specific domain (name or ID) + This can be used in case collisions between user names exist. + + .. versionadded:: 3 + +.. _ec2_credentials_delete-access-key: +.. describe:: access-key + + Credentials access key(s) + +The :option:`--user` option is 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. + +ec2 credentials list +-------------------- + +List EC2 credentials + +.. program:: ec2 credentials list +.. code-block:: bash + + openstack ec2 credentials list + [--user ] + [--user-domain ] + +.. option:: --user + + Filter list by (name or ID) + +.. option:: --user-domain + + Select user from a specific domain (name or ID) + This can be used in case collisions between user names exist. + + .. versionadded:: 3 + +The :option:`--user` option is 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. + +ec2 credentials show +-------------------- + +Display EC2 credentials details + +.. program:: ec2 credentials show +.. code-block:: bash + + openstack ec2 credentials show + [--user ] + [--user-domain ] + + +.. option:: --user + + Show credentials for user (name or ID) + +.. option:: --user-domain + + Select user from a specific domain (name or ID) + This can be used in case collisions between user names exist. + + .. versionadded:: 3 + +.. _ec2_credentials_show-access-key: +.. describe:: access-key + + Credentials access key + +The :option:`--user` option is 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. diff --git a/doc/source/cli/command-objects/endpoint.rst b/doc/source/cli/command-objects/endpoint.rst new file mode 100644 index 00000000..02a75bea --- /dev/null +++ b/doc/source/cli/command-objects/endpoint.rst @@ -0,0 +1,196 @@ +======== +endpoint +======== + +Identity v2, v3 + +endpoint create +--------------- + +Create new endpoint + +*Identity version 2 only* + +.. program:: endpoint create (v2) +.. code:: bash + + openstack endpoint create + --publicurl + [--adminurl ] + [--internalurl ] + [--region ] + + +.. option:: --publicurl + + New endpoint public URL (required) + +.. option:: --adminurl + + New endpoint admin URL + +.. option:: --internalurl + + New endpoint internal URL + +.. option:: --region + + New endpoint region ID + +.. _endpoint_create-endpoint: +.. describe:: + + Service to be associated with new endpoint (name or ID) + +*Identity version 3 only* + +.. program:: endpoint create (v3) +.. code:: bash + + openstack endpoint create + [--region ] + [--enable | --disable] + + + + +.. option:: --region + + New endpoint region ID + +.. option:: --enable + + Enable endpoint (default) + +.. option:: --disable + + Disable endpoint + +.. describe:: + + Service to be associated with new endpoint(name or ID) + +.. describe:: + + New endpoint interface type (admin, public or internal) + +.. describe:: + + New endpoint URL + +endpoint delete +--------------- + +Delete endpoint(s) + +.. program:: endpoint delete +.. code:: bash + + openstack endpoint delete + [ ...] + +.. _endpoint_delete-endpoint: +.. describe:: + + Endpoint(s) to delete (ID only) + +endpoint list +------------- + +List endpoints + +.. program:: endpoint list +.. code:: bash + + openstack endpoint list + [--service ] + [--interface ] + [--region ] + [--long] + +.. option:: --service + + Filter by service (type, name or ID) + + *Identity version 3 only* + +.. option:: --interface + + Filter by interface type (admin, public or internal) + + *Identity version 3 only* + +.. option:: --region + + Filter by region ID + + *Identity version 3 only* + +.. option:: --long + + List additional fields in output + + *Identity version 2 only* + +endpoint set +------------ + +Set endpoint properties + +*Identity version 3 only* + +.. program:: endpoint set +.. code:: bash + + openstack endpoint set + [--region ] + [--interface ] + [--url ] + [--service ] + [--enable | --disable] + + +.. option:: --region + + New endpoint region ID + +.. option:: --interface + + New endpoint interface type (admin, public or internal) + +.. option:: --url + + New endpoint URL + +.. option:: --service + + New endpoint service (name or ID) + +.. option:: --enable + + Enable endpoint + +.. option:: --disable + + Disable endpoint + +.. _endpoint_set-endpoint: +.. describe:: + + Endpoint to modify (ID only) + +endpoint show +------------- + +Display endpoint details + +.. program:: endpoint show +.. code:: bash + + openstack endpoint show + + +.. _endpoint_show-endpoint: +.. describe:: + + Endpoint to display (endpoint ID, service ID, service name, service type) diff --git a/doc/source/cli/command-objects/extension.rst b/doc/source/cli/command-objects/extension.rst new file mode 100644 index 00000000..36cf418b --- /dev/null +++ b/doc/source/cli/command-objects/extension.rst @@ -0,0 +1,58 @@ +========= +extension +========= + +Many OpenStack server APIs include API extensions that enable +additional functionality. + +extension list +-------------- + +List API extensions + +.. program:: extension list +.. code:: bash + + openstack extension list + [--compute] + [--identity] + [--network] + [--volume] + [--long] + +.. option:: --compute + + List extensions for the Compute API + +.. option:: --identity + + List extensions for the Identity API + +.. option:: --network + + List extensions for the Network API + +.. option:: --volume + + List extensions for the Block Storage API + +.. option:: --long + + List additional fields in output + +extension show +-------------- + +Show API extension + +.. program:: extension show +.. code:: bash + + openstack extension show + + +.. _extension_show: +.. describe:: + + Extension to display. Currently, only network extensions are supported. + (Name or Alias) diff --git a/doc/source/cli/command-objects/federation-protocol.rst b/doc/source/cli/command-objects/federation-protocol.rst new file mode 100644 index 00000000..e1f98174 --- /dev/null +++ b/doc/source/cli/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 + + openstack federation protocol create + --identity-provider + --mapping + + +.. option:: --identity-provider + + Identity provider that will support the new federation protocol (name or ID) (required) + +.. option:: --mapping + + Mapping that is to be used (name or ID) (required) + +.. describe:: + + New federation protocol name (must be unique per identity provider) + +federation protocol delete +-------------------------- + +Delete federation protocol(s) + +.. program:: federation protocol delete +.. code:: bash + + openstack federation protocol delete + --identity-provider + [ ...] + +.. option:: --identity-provider + + Identity provider that supports (name or ID) (required) + +.. describe:: + + Federation protocol(s) to delete (name or ID) + +federation protocol list +------------------------ + +List federation protocols + +.. program:: federation protocol list +.. code:: bash + + openstack federation protocol list + --identity-provider + +.. option:: --identity-provider + + Identity provider to list (name or ID) (required) + +federation protocol set +----------------------- + +Set federation protocol properties + +.. program:: federation protocol set +.. code:: bash + + openstack federation protocol set + --identity-provider + [--mapping ] + + +.. option:: --identity-provider + + Identity provider that supports (name or ID) (required) + +.. option:: --mapping + + Mapping that is to be used (name or ID) + +.. describe:: + + Federation protocol to modify (name or ID) + +federation protocol show +------------------------ + +Display federation protocol details + +.. program:: federation protocol show +.. code:: bash + + openstack federation protocol show + --identity-provider + + +.. option:: --identity-provider + + Identity provider that supports (name or ID) (required) + +.. describe:: + + Federation protocol to display (name or ID) diff --git a/doc/source/cli/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst new file mode 100644 index 00000000..6feb4498 --- /dev/null +++ b/doc/source/cli/command-objects/flavor.rst @@ -0,0 +1,220 @@ +====== +flavor +====== + +Compute v2 + +flavor create +------------- + +Create new flavor + +.. program:: flavor create +.. code:: bash + + openstack flavor create + [--id ] + [--ram ] + [--disk ] + [--ephemeral-disk ] + [--swap ] + [--vcpus ] + [--rxtx-factor ] + [--public | --private] + [--property [...] ] + [--project ] + [--project-domain ] + + +.. option:: --id + + Unique flavor ID; 'auto' creates a UUID (default: auto) + +.. option:: --ram + + Memory size in MB (default 256M) + +.. option:: --disk + + Disk size in GB (default 0G) + +.. option:: --ephemeral-disk + + Ephemeral disk size in GB (default 0G) + +.. option:: --swap + + Swap space size in MB (default 0M) + +.. option:: --vcpus + + Number of vcpus (default 1) + +.. option:: --rxtx-factor + + RX/TX factor (default 1.0) + +.. option:: --public + + Flavor is available to other projects (default) + +.. option:: --private + + Flavor is not available to other projects + +.. option:: --property + + Property to add for this flavor (repeat option to set multiple properties) + +.. option:: --project + + Allow to access private flavor (name or ID) + (Must be used with :option:`--private` option) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _flavor_create-flavor-name: +.. describe:: + + New flavor name + +flavor delete +------------- + +Delete flavor(s) + +.. program:: flavor delete +.. code:: bash + + openstack flavor delete + [ ...] + +.. _flavor_delete-flavor: +.. describe:: + + Flavor(s) to delete (name or ID) + +flavor list +----------- + +List flavors + +.. program:: flavor list +.. code:: bash + + openstack flavor list + [--public | --private | --all] + [--long] + [--marker ] + [--limit ] + +.. option:: --public + + List only public flavors (default) + +.. option:: --private + + List only private flavors + +.. option:: --all + + List all flavors, whether public or private + +.. option:: --long + + List additional fields in output + +.. option:: --marker + + The last flavor ID of the previous page + +.. option:: --limit + + Maximum number of flavors to display + +flavor set +---------- + +Set flavor properties + +.. program:: flavor set +.. code:: bash + + openstack flavor set + [--no-property] + [--property [...] ] + [--project ] + [--project-domain ] + + +.. option:: --property + + Property to add or modify for this flavor (repeat option to set multiple properties) + +.. option:: --project + + Set flavor access to project (name or ID) (admin only) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --no-property + + Remove all properties from this flavor (specify both --no-property and --property + to remove the current properties before setting new properties.) + +.. describe:: + + Flavor to modify (name or ID) + +flavor show +----------- + +Display flavor details + +.. program:: flavor show +.. code:: bash + + openstack flavor show + + +.. _flavor_show-flavor: +.. describe:: + + Flavor to display (name or ID) + +flavor unset +------------ + +Unset flavor properties + +.. program:: flavor unset +.. code:: bash + + openstack flavor unset + [--property [...] ] + [--project ] + [--project-domain ] + + +.. option:: --property + + Property to remove from flavor (repeat option to remove multiple properties) + +.. option:: --project + + Remove flavor access from project (name or ID) (admin only) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. describe:: + + Flavor to modify (name or ID) diff --git a/doc/source/cli/command-objects/floating-ip-pool.rst b/doc/source/cli/command-objects/floating-ip-pool.rst new file mode 100644 index 00000000..9213b86d --- /dev/null +++ b/doc/source/cli/command-objects/floating-ip-pool.rst @@ -0,0 +1,15 @@ +================ +floating ip pool +================ + +Compute v2, Network v2 + +floating ip pool list +--------------------- + +List pools of floating IP addresses + +.. program:: floating ip pool list +.. code:: bash + + openstack floating ip pool list diff --git a/doc/source/cli/command-objects/floating-ip.rst b/doc/source/cli/command-objects/floating-ip.rst new file mode 100644 index 00000000..f2f101d3 --- /dev/null +++ b/doc/source/cli/command-objects/floating-ip.rst @@ -0,0 +1,205 @@ +=========== +floating ip +=========== + +Compute v2, Network v2 + +floating ip create +------------------ + +Create floating IP + +.. program:: floating ip create +.. code:: bash + + openstack floating ip create + [--subnet ] + [--port ] + [--floating-ip-address ] + [--fixed-ip-address ] + [--description ] + [--project [--project-domain ]] + + +.. option:: --subnet + + Subnet on which you want to create the floating IP (name or ID) + *Network version 2 only* + +.. option:: --port + + Port to be associated with the floating IP (name or ID) + *Network version 2 only* + +.. option:: --floating-ip-address + + Floating IP address + *Network version 2 only* + +.. option:: --fixed-ip-address + + Fixed IP address mapped to the floating IP + *Network version 2 only* + +.. option:: --description + + Set floating IP description + *Network version 2 only* + +.. option:: --project + + Owner's project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + *Network version 2 only* + +.. describe:: + + Network to allocate floating IP from (name or ID) + +floating ip delete +------------------ + +Delete floating IP(s) + +.. program:: floating ip delete +.. code:: bash + + openstack floating ip delete [ ...] + +.. describe:: + + Floating IP(s) to delete (IP address or ID) + +floating ip list +---------------- + +List floating IP(s) + +.. program:: floating ip list +.. code:: bash + + openstack floating ip list + [--network ] + [--port ] + [--fixed-ip-address ] + [--long] + [--status ] + [--project [--project-domain ]] + [--router ] + +.. option:: --network + + List floating IP(s) according to given network (name or ID) + + *Network version 2 only* + +.. option:: --port + + List floating IP(s) according to given port (name or ID) + + *Network version 2 only* + +.. option:: --fixed-ip-address + + List floating IP(s) according to given fixed IP address + + *Network version 2 only* + +.. option:: --long + + List additional fields in output + + *Network version 2 only* + +.. option:: --status + + List floating IP(s) according to given status ('ACTIVE', 'DOWN') + + *Network version 2 only* + +.. option:: --project + + List floating IP(s) according to given project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). This can + be used in case collisions between project names exist. + + *Network version 2 only* + +.. option:: --router + + List floating IP(s) according to given router (name or ID) + + *Network version 2 only* + +floating ip set +--------------- + +Set floating IP properties + +.. program:: floating ip set +.. code:: bash + + openstack floating ip set + --port + [--fixed-ip-address ] + + +.. option:: --port + + Assocaite the floating IP with port (name or ID) + +.. option:: --fixed-ip-address + + Fixed IP of the port (required only if port has multiple IPs) + +.. _floating_ip_set-floating-ip: +.. describe:: + + Floating IP to associate (IP address or ID) + +floating ip show +---------------- + +Display floating IP details + +.. program:: floating ip show +.. code:: bash + + openstack floating ip show + +.. describe:: + + Floating IP to display (IP address or ID) + +floating ip unset +----------------- + +Unset floating IP Properties + +.. program:: floating ip unset +.. code:: bash + + openstack floating ip unset + --port + + +.. option:: --port + + Disassociate any port associated with the floating IP + +.. _floating_ip_unset-floating-ip: +.. describe:: + + Floating IP to disassociate (IP address or ID) diff --git a/doc/source/cli/command-objects/group.rst b/doc/source/cli/command-objects/group.rst new file mode 100644 index 00000000..ac938efd --- /dev/null +++ b/doc/source/cli/command-objects/group.rst @@ -0,0 +1,249 @@ +===== +group +===== + +Identity v3 + +group add user +-------------- + +Add user to group + +.. program:: group add user +.. code:: bash + + openstack group add user + [--group-domain ] + [--user-domain ] + + [ ...] + +.. option:: --group-domain + + Domain the group belongs to (name or ID). This can be + used in case collisions between group names exist. + + .. versionadded:: 3 + +.. option:: --user-domain + + Domain the user belongs to (name or ID). This can be + used in case collisions between user names exist. + + .. versionadded:: 3 + +.. describe:: + + Group to contain (name or ID) + +.. describe:: + + User(s) to add to (name or ID) + (repeat option to add multiple users) + +group contains user +------------------- + +Check user membership in group + +.. program:: group contains user +.. code:: bash + + openstack group contains user + [--group-domain ] + [--user-domain ] + + + +.. option:: --group-domain + + Domain the group belongs to (name or ID). This can be + used in case collisions between group names exist. + + .. versionadded:: 3 + +.. option:: --user-domain + + Domain the user belongs to (name or ID). This can be + used in case collisions between user names exist. + + .. versionadded:: 3 + +.. describe:: + + Group to check (name or ID) + +.. describe:: + + User to check (name or ID) + +group create +------------ + +Create new group + +.. program:: group create +.. code:: bash + + openstack group create + [--domain ] + [--description ] + [--or-show] + + +.. option:: --domain + + Domain to contain new group (name or ID) + +.. option:: --description + + New group description + +.. option:: --or-show + + Return existing group + + If the group already exists, return the existing group data and do not fail. + +.. describe:: + + New group name + +group delete +------------ + +Delete group + +.. program:: group delete +.. code:: bash + + openstack group delete + [--domain ] + [ ...] + +.. option:: --domain + + Domain containing group(s) (name or ID) + +.. describe:: + + Group(s) to delete (name or ID) + +group list +---------- + +List groups + +.. program:: group list +.. code:: bash + + openstack group list + [--domain ] + [--user [--user-domain ]] + [--long] + +.. option:: --domain + + Filter group list by (name or ID) + +.. option:: --user + + Filter group list by (name or ID) + +.. option:: --user-domain + + Domain the user belongs to (name or ID). This can be + used in case collisions between user names exist. + + .. versionadded:: 3 + +.. option:: --long + + List additional fields in output + +group remove user +----------------- + +Remove user from group + +.. program:: group remove user +.. code:: bash + + openstack group remove user + [--group-domain ] + [--user-domain ] + + [ ...] + +.. option:: --group-domain + + Domain the group belongs to (name or ID). This can be + used in case collisions between group names exist. + + .. versionadded:: 3 + +.. option:: --user-domain + + Domain the user belongs to (name or ID). This can be + used in case collisions between user names exist. + + .. versionadded:: 3 + +.. describe:: + + Group containing (name or ID) + +.. describe:: + + User(s) to remove from (name or ID) + (repeat option to remove multiple users) + +group set +--------- + +Set group properties + +.. program:: group set +.. code:: bash + + openstack group set + [--domain ] + [--name ] + [--description ] + + +.. option:: --domain + + Domain containing (name or ID) + +.. option:: --name + + New group name + +.. option:: --description + + New group description + +.. describe:: + + Group to modify (name or ID) + +group show +---------- + +Display group details + +.. program:: group show +.. code:: bash + + openstack group show + [--domain ] + + +.. option:: --domain + + Domain containing (name or ID) + +.. describe:: + + Group to display (name or ID) diff --git a/doc/source/cli/command-objects/host.rst b/doc/source/cli/command-objects/host.rst new file mode 100644 index 00000000..cbf34398 --- /dev/null +++ b/doc/source/cli/command-objects/host.rst @@ -0,0 +1,72 @@ +==== +host +==== + +Compute v2 + +The physical computer running a hypervisor. + +host list +--------- + +List hosts + +.. program:: host list +.. code:: bash + + openstack host list + [--zone ] + +.. option:: --zone + + Only return hosts in the availability zone + +host set +-------- + +Set host properties + +.. program:: host set +.. code:: bash + + openstack host set + [--enable | --disable] + [--enable-maintenance | --disable-maintenance] + + +.. _host-set: +.. option:: --enable + + Enable the host + +.. option:: --disable + + Disable the host + +.. _maintenance-set: +.. option:: --enable-maintenance + + Enable maintenance mode for the host + +.. option:: --disable-maintenance + + Disable maintenance mode for the host + +.. describe:: + + Host to modify (name only) + +host show +--------- + +Display host details + +.. program:: host show +.. code:: bash + + openstack host show + + +.. describe:: + + Name of host diff --git a/doc/source/cli/command-objects/hypervisor-stats.rst b/doc/source/cli/command-objects/hypervisor-stats.rst new file mode 100644 index 00000000..89faf135 --- /dev/null +++ b/doc/source/cli/command-objects/hypervisor-stats.rst @@ -0,0 +1,16 @@ +================ +hypervisor stats +================ + +Compute v2 + +hypervisor stats show +--------------------- + +Display hypervisor stats details + +.. program:: hypervisor stats show +.. code:: bash + + openstack hypervisor stats show + diff --git a/doc/source/cli/command-objects/hypervisor.rst b/doc/source/cli/command-objects/hypervisor.rst new file mode 100644 index 00000000..9db384a2 --- /dev/null +++ b/doc/source/cli/command-objects/hypervisor.rst @@ -0,0 +1,41 @@ +========== +hypervisor +========== + +Compute v2 + +hypervisor list +--------------- + +List hypervisors + +.. program:: hypervisor list +.. code:: bash + + openstack hypervisor list + [--matching ] + [--long] + +.. option:: --matching + + Filter hypervisors using substring + +.. option:: --long + + List additional fields in output + +hypervisor show +--------------- + +Display hypervisor details + +.. program:: hypervisor show +.. code:: bash + + openstack hypervisor show + + +.. _hypervisor_show-flavor: +.. describe:: + + Hypervisor to display (name or ID) diff --git a/doc/source/cli/command-objects/identity-provider.rst b/doc/source/cli/command-objects/identity-provider.rst new file mode 100644 index 00000000..0c2d02bd --- /dev/null +++ b/doc/source/cli/command-objects/identity-provider.rst @@ -0,0 +1,127 @@ +================= +identity provider +================= + +Identity v3 + +`Requires: OS-FEDERATION extension` + +identity provider create +------------------------ + +Create new identity provider + +.. program:: identity provider create +.. code:: bash + + openstack identity provider create + [--remote-id [...] | --remote-id-file ] + [--description ] + [--enable | --disable] + + +.. option:: --remote-id + + Remote IDs to associate with the Identity Provider + (repeat option to provide multiple values) + +.. option:: --remote-id-file + + Name of a file that contains many remote IDs to associate with the identity + provider, one per line + +.. option:: --description + + New identity provider description + +.. option:: --enable + + Enable the identity provider (default) + +.. option:: --disable + + Disable the identity provider + +.. describe:: + + New identity provider name (must be unique) + +identity provider delete +------------------------ + +Delete identity provider(s) + +.. program:: identity provider delete +.. code:: bash + + openstack identity provider delete + [ ...] + +.. describe:: + + Identity provider(s) to delete + +identity provider list +---------------------- + +List identity providers + +.. program:: identity provider list +.. code:: bash + + openstack identity provider list + +identity provider set +--------------------- + +Set identity provider properties + +.. program:: identity provider set +.. code:: bash + + openstack identity provider set + [--remote-id [...] | --remote-id-file ] + [--description ] + [--enable | --disable] + + +.. option:: --remote-id + + Remote IDs to associate with the Identity Provider + (repeat option to provide multiple values) + +.. option:: --remote-id-file + + Name of a file that contains many remote IDs to associate with the identity + provider, one per line + +.. option:: --description + + Set identity provider description + +.. option:: --enable + + Enable the identity provider + +.. option:: --disable + + Disable the identity provider + +.. describe:: + + Identity provider to modify + +identity provider show +---------------------- + +Display identity provider details + +.. program:: identity provider show +.. code:: bash + + openstack identity provider show + + +.. describe:: + + Identity provider to display diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst new file mode 100644 index 00000000..ec51fa93 --- /dev/null +++ b/doc/source/cli/command-objects/image.rst @@ -0,0 +1,576 @@ +===== +image +===== + +Image v1, v2 + +image add project +----------------- + +*Only supported for Image v2* + +Associate project with image + +.. program:: image add project +.. code:: bash + + openstack image add project + [--project-domain ] + + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _image_add_project-image: +.. describe:: + + Image to share (name or ID). + +.. _image_add_project-project: +.. describe:: + + Project to associate with image (name or ID) + +image create +------------ + +*Image v1, v2* + +Create/upload an image + +.. program:: image create +.. code:: bash + + openstack image create + [--id ] + [--store ] + [--container-format ] + [--disk-format ] + [--size ] + [--min-disk ] + [--min-ram ] + [--location ] + [--copy-from ] + [--file | --volume ] + [--force] + [--checksum ] + [--protected | --unprotected] + [--public | --private] + [--property [...] ] + [--tag [...] ] + [--project [--project-domain ]] + + +.. option:: --id + + Image ID to reserve + +.. option:: --store + + Upload image to this store + + *Image version 1 only.* + +.. option:: --container-format + + Image container format. The supported options are: ami, ari, aki, + bare, docker, ova, ovf. The default format is: bare + +.. option:: --disk-format + + Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, + raw, qcow2, vhdx, vdi, iso, and ploop. The default format is: raw + +.. option:: --size + + Image size, in bytes (only used with :option:`--location` and :option:`--copy-from`) + + *Image version 1 only.* + +.. option:: --min-disk + + Minimum disk size needed to boot image, in gigabytes + +.. option:: --min-ram + + Minimum RAM size needed to boot image, in megabytes + +.. option:: --location + + Download image from an existing URL + + *Image version 1 only.* + +.. option:: --copy-from + + Copy image from the data store (similar to :option:`--location`) + + *Image version 1 only.* + +.. option:: --file + + Upload image from local file + +.. option:: --volume + + Create image from a volume + +.. option:: --force + + Force image creation if volume is in use (only meaningful with :option:`--volume`) + +.. option:: --checksum + + Image hash used for verification + + *Image version 1 only.* + +.. 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 + + Set a property on this image (repeat for multiple values) + +.. option:: --tag + + Set a tag on this image (repeat for multiple values) + + .. versionadded:: 2 + +.. option:: --project + + Set an alternate project on this image (name or ID). + Previously known as `--owner`. + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + .. versionadded:: 2 + +.. _image_create-image-name: +.. describe:: + + New image name + +image delete +------------ + +Delete image(s) + +.. program:: image delete +.. code:: bash + + openstack image delete + + +.. _image_delete-image: +.. describe:: + + Image(s) to delete (name or ID) + +image list +---------- + +List available images + +.. program:: image list +.. code:: bash + + openstack image list + [--public | --private | --shared] + [--property ] + [--long] + [--sort [:]] + [--limit ] + [--marker ] + +.. option:: --public + + List only public images + +.. option:: --private + + List only private images + +.. option:: --shared + + List only shared images + + *Image version 2 only.* + +.. option:: --property + + Filter output based on property + +.. option:: --long + + List additional fields in output + +.. option:: --sort [:] + + Sort output by selected keys and directions(asc or desc) (default: name:asc), + multiple keys and directions can be specified separated by comma + +.. option:: --limit + + Maximum number of images to display. + + *Image version 2 only* + +.. option:: --marker + + The last image of the previous page. Display list of images + after marker. Display all images if not specified. (name or ID) + + *Image version 2 only* + +image remove project +-------------------- + +*Only supported for Image v2* + +Disassociate project with image + +.. program:: image remove project +.. code:: bash + + openstack image remove remove + [--project-domain ] + + + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _image_remove_project: +.. describe:: + + Image to unshare (name or ID). + +.. describe:: + + Project to disassociate with image (name or ID) + +image save +---------- + +Save an image locally + +.. program:: image save +.. code:: bash + + openstack image save + --file + + +.. option:: --file + + Downloaded image save filename (default: stdout) + +.. _image_save-image: +.. describe:: + + Image to save (name or ID) + +image set +--------- + +*Image v1, v2* + +Set image properties + +.. program:: image set +.. code:: bash + + openstack image set + [--name ] + [--min-disk ] + [--min-ram ] + [--container-format ] + [--disk-format ] + [--size ] + [--protected | --unprotected] + [--public | --private] + [--store ] + [--location ] + [--copy-from ] + [--file ] + [--volume ] + [--force] + [--checksum ] + [--stdin] + [--property [...] ] + [--tag [...] ] + [--architecture ] + [--instance-id ] + [--kernel-id ] + [--os-distro ] + [--os-version ] + [--ramdisk-id ] + [--activate|--deactivate] + [--project [--project-domain ]] + [--accept | --reject | --pending] + + +.. option:: --name + + New image name + +.. option:: --min-disk + + Minimum disk size needed to boot image, in gigabytes + +.. option:: --min-ram + + Minimum RAM size needed to boot image, in megabytes + +.. option:: --container-format + + Image container format. The supported options are: ami, ari, aki, + bare, docker, ova, ovf. + +.. option:: --disk-format + + Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, + raw, qcow2, vhdx, vdi, iso, and ploop. + +.. option:: --size + + Size of image data (in bytes) + + *Image version 1 only.* + +.. 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:: --store + + Upload image to this store + + *Image version 1 only.* + +.. option:: --location + + Download image from an existing URL + + *Image version 1 only.* + +.. option:: --copy-from + + Copy image from the data store (similar to :option:`--location`) + + *Image version 1 only.* + +.. option:: --file + + Upload image from local file + + *Image version 1 only.* + +.. option:: --volume + + Update image with a volume + + *Image version 1 only.* + +.. option:: --force + + Force image update if volume is in use (only meaningful with :option:`--volume`) + + *Image version 1 only.* + +.. option:: --checksum + + Image hash used for verification + + *Image version 1 only.* + +.. option:: --stdin + + Allow to read image data from standard input + + *Image version 1 only.* + +.. option:: --property + + Set a property on this image (repeat option to set multiple properties) + + .. versionadded:: 2 + +.. option:: --tag + + Set a tag on this image (repeat for multiple values) + + .. versionadded:: 2 + +.. option:: --architecture + + Operating system architecture + + .. versionadded:: 2 + +.. option:: --instance-id + + ID of server instance used to create this image + + .. versionadded:: 2 + +.. option:: --kernel-id + + ID of kernel image used to boot this disk image + + .. versionadded:: 2 + +.. option:: --os-distro + + Operating system distribution name + + .. versionadded:: 2 + +.. option:: --os-version + + Operating system distribution version + + .. versionadded:: 2 + +.. option:: --ramdisk-id + + ID of ramdisk image used to boot this disk image + + .. versionadded:: 2 + +.. option:: --activate + + Activate the image. + + .. versionadded:: 2 + +.. option:: --deactivate + + Deactivate the image. + + .. versionadded:: 2 + +.. option:: --project + + Set an alternate project on this image (name or ID). + Previously known as `--owner`. + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + .. versionadded:: 2 + +.. option:: --accept + + Accept the image membership. + + If `--project` is passed, this will update the membership status for the + given project, otherwise `--project` will default to the project the user + is authenticated to. + + .. versionadded:: 2 + +.. option:: --reject + + Reject the image membership. + + If `--project` is passed, this will update the membership status for the + given project, otherwise `--project` will default to the project the user + is authenticated to. + + .. versionadded:: 2 + +.. option:: --pending + + Reset the image membership to 'pending'. + + If `--project` is passed, this will update the membership status for the + given project, otherwise `--project` will default to the project the user + is authenticated to. + + .. versionadded:: 2 + +.. _image_set-image: +.. describe:: + + Image to modify (name or ID) + +image show +---------- + +Display image details + +.. program:: image show +.. code:: bash + + openstack image show + + +.. _image_show-image: +.. describe:: + + Image to display (name or ID) + +image unset +----------- + +*Only supported for Image v2* + +Unset image tags or properties + +.. program:: image unset +.. code:: bash + + openstack image set + [--tag ] + [--property ] + + +.. option:: --tag + + Unset a tag on this image (repeat option to unset multiple tags) + +.. option:: --property + + Unset a property on this image (repeat option to unset multiple properties) + +.. _image_unset-image: +.. describe:: + + Image to modify (name or ID) diff --git a/doc/source/cli/command-objects/ip-availability.rst b/doc/source/cli/command-objects/ip-availability.rst new file mode 100644 index 00000000..dd39e649 --- /dev/null +++ b/doc/source/cli/command-objects/ip-availability.rst @@ -0,0 +1,60 @@ +=============== +ip availability +=============== + +Network v2 + +ip availability list +-------------------- + +List IP availability for network + +This command retrieves information about IP availability. +Useful for admins who need a quick way to check the +IP availability for all associated networks. +List specifically returns total IP capacity and the +number of allocated IP addresses from that pool. + +.. program:: ip availability list +.. code:: bash + + openstack ip availability list + [--ip-version {4,6}] + [--project ] + +.. option:: --ip-version {4,6} + + List IP availability of given IP version networks + (default is 4) + +.. option:: --project + + List IP availability of given project + (name or ID) + +ip availability show +-------------------- + +Show network IP availability details + +This command retrieves information about IP availability. +Useful for admins who need a quick way to +check the IP availability and details for a +specific network. + +This command will return information about +IP availability for the network as a whole, and +return availability information for each individual +subnet within the network as well. + + +.. program:: ip availability show +.. code:: bash + + openstack ip availability show + + +.. _ip_availability_show-network: +.. describe:: + + Show IP availability for a specific network (name or ID) diff --git a/doc/source/cli/command-objects/ip-fixed.rst b/doc/source/cli/command-objects/ip-fixed.rst new file mode 100644 index 00000000..f5b11dc6 --- /dev/null +++ b/doc/source/cli/command-objects/ip-fixed.rst @@ -0,0 +1,47 @@ +======== +ip fixed +======== + +Compute v2 + +ip fixed add +------------ + +Add fixed IP address to server +(Deprecated, please use ``server add fixed ip`` instead) + +.. program:: ip fixed add +.. code:: bash + + openstack ip fixed add + + + +.. describe:: + + Network to fetch an IP address from (name or ID) + +.. describe:: + + Server to receive the IP address (name or ID) + +ip fixed remove +--------------- + +Remove fixed IP address from server +(Deprecated, please use ``server remove fixed ip`` instead) + +.. program:: ip fixed remove +.. code:: bash + + openstack ip fixed remove + + + +.. describe:: + + IP address to remove from server (name only) + +.. describe:: + + Server to remove the IP address from (name or ID) diff --git a/doc/source/cli/command-objects/ip-floating-pool.rst b/doc/source/cli/command-objects/ip-floating-pool.rst new file mode 100644 index 00000000..6d00355a --- /dev/null +++ b/doc/source/cli/command-objects/ip-floating-pool.rst @@ -0,0 +1,16 @@ +================ +ip floating pool +================ + +Compute v2 + +ip floating pool list +--------------------- + +List pools of floating IP addresses +(Deprecated, please use ``floating ip pool list`` instead) + +.. program:: ip floating pool list +.. code:: bash + + openstack ip floating pool list diff --git a/doc/source/cli/command-objects/ip-floating.rst b/doc/source/cli/command-objects/ip-floating.rst new file mode 100644 index 00000000..4e5f7b00 --- /dev/null +++ b/doc/source/cli/command-objects/ip-floating.rst @@ -0,0 +1,129 @@ +=========== +ip floating +=========== + +Compute v2, Network v2 + +ip floating add +--------------- + +Add floating IP address to server +(Deprecated, please use ``server add floating ip`` instead) + +.. program:: ip floating add +.. code:: bash + + openstack ip floating add + + + +.. describe:: + + IP address to add to server (name only) + +.. describe:: + + Server to receive the IP address (name or ID) + +ip floating create +------------------ + +Create new floating IP address +(Deprecated, please use ``floating ip create`` instead) + +.. program:: ip floating create +.. code:: bash + + openstack ip floating create + [--subnet ] + [--port ] + [--floating-ip-address ] + [--fixed-ip-address ] + + +.. option:: --subnet + + Subnet on which you want to create the floating IP (name or ID) + (Network v2 only) + +.. option:: --port + + Port to be associated with the floating IP (name or ID) + (Network v2 only) + +.. option:: --floating-ip-address + + Floating IP address + (Network v2 only) + +.. option:: --fixed-ip-address + + Fixed IP address mapped to the floating IP + (Network v2 only) + +.. describe:: + + Network to allocate floating IP from (name or ID) + +ip floating delete +------------------ + +Delete floating IP(s) +(Deprecated, please use ``floating ip delete`` instead) + +.. program:: ip floating delete +.. code:: bash + + openstack ip floating delete + [ ...] + +.. describe:: + + Floating IP(s) to delete (IP address or ID) + +ip floating list +---------------- + +List floating IP addresses +(Deprecated, please use ``floating ip list`` instead) + +.. program:: ip floating list +.. code:: bash + + openstack ip floating list + +ip floating remove +------------------ + +Remove floating IP address from server +(Deprecated, please use ``server remove floating ip`` instead) + +.. program:: ip floating remove +.. code:: bash + + openstack ip floating remove + + + +.. describe:: + + IP address to remove from server (name only) + +.. describe:: + + Server to remove the IP address from (name or ID) + +ip floating show +---------------- + +Display floating IP details +(Deprecated, please use ``floating ip show`` instead) + +.. program:: ip floating show +.. code:: bash + + openstack ip floating show + +.. describe:: + + Floating IP to display (IP address or ID) diff --git a/doc/source/cli/command-objects/keypair.rst b/doc/source/cli/command-objects/keypair.rst new file mode 100644 index 00000000..a539f0a2 --- /dev/null +++ b/doc/source/cli/command-objects/keypair.rst @@ -0,0 +1,80 @@ +======= +keypair +======= + +The badly named keypair is really the public key of an OpenSSH key pair to be +used for access to created servers. You can also create a private key for +access to a created server by not passing any argument to the keypair create +command. + +Compute v2 + +keypair create +-------------- + +Create new public or private key for server ssh access + +.. program:: keypair create +.. code:: bash + + openstack keypair create + [--public-key | --private-key ] + + +.. option:: --public-key + + Filename for public key to add. If not used, creates a private key. + +.. option:: --private-key + + Filename for private key to save. If not used, print private key in + console. + +.. describe:: + + New public or private key name + +keypair delete +-------------- + +Delete public or private key(s) + +.. program:: keypair delete +.. code:: bash + + openstack keypair delete + [ ...] + +.. describe:: + + Name of key(s) to delete (name only) + +keypair list +------------ + +List key fingerprints + +.. program:: keypair list +.. code:: bash + + openstack keypair list + +keypair show +------------ + +Display key details + +.. program:: keypair show +.. code:: bash + + openstack keypair show + [--public-key] + + +.. option:: --public-key + + Show only bare public key paired with the generated key + +.. describe:: + + Public or private key to display (name only) diff --git a/doc/source/cli/command-objects/limits.rst b/doc/source/cli/command-objects/limits.rst new file mode 100644 index 00000000..92614209 --- /dev/null +++ b/doc/source/cli/command-objects/limits.rst @@ -0,0 +1,41 @@ +====== +limits +====== + +The Compute and Block Storage APIs have resource usage limits. + +Compute v2, Block Storage v1 + +limits show +----------- + +Show compute and block storage limits + +.. program:: limits show +.. code:: bash + + openstack limits show + --absolute | --rate + [--reserved] + [--project ] + [--domain ] + +.. option:: --absolute + + Show absolute limits + +.. option:: --rate + + Show rate limits + +.. option:: --reserved + + Include reservations count [only valid with :option:`--absolute`] + +.. option:: --project + + Show limits for a specific project (name or ID) [only valid with :option:`--absolute`] + +.. option:: --domain + + Domain the project belongs to (name or ID) [only valid with :option:`--absolute`] diff --git a/doc/source/cli/command-objects/mapping.rst b/doc/source/cli/command-objects/mapping.rst new file mode 100644 index 00000000..1f657ed2 --- /dev/null +++ b/doc/source/cli/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 + + openstack mapping create + --rules + + +.. option:: --rules + + Filename that contains a set of mapping rules (required) + +.. _mapping_create-mapping: +.. describe:: + + New mapping name (must be unique) + +mapping delete +-------------- + +Delete mapping(s) + +.. program:: mapping delete +.. code:: bash + + openstack mapping delete + [ ...] + +.. _mapping_delete-mapping: +.. describe:: + + Mapping(s) to delete + +mapping list +------------ + +List mappings + +.. program:: mapping list +.. code:: bash + + openstack mapping list + +mapping set +----------- + +Set mapping properties + +.. program:: mapping set +.. code:: bash + + openstack mapping set + [--rules ] + + +.. option:: --rules + + Filename that contains a new set of mapping rules + +.. _mapping_set-mapping: +.. describe:: + + Mapping to modify + +mapping show +------------ + +Display mapping details + +.. program:: mapping show +.. code:: bash + + openstack mapping show + + +.. _mapping_show-mapping: +.. describe:: + + Mapping to display diff --git a/doc/source/cli/command-objects/module.rst b/doc/source/cli/command-objects/module.rst new file mode 100644 index 00000000..f4b32e75 --- /dev/null +++ b/doc/source/cli/command-objects/module.rst @@ -0,0 +1,22 @@ +====== +module +====== + +Internal + +Installed Python modules in the OSC process. + +module list +----------- + +List module versions + +.. program:: module list +.. code:: bash + + openstack module list + [--all] + +.. option:: --all + + Show all modules that have version information diff --git a/doc/source/cli/command-objects/network-agent.rst b/doc/source/cli/command-objects/network-agent.rst new file mode 100644 index 00000000..f69d0ece --- /dev/null +++ b/doc/source/cli/command-objects/network-agent.rst @@ -0,0 +1,151 @@ +============= +network agent +============= + +A **network agent** is an agent that handles various tasks used to +implement virtual networks. These agents include neutron-dhcp-agent, +neutron-l3-agent, neutron-metering-agent, and neutron-lbaas-agent, +among others. The agent is available when the alive status of the +agent is "True". + +Network v2 + +network agent add network +------------------------- + +Add network to an agent + +.. program:: network agent add network +.. code:: bash + + openstack network agent add network + [--dhcp] + + + +.. describe:: --dhcp + + Add a network to DHCP agent + +.. describe:: + + Agent to which a network is added (ID only) + +.. describe:: + + Network to be added to an agent (ID or name) + +network agent delete +-------------------- + +Delete network agent(s) + +.. program:: network agent delete +.. code:: bash + + openstack network agent delete + [ ...] + +.. _network_agent_delete-network-agent: +.. describe:: + + Network agent(s) to delete (ID only) + +network agent list +------------------ + +List network agents + +.. program:: network agent list +.. code:: bash + + openstack network agent list + [--agent-type ] + [--host ] + [--network ] + +.. option:: --agent-type + + List only agents with the specified agent type. + The supported agent types are: dhcp, open-vswitch, + linux-bridge, ofa, l3, loadbalancer, metering, + metadata, macvtap, nic. + +.. option:: --host + + List only agents running on the specified host + +.. option:: --network + + List agents hosting a network (ID or name) + +network agent set +----------------- + +Set network agent properties + +.. program:: network agent set +.. code:: bash + + openstack network agent set + [--description ] + [--enable | --disable] + + +.. option:: --description + + Set network agent description + +.. option:: --enable + + Enable network agent + +.. option:: --disable + + Disable network agent + +.. _network_agent_set-network-agent: +.. describe:: + + Network agent to modify (ID only) + +network agent show +------------------ + +Display network agent details + +.. program:: network agent show +.. code:: bash + + openstack network agent show + + +.. _network_agent_show-network-agent: +.. describe:: + + Network agent to display (ID only) + +network agent remove network +---------------------------- + +Remove network from an agent + +.. program:: network agent remove network +.. code:: bash + + openstack network agent remove network + [--dhcp] + + + +.. describe:: --dhcp + + Remove network from DHCP agent. + +.. describe:: + + Agent to which a network is removed (ID only) + +.. describe:: + + Network to be removed from an agent (ID or name) diff --git a/doc/source/cli/command-objects/network-auto-allocated-topology.rst b/doc/source/cli/command-objects/network-auto-allocated-topology.rst new file mode 100644 index 00000000..4ed68cda --- /dev/null +++ b/doc/source/cli/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-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 + + Return the auto allocated topology for a given project. + Default is current project. + +.. option:: --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-domain ]] + +.. option:: --project + + Delete auto allocated topology for a given project. + Default is the current project. + +.. option:: --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/cli/command-objects/network-flavor-profile.rst b/doc/source/cli/command-objects/network-flavor-profile.rst new file mode 100644 index 00000000..fdb95059 --- /dev/null +++ b/doc/source/cli/command-objects/network-flavor-profile.rst @@ -0,0 +1,145 @@ +====================== +network flavor profile +====================== + +A **network flavor profile** allows administrators to create, delete, list, +show and update network service profile, which details a framework to enable +operators to configure and users to select from different abstract +representations of a service implementation in the Networking service. +It decouples the logical configuration from its instantiation enabling +operators to create user options according to deployment needs. + +Network v2 + +network flavor profile create +----------------------------- + +Create a new network flavor profile + +.. program:: network flavor profile create +.. code:: bash + + openstack network flavor profile create + [--project [--project-domain ]] + [--description ] + [--enable | --disable] + (--driver | --metainfo | --driver --metainfo ) + +.. option:: --project + + Owner's project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). This can + be used in case collisions between project names + exist + +.. option:: --description + + Description for the flavor profile + + *Network version 2 only* + +.. option:: --enable + + Enable the flavor profile (default) + +.. option:: --disable + + Disable the flavor profile + +.. option:: --driver + + Python module path to driver + + *Network version 2 only* + +.. option:: --metainfo + + Metainfo for the flavor profile + + *Network version 2 only* + + +network flavor profile delete +----------------------------- + +Delete network flavor profile + +.. program:: network flavor profile delete +.. code:: bash + + openstack network flavor profile delete + [ ...] + +.. describe:: + + Flavor profile(s) to delete (ID only) + +network flavor profile list +--------------------------- + +List network flavor profiles + +.. program:: network flavor profile list +.. code:: bash + + openstack network flavor profile list + +network flavor profile set +-------------------------- + +Set network flavor profile properties + +.. program:: network flavor profile set +.. code:: bash + + openstack network flavor profile set + [--description ] + [--driver ] + [--enable | --disable] + [--metainfo ] + + + +.. option:: --description + + Description of the flavor profile + +.. option:: --driver + + Python module path to driver + +.. option:: --enable (Default) + + Enable the flavor profile + +.. option:: --disable + + Disable the flavor profile + +.. option:: --metainfo + + Metainfo for the flavor profile + +.. describe:: + + Flavor profile to update (ID only) + +network flavor profile show +--------------------------- + +Show network flavor profile + +.. program:: network flavor profile show +.. code:: bash + + openstack network flavor profile show + + +.. describe:: + + Flavor profile to display (ID only) diff --git a/doc/source/cli/command-objects/network-flavor.rst b/doc/source/cli/command-objects/network-flavor.rst new file mode 100644 index 00000000..2d23bf05 --- /dev/null +++ b/doc/source/cli/command-objects/network-flavor.rst @@ -0,0 +1,183 @@ +============== +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 add profile +-------------------------- + +Add network flavor to service profile + +.. program:: network flavor add profile +.. code:: bash + + openstack network flavor add profile + + + +.. describe:: + + Flavor to which service profile is added. (Name or ID) + +.. describe:: + + Service profile to be added to flavor. (ID only) + +.. _network_flavor_add_profile: + +network flavor create +--------------------- + +Create network flavor + +.. program:: network flavor create +.. code:: bash + + openstack network flavor create + --service-type + [--description ] + [--enable | --disable] + [--project [--project-domain ]] + + +.. option:: --service-type + + Service type to which the flavor applies to: e.g. VPN. + (See openstack :ref:`\ `) (required) + +.. option:: --description + + Description for the flavor + +.. option:: --enable + + Enable the flavor (default) + +.. option:: --disable + + Disable the flavor + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). This can + be used in case collisions between project names + exist. + +.. describe:: + + Name for the flavor + +.. _network_flavor_create: + +network flavor delete +--------------------- + +Delete network flavor(s) + +.. program:: network flavor delete +.. code:: bash + + openstack network flavor delete + [ ...] + +.. describe:: + + 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 remove profile +----------------------------- + +Remove network flavor from service profile + +.. program:: network flavor remove profile +.. code:: bash + + openstack network flavor remove profile + + + +.. describe:: + + Flavor from which service profile is removed. (Name or ID) + +.. describe:: + + Service profile to be removed from flavor. (ID only) + +.. _network_flavor_remove_profile: + +network flavor set +------------------ + +Set network flavor properties + +.. program:: network flavor set +.. code:: bash + + openstack network flavor set + [--name ] + [--description ] + [--enable | --disable] + + +.. option:: --name + + Set flavor name + +.. option:: --description + + Set network flavor description + +.. option:: --enable + + Enable network flavor + +.. option:: --disable + + Disable network flavor + +.. describe:: + + 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 + + +.. describe:: + + Flavor to display (name or ID) + +.. _network_flavor_show: diff --git a/doc/source/cli/command-objects/network-meter-rule.rst b/doc/source/cli/command-objects/network-meter-rule.rst new file mode 100644 index 00000000..22d50aa9 --- /dev/null +++ b/doc/source/cli/command-objects/network-meter-rule.rst @@ -0,0 +1,101 @@ +================== +network meter rule +================== + +A **meter rule** sets the rule for +a meter to measure traffic for a specific IP range. +The following uses **meter** and requires the L3 +metering extension. + +Network v2 + +network meter rule create +------------------------- + +Create meter rule + +.. program:: network meter rule create +.. code:: bash + + openstack network meter rule create + --remote-ip-prefix + [--ingress | --egress] + [--exclude | --include] + [--project [--project-domain ]] + + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name of ID). + This can be used in case collisions between project names exist. + +.. option:: --ingress + + Rule is applied to incoming traffic (default) + +.. option:: --egress + + Rule is applied to outgoing traffic + +.. option:: --exclude + + Exclude remote_ip_prefix from count of the traffic of IP addresses + +.. option:: --include + + Include remote_ip_prefix into count of the traffic of IP addresses + (default) + +.. option:: --remote-ip-prefix + + The remote IP prefix to associate with this metering rule packet + +.. _network_meter_rule_create: +.. describe:: + + Meter to associate with this meter rule (name or ID) + + +network meter rule delete +------------------------- + +Delete meter rule(s) + +.. program:: network meter rule delete +.. code:: bash + + openstack network meter rule delete [ ...] + +.. _network_meter_rule_delete: +.. describe:: + + ID of meter rule(s) to delete + +network meter rule list +----------------------- + +List meter rules + +.. program:: network meter rule list +.. code:: bash + + openstack network meter rule list + +network meter rule show +----------------------- + +Show meter rule + +.. program:: network meter rule show +.. code:: bash + + openstack network meter rule show + +.. _network_meter_show: +.. describe:: + + Meter rule to display (ID only) diff --git a/doc/source/cli/command-objects/network-meter.rst b/doc/source/cli/command-objects/network-meter.rst new file mode 100644 index 00000000..6077ce92 --- /dev/null +++ b/doc/source/cli/command-objects/network-meter.rst @@ -0,0 +1,91 @@ +============= +network meter +============= + +A **network meter** allows operators to measure +traffic for a specific IP range. The following commands +are specific to the L3 metering extension. + +Network v2 + +network meter create +-------------------- + +Create network meter + +.. program:: network meter create +.. code:: bash + + openstack network meter create + [--project [--project-domain ]] + [--description ] + [--share | --no-share] + + +.. option:: --project + + Owner's project (name of ID) + + *Network version 2 only* + +.. option:: --description + + Description of meter + + *Network version 2 only* + +.. option:: --share + + Share the meter between projects + +.. option:: --no-share + + Do not share the meter between projects (Default) + +.. _network_meter_create: +.. describe:: + + New meter name + +network meter delete +-------------------- + +Delete network meter(s) + +.. program:: network meter delete +.. code:: bash + + openstack network meter delete + [ ...] + +.. _network_meter_delete: +.. describe:: + + Meter(s) to delete (name or ID) + +network meter list +------------------ + +List network meters + +.. program:: network meter list +.. code:: bash + + openstack network meter list + + +network meter show +------------------ + +Show network meter + +.. program:: network meter show +.. code:: bash + + openstack network meter show + + +.. _network_meter_show: +.. describe:: + + Meter to display (name or ID) diff --git a/doc/source/cli/command-objects/network-qos-policy.rst b/doc/source/cli/command-objects/network-qos-policy.rst new file mode 100644 index 00000000..a75c32fe --- /dev/null +++ b/doc/source/cli/command-objects/network-qos-policy.rst @@ -0,0 +1,145 @@ +================== +network qos policy +================== + +A **Network QoS policy** groups a number of Network QoS rules, applied to a +network or a port. + +Network v2 + +network qos policy create +------------------------- + +Create new Network QoS policy + +.. program:: network qos policy create +.. code:: bash + + openstack network qos policy create + [--description ] + [--share | --no-share] + [--project ] + [--project-domain ] + + +.. option:: --description + + Description of the QoS policy + +.. option:: --share + + Make the QoS policy accessible by other projects + +.. option:: --no-share + + Make the QoS policy not accessible by other projects (default) + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _network_qos_policy_create-name: +.. describe:: + + New QoS policy specification name + +network qos policy delete +------------------------- + +Delete Network QoS policy + +.. program:: network qos policy delete +.. code:: bash + + openstack network qos policy delete + [ ...] + +.. _network_qos_policy_delete-qos-policy: +.. describe:: + + Network QoS policy(s) to delete (name or ID) + +network qos policy list +----------------------- + +List Network QoS policies + +.. program:: network qos policy list +.. code:: bash + + openstack network qos policy list + [--project [--project-domain ]] + [--share | --no-share] + +.. option:: --project + + List qos policies according to their project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --share + + List qos policies shared between projects + +.. option:: --no-share + + List qos policies not shared between projects + +network qos policy set +---------------------- + +Set Network QoS policy properties + +.. program:: network qos policy set +.. code:: bash + + openstack network qos policy set + [--name ] + [--description ] + [--share | --no-share] + + +.. option:: --name + + Name of the QoS policy + +.. option:: --description + + Description of the QoS policy + +.. option:: --share + + Make the QoS policy accessible by other projects + +.. option:: --no-share + + Make the QoS policy not accessible by other projects + +.. _network_qos_policy_set-qos-policy: +.. describe:: + + Network QoS policy to modify (name or ID) + +network qos policy show +----------------------- + +Display Network QoS policy details + +.. program:: network qos policy show +.. code:: bash + + openstack network qos policy show + + +.. _network_qos_policy_show-qos-policy: +.. describe:: + + Network QoS policy to display (name or ID) diff --git a/doc/source/cli/command-objects/network-qos-rule-type.rst b/doc/source/cli/command-objects/network-qos-rule-type.rst new file mode 100644 index 00000000..ee53e30b --- /dev/null +++ b/doc/source/cli/command-objects/network-qos-rule-type.rst @@ -0,0 +1,18 @@ +===================== +network qos rule type +===================== + +A **Network QoS rule type** is a specific Network QoS rule type available to be +used. + +Network v2 + +network qos rule type list +-------------------------- + +List Network QoS rule types + +.. program:: network qos rule type list +.. code:: bash + + openstack network qos rule type list diff --git a/doc/source/cli/command-objects/network-qos-rule.rst b/doc/source/cli/command-objects/network-qos-rule.rst new file mode 100644 index 00000000..1baf5dbf --- /dev/null +++ b/doc/source/cli/command-objects/network-qos-rule.rst @@ -0,0 +1,165 @@ +================ +network qos rule +================ + +A **Network QoS rule** specifies a rule defined in a Network QoS policy; its +type is defined by the parameter 'type'. Can be assigned, within a Network QoS +policy, to a port or a network. Each Network QoS policy can contain several +rules, each of them + +Network v2 + +network qos rule create +----------------------- + +Create new Network QoS rule + +.. program:: network qos rule create +.. code:: bash + + openstack network qos rule create + --type + [--max-kbps ] + [--max-burst-kbits ] + [--dscp-marks ] + [--min-kbps ] + [--ingress | --egress] + + +.. option:: --type + + QoS rule type (minimum-bandwidth, dscp-marking, bandwidth-limit) + +.. option:: --max-kbps + + Maximum bandwidth in kbps + +.. option:: --max-burst-kbits + + Maximum burst in kilobits, 0 means automatic + +.. option:: --dscp-mark + + DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, + 52, and 54 + +.. option:: --min-kbps + + Minimum guaranteed bandwidth in kbps + +.. option:: --ingress + + Ingress traffic direction from the project point of view + +.. option:: --egress + + Egress traffic direction from the project point of view + +.. describe:: + + QoS policy that contains the rule (name or ID) + +network qos rule delete +----------------------- + +Delete Network QoS rule + +.. program:: network qos rule delete +.. code:: bash + + openstack network qos rule delete + + + +.. describe:: + + QoS policy that contains the rule (name or ID) + +.. describe:: + + Network QoS rule to delete (ID) + +network qos rule list +--------------------- + +List Network QoS rules + +.. program:: network qos rule list +.. code:: bash + + openstack network qos rule list + + +.. describe:: + + QoS policy that contains the rule (name or ID) + +network qos rule set +-------------------- + +Set Network QoS rule properties + +.. program:: network qos rule set +.. code:: bash + + openstack network qos rule set + [--max-kbps ] + [--max-burst-kbits ] + [--dscp-marks ] + [--min-kbps ] + [--ingress | --egress] + + + +.. option:: --max-kbps + + Maximum bandwidth in kbps + +.. option:: --max-burst-kbits + + Maximum burst in kilobits, 0 means automatic + +.. option:: --dscp-mark + + DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, + 52, and 54 + +.. option:: --min-kbps + + Minimum guaranteed bandwidth in kbps + +.. option:: --ingress + + Ingress traffic direction from the project point of view + +.. option:: --egress + + Egress traffic direction from the project point of view + +.. describe:: + + QoS policy that contains the rule (name or ID) + +.. describe:: + + Network QoS rule to delete (ID) + +network qos rule show +--------------------- + +Display Network QoS rule details + +.. program:: network qos rule show +.. code:: bash + + openstack network qos rule show + + + +.. describe:: + + QoS policy that contains the rule (name or ID) + +.. describe:: + + Network QoS rule to delete (ID) diff --git a/doc/source/cli/command-objects/network-rbac.rst b/doc/source/cli/command-objects/network-rbac.rst new file mode 100644 index 00000000..c49f29bb --- /dev/null +++ b/doc/source/cli/command-objects/network-rbac.rst @@ -0,0 +1,138 @@ +============ +network rbac +============ + +A **network rbac** is a Role-Based Access Control (RBAC) policy for +network resources. It enables both operators and users to grant access +to network resources for specific projects. + +Network v2 + +network rbac create +------------------- + +Create network RBAC policy + +.. program:: network rbac create +.. code:: bash + + openstack network rbac create + --type + --action + --target-project [--target-project-domain ] + [--project [--project-domain ]] + + +.. option:: --type + + Type of the object that RBAC policy affects ("qos_policy" or "network") (required) + +.. option:: --action + + Action for the RBAC policy ("access_as_external" or "access_as_shared") (required) + +.. option:: --target-project + + The project to which the RBAC policy will be enforced (name or ID) (required) + +.. option:: --target-project-domain + + Domain the target project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --project + + The owner project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _network_rbac_create-rbac-policy: +.. describe:: + + The object to which this RBAC policy affects (name or ID) + +network rbac delete +------------------- + +Delete network RBAC policy(s) + +.. program:: network rbac delete +.. code:: bash + + openstack network rbac delete + [ ...] + +.. _network_rbac_delete-rbac-policy: +.. describe:: + + RBAC policy(s) to delete (ID only) + +network rbac list +----------------- + +List network RBAC policies + +.. program:: network rbac list +.. code:: bash + + openstack network rbac list + [--type ] + [--action ] + [--long] + +.. option:: --type + + List network RBAC policies according to given object type ("qos_policy" or "network") + +.. option:: --action + + List network RBAC policies according to given action ("access_as_external" or "access_as_shared") + +.. option:: --long + + List additional fields in output + +network rbac set +---------------- + +Set network RBAC policy properties + +.. program:: network rbac set +.. code:: bash + + openstack network rbac set + [--target-project [--target-project-domain ]] + + +.. option:: --target-project + + The project to which the RBAC policy will be enforced (name or ID) + +.. option:: --target-project-domain + + Domain the target project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _network_rbac_set-rbac-policy: +.. describe:: + + RBAC policy to be modified (ID only) + +network rbac show +----------------- + +Display network RBAC policy details + +.. program:: network rbac show +.. code:: bash + + openstack network rbac show + + +.. _network_rbac_show-rbac-policy: +.. describe:: + + RBAC policy (ID only) diff --git a/doc/source/cli/command-objects/network-segment.rst b/doc/source/cli/command-objects/network-segment.rst new file mode 100644 index 00000000..d6a66aa0 --- /dev/null +++ b/doc/source/cli/command-objects/network-segment.rst @@ -0,0 +1,133 @@ +=============== +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 create +---------------------- + +Create new network segment + +.. program:: network segment create +.. code:: bash + + openstack network segment create + [--description ] + [--physical-network ] + [--segment ] + --network + --network-type + + +.. option:: --description + + Network segment description + +.. option:: --physical-network + + Physical network name of this network segment + +.. option:: --segment + + Segment identifier for this network segment which is + based on the network type, VLAN ID for vlan network + type and tunnel ID for geneve, gre and vxlan network + types + +.. option:: --network + + Network this network segment belongs to (name or ID) + +.. option:: --network-type + + Network type of this network segment + (flat, geneve, gre, local, vlan or vxlan) + +.. _network_segment_create-name: +.. describe:: + + New network segment name + +network segment delete +---------------------- + +Delete network segment(s) + +.. program:: network segment delete +.. code:: bash + + openstack network segment delete + [ ...] + +.. _network_segment_delete-segment: +.. describe:: + + Network segment(s) to delete (name or ID) + +network segment list +-------------------- + +List network segments + +.. program:: network segment list +.. code:: bash + + openstack network segment list + [--long] + [--network ] + +.. option:: --long + + List additional fields in output + +.. option:: --network + + List network segments that belong to this network (name or ID) + +network segment set +------------------- + +Set network segment properties + +.. program:: network segment set +.. code:: bash + + openstack network segment set + [--description ] + [--name ] + + +.. option:: --description + + Set network segment description + +.. option:: --name + + Set network segment name + +.. _network_segment_set-segment: +.. describe:: + + Network segment to modify (name or ID) + +network segment show +-------------------- + +Display network segment details + +.. program:: network segment show +.. code:: bash + + openstack network segment show + + +.. _network_segment_show-segment: +.. describe:: + + Network segment to display (name or ID) diff --git a/doc/source/cli/command-objects/network-service-provider.rst b/doc/source/cli/command-objects/network-service-provider.rst new file mode 100644 index 00000000..f46073f6 --- /dev/null +++ b/doc/source/cli/command-objects/network-service-provider.rst @@ -0,0 +1,20 @@ +======================== +network service provider +======================== + +A **network service provider** is a particular driver that implements a +networking service + +Network v2 + +.. _network_service_provider_list: + +network service provider list +----------------------------- + +List service providers + +.. program:: network service provider list +.. code:: bash + + openstack network service provider list diff --git a/doc/source/cli/command-objects/network.rst b/doc/source/cli/command-objects/network.rst new file mode 100644 index 00000000..ed9fd13d --- /dev/null +++ b/doc/source/cli/command-objects/network.rst @@ -0,0 +1,414 @@ +======= +network +======= + +A **network** is an isolated Layer 2 networking segment. There are two types +of networks, project and provider networks. Project networks are fully isolated +and are not shared with other projects. Provider networks map to existing +physical networks in the data center and provide external network access for +servers and other resources. Only an OpenStack administrator can create +provider networks. Networks can be connected via routers. + +Compute v2, Network v2 + +network create +-------------- + +Create new network + +.. program:: network create +.. code:: bash + + openstack network create + [--project [--project-domain ]] + [--enable | --disable] + [--share | --no-share] + [--description ] + [--availability-zone-hint ] + [--enable-port-security | --disable-port-security] + [--external [--default | --no-default] | --internal] + [--provider-network-type ] + [--provider-physical-network ] + [--provider-segment ] + [--qos-policy ] + [--transparent-vlan | --no-transparent-vlan] + + +.. option:: --project + + Owner's project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + *Network version 2 only* + +.. option:: --enable + + Enable network (default) + + *Network version 2 only* + +.. option:: --disable + + Disable network + + *Network version 2 only* + +.. option:: --share + + Share the network between projects + +.. option:: --no-share + + Do not share the network between projects + +.. option:: --description + + Set network description + + *Network version 2 only* + +.. option:: --availability-zone-hint + + Availability Zone in which to create this network + (Network Availability Zone extension required, + repeat option to set multiple availability zones) + + *Network version 2 only* + +.. option:: --enable-port-security + + Enable port security by default for ports created on + this network (default) + + *Network version 2 only* + +.. option:: --disable-port-security + + Disable port security by default for ports created on + this network + + *Network version 2 only* + +.. option:: --subnet + + IPv4 subnet for fixed IPs (in CIDR notation) + + *Compute version 2 only* + +.. option:: --external + + Set this network as an external network + (external-net extension required) + + *Network version 2 only* + +.. option:: --internal + + Set this network as an internal network (default) + + *Network version 2 only* + +.. option:: --default + + Specify if this network should be used as + the default external network + + *Network version 2 only* + +.. option:: --no-default + + Do not use the network as the default external network + (default) + + *Network version 2 only* + +.. option:: --provider-network-type + + The physical mechanism by which the virtual network is implemented. + The supported options are: flat, geneve, gre, local, vlan, vxlan. + + *Network version 2 only* + +.. option:: --provider-physical-network + + Name of the physical network over which the virtual network is implemented + + *Network version 2 only* + +.. option:: --provider-segment + + VLAN ID for VLAN networks or Tunnel ID for GENEVE/GRE/VXLAN networks + + *Network version 2 only* + +.. option:: --qos-policy + + QoS policy to attach to this network (name or ID) + + *Network version 2 only* + +.. option:: --transparent-vlan + + Make the network VLAN transparent + + *Network version 2 only* + +.. option:: --no-transparent-vlan + + Do not make the network VLAN transparent + + *Network version 2 only* + +.. _network_create-name: +.. describe:: + + New network name + +network delete +-------------- + +Delete network(s) + +.. program:: network delete +.. code:: bash + + openstack network delete + [ ...] + +.. _network_delete-network: +.. describe:: + + Network(s) to delete (name or ID) + +network list +------------ + +List networks + +.. program:: network list +.. code:: bash + + openstack network list + [--external | --internal] + [--long] + [--name ] + [--enable | --disable] + [--project [--project-domain ]] + [--share | --no-share] + [--status ] + [--provider-network-type ] + [--provider-physical-network ] + [--provider-segment ] + [--agent ] + +.. option:: --external + + List external networks + + *Network version 2 only* + +.. option:: --internal + + List internal networks + + *Network version 2 only* + +.. option:: --long + + List additional fields in output + + *Network version 2 only* + +.. option:: --name + + List networks according to their name + + *Network version 2 only* + +.. option:: --enable + + List enabled networks + + *Network version 2 only* + +.. option:: --disable + + List disabled networks + + *Network version 2 only* + +.. option:: --project + + List networks according to their project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + *Network version 2 only* + +.. option:: --share + + List networks shared between projects + + *Network version 2 only* + +.. option:: --no-share + + List networks not shared between projects + + *Network version 2 only* + +.. option:: --status + + List networks according to their status + ('ACTIVE', 'BUILD', 'DOWN', 'ERROR') + +.. option:: --provider-network-type + + List networks according to their physical mechanisms. + The supported options are: flat, geneve, gre, local, vlan, vxlan. + + *Network version 2 only* + +.. option:: --provider-physical-network + + List networks according to name of the physical network + + *Network version 2 only* + +.. option:: --provider-segment + + List networks according to VLAN ID for VLAN networks + or Tunnel ID for GENEVE/GRE/VXLAN networks + + *Network version 2 only* + +.. option:: --agent + + List networks hosted by agent (ID only) + +network set +----------- + +Set network properties + +*Network version 2 only* + +.. program:: network set +.. code:: bash + + openstack network set + [--name ] + [--enable | --disable] + [--share | --no-share] + [--description ] + [--enable-port-security | --disable-port-security] + [--external [--default | --no-default] | --internal] + [--provider-network-type ] + [--provider-physical-network ] + [--provider-segment ] + [--qos-policy | --no-qos-policy] + + +.. option:: --name + + Set network name + +.. option:: --enable + + Enable network + +.. option:: --disable + + Disable network + +.. option:: --share + + Share the network between projects + +.. option:: --no-share + + Do not share the network between projects + +.. option:: --description + + Set network description + +.. option:: --enable-port-security + + Enable port security by default for ports created on + this network + +.. option:: --disable-port-security + + Disable port security by default for ports created on + this network + +.. option:: --external + + Set this network as an external network. + (external-net extension required) + +.. option:: --internal + + Set this network as an internal network + +.. option:: --default + + Set the network as the default external network + +.. option:: --no-default + + Do not use the network as the default external network. + +.. option:: --provider-network-type + + The physical mechanism by which the virtual network is implemented. + The supported options are: flat, gre, local, vlan, vxlan. + +.. option:: --provider-physical-network + + Name of the physical network over which the virtual network is implemented + +.. option:: --provider-segment + + VLAN ID for VLAN networks or Tunnel ID for GRE/VXLAN networks + +.. option:: --qos-policy + + QoS policy to attach to this network (name or ID) + +.. option:: --no-qos-policy + + Remove the QoS policy attached to this network + +.. _network_set-network: +.. describe:: + + Network to modify (name or ID) + +network show +------------ + +Display network details + +.. program:: network show +.. code:: bash + + openstack network show + + +.. _network_show-network: +.. describe:: + + Network to display (name or ID) diff --git a/doc/source/cli/command-objects/object-store-account.rst b/doc/source/cli/command-objects/object-store-account.rst new file mode 100644 index 00000000..e8f09d45 --- /dev/null +++ b/doc/source/cli/command-objects/object-store-account.rst @@ -0,0 +1,45 @@ +==================== +object store account +==================== + +Object Storage v1 + +object store account set +------------------------ + +Set account properties + +.. program:: object store account set +.. code:: bash + + openstack object store account set + [--property [...] ] + +.. option:: --property + + 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 ] + +.. option:: --property + + Property to remove from account (repeat option to remove multiple properties) diff --git a/doc/source/cli/command-objects/object.rst b/doc/source/cli/command-objects/object.rst new file mode 100644 index 00000000..6323c4ed --- /dev/null +++ b/doc/source/cli/command-objects/object.rst @@ -0,0 +1,195 @@ +====== +object +====== + +Object Storage v1 + +object create +------------- + +Upload object to container + +.. program:: object create +.. code:: bash + + openstack object create + [--name ] + + [ ...] + +.. option:: --name + + Upload a file and rename it. Can only be used when uploading a single object + +.. describe:: + + Container for new object + +.. describe:: + + Local filename(s) to upload + +object delete +------------- + +Delete object from container + +.. program:: object delete +.. code:: bash + + openstack object delete + + [ ...] + +.. describe:: + + Delete object(s) from + +.. describe:: + + Object(s) to delete + +object list +----------- + +List objects + +.. program object list +.. code:: bash + + openstack object list + [--prefix ] + [--delimiter ] + [--marker ] + [--end-marker ] + [--limit ] + [--long] + [--all] + + +.. option:: --prefix + + Filter list using + +.. option:: --delimiter + + Roll up items with + +.. option:: --marker + + Anchor for paging + +.. option:: --end-marker + + End anchor for paging + +.. option:: --limit + + Limit number of objects returned + +.. option:: --long + + List additional fields in output + +.. option:: --all + + List all objects in (default is 10000) + +.. describe:: + + Container to list + +object save +----------- + +Save object locally + +.. program:: object save +.. code:: bash + + openstack object save + [--file ] + + + +.. option:: --file + + Destination filename (defaults to object name) + +.. describe:: + + Download from + +.. describe:: + + Object to save + +object set +---------- + +Set object properties + +.. program:: object set +.. code:: bash + + openstack object set + [--property [...] ] + + + +.. option:: --property + + Set a property on this object (repeat option to set multiple properties) + +.. describe:: + + Modify from + +.. describe:: + + Object to modify + +object show +----------- + +Display object details + +.. program:: object show +.. code:: bash + + openstack object show + + + +.. describe:: + + Display from + +.. describe:: + + Object to display + +object unset +------------ + +Unset object properties + +.. program:: object unset +.. code:: bash + + openstack object unset + [--property ] + + + +.. option:: --property + + Property to remove from object (repeat option to remove multiple properties) + +.. describe:: + + Modify from + +.. describe:: + + Object to modify diff --git a/doc/source/cli/command-objects/policy.rst b/doc/source/cli/command-objects/policy.rst new file mode 100644 index 00000000..deddf2c4 --- /dev/null +++ b/doc/source/cli/command-objects/policy.rst @@ -0,0 +1,95 @@ +====== +policy +====== + +Identity v3 + +policy create +------------- + +Create new policy + +.. program:: policy create +.. code:: bash + + openstack policy create + [--type ] + + +.. option:: --type + + New MIME type of the policy rules file (defaults to application/json) + +.. describe:: + + New serialized policy rules file + +policy delete +------------- + +Delete policy(s) + +.. program:: policy delete +.. code:: bash + + openstack policy delete + [ ...] + +.. describe:: + + Policy(s) to delete + +policy list +----------- + +List policies + +.. program:: policy list +.. code:: bash + + openstack policy list + [--long] + +.. option:: --long + + List additional fields in output + +policy set +---------- + +Set policy properties + +.. program:: policy set +.. code:: bash + + openstack policy set + [--type ] + [--rules ] + + +.. option:: --type + + New MIME type of the policy rules file + +.. describe:: --rules + + New serialized policy rules file + +.. describe:: + + Policy to modify + +policy show +----------- + +Display policy details + +.. program:: policy show +.. code:: bash + + openstack policy show + + +.. describe:: + + Policy to display diff --git a/doc/source/cli/command-objects/port.rst b/doc/source/cli/command-objects/port.rst new file mode 100644 index 00000000..b3f4c7f9 --- /dev/null +++ b/doc/source/cli/command-objects/port.rst @@ -0,0 +1,404 @@ +==== +port +==== + +A **port** is a connection point for attaching a single device, such as the +NIC of a server, to a network. The port also describes the associated network +configuration, such as the MAC and IP addresses to be used on that port. + +Network v2 + +port create +----------- + +Create new port + +.. program:: port create +.. code:: bash + + openstack port create + --network + [--description ] + [--fixed-ip subnet=,ip-address=] + [--device ] + [--device-owner ] + [--vnic-type ] + [--binding-profile ] + [--host ] + [--enable | --disable] + [--mac-address ] + [--security-group | --no-security-group] + [--dns-name ] + [--allowed-address ip-address=[,mac-address=]] + [--qos-policy ] + [--project [--project-domain ]] + [--enable-port-security | --disable-port-security] + + +.. option:: --network + + Network this port belongs to (name or ID) + +.. option:: --description + + Description of this port + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet for this port (name or ID): + subnet=,ip-address= + (repeat option to set multiple fixed IP addresses) + +.. option:: --device + + Port device ID + +.. option:: --device-owner + + Device owner of this port. This is the entity that uses + the port (for example, network:dhcp). + +.. option:: --vnic-type + + VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal, + default: normal) + +.. option:: --binding-profile + + Custom data to be passed as binding:profile. Data may + be passed as = or JSON. + (repeat option to set multiple binding:profile data) + +.. option:: --host + + Allocate port on host ```` (ID only) + +.. option:: --enable + + Enable port (default) + +.. option:: --disable + + Disable port + +.. option:: --mac-address + + MAC address of this port + +.. option:: --security-group + + Security group to associate with this port (name or ID) + (repeat option to set multiple security groups) + +.. option:: --no-security-group + + Associate no security groups with this port + +.. option:: --dns-name + + Set DNS name to this port + (requires DNS integration extension) + +.. option:: --allowed-address ip-address=[,mac-address=] + + Add allowed-address pair associated with this port: + ip-address=[,mac-address=] + (repeat option to set multiple allowed-address pairs) + +.. option:: --qos-policy + + Attach QoS policy to this port (name or ID) + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --enable-port-security + + Enable port security for this port (Default) + +.. option:: --disable-port-security + + Disable port security for this port + +.. _port_create-name: +.. describe:: + + Name of this port + +port delete +----------- + +Delete port(s) + +.. program:: port delete +.. code:: bash + + openstack port delete + [ ...] + +.. _port_delete-port: +.. describe:: + + Port(s) to delete (name or ID) + +port list +--------- + +List ports + +.. program:: port list +.. code:: bash + + openstack port list + [--device-owner ] + [--router | --server ] + [--network ] + [--mac-address ] + [--fixed-ip subnet=,ip-address=] + [--long] + [--project [--project-domain ]] + +.. option:: --device-owner + + List only ports with the specified device owner. This is + the entity that uses the port (for example, network:dhcp). + +.. option:: --router + + List only ports attached to this router (name or ID) + +.. option:: --server + + List only ports attached to this server (name or ID) + +.. option:: --network + + List only ports attached to this network (name or ID) + +.. option:: --mac-address + + List only ports with this MAC address + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet for filtering ports (name or ID): + subnet=,ip-address= + (repeat option to set multiple fixed IP addresses) + +.. option:: --long + + List additional fields in output + +.. option:: --project + + List ports according to their project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +port set +-------- + +Set port properties + +.. program:: port set +.. code:: bash + + openstack port set + [--description ] + [--fixed-ip subnet=,ip-address=] + [--no-fixed-ip] + [--device ] + [--device-owner ] + [--vnic-type ] + [--binding-profile ] + [--no-binding-profile] + [--host ] + [--qos-policy ] + [--enable | --disable] + [--name ] + [--mac-address ] + [--security-group ] + [--no-security-group] + [--enable-port-security | --disable-port-security] + [--dns-name ] + [--allowed-address ip-address=[,mac-address=]] + [--no-allowed-address] + + +.. option:: --description + + Description of this port + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet for this port (name or ID): + subnet=,ip-address= + (repeat option to set multiple fixed IP addresses) + +.. option:: --no-fixed-ip + + Clear existing information of fixed IP addresses. + Specify both :option:`--fixed-ip` and :option:`--no-fixed-ip` + to overwrite the current fixed IP addresses. + +.. option:: --device + + Port device ID + +.. option:: --device-owner + + Device owner of this port. This is the entity that uses + the port (for example, network:dhcp). + +.. option:: --vnic-type + + VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal, + default: normal) + +.. option:: --binding-profile + + Custom data to be passed as binding:profile. Data may + be passed as = or JSON. + (repeat option to set multiple binding:profile data) + +.. option:: --no-binding-profile + + Clear existing information of binding:profile. + Specify both :option:`--binding-profile` and :option:`--no-binding-profile` + to overwrite the current binding:profile information. + +.. option:: --host + + Allocate port on host ```` (ID only) + +.. option:: --qos-policy + + Attach QoS policy to this port (name or ID) + +.. option:: --enable + + Enable port + +.. option:: --disable + + Disable port + +.. option:: --name + + Set port name + +.. option:: --mac-address + + Set port's MAC address (admin only) + +.. option:: --security-group + + Security group to associate with this port (name or ID) + (repeat option to set multiple security groups) + +.. option:: --no-security-group + + Clear existing security groups associated with this port + +.. option:: --enable-port-security + + Enable port security for this port + +.. option:: --disable-port-security + + Disable port security for this port + +.. option:: --dns-name + + Set DNS name to this port + (requires DNS integration extension) + +.. option:: --allowed-address ip-address=[,mac-address=] + + Add allowed-address pair associated with this port: + ip-address=[,mac-address=] + (repeat option to set multiple allowed-address pairs) + +.. option:: --no-allowed-address + + Clear existing allowed-address pairs associated + with this port. + (Specify both --allowed-address and --no-allowed-address + to overwrite the current allowed-address pairs) + +.. _port_set-port: +.. describe:: + + Port to modify (name or ID) + +port show +--------- + +Display port details + +.. program:: port show +.. code:: bash + + openstack port show + + +.. _port_show-port: +.. describe:: + + Port to display (name or ID) + +port unset +---------- + +Unset port properties + +.. program:: port unset +.. code:: bash + + openstack port unset + [--fixed-ip subnet=,ip-address= [...]] + [--binding-profile [...]] + [--security-group [...]] + [--allowed-address ip-address=[,mac-address=] [...]] + [--qos-policy] + + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet which should be removed + from this port (name or ID): subnet=,ip-address= + (repeat option to unset multiple fixed IP addresses) + +.. option:: --binding-profile + + Desired key which should be removed from binding-profile + (repeat option to unset multiple binding:profile data) + +.. option:: --security-group + + Security group which should be removed from this port (name or ID) + (repeat option to unset multiple security groups) + +.. option:: --allowed-address ip-address=[,mac-address=] + + Desired allowed-address pair which should be removed from this port: + ip-address=[,mac-address=] + (repeat option to unset multiple allowed-address pairs) + +.. option:: --qos-policy + + Remove the QoS policy attached to the port + +.. _port_unset-port: +.. describe:: + + Port to modify (name or ID) diff --git a/doc/source/cli/command-objects/project-purge.rst b/doc/source/cli/command-objects/project-purge.rst new file mode 100644 index 00000000..0ad0bbf9 --- /dev/null +++ b/doc/source/cli/command-objects/project-purge.rst @@ -0,0 +1,42 @@ +============= +project purge +============= + +Clean resources associated with a specific project. + +Block Storage v1, v2; Compute v2; Image v1, v2 + +project purge +------------- + +Clean resources associated with a project + +.. program:: project purge +.. code:: bash + + openstack project purge + [--dry-run] + [--keep-project] + [--auth-project | --project ] + [--project-domain ] + +.. option:: --dry-run + + List a project's resources + +.. option:: --keep-project + + Clean project resources, but don't delete the project. + +.. option:: --auth-project + + Delete resources of the project used to authenticate + +.. option:: --project + + Project to clean (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). This can be + used in case collisions between project names exist. diff --git a/doc/source/cli/command-objects/project.rst b/doc/source/cli/command-objects/project.rst new file mode 100644 index 00000000..cb0941ca --- /dev/null +++ b/doc/source/cli/command-objects/project.rst @@ -0,0 +1,235 @@ +======= +project +======= + +Identity v2, v3 + +project create +-------------- + +Create new project + +.. program:: project create +.. code:: bash + + openstack project create + [--domain ] + [--parent ] + [--description ] + [--enable | --disable] + [--property ] + [--or-show] + + +.. option:: --domain + + Domain owning the project (name or ID) + + .. versionadded:: 3 + +.. option:: --parent + + Parent of the project (name or ID) + + .. versionadded:: 3 + +.. option:: --description + + Project description + +.. option:: --enable + + Enable project (default) + +.. option:: --disable + + Disable project + +.. option:: --property + + Add a property to :ref:`\ ` + (repeat option to set multiple properties) + +.. option:: --or-show + + Return existing project + + If the project already exists return the existing project data and do not fail. + +.. _project_create-name: +.. describe:: + + New project name + +project delete +-------------- + +Delete project(s) + +.. program:: project delete +.. code:: bash + + openstack project delete + [--domain ] + [ ...] + +.. option:: --domain + + Domain owning :ref:`\ ` (name or ID) + + .. versionadded:: 3 + +.. _project_delete-project: +.. describe:: + + Project to delete (name or ID) + +project list +------------ + +List projects + +.. program:: project list +.. code:: bash + + openstack project list + [--domain ] + [--user ] + [--my-projects] + [--long] + [--sort [:,:,..]] + +.. option:: --domain + + Filter projects by :option:`\ <--domain>` (name or ID) + + .. versionadded:: 3 + +.. option:: --user + + Filter projects by :option:`\ <--user>` (name or ID) + + .. versionadded:: 3 + +.. option:: --my-projects + + List projects for the authenticated user. Supersedes other filters. + + .. versionadded:: 3 + +.. option:: --long + + List additional fields in output + +.. option:: --sort [:,:,..] + + Sort output by selected keys and directions (asc or desc) (default: asc), + multiple keys and directions can be specified --sort + [:,:,..] + +project set +----------- + +Set project properties + +.. program:: project set +.. code:: bash + + openstack project set + [--name ] + [--domain ] + [--description ] + [--enable | --disable] + [--property ] + + +.. option:: --name + + Set project name + +.. option:: --domain + + Domain owning :ref:`\ ` (name or ID) + + .. versionadded:: 3 + +.. option:: --description + + Set project description + +.. option:: --enable + + Enable project (default) + +.. option:: --disable + + Disable project + +.. option:: --property + + Set a property on :ref:`\ ` + (repeat option to set multiple properties) + + *Identity version 2 only* + +.. _project_set-project: +.. describe:: + + Project to modify (name or ID) + +project show +------------ + +Display project details + +.. program:: project show +.. code:: bash + + openstack project show + [--domain ] + + +.. option:: --domain + + Domain owning :ref:`\ ` (name or ID) + + .. versionadded:: 3 + +.. option:: --parents + + Show the project\'s parents as a list + + .. versionadded:: 3 + +.. option:: --children + + Show project\'s subtree (children) as a list + + .. versionadded:: 3 + +.. _project_show-project: +.. describe:: + + Project to display (name or ID) + +project unset +------------- + +Unset project properties + +*Identity version 2 only* + +.. program:: project unset +.. code:: bash + + openstack project unset + --property [--property ...] + + +.. option:: --property + + Property key to remove from project (repeat option to remove multiple properties) + +.. describe:: + + Project to modify (name or ID) diff --git a/doc/source/cli/command-objects/quota.rst b/doc/source/cli/command-objects/quota.rst new file mode 100644 index 00000000..f39536af --- /dev/null +++ b/doc/source/cli/command-objects/quota.rst @@ -0,0 +1,269 @@ +===== +quota +===== + +Resource quotas appear in multiple APIs, OpenStackClient presents them as a +single object with multiple properties. + +Block Storage v1, v2, Compute v2, Network v2 + +quota list +---------- + +List quotas for all projects with non-default quota values + +.. program:: quota list +.. code:: bash + + openstack quota list + --compute | --network | --volume + +.. option:: --network + + List network quotas + +.. option:: --compute + + List compute quotas + +.. option:: --volume + + List volume quotas + +quota set +--------- + +Set quotas for project + +.. program:: quota set +.. code:: bash + + openstack quota set + # Compute settings + [--cores ] + [--fixed-ips ] + [--floating-ips ] + [--injected-file-size ] + [--injected-files ] + [--instances ] + [--key-pairs ] + [--properties ] + [--ram ] + [--server-groups ] + [--server-group-members ] + + # Block Storage settings + [--backups ] + [--backup-gigabytes ] + [--gigabytes ] + [--per-volume-gigabytes ] + [--snapshots ] + [--volumes ] + [--volume-type ] + + # Network settings + [--floating-ips ] + [--secgroup-rules ] + [--secgroups ] + [--networks ] + [--subnets ] + [--ports ] + [--routers ] + [--rbac-policies ] + [--vips ] + [--subnetpools ] + [--members ] + [--health-monitors ] + + + +Set quotas for class + +.. code:: bash + + openstack quota set + --class + # Compute settings + [--cores ] + [--fixed-ips ] + [--floating-ips ] + [--injected-file-size ] + [--injected-files ] + [--instances ] + [--key-pairs ] + [--properties ] + [--ram ] + [--server-groups ] + [--server-group-members ] + + # Block Storage settings + [--backups ] + [--backup-gigabytes ] + [--gigabytes ] + [--per-volume-gigabytes ] + [--snapshots ] + [--volumes ] + + + +.. option:: --class + + Set quotas for ```` + +.. option:: --properties + + New value for the properties quota + +.. option:: --ram + + New value for the ram quota + +.. option:: --secgroup-rules + + New value for the secgroup-rules quota + +.. option:: --instances + + New value for the instances quota + +.. option:: --key-pairs + + New value for the key-pairs quota + +.. option:: --fixed-ips + + New value for the fixed-ips quota + +.. option:: --secgroups + + New value for the secgroups quota + +.. option:: --injected-file-size + + New value for the injected-file-size quota + +.. option:: --server-groups + + New value for the server-groups quota + +.. option:: --server-group-members + + New value for the server-group-members quota + +.. option:: --floating-ips + + New value for the floating-ips quota + +.. option:: --injected-files + + New value for the injected-files quota + +.. option:: --cores + + New value for the cores quota + +.. option:: --injected-path-size + + New value for the injected-path-size quota + +.. option:: --backups + + New value for the backups quota + +.. option:: --backup-gigabytes + + New value for the backup gigabytes quota + +.. option:: --gigabytes + + New value for the gigabytes quota + +.. option:: --per-volume-gigabytes + + New value for the gigabytes quota of per volume + +.. option:: --volumes + + New value for the volumes quota + +.. option:: --snapshots + + New value for the snapshots quota + +.. option:: --volume-type + + Set quotas for a specific . The supported quotas are: + gigabytes, snapshots, volumes. + +.. option:: --networks + + New value for the networks quota + +.. option:: --subnets + + New value for the subnets quota + +.. option:: --ports + + New value for the ports quota + +.. option:: --routers + + New value for the routers quota + +.. option:: --rbac-policies + + New value for the rbac-policies quota + +.. option:: --vips + + New value for the vips quota + +.. option:: --subnetpools + + New value for the subnetpools quota + +.. option:: --members + + New value for the members quota + +.. option:: --health-monitors + + New value for the health-monitors quota + +quota show +---------- + +Show quotas for project or class + +.. program:: quota show +.. code:: bash + + openstack quota show + [--default] + [] + + +.. option:: --default + + Show default quotas for :ref:`\ ` + +.. _quota_show-project: +.. describe:: + + Show quotas for this project (name or ID) + +.. code:: bash + + openstack quota show + --class + [] + +.. option:: --class + + Show quotas for :ref:`\ ` + +.. _quota_show-class: +.. describe:: + + Show quotas for this class (name or ID) diff --git a/doc/source/cli/command-objects/region.rst b/doc/source/cli/command-objects/region.rst new file mode 100644 index 00000000..d2c63c1b --- /dev/null +++ b/doc/source/cli/command-objects/region.rst @@ -0,0 +1,104 @@ +====== +region +====== + +Identity v3 + +region create +------------- + +Create new region + +.. program:: region create +.. code:: bash + + openstack region create + [--parent-region ] + [--description ] + + +.. option:: --parent-region + + Parent region ID + +.. option:: --description + + New region description + +.. _region_create-region-id: +.. describe:: + + New region ID + +region delete +------------- + +Delete region(s) + +.. program:: region delete +.. code:: bash + + openstack region delete + [ ...] + +.. _region_delete-region-id: +.. describe:: + + Region ID(s) to delete + +region list +----------- + +List regions + +.. program:: region list +.. code:: bash + + openstack region list + [--parent-region ] + +.. option:: --parent-region + + Filter by parent region ID + +region set +---------- + +Set region properties + +.. program:: region set +.. code:: bash + + openstack region set + [--parent-region ] + [--description ] + + +.. option:: --parent-region + + New parent region ID + +.. option:: --description + + New region description + +.. _region_set-region-id: +.. describe:: + + Region to modify + +region show +----------- + +Display region details + +.. program:: region show +.. code:: bash + + openstack region show + + +.. _region_show-region-id: +.. describe:: + + Region to display diff --git a/doc/source/cli/command-objects/request-token.rst b/doc/source/cli/command-objects/request-token.rst new file mode 100644 index 00000000..3c80780f --- /dev/null +++ b/doc/source/cli/command-objects/request-token.rst @@ -0,0 +1,58 @@ +============= +request token +============= + +Identity v3 + +`Requires: OS-OAUTH1 extension` + +request token authorize +----------------------- + +Authorize a request token + +.. program:: request token authorize +.. code:: bash + + openstack request token authorize + --request-key + --role + +.. option:: --request-key + + Request token to authorize (ID only) (required) + +.. option:: --role + + Roles to authorize (name or ID) + (repeat option to set multiple values) (required) + +request token create +-------------------- + +Create a request token + +.. program:: request token create +.. code:: bash + + openstack request token create + --consumer-key + --consumer-secret + --project + [--domain ] + +.. option:: --consumer-key + + Consumer key (required) + +.. option:: --description + + Consumer secret (required) + +.. option:: --project + + Project that consumer wants to access (name or ID) (required) + +.. option:: --domain + + Domain owning (name or ID) diff --git a/doc/source/cli/command-objects/role-assignment.rst b/doc/source/cli/command-objects/role-assignment.rst new file mode 100644 index 00000000..b29f32c6 --- /dev/null +++ b/doc/source/cli/command-objects/role-assignment.rst @@ -0,0 +1,106 @@ +=============== +role assignment +=============== + +Identity v2, v3 + +role assignment list +-------------------- + +List role assignments + +.. program:: role assignment list +.. code:: bash + + openstack role assignment list + [--role ] + [--role-domain ] + [--user ] + [--user-domain ] + [--group ] + [--group-domain ] + [--domain ] + [--project ] + [--project-domain ] + [--effective] + [--inherited] + [--names] + +.. option:: --role + + Role to filter (name or ID) + + .. versionadded:: 3 + +.. option:: --role-domain + + Domain the role belongs to (name or ID). + This can be used in case collisions between role names exist. + + .. versionadded:: 3 + +.. option:: --user + + User to filter (name or ID) + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + + .. versionadded:: 3 + +.. option:: --group + + Group to filter (name or ID) + + .. versionadded:: 3 + +.. option:: --group-domain + + Domain the group belongs to (name or ID). + This can be used in case collisions between group names exist. + + .. versionadded:: 3 + +.. option:: --domain + + Domain to filter (name or ID) + + .. versionadded:: 3 + +.. option:: --project + + Project to filter (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + .. versionadded:: 3 + +.. option:: --effective + + Returns only effective role assignments (defaults to False) + + .. versionadded:: 3 + +.. option:: --inherited + + Specifies if the role grant is inheritable to the sub projects + + .. versionadded:: 3 + +.. option:: --names + + Returns role assignments with names instead of IDs + +.. option:: --auth-user + + Returns role assignments for the authenticated user. + +.. option:: --auth-project + + Returns role assignments for the project to which the authenticated user + is scoped. diff --git a/doc/source/cli/command-objects/role.rst b/doc/source/cli/command-objects/role.rst new file mode 100644 index 00000000..fe3126c0 --- /dev/null +++ b/doc/source/cli/command-objects/role.rst @@ -0,0 +1,326 @@ +==== +role +==== + +Identity v2, v3 + +role add +-------- + +Add role assignment to a user or group in a project or domain + +.. program:: role add +.. code:: bash + + openstack role add + --domain | --project [--project-domain ] + --user [--user-domain ] | --group [--group-domain ] + --role-domain + --inherited + + +.. option:: --domain + + Include (name or ID) + + .. versionadded:: 3 + +.. option:: --project + + Include (name or ID) + +.. option:: --user + + Include (name or ID) + +.. option:: --group + + Include (name or ID) + + .. versionadded:: 3 + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + + .. versionadded:: 3 + +.. option:: --group-domain + + Domain the group belongs to (name or ID). + This can be used in case collisions between group names exist. + + .. versionadded:: 3 + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + .. versionadded:: 3 + +.. option:: --inherited + + Specifies if the role grant is inheritable to the sub projects. + + .. versionadded:: 3 + +.. option:: --role-domain + + Domain the role belongs to (name or ID). + This must be specified when the name of a domain specific role is used. + + .. versionadded:: 3 + +.. describe:: + + Role to add to : (name or ID) + +role create +----------- + +Create new role + +.. program:: role create +.. code:: bash + + openstack role create + [--or-show] + [--domain ] + + +.. option:: --domain + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + +.. option:: --or-show + + Return existing role + + If the role already exists return the existing role data and do not fail. + +.. describe:: + + New role name + +role delete +----------- + +Delete role(s) + +.. program:: role delete +.. code:: bash + + openstack role delete + [ ...] + [--domain ] + +.. describe:: + + Role to delete (name or ID) + +.. option:: --domain + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + +role list +--------- + +List roles + +.. program:: role list +.. code:: bash + + openstack role list + --domain | --project [--project-domain ] + --user [--user-domain ] | --group [--group-domain ] + --inherited + +.. option:: --domain + + Filter roles by (name or ID) + + (Deprecated if being used to list assignments in conjunction with the + ``--user ``, option, please use ``role assignment list`` instead) + +.. option:: --project + + Filter roles by (name or ID) + + (Deprecated, please use ``role assignment list`` instead) + +.. option:: --user + + Filter roles by (name or ID) + + (Deprecated, please use ``role assignment list`` instead) + +.. option:: --group + + Filter roles by (name or ID) + + (Deprecated, please use ``role assignment list`` instead) + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + + (Deprecated, please use ``role assignment list`` instead) + + .. versionadded:: 3 + +.. option:: --group-domain + + Domain the group belongs to (name or ID). + This can be used in case collisions between group names exist. + + (Deprecated, please use ``role assignment list`` instead) + + .. versionadded:: 3 + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + (Deprecated, please use ``role assignment list`` instead) + + .. versionadded:: 3 + +.. option:: --inherited + + Specifies if the role grant is inheritable to the sub projects. + + (Deprecated, please use ``role assignment list`` instead) + + .. versionadded:: 3 + +role remove +----------- + +Remove role assignment from domain/project : user/group + +.. program:: role remove +.. code:: bash + + openstack role remove + --domain | --project [--project-domain ] + --user [--user-domain ] | --group [--group-domain ] + --role-domain + --inherited + + +.. option:: --domain + + Include (name or ID) + + .. versionadded:: 3 + +.. option:: --project + + Include (name or ID) + +.. option:: --user + + Include (name or ID) + +.. option:: --group + + Include (name or ID) + + .. versionadded:: 3 + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + + .. versionadded:: 3 + +.. option:: --group-domain + + Domain the group belongs to (name or ID). + This can be used in case collisions between group names exist. + + .. versionadded:: 3 + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + .. versionadded:: 3 + +.. option:: --inherited + + Specifies if the role grant is inheritable to the sub projects. + + .. versionadded:: 3 + +.. option:: --role-domain + + Domain the role belongs to (name or ID). + This must be specified when the name of a domain specific role is used. + + .. versionadded:: 3 + +.. describe:: + + Role to remove (name or ID) + +role set +-------- + +Set role properties + +.. versionadded:: 3 + +.. program:: role set +.. code:: bash + + openstack role set + [--name ] + [--domain ] + + +.. option:: --name + + Set role name + +.. option:: --domain + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + +.. describe:: + + Role to modify (name or ID) + +role show +--------- + +Display role details + +.. program:: role show +.. code:: bash + + openstack role show + [--domain ] + + +.. option:: --domain + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + +.. describe:: + + Role to display (name or ID) diff --git a/doc/source/cli/command-objects/router.rst b/doc/source/cli/command-objects/router.rst new file mode 100644 index 00000000..50e791ea --- /dev/null +++ b/doc/source/cli/command-objects/router.rst @@ -0,0 +1,357 @@ +====== +router +====== + +A **router** is a logical component that forwards data packets between +networks. It also provides Layer 3 and NAT forwarding to provide external +network access for servers on project networks. + +Network v2 + +router add port +--------------- + +Add a port to a router + +.. program:: router add port +.. code:: bash + + openstack router add port + + + +.. _router_add_port: + +.. describe:: + + Router to which port will be added (name or ID) + +.. describe:: + + Port to be added (name or ID) + +router add subnet +----------------- + +Add a subnet to a router + +.. program:: router add subnet +.. code:: bash + + openstack router add subnet + + + +.. _router_add_subnet: + +.. describe:: + + Router to which subnet will be added (name or ID) + +.. describe:: + + Subnet to be added (name or ID) + +router create +------------- + +Create new router + +.. program:: router create +.. code:: bash + + openstack router create + [--project [--project-domain ]] + [--enable | --disable] + [--distributed | --centralized] + [--ha | --no-ha] + [--description ] + [--availability-zone-hint ] + + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --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 + + The default router type (distributed vs centralized) is determined by a + configuration setting in the OpenStack deployment. Since we are unable + to know that default wihtout attempting to actually create a router it + is suggested to use either :option:`--distributed` or :option:`--centralized` + in situations where multiple cloud deployments may be used. + +.. option:: --centralized + + Create a centralized router + + See the note in :option:`--distributed` regarding the default used when + creating a new router. + +.. option:: --ha + + Create a highly available router + +.. option:: --no-ha + + Create a legacy router + +.. option:: --description + + Set router description + +.. option:: --availability-zone-hint + + Availability Zone in which to create this router + (Router Availability Zone extension required, + repeat option to set multiple availability zones) + +.. _router_create-name: +.. describe:: + + New router name + +router delete +------------- + +Delete router(s) + +.. program:: router delete +.. code:: bash + + openstack router delete + [ ...] + +.. _router_delete-router: +.. describe:: + + Router(s) to delete (name or ID) + +router list +----------- + +List routers + +.. program:: router list +.. code:: bash + + openstack router list + [--name ] + [--enable | --disable] + [--long] + [--project [--project-domain ]] + +.. option:: --long + + List additional fields in output + +.. option:: --name + + List routers according to their name + +.. option:: --enable + + List enabled routers + +.. option:: --disable + + List disabled routers + +.. option:: --project + + List routers according to their project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +router remove port +------------------ + +Remove a port from a router + +.. program:: router remove port +.. code:: bash + + openstack router remove port + + + +.. _router_remove_port: + +.. describe:: + + Router from which port will be removed (name or ID) + +.. describe:: + + Port to be removed and deleted (name or ID) + +router remove subnet +-------------------- + +Remove a subnet from a router + +.. program:: router remove subnet +.. code:: bash + + openstack router remove subnet + + + +.. _router_remove_subnet: + +.. describe:: + + Router from which subnet will be removed (name or ID) + +.. describe:: + + Subnet to be removed (name or ID) + +router set +---------- + +Set router properties + +.. program:: router set +.. code:: bash + + openstack router set + [--name ] + [--enable | --disable] + [--distributed | --centralized] + [--description ] + [--route destination=,gateway= | --no-route] + [--ha | --no-ha] + [--external-gateway [--enable-snat|--disable-snat] [--fixed-ip subnet=,ip-address=]] + + +.. option:: --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) + +.. option:: --description + + Set router description + +.. option:: --route destination=,gateway= + + Routes associated with the router + destination: destination subnet (in CIDR notation) + gateway: nexthop IP address + (repeat option to set multiple routes) + +.. option:: --no-route + + Clear routes associated with the router. + Specify both --route and --no-route to overwrite + current value of route. + +.. option:: --ha + + Set the router as highly available (disabled router only) + +.. option:: --no-ha + + Clear high availablability attribute of the router (disabled router only) + +.. option:: --external-gateway + + External Network used as router's gateway (name or ID) + +.. option:: --enable-snat + + Enable Source NAT on external gateway + +.. option:: --disable-snat + + Disable Source NAT on external gateway + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet (name or ID) on external gateway: + subnet=,ip-address= + (repeat option to set multiple fixed IP addresses) + +.. _router_set-router: +.. describe:: + + Router to modify (name or ID) + +router show +----------- + +Display router details + +.. program:: router show +.. code:: bash + + openstack router show + + +.. _router_show-router: +.. describe:: + + Router to display (name or ID) + +router unset +------------ + +Unset router properties + +.. program:: router unset +.. code:: bash + + openstack router unset + [--route destination=,gateway=] + [--external-gateway] + + +.. option:: --route destination=,gateway= + + Routes to be removed from the router + destination: destination subnet (in CIDR notation) + gateway: nexthop IP address + (repeat option to unset multiple routes) + +.. option:: --external-gateway + + Remove external gateway information from the router + +.. _router_unset-router: +.. describe:: + + Router to modify (name or ID) diff --git a/doc/source/cli/command-objects/security-group-rule.rst b/doc/source/cli/command-objects/security-group-rule.rst new file mode 100644 index 00000000..1dbf16d2 --- /dev/null +++ b/doc/source/cli/command-objects/security-group-rule.rst @@ -0,0 +1,193 @@ +=================== +security group rule +=================== + +A **security group rule** specifies the network access rules for servers +and other resources on the network. + +Compute v2, Network v2 + +security group rule create +-------------------------- + +Create a new security group rule + +.. program:: security group rule create +.. code:: bash + + openstack security group rule create + [--remote-ip | --remote-group ] + [--dst-port | [--icmp-type [--icmp-code ]]] + [--protocol ] + [--ingress | --egress] + [--ethertype ] + [--project [--project-domain ]] + [--description ] + + +.. option:: --remote-ip + + Remote IP address block + (may use CIDR notation; default for IPv4 rule: 0.0.0.0/0) + +.. option:: --remote-group + + Remote security group (name or ID) + +.. option:: --dst-port + + Destination port, may be a single port or a starting and + ending port range: 137:139. Required for IP protocols TCP + and UDP. Ignored for ICMP IP protocols. + +.. option:: --icmp-type + + ICMP type for ICMP IP protocols + + *Network version 2 only* + +.. option:: --icmp-code + + ICMP code for ICMP IP protocols + + *Network version 2 only* + +.. option:: --protocol + + IP protocol (icmp, tcp, udp; default: tcp) + + *Compute version 2* + + IP protocol (ah, dccp, egp, esp, gre, icmp, igmp, + ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, + ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, + udp, udplite, vrrp and integer representations [0-255]; + default: tcp) + + *Network version 2* + +.. option:: --ingress + + Rule applies to incoming network traffic (default) + + *Network version 2 only* + +.. option:: --egress + + Rule applies to outgoing network traffic + + *Network version 2 only* + +.. option:: --ethertype + + Ethertype of network traffic + (IPv4, IPv6; default: based on IP protocol) + + *Network version 2 only* + +.. option:: --project + + Owner's project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + *Network version 2 only* + +.. option:: --description + + Set security group rule description + + *Network version 2 only* + +.. describe:: + + Create rule in this security group (name or ID) + +security group rule delete +-------------------------- + +Delete security group rule(s) + +.. program:: security group rule delete +.. code:: bash + + openstack security group rule delete + [ ...] + +.. describe:: + + Security group rule(s) to delete (ID only) + +security group rule list +------------------------ + +List security group rules + +.. program:: security group rule list +.. code:: bash + + openstack security group rule list + [--all-projects] + [--protocol ] + [--ingress | --egress] + [--long] + [] + +.. option:: --all-projects + + Display information from all projects (admin only) + + *Network version 2 ignores this option and will always display information* + *for all projects (admin only).* + +.. option:: --long + + List additional fields in output + + *Compute version 2 does not have additional fields to display.* + + +.. option:: --protocol + + List rules by the IP protocol (ah, dhcp, egp, esp, gre, icmp, igmp, + ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt,ipv6-opts, ipv6-route, + ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp and integer + representations [0-255]) + + *Network version 2* + +.. option:: --ingress + + List rules applied to incoming network traffic + + *Network version 2 only* + +.. option:: --egress + + List rules applied to outgoing network traffic + + *Network version 2 only* + +.. describe:: + + List all rules in this security group (name or ID) + +security group rule show +------------------------ + +Display security group rule details + +.. program:: security group rule show +.. code:: bash + + openstack security group rule show + + +.. describe:: + + Security group rule to display (ID only) diff --git a/doc/source/cli/command-objects/security-group.rst b/doc/source/cli/command-objects/security-group.rst new file mode 100644 index 00000000..a95a96f4 --- /dev/null +++ b/doc/source/cli/command-objects/security-group.rst @@ -0,0 +1,130 @@ +============== +security group +============== + +A **security group** acts as a virtual firewall for servers and other +resources on a network. It is a container for security group rules +which specify the network access rules. + +Compute v2, Network v2 + +security group create +--------------------- + +Create a new security group + +.. program:: security group create +.. code:: bash + + openstack security group create + [--description ] + [--project [--project-domain ]] + + +.. option:: --description + + Security group description + +.. option:: --project + + Owner's project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + *Network version 2 only* + +.. describe:: + + New security group name + +security group delete +--------------------- + +Delete security group(s) + +.. program:: security group delete +.. code:: bash + + openstack security group delete + [ ...] + +.. describe:: + + Security group(s) to delete (name or ID) + +security group list +------------------- + +List security groups + +.. program:: security group list +.. code:: bash + + openstack security group list + [--all-projects] + [--project [--project-domain ]] + +.. option:: --all-projects + + Display information from all projects (admin only) + + *Network version 2 ignores this option and will always display information* + *for all projects (admin only).* + +.. option:: --project + + List security groups according to the project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + *Network version 2 only* + +security group set +------------------ + +Set security group properties + +.. program:: security group set +.. code:: bash + + openstack security group set + [--name ] + [--description ] + + +.. option:: --name + + New security group name + +.. option:: --description + + New security group description + +.. describe:: + + Security group to modify (name or ID) + +security group show +------------------- + +Display security group details + +.. program:: security group show +.. code:: bash + + openstack security group show + + +.. describe:: + + Security group to display (name or ID) diff --git a/doc/source/cli/command-objects/server-backup.rst b/doc/source/cli/command-objects/server-backup.rst new file mode 100644 index 00000000..9ddb2cdf --- /dev/null +++ b/doc/source/cli/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 + + openstack server backup create + [--name ] + [--type ] + [--rotate ] + [--wait] + + +.. option:: --name + + Name of the backup image (default: server name) + +.. option:: --type + + Used to populate the ``backup_type`` property of the backup + image (default: empty) + +.. option:: --rotate + + Number of backup images to keep (default: 1) + +.. option:: --wait + + Wait for operation to complete + +.. describe:: + + Server to back up (name or ID) diff --git a/doc/source/cli/command-objects/server-event.rst b/doc/source/cli/command-objects/server-event.rst new file mode 100644 index 00000000..ef4685f8 --- /dev/null +++ b/doc/source/cli/command-objects/server-event.rst @@ -0,0 +1,45 @@ +============ +server event +============ + +Server event is the event record that had been done on a server, include: event +type(create, delete, reboot and so on), event result(success, error), start +time, finish time and so on. These are important information for server +maintains. + +Compute v2 + +server event list +----------------- + +List recent events of a server + +.. program:: server event list +.. code:: bash + + openstack server event list + + +.. describe:: + + Server to list events (name or ID) + +server event show +----------------- + +Show server event details + +.. program:: server event show +.. code:: bash + + openstack server event show + + + +.. describe:: + + Server to show event details (name or ID) + +.. describe:: + + Request ID of the event to show (ID only) diff --git a/doc/source/cli/command-objects/server-group.rst b/doc/source/cli/command-objects/server-group.rst new file mode 100644 index 00000000..97696350 --- /dev/null +++ b/doc/source/cli/command-objects/server-group.rst @@ -0,0 +1,80 @@ +============ +server group +============ + +Server group provides a mechanism to group servers according to certain policy. + +Compute v2 + +server group create +------------------- + +Create a new server group + +.. program:: server group create +.. code-block:: bash + + openstack server group create + --policy + + +.. option:: --policy + + Add a policy to :ref:`\ ` + ('affinity' or 'anti-affinity', default to 'affinity') + +.. _server_group_create-name: +.. describe:: + + New server group name + +server group delete +------------------- + +Delete existing server group(s) + +.. program:: server group delete +.. code-block:: bash + + openstack server group delete + [ ...] + +.. describe:: + + Server group(s) to delete (name or ID) + (repeat to delete multiple server groups) + +server group list +----------------- + +List all server groups + +.. program:: server group list +.. code-block:: bash + + openstack server group list + [--all-projects] + [--long] + +.. option:: --all-projects + + Display information from all projects (admin only) + +.. option:: --long + + List additional fields in output + +server group show +----------------- + +Display server group details + +.. program:: server group show +.. code-block:: bash + + openstack server group show + + +.. describe:: + + Server group to display (name or ID) diff --git a/doc/source/cli/command-objects/server-image.rst b/doc/source/cli/command-objects/server-image.rst new file mode 100644 index 00000000..7e625d9e --- /dev/null +++ b/doc/source/cli/command-objects/server-image.rst @@ -0,0 +1,33 @@ +============ +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 +------------------- + +Create a new server disk image from an existing server + +.. program:: server image create +.. code:: bash + + openstack server image create + [--name ] + [--wait] + + +.. option:: --name + + Name of new disk image (default: server name) + +.. option:: --wait + + Wait for operation to complete + +.. describe:: + + Server to create image (name or ID) diff --git a/doc/source/cli/command-objects/server.rst b/doc/source/cli/command-objects/server.rst new file mode 100644 index 00000000..cc580603 --- /dev/null +++ b/doc/source/cli/command-objects/server.rst @@ -0,0 +1,986 @@ +====== +server +====== + +Compute v2 + +server add fixed ip +------------------- + +Add fixed IP address to server + +.. program:: server add fixed ip +.. code:: bash + + openstack server add fixed ip + [--fixed-ip-address ] + + + +.. option:: --fixed-ip-address + + Requested fixed IP address + +.. describe:: + + Server to receive the fixed IP address (name or ID) + +.. describe:: + + Network to allocate the fixed IP address from (name or ID) + +server add floating ip +---------------------- + +Add floating IP address to server + +.. program:: server add floating ip +.. code:: bash + + openstack server add floating ip + [--fixed-ip-address ] + + + +.. option:: --fixed-ip-address + + Fixed IP address to associate with this floating IP address + +.. describe:: + + Server to receive the floating IP address (name or ID) + +.. describe:: + + Floating IP address to assign to server (IP only) + +server add port +--------------- + +Add port to server + +.. program:: server add port +.. code:: bash + + openstack server add port + + + +.. describe:: + + Server to add the port to (name or ID) + +.. describe:: + + Port to add to the server (name or ID) + +server add security group +------------------------- + +Add security group to server + +.. program:: server add security group +.. code:: bash + + openstack server add security group + + + +.. describe:: + + Server (name or ID) + +.. describe:: + + Security group to add (name or ID) + +server add volume +----------------- + +Add volume to server + +.. program:: server add volume +.. code:: bash + + openstack server add volume + [--device ] + + + +.. option:: --device + + Server internal device name for volume + +.. describe:: + + Server (name or ID) + +.. describe:: + + Volume to add (name or ID) + +server create +------------- + +Create a new server + +.. program:: server create +.. code:: bash + + openstack server create + --image | --volume + --flavor + [--security-group [...] ] + [--key-name ] + [--property [...] ] + [--file ] [...] ] + [--user-data ] + [--availability-zone ] + [--block-device-mapping [...] ] + [--nic [...] ] + [--network ] + [--port ] + [--hint [...] ] + [--config-drive |True ] + [--min ] + [--max ] + [--wait] + + +.. option:: --image + + Create server boot disk from this image (name or ID) + +.. option:: --volume + + Create server using this volume as the boot disk (name or ID) + + This option automatically creates a block device mapping with a boot + index of 0. On many hypervisors (libvirt/kvm for example) this will + be device ``vda``. Do not create a duplicate mapping using + :option:`--block-device-mapping` for this volume. + +.. option:: --flavor + + Create server with this flavor (name or ID) + +.. option:: --security-group + + Security group to assign to this server (name or ID) + (repeat option to set multiple groups) + +.. option:: --key-name + + Keypair to inject into this server (optional extension) + +.. option:: --property + + Set a property on this server + (repeat option to set multiple values) + +.. option:: --file + + File to inject into image before boot + (repeat option to set multiple files) + +.. option:: --user-data + + User data file to serve from the metadata server + +.. option:: --availability-zone + + Select an availability zone for the server + +.. option:: --block-device-mapping + + Create a block device on the server. + + Block device mapping in the format + + =::: + + : block device name, like: vdb, xvdc (required) + + : UUID of the volume or snapshot (required) + + : volume or snapshot; default: volume (optional) + + : volume size if create from snapshot (optional) + + : true or false; default: false (optional) + + (optional extension) + +.. option:: --nic + + Create a NIC on the server. Specify option multiple times to create + multiple NICs. Either net-id or port-id must be provided, but not both. + net-id: attach NIC to network with this UUID, + port-id: attach NIC to port with this UUID, + v4-fixed-ip: IPv4 fixed address for NIC (optional), + 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:: --network + + Create a NIC on the server and connect it to network. + Specify option multiple times to create multiple NICs. + For more options on NICs see --nic parameter. + network: attach NIC to this network + +.. option:: --port + + Create a NIC on the server and connect it to port. + Specify option multiple times to create multiple NICs. + For more options on NICs see --nic parameter. + port: attach NIC to this port + +.. option:: --hint + + Hints for the scheduler (optional extension) + +.. option:: --config-drive |True + + Use specified volume as the config drive, or 'True' to use an ephemeral drive + +.. option:: --min + + Minimum number of servers to launch (default=1) + +.. option:: --max + + Maximum number of servers to launch (default=1) + +.. option:: --wait + + Wait for build to complete + +.. describe:: + + New server name + +.. + +The parameters ``--network `` and ``--port `` are actually +wrappers to ``--nic net-id=`` and ``--nic port-id=``. ``--nic`` +also provides additional options to specify an IP address, automatic network +assignment and NICs which are not assigned to any port. This functionality +is not part of ``--network`` and ``--port``, which aim to provide a simple +syntax for the standard use cases of connecting a new server to a given +network or port. + +server delete +------------- + +Delete server(s) + +.. program:: server delete +.. code:: bash + + openstack server delete + [ ...] [--wait] + +.. option:: --wait + + Wait for delete to complete + +.. describe:: + + Server(s) to delete (name or ID) + +server dump create +------------------ +Create a dump file in server(s) + +Trigger crash dump in server(s) with features like kdump in Linux. It will +create a dump file in the server(s) dumping the server(s)' memory, and also +crash the server(s). OSC sees the dump file (server dump) as a kind of +resource. + +.. program:: server dump create +.. code:: bash + + openstack server dump create + [ ...] + +.. describe:: + + Server(s) to create dump file (name or ID) + +server list +----------- + +List servers + +.. code:: bash + + openstack server list + [--reservation-id ] + [--ip ] + [--ip6 ] + [--name ] + [--instance-name ] + [--status ] + [--flavor ] + [--image ] + [--host ] + [--all-projects] + [--project [--project-domain ]] + [--long] + [--marker ] + [--limit ] + [--deleted] + [--changes-since ] + +.. option:: --reservation-id + + Only return instances that match the reservation + +.. option:: --ip + + Regular expression to match IP addresses + +.. option:: --ip6 + + Regular expression to match IPv6 addresses + +.. option:: --name + + Regular expression to match names + +.. option:: --instance-name + + Regular expression to match instance name (admin only) + +.. option:: --status + + Search by server status + +.. option:: --flavor + + Search by flavor (name or ID) + +.. option:: --image + + Search by image (name or ID) + +.. option:: --host + + Search by hostname + +.. option:: --all-projects + + Include all projects (admin only) + +.. option:: --project + + Search by project (admin only) (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --user + + Search by user (admin only) (name or ID) + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + +.. option:: --long + + List additional fields in output + +.. option:: --marker + + The last server of the previous page. Display list of servers + after marker. Display all servers if not specified. (name or ID) + +.. option:: --limit + + Maximum number of servers to display. If limit equals -1, all servers will + be displayed. If limit is greater than 'osapi_max_limit' option of Nova + API, 'osapi_max_limit' will be used instead. + +.. option:: --deleted + + Only display deleted servers (Admin only). + +.. option:: --changes-since + + List only servers changed after a certain point of time. The provided time + should be an ISO 8061 formatted time. ex 2016-03-04T06:27:59Z. + +server lock +----------- + +Lock server(s). A non-admin user will not be able to execute actions + +.. program:: server lock +.. code:: bash + + openstack server lock + [ ...] + +.. describe:: + + Server(s) to lock (name or ID) + +server migrate +-------------- + +Migrate server to different host + +.. program:: server migrate +.. code:: bash + + openstack server migrate + --live + [--shared-migration | --block-migration] + [--disk-overcommit | --no-disk-overcommit] + [--wait] + + +.. option:: --live + + Target hostname + +.. option:: --shared-migration + + Perform a shared live migration (default) + +.. option:: --block-migration + + Perform a block live migration + +.. option:: --disk-overcommit + + Allow disk over-commit on the destination host + +.. option:: --no-disk-overcommit + + Do not over-commit disk on the destination host (default) + +.. option:: --wait + + Wait for migrate to complete + +.. describe:: + + Server to migrate (name or ID) + +server pause +------------ + +Pause server(s) + +.. program:: server pause +.. code:: bash + + openstack server pause + [ ...] + +.. describe:: + + Server(s) to pause (name or ID) + +server reboot +------------- + +Perform a hard or soft server reboot + +.. program:: server reboot +.. code:: bash + + openstack server reboot + [--hard | --soft] + [--wait] + + +.. option:: --hard + + Perform a hard reboot + +.. option:: --soft + + Perform a soft reboot + +.. option:: --wait + + Wait for reboot to complete + +.. describe:: + + Server (name or ID) + +server rebuild +-------------- + +Rebuild server + +.. program:: server rebuild +.. code:: bash + + openstack server rebuild + [--image ] + [--password ] + [--wait] + + +.. option:: --image + + Recreate server from the specified image (name or ID). Defaults to the + currently used one. + +.. option:: --password + + Set the password on the rebuilt instance + +.. option:: --wait + + Wait for rebuild to complete + +.. describe:: + + Server (name or ID) + +server remove fixed ip +---------------------- + +Remove fixed IP address from server + +.. program:: server remove fixed ip +.. code:: bash + + openstack server remove fixed ip + + + +.. describe:: + + Server to remove the fixed IP address from (name or ID) + +.. describe:: + + Fixed IP address to remove from the server (IP only) + +server remove floating ip +------------------------- + +Remove floating IP address from server + +.. program:: server remove floating ip +.. code:: bash + + openstack server remove floating ip + + + +.. describe:: + + Server to remove the floating IP address from (name or ID) + +.. describe:: + + Floating IP address to remove from server (IP only) + +server remove port +------------------ + +Remove port from server + +.. program:: server remove port +.. code:: bash + + openstack server remove port + + + +.. describe:: + + Server to remove the port from (name or ID) + +.. describe:: + + Port to remove from the server (name or ID) + +server remove security group +---------------------------- + +Remove security group from server + +.. program:: server remove security group +.. code:: bash + + openstack server remove security group + + + +.. describe:: + + Name or ID of server to use + +.. describe:: + + Name or ID of security group to remove from server + +server remove volume +-------------------- + +Remove volume from server + +.. program:: server remove volume +.. code:: bash + + openstack server remove volume + + + +.. describe:: + + Server (name or ID) + +.. describe:: + + Volume to remove (name or ID) + +server rescue +------------- + +Put server in rescue mode + +.. program:: server rescue +.. code:: bash + + openstack server rescue + + +.. describe:: + + Server (name or ID) + +server resize +------------- + +Scale server to a new flavor + +.. program:: server resize +.. code:: bash + + openstack server resize + --flavor + [--wait] + + + openstack server resize + --confirm | --revert + + +.. option:: --flavor + + Resize server to specified flavor + +.. option:: --confirm + + Confirm server resize is complete + +.. option:: --revert + + Restore server state before resize + +.. option:: --wait + + Wait for resize to complete + +.. describe:: + + Server (name or ID) + +A resize operation is implemented by creating a new server and copying +the contents of the original disk into a new one. It is also a two-step +process for the user: the first is to perform the resize, the second is +to either confirm (verify) success and release the old server, or to declare +a revert to release the new server and restart the old one. + +server restore +-------------- + +Restore server(s) from soft-deleted state + +.. program:: server restore +.. code:: bash + + openstack server restore + [ ...] + +.. describe:: + + Server(s) to restore (name or ID) + +server resume +------------- + +Resume server(s) + +.. program:: server resume +.. code:: bash + + openstack server resume + [ ...] + +.. describe:: + + Server(s) to resume (name or ID) + +server set +---------- + +Set server properties + +.. program:: server set +.. code:: bash + + openstack server set + --name + --property + [--property ] ... + --root-password + --state + + +.. option:: --name + + New server name + +.. option:: --root-password + + Set new root password (interactive only) + +.. option:: --property + + Property to add/change for this server + (repeat option to set multiple properties) + +.. option:: --state + + New server state (valid value: active, error) + +.. describe:: + + Server (name or ID) + +server shelve +------------- + +Shelve server(s) + +.. program:: server shelve +.. code:: bash + + openstack server shelve + [ ...] + +.. describe:: + + Server(s) to shelve (name or ID) + +server show +----------- + +Show server details + +.. program:: server show +.. code:: bash + + openstack server show + [--diagnostics] + + +.. option:: --diagnostics + + Display server diagnostics information + +.. describe:: + + Server (name or ID) + +server ssh +---------- + +SSH to server + +.. program:: server ssh +.. code:: bash + + openstack server ssh + [--login ] + [--port ] + [--identity ] + [--option ] + [--public | --private | --address-type ] + + +.. option:: --login + + Login name (ssh -l option) + +.. option:: --port + + Destination port (ssh -p option) + +.. option:: --identity + + Private key file (ssh -i option) + +.. option:: --option + + Options in ssh_config(5) format (ssh -o option) + +.. option:: --public + + Use public IP address + +.. option:: --private + + Use private IP address + +.. option:: --address-type + + Use other IP address (public, private, etc) + +.. describe:: + + Server (name or ID) + +server start +------------ + +Start server(s) + +.. program:: server start +.. code:: bash + + openstack server start + [ ...] + +.. describe:: + + Server(s) to start (name or ID) + +server stop +----------- + +Stop server(s) + +.. program:: server stop +.. code:: bash + + openstack server stop + [ ...] + +.. describe:: + + Server(s) to stop (name or ID) + +server suspend +-------------- + +Suspend server(s) + +.. program:: server suspend +.. code:: bash + + openstack server suspend + [ ...] + +.. describe:: + + Server(s) to suspend (name or ID) + +server unlock +------------- + +Unlock server(s) + +.. program:: server unlock +.. code:: bash + + openstack server unlock + [ ...] + +.. describe:: + + Server(s) to unlock (name or ID) + +server unpause +-------------- + +Unpause server(s) + +.. program:: server unpause +.. code:: bash + + openstack server unpause + [ ...] + +.. describe:: + + Server(s) to unpause (name or ID) + +server unrescue +--------------- + +Restore server from rescue mode + +.. program:: server unrescue +.. code:: bash + + openstack server unrescue + + +.. describe:: + + Server (name or ID) + +server unset +------------ + +Unset server properties + +.. program:: server unset +.. code:: bash + + openstack server unset + --property + [--property ] ... + + +.. option:: --property + + Property key to remove from server + (repeat option to remove multiple values) + +.. describe:: + + Server (name or ID) + +server unshelve +--------------- + +Unshelve server(s) + +.. program:: server unshelve +.. code:: bash + + openstack server unshelve + [ ...] + +.. describe:: + + Server(s) to unshelve (name or ID) diff --git a/doc/source/cli/command-objects/service-provider.rst b/doc/source/cli/command-objects/service-provider.rst new file mode 100644 index 00000000..63ef44e1 --- /dev/null +++ b/doc/source/cli/command-objects/service-provider.rst @@ -0,0 +1,125 @@ +================ +service provider +================ + +Identity v3 + +`Requires: OS-FEDERATION extension` + +service provider create +----------------------- + +Create new service provider + +.. program:: service provider create +.. code:: bash + + openstack service provider create + [--description ] + [--enable | --disable] + --auth-url + --service-provider-url + + +.. option:: --auth-url + + Authentication URL of remote federated service provider (required) + +.. option:: --service-provider-url + + A service URL where SAML assertions are being sent (required) + +.. option:: --description + + New service provider description + +.. option:: --enable + + Enable the service provider (default) + +.. option:: --disable + + Disable the service provider + +.. describe:: + + New service provider name (must be unique) + +service provider delete +----------------------- + +Delete service provider(s) + +.. program:: service provider delete +.. code:: bash + + openstack service provider delete + [ ...] + +.. describe:: + + Service provider(s) to delete + +service provider list +--------------------- + +List service providers + +.. program:: service provider list +.. code:: bash + + openstack service provider list + +service provider set +-------------------- + +Set service provider properties + +.. program:: service provider set +.. code:: bash + + openstack service provider set + [--enable | --disable] + [--description ] + [--auth-url ] + [--service-provider-url ] + + +.. option:: --service-provider-url + + New service provider URL, where SAML assertions are sent + +.. option:: --auth-url + + New Authentication URL of remote federated service provider + +.. option:: --description + + New service provider description + +.. option:: --enable + + Enable the service provider + +.. option:: --disable + + Disable the service provider + +.. describe:: + + Service provider to modify + +service provider show +--------------------- + +Display service provider details + +.. program:: service provider show +.. code:: bash + + openstack service provider show + + +.. describe:: + + Service provider to display diff --git a/doc/source/cli/command-objects/service.rst b/doc/source/cli/command-objects/service.rst new file mode 100644 index 00000000..a69c6950 --- /dev/null +++ b/doc/source/cli/command-objects/service.rst @@ -0,0 +1,143 @@ +======= +service +======= + +Identity v2, v3 + +service create +-------------- + +Create new service + +.. program:: service create +.. code-block:: bash + + openstack service create + [--name ] + [--description ] + [--enable | --disable] + + +.. option:: --name + + New service name + +.. option:: --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:: + + New service type (compute, image, identity, volume, etc) + +service delete +-------------- + +Delete service(s) + +.. program:: service delete +.. code-block:: bash + + openstack service delete + [ ...] + +.. _service_delete-service: +.. describe:: + + Service(s) to delete (type, name or ID) + +service list +------------ + +List services + +.. program:: service list +.. code-block:: bash + + openstack 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 + + openstack service set + [--type ] + [--name ] + [--description ] + [--enable | --disable] + + +.. option:: --type + + New service type (compute, image, identity, volume, etc) + +.. option:: --name + + New service name + +.. option:: --description + + New service description + +.. option:: --enable + + Enable service + +.. option:: --disable + + Disable service + +.. _service_set-service: +.. describe:: + + Service to modify (type, name or ID) + +service show +------------ + +Display service details + +.. program:: service show +.. code-block:: bash + + openstack service show + [--catalog] + + +.. option:: --catalog + + Show service catalog information + + *Identity version 2 only* + +.. _service_show-service: +.. describe:: + + Service to display (type, name or ID) diff --git a/doc/source/cli/command-objects/snapshot.rst b/doc/source/cli/command-objects/snapshot.rst new file mode 100644 index 00000000..fc516067 --- /dev/null +++ b/doc/source/cli/command-objects/snapshot.rst @@ -0,0 +1,176 @@ +======== +snapshot +======== + +Block Storage v1, v2 + +snapshot create +--------------- + +Create new snapshot +(Deprecated, please use ``volume snapshot create`` instead) + +.. program:: snapshot create +.. code:: bash + + openstack snapshot create + [--name ] + [--description ] + [--force] + [--property [...] ] + + +.. option:: --name + + Name of the snapshot + +.. option:: --description + + Description of the snapshot + +.. option:: --force + + Create a snapshot attached to an instance. Default is False + +.. option:: --property + + Set a property to this snapshot (repeat option to set multiple properties) + + *Volume version 2 only* + +.. _snapshot_create-snapshot: +.. describe:: + + Volume to snapshot (name or ID) + +snapshot delete +--------------- + +Delete snapshot(s) +(Deprecated, please use ``volume snapshot delete`` instead) + +.. program:: snapshot delete +.. code:: bash + + openstack snapshot delete + [ ...] + +.. _snapshot_delete-snapshot: +.. describe:: + + Snapshot(s) to delete (name or ID) + +snapshot list +------------- + +List snapshots +(Deprecated, please use ``volume snapshot list`` instead) + +.. program:: snapshot list +.. code:: bash + + openstack snapshot list + [--all-projects] + [--long] + [--limit ] + [--marker ] + +.. option:: --all-projects + + Include all projects (admin only) + +.. option:: --long + + List additional fields in output + +.. option:: --limit + + Maximum number of snapshots to display + + *Volume version 2 only* + +.. option:: --marker + + The last snapshot ID of the previous page + + *Volume version 2 only* + +snapshot set +------------ + +Set snapshot properties +(Deprecated, please use ``volume snapshot set`` instead) + +.. program:: snapshot set +.. code:: bash + + openstack snapshot set + [--name ] + [--description ] + [--property [...] ] + [--state ] + + +.. _snapshot_restore-snapshot: +.. option:: --name + + New snapshot name + +.. option:: --description + + New snapshot description + +.. option:: --property + + Property to add or modify for this snapshot (repeat option to set multiple properties) + +.. option:: --state + + New snapshot state. + ("available", "error", "creating", "deleting", or "error_deleting") (admin only) + (This option simply changes the state of the snapshot in the database with + no regard to actual status, exercise caution when using) + + *Volume version 2 only* + +.. describe:: + + Snapshot to modify (name or ID) + +snapshot show +------------- + +Display snapshot details +(Deprecated, please use ``volume snapshot show`` instead) + +.. program:: snapshot show +.. code:: bash + + openstack snapshot show + + +.. _snapshot_show-snapshot: +.. describe:: + + Snapshot to display (name or ID) + +snapshot unset +-------------- + +Unset snapshot properties +(Deprecated, please use ``volume snapshot unset`` instead) + +.. program:: snapshot unset +.. code:: bash + + openstack snapshot unset + [--property ] + + +.. option:: --property + + Property to remove from snapshot (repeat option to remove multiple properties) + +.. describe:: + + Snapshot to modify (name or ID) diff --git a/doc/source/cli/command-objects/subnet-pool.rst b/doc/source/cli/command-objects/subnet-pool.rst new file mode 100644 index 00000000..3a60974a --- /dev/null +++ b/doc/source/cli/command-objects/subnet-pool.rst @@ -0,0 +1,269 @@ +=========== +subnet pool +=========== + +A **subnet pool** contains a collection of prefixes in CIDR notation +that are available for IP address allocation. + +Network v2 + +subnet pool create +------------------ + +Create subnet pool + +.. program:: subnet pool create +.. code:: bash + + openstack subnet pool create + [--default-prefix-length ] + [--min-prefix-length ] + [--max-prefix-length ] + [--description ] + [--project [--project-domain ]] + [--address-scope ] + [--default | --no-default] + [--share | --no-share] + [--default-quota ] + --pool-prefix [...] + + +.. option:: --default-prefix-length + + Set subnet pool default prefix length + +.. option:: --min-prefix-length + + Set subnet pool minimum prefix length + +.. option:: --max-prefix-length + + Set subnet pool maximum prefix length + +.. option:: --description + + Set subnet pool description + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). This can be used in case + collisions between project names exist. + +.. option:: --address-scope + + Set address scope associated with the subnet pool (name or ID), + prefixes must be unique across address scopes + +.. option:: --default + + Set this as a default subnet pool + +.. option:: --no-default + + Set this as a non-default subnet pool + +.. option:: --share + + Set this subnet pool as shared + +.. option:: --no-share + + Set this subnet pool as not shared + +.. option:: --default-quota + + Set default quota for subnet pool as the number of + IP addresses allowed in a subnet + +.. option:: --pool-prefix + + Set subnet pool prefixes (in CIDR notation) + (repeat option to set multiple prefixes) + +.. _subnet_pool_create-name: +.. describe:: + + Name of the new subnet pool + +subnet pool delete +------------------ + +Delete subnet pool(s) + +.. program:: subnet pool delete +.. code:: bash + + openstack subnet pool delete + [ ...] + +.. _subnet_pool_delete-subnet-pool: +.. describe:: + + Subnet pool(s) to delete (name or ID) + +subnet pool list +---------------- + +List subnet pools + +.. program:: subnet pool list +.. code:: bash + + openstack subnet pool list + [--long] + [--share | --no-share] + [--default | --no-default] + [--project [--project-domain ]] + [--name ] + [--address-scope ] + +.. option:: --long + + List additional fields in output + +.. option:: --share + + List subnet pools shared between projects + +.. option:: --no-share + + List subnet pools not shared between projects + +.. option:: --default + + List subnet pools used as the default external subnet pool + +.. option:: --no-default + + List subnet pools not used as the default external subnet pool + +.. option:: --project + + List subnet pools according to their project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --name + + List only subnet pools of given name in output + +.. option:: --address-scope + + List only subnet pools of given address scope in output (name or ID) + +subnet pool set +--------------- + +Set subnet pool properties + +.. program:: subnet pool set +.. code:: bash + + openstack subnet pool set + [--name ] + [--pool-prefix [...]] + [--default-prefix-length ] + [--min-prefix-length ] + [--max-prefix-length ] + [--address-scope | --no-address-scope] + [--default | --no-default] + [--description ] + [--default-quota ] + + +.. option:: --name + + Set subnet pool name + +.. option:: --pool-prefix + + Set subnet pool prefixes (in CIDR notation) + (repeat option to set multiple prefixes) + +.. option:: --default-prefix-length + + Set subnet pool default prefix length + +.. option:: --min-prefix-length + + Set subnet pool minimum prefix length + +.. option:: --max-prefix-length + + Set subnet pool maximum prefix length + +.. option:: --address-scope + + Set address scope associated with the subnet pool (name or ID), + prefixes must be unique across address scopes + +.. option:: --no-address-scope + + Remove address scope associated with the subnet pool + +.. option:: --default + + Set this as a default subnet pool + +.. option:: --no-default + + Set this as a non-default subnet pool + +.. option:: --description + + Set subnet pool description + +.. option:: --default-quota + + Set default quota for subnet pool as the number of + IP addresses allowed in a subnet + +.. _subnet_pool_set-subnet-pool: +.. describe:: + + Subnet pool to modify (name or ID) + +subnet pool show +---------------- + +Display subnet pool details + +.. program:: subnet pool show +.. code:: bash + + openstack subnet pool show + + +.. _subnet_pool_show-subnet-pool: +.. describe:: + + Subnet pool to display (name or ID) + +subnet pool unset +----------------- + +Unset subnet pool properties + +.. program:: subnet pool unset +.. code:: bash + + openstack subnet pool unset + [--pool-prefix [...]] + + +.. option:: --pool-prefix + + Remove subnet pool prefixes (in CIDR notation). + (repeat option to unset multiple prefixes). + +.. _subnet_pool_unset-subnet-pool: +.. describe:: + + Subnet pool to modify (name or ID) diff --git a/doc/source/cli/command-objects/subnet.rst b/doc/source/cli/command-objects/subnet.rst new file mode 100644 index 00000000..4e609361 --- /dev/null +++ b/doc/source/cli/command-objects/subnet.rst @@ -0,0 +1,374 @@ +====== +subnet +====== + +A **subnet** is a block of IP addresses and associated configuration state. +Subnets are used to allocate IP addresses when new ports are created on a +network. + +Network v2 + +subnet create +------------- + +Create new subnet + +.. program:: subnet create +.. code:: bash + + openstack subnet create + [--project [--project-domain ]] + [--subnet-pool | --use-default-subnet-pool [--prefix-length ]] + [--subnet-range ] + [--allocation-pool start=,end=] + [--dhcp | --no-dhcp] + [--dns-nameserver ] + [--gateway ] + [--host-route destination=,gateway=] + [--ip-version {4,6}] + [--description ] + [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] + [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] + [--network-segment ] + [--service-type ] + --network + + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --subnet-pool + + Subnet pool from which this subnet will obtain a CIDR (name or ID) + +.. option:: --use-default-subnet-pool + + Use default subnet pool for :option:`--ip-version` + +.. option:: --prefix-length + + Prefix length for subnet allocation from subnet pool + +.. option:: --subnet-range + + Subnet range in CIDR notation + (required if :option:`--subnet-pool` is not specified, optional otherwise) + +.. option:: --allocation-pool start=,end= + + Allocation pool IP addresses for this subnet e.g.: + ``start=192.168.199.2,end=192.168.199.254`` + (repeat option to add multiple IP addresses) + +.. option:: --dhcp + + Enable DHCP (default) + +.. option:: --no-dhcp + + Disable DHCP + +.. option:: --dns-nameserver + + DNS server for this subnet (repeat option to set multiple DNS servers) + +.. option:: --gateway + + Specify a gateway for the subnet. The three options are: + : Specific IP address to use as the gateway, + 'auto': Gateway address should automatically be chosen from + within the subnet itself, 'none': This subnet will not use + a gateway, e.g.: ``--gateway 192.168.9.1``, ``--gateway auto``, + ``--gateway none`` (default is 'auto'). + +.. option:: --host-route destination=,gateway= + + Additional route for this subnet e.g.: + ``destination=10.10.0.0/16,gateway=192.168.71.254`` + destination: destination subnet (in CIDR notation) + gateway: nexthop IP address + (repeat option to add multiple routes) + +.. option:: --ip-version {4,6} + + IP version (default is 4). Note that when subnet pool is specified, + IP version is determined from the subnet pool and this option + is ignored. + +.. option:: --description + + Set subnet description + +.. option:: --ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} + + IPv6 RA (Router Advertisement) mode, + valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] + +.. option:: --ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} + + IPv6 address mode, valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] + +.. option:: --network-segment + + Network segment to associate with this subnet (name or ID) + +.. option:: --service-type + + Service type for this subnet e.g.: + ``network:floatingip_agent_gateway``. + Must be a valid device owner value for a network port + (repeat option to set multiple service types) + +.. option:: --network + + Network this subnet belongs to (name or ID) + +.. _subnet_create-name: +.. describe:: + + Name of subnet to create + +subnet delete +------------- + +Delete subnet(s) + +.. program:: subnet delete +.. code:: bash + + openstack subnet delete + [ ...] + +.. _subnet_delete-subnet: +.. describe:: + + Subnet(s) to delete (name or ID) + +subnet list +----------- + +List subnets + +.. program:: subnet list +.. code:: bash + + openstack subnet list + [--long] + [--ip-version {4,6}] + [--dhcp | --no-dhcp] + [--project [--project-domain ]] + [--network ] + [--gateway ] + [--name ] + [--subnet-range ] + +.. option:: --long + + List additional fields in output + +.. option:: --ip-version {4, 6} + + List only subnets of given IP version in output. + Allowed values for IP version are 4 and 6. + +.. option:: --dhcp + + List subnets which have DHCP enabled + +.. option:: --no-dhcp + + List subnets which have DHCP disabled + +.. option:: --service-type + + List only subnets of a given service type in output + e.g.: ``network:floatingip_agent_gateway``. + Must be a valid device owner value for a network port + (repeat option to list multiple service types) + +.. option:: --project + + List only subnets which belong to a given project in output (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --network + + List only subnets which belong to a given network in output (name or ID) + +.. option:: --gateway + + List only subnets of given gateway IP in output + +.. option:: --name + + List only subnets of given name in output + +.. option:: --subnet-range + + List only subnets of given subnet range (in CIDR notation) in output + e.g.: ``--subnet-range 10.10.0.0/16`` + +subnet set +---------- + +Set subnet properties + +.. program:: subnet set +.. code:: bash + + openstack subnet set + [--allocation-pool start=,end=] + [--no-allocation-pool] + [--dhcp | --no-dhcp] + [--dns-nameserver ] + [--no-dns-nameserver] + [--gateway ] + [--host-route destination=,gateway=] + [--no-host-route] + [--service-type ] + [--name ] + [--description ] + + +.. option:: --allocation-pool start=,end= + + Allocation pool IP addresses for this subnet e.g.: + ``start=192.168.199.2,end=192.168.199.254`` + (repeat option to add multiple IP addresses) + +.. option:: --no-allocation-pool + + Clear associated allocation pools from this subnet. + Specify both :option:`--allocation-pool` and :option:`--no-allocation-pool` + to overwrite the current allocation pool information. + +.. option:: --dhcp + + Enable DHCP + +.. option:: --no-dhcp + + Disable DHCP + +.. option:: --dns-nameserver + + DNS server for this subnet (repeat option to set multiple DNS servers) + +.. option:: --no-dns-nameservers + + Clear existing information of DNS servers. + Specify both :option:`--dns-nameserver` and :option:`--no-dns-nameservers` + to overwrite the current DNS server information. + +.. option:: --gateway + + Specify a gateway for the subnet. The options are: + : Specific IP address to use as the gateway, + 'none': This subnet will not use a gateway, + e.g.: ``--gateway 192.168.9.1``, ``--gateway none``. + +.. option:: --host-route destination=,gateway= + + Additional route for this subnet e.g.: + ``destination=10.10.0.0/16,gateway=192.168.71.254`` + destination: destination subnet (in CIDR notation) + gateway: nexthop IP address + +.. option:: --no-host-route + + Clear associated host routes from this subnet. + Specify both :option:`--host-route` and :option:`--no-host-route` + to overwrite the current host route information. + +.. option:: --service-type + + Service type for this subnet e.g.: + ``network:floatingip_agent_gateway``. + Must be a valid device owner value for a network port + (repeat option to set multiple service types) + +.. option:: --description + + Set subnet description + +.. option:: --name + + Updated name of the subnet + +.. _subnet_set-subnet: +.. describe:: + + Subnet to modify (name or ID) + + +subnet show +----------- + +Display subnet details + +.. program:: subnet show +.. code:: bash + + openstack subnet show + + +.. _subnet_show-subnet: +.. describe:: + + Subnet to display (name or ID) + +subnet unset +------------ + +Unset subnet properties + +.. program:: subnet unset +.. code:: bash + + openstack subnet unset + [--allocation-pool start=,end= [...]] + [--dns-nameserver [...]] + [--host-route destination=,gateway= [...]] + [--service-type ] + + +.. option:: --dns-nameserver + + DNS server to be removed from this subnet + (repeat option to unset multiple DNS servers) + +.. option:: --allocation-pool start=,end= + + Allocation pool IP addresses to be removed from this + subnet e.g.: ``start=192.168.199.2,end=192.168.199.254`` + (repeat option to unset multiple allocation pools) + +.. option:: --host-route destination=,gateway= + + Route to be removed from this subnet e.g.: + ``destination=10.10.0.0/16,gateway=192.168.71.254`` + destination: destination subnet (in CIDR notation) + gateway: nexthop IP address + (repeat option to unset multiple host routes) + +.. option:: --service-type + + Service type to be removed from this subnet e.g.: + ``network:floatingip_agent_gateway``. + Must be a valid device owner value for a network port + (repeat option to unset multiple service types) + +.. _subnet_unset-subnet: +.. describe:: + + Subnet to modify (name or ID) diff --git a/doc/source/cli/command-objects/token.rst b/doc/source/cli/command-objects/token.rst new file mode 100644 index 00000000..b4b14cd9 --- /dev/null +++ b/doc/source/cli/command-objects/token.rst @@ -0,0 +1,30 @@ +===== +token +===== + +Identity v2, v3 + +token issue +----------- + +Issue new token + +.. program:: token issue +.. code:: bash + + openstack token issue + +token revoke +------------ + +Revoke existing token + +.. program:: token revoke +.. code:: bash + + openstack token revoke + + +.. describe:: + + Token to be deleted diff --git a/doc/source/cli/command-objects/trust.rst b/doc/source/cli/command-objects/trust.rst new file mode 100644 index 00000000..28459bca --- /dev/null +++ b/doc/source/cli/command-objects/trust.rst @@ -0,0 +1,102 @@ +===== +trust +===== + +Identity v3 + +trust create +------------ + +Create new trust + +.. program:: trust create +.. code:: bash + + openstack trust create + --project + --role + [--impersonate] + [--expiration ] + [--project-domain ] + [--trustor-domain ] + [--trustee-domain ] + + + +.. option:: --project + + Project being delegated (name or ID) (required) + +.. option:: --role + + Roles to authorize (name or ID) (repeat option to set multiple values, required) + +.. option:: --impersonate + + Tokens generated from the trust will represent (defaults to False) + +.. option:: --expiration + + Sets an expiration date for the trust (format of YYYY-mm-ddTHH:MM:SS) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). This can be + used in case collisions between user names exist. + +.. option:: --trustor-domain + + Domain that contains (name or ID) + +.. option:: --trustee-domain + + Domain that contains (name or ID) + +.. describe:: + + User that is delegating authorization (name or ID) + +.. describe:: + + User that is assuming authorization (name or ID) + + +trust delete +------------ + +Delete trust(s) + +.. program:: trust delete +.. code:: bash + + openstack trust delete + [ ...] + +.. describe:: + + Trust(s) to delete + +trust list +---------- + +List trusts + +.. program:: trust list +.. code:: bash + + openstack trust list + +trust show +---------- + +Display trust details + +.. program:: trust show +.. code:: bash + + openstack trust show + + +.. describe:: + + Trust to display diff --git a/doc/source/cli/command-objects/usage.rst b/doc/source/cli/command-objects/usage.rst new file mode 100644 index 00000000..9cd0f70e --- /dev/null +++ b/doc/source/cli/command-objects/usage.rst @@ -0,0 +1,50 @@ +===== +usage +===== + +Compute v2 + +usage list +---------- + +List resource usage per project + +.. program:: usage list +.. code:: bash + + openstack usage list + [--start ] + [--end ] + +.. option:: --start + + Usage range start date, ex 2012-01-20 (default: 4 weeks ago) + +.. option:: --end + + Usage range end date, ex 2012-01-20 (default: tomorrow) + +usage show +---------- + +Show resource usage for a single project + +.. program:: usage show +.. code:: bash + + openstack usage show + [--project ] + [--start ] + [--end ] + +.. option:: --project + + Name or ID of project to show usage for + +.. option:: --start + + Usage range start date, ex 2012-01-20 (default: 4 weeks ago) + +.. option:: --end + + Usage range end date, ex 2012-01-20 (default: tomorrow) diff --git a/doc/source/cli/command-objects/user-role.rst b/doc/source/cli/command-objects/user-role.rst new file mode 100644 index 00000000..4f443f31 --- /dev/null +++ b/doc/source/cli/command-objects/user-role.rst @@ -0,0 +1,27 @@ +========= +user role +========= + +Identity v2 + +user role list +-------------- + +List user-role assignments + +*Removed in version 3.* + +.. program:: user role list +.. code:: bash + + openstack user role list + [--project ] + [] + +.. option:: --project + + Filter users by `` (name or ID) + +.. describe:: + + User to list (name or ID) diff --git a/doc/source/cli/command-objects/user.rst b/doc/source/cli/command-objects/user.rst new file mode 100644 index 00000000..632d0e25 --- /dev/null +++ b/doc/source/cli/command-objects/user.rst @@ -0,0 +1,223 @@ +==== +user +==== + +Identity v2, v3 + +user create +----------- + +Create new user + +.. program:: user create +.. code:: bash + + openstack user create + [--domain ] + [--project [--project-domain ]] + [--password ] + [--password-prompt] + [--email ] + [--description ] + [--enable | --disable] + [--or-show] + + +.. option:: --domain + + Default domain (name or ID) + + .. versionadded:: 3 + +.. option:: --project + + Default project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --password + + Set user password + +.. option:: --password-prompt + + Prompt interactively for password + +.. option:: --email + + Set user email address + +.. option:: --description + + User description + + .. versionadded:: 3 + +.. option:: --enable + + Enable user (default) + +.. option:: --disable + + Disable user + +.. option:: --or-show + + Return existing user + + If the username already exist return the existing user data and do not fail. + +.. describe:: + + New user name + +user delete +----------- + +Delete user(s) + +.. program:: user delete +.. code:: bash + + openstack user delete + [--domain ] + [ ...] + +.. option:: --domain + + Domain owning :ref:`\ ` (name or ID) + + .. versionadded:: 3 + +.. _user_delete-user: +.. describe:: + + User(s) to delete (name or ID) + +user list +--------- + +List users + +.. program:: user list +.. code:: bash + + openstack user list + [--project ] + [--domain ] + [--group | --project ] + [--long] + +.. option:: --project + + Filter users by `` (name or ID) + +.. option:: --domain + + Filter users by `` (name or ID) + + *Identity version 3 only* + +.. option:: --group + + Filter users by `` membership (name or ID) + + *Identity version 3 only* + +.. option:: --long + + List additional fields in output + +user set +-------- + +Set user properties + +.. program:: user set +.. code:: bash + + openstack user set + [--name ] + [--project [--project-domain ]] + [--password ] + [--password-prompt] + [--email ] + [--description ] + [--enable|--disable] + + +.. option:: --name + + Set user name + +.. option:: --domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + + .. versionadded:: 3 + +.. option:: --project + + Set default project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --password + + Set user password + +.. option:: --password-prompt + + Prompt interactively for password + +.. option:: --email + + Set user email address + +.. option:: --description + + Set user description + + .. versionadded:: 3 + +.. option:: --enable + + Enable user (default) + +.. option:: --disable + + Disable user + +.. describe:: + + User to modify (name or ID) + +user show +--------- + +Display user details + +.. program:: user show +.. code:: bash + + openstack user show + [--domain ] + + +.. option:: --domain + + Domain owning :ref:`\ ` (name or ID) + + .. versionadded:: 3 + +.. _user_show-user: +.. describe:: + + User to display (name or ID) diff --git a/doc/source/cli/command-objects/volume-backup.rst b/doc/source/cli/command-objects/volume-backup.rst new file mode 100644 index 00000000..585f47d4 --- /dev/null +++ b/doc/source/cli/command-objects/volume-backup.rst @@ -0,0 +1,201 @@ +============= +volume backup +============= + +Block Storage v1, v2 + +volume backup create +-------------------- + +Create new volume backup + +.. program:: volume backup create +.. code:: bash + + openstack volume backup create + [--container ] + [--name ] + [--description ] + [--snapshot ] + [--force] + [--incremental] + + +.. option:: --container + + Optional backup container name + +.. option:: --name + + Name of the backup + +.. option:: --description + + Description of the backup + +.. option:: --snapshot + + Snapshot to backup (name or ID) + + *Volume version 2 only* + +.. option:: --force + + Allow to back up an in-use volume + + *Volume version 2 only* + +.. option:: --incremental + + Perform an incremental backup + + *Volume version 2 only* + +.. _volume_backup_create-backup: +.. describe:: + + Volume to backup (name or ID) + +volume backup delete +-------------------- + +Delete volume backup(s) + +.. program:: volume backup delete +.. code:: bash + + openstack volume backup delete + [--force] + [ ...] + +.. option:: --force + + Allow delete in state other than error or available + + *Volume version 2 only* + +.. _volume_backup_delete-backup: +.. describe:: + + Backup(s) to delete (name or ID) + +volume backup list +------------------ + +List volume backups + +.. program:: volume backup list +.. code:: bash + + openstack volume backup list + [--long] + [--name ] + [--status ] + [--volume ] + [--marker ] + [--limit ] + [--all-projects] + +.. _volume_backup_list-backup: +.. option:: --long + + List additional fields in output + +.. option:: --name + + Filters results by the backup name + +.. option:: --status + + Filters results by the backup status + ('creating', 'available', 'deleting', 'error', 'restoring' or 'error_restoring') + +.. option:: --volume + + Filters results by the volume which they backup (name or ID)" + +.. option:: --marker + + The last backup of the previous page (name or ID) + + *Volume version 2 only* + +.. option:: --limit + + Maximum number of backups to display + + *Volume version 2 only* + +.. option:: --all-projects + + Include all projects (admin only) + +volume backup restore +--------------------- + +Restore volume backup + +.. program:: volume backup restore +.. code:: bash + + openstack volume backup restore + + + +.. _volume_backup_restore-backup: +.. describe:: + + Backup to restore (name or ID) + +.. describe:: + + Volume to restore to (name or ID) + +volume backup set +----------------- + +Set volume backup properties + +.. program:: volume backup set +.. code:: bash + + openstack volume backup set + [--name ] + [--description ] + [--state ] + + +.. option:: --name + + New backup name + +.. option:: --description + + New backup description + +.. option:: --state + + New backup state ("available" or "error") (admin only) + (This option simply changes the state of the backup in the database with + no regard to actual status, exercise caution when using) + +.. _backup_set-volume-backup: +.. describe:: + + Backup to modify (name or ID) + +volume backup show +------------------ + +Display volume backup details + +.. program:: volume backup show +.. code:: bash + + openstack volume backup show + + +.. _volume_backup_show-backup: +.. describe:: + + Backup to display (name or ID) diff --git a/doc/source/cli/command-objects/volume-host.rst b/doc/source/cli/command-objects/volume-host.rst new file mode 100644 index 00000000..1e513cb7 --- /dev/null +++ b/doc/source/cli/command-objects/volume-host.rst @@ -0,0 +1,52 @@ +=========== +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 + + +.. option:: --volume-backend + + The ID of the volume backend replication + target where the host will failover to (required) + +.. _volume_host_failover-host-name: +.. describe:: + + Name of volume host + +volume host set +--------------- + +Set volume host properties + +.. program:: volume host set +.. code:: bash + + openstack volume host set + [--enable | --disable] + + +.. option:: --enable + + Thaw and enable the specified volume host. + +.. option:: --disable + + Freeze and disable the specified volume host + +.. _volume_host_set-host-name: +.. describe:: + + Name of volume host diff --git a/doc/source/cli/command-objects/volume-qos.rst b/doc/source/cli/command-objects/volume-qos.rst new file mode 100644 index 00000000..8fdbc122 --- /dev/null +++ b/doc/source/cli/command-objects/volume-qos.rst @@ -0,0 +1,166 @@ +========== +volume qos +========== + +Block Storage v1, v2 + +volume qos associate +-------------------- + +Associate a QoS specification to a volume type + +.. program:: volume qos associate +.. code:: bash + + openstack volume qos associate + + + +.. _volume_qos_associate: +.. describe:: + + QoS specification to modify (name or ID) + +.. describe:: + + Volume type to associate the QoS (name or ID) + +volume qos create +----------------- + +Create new QoS Specification + +.. program:: volume qos create +.. code:: bash + + openstack volume qos create + [--consumer ] + [--property [...] ] + + +.. option:: --consumer + + Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both') + +.. option:: --property + + Set a property on this QoS specification (repeat option to set multiple properties) + +.. _volume_qos_create-name: +.. describe:: + + New QoS specification name + +volume qos delete +----------------- + +Delete QoS specification + +.. program:: volume qos delete +.. code:: bash + + openstack volume qos delete + [--force] + [ ...] + +.. option:: --force + + Allow to delete in-use QoS specification(s) + +.. _volume_qos_delete-qos-spec: +.. describe:: + + QoS specification(s) to delete (name or ID) + +volume qos disassociate +----------------------- + +Disassociate a QoS specification from a volume type + +.. program:: volume qos disassociate +.. code:: bash + + openstack volume qos disassociate + --volume-type | --all + + +.. option:: --volume-type + + Volume type to disassociate the QoS from (name or ID) + +.. option:: --all + + Disassociate the QoS from every volume type + +.. _volume_qos_disassociate-qos-spec: +.. describe:: + + QoS specification to modify (name or ID) + +volume qos list +--------------- + +List QoS specifications + +.. program:: volume qos list +.. code:: bash + + openstack volume qos list + +volume qos set +-------------- + +Set QoS specification properties + +.. program:: volume qos set +.. code:: bash + + openstack volume qos set + [--property [...] ] + + +.. option:: --property + + Property to add or modify for this QoS specification (repeat option to set multiple properties) + +.. _volume_qos_set-qos-spec: +.. describe:: + + QoS specification to modify (name or ID) + +volume qos show +--------------- + +Display QoS specification details + +.. program:: volume qos show +.. code:: bash + + openstack volume qos show + + +.. _volume_qos_show-qos-spec: +.. describe:: + + QoS specification to display (name or ID) + +volume qos unset +---------------- + +Unset QoS specification properties + +.. program:: volume qos unset +.. code:: bash + + openstack volume qos unset + [--property [...] ] + + +.. option:: --property + + Property to remove from QoS specification (repeat option to remove multiple properties) + +.. _volume_qos_unset-qos-spec: +.. describe:: + + QoS specification to modify (name or ID) diff --git a/doc/source/cli/command-objects/volume-service.rst b/doc/source/cli/command-objects/volume-service.rst new file mode 100644 index 00000000..2ad23240 --- /dev/null +++ b/doc/source/cli/command-objects/volume-service.rst @@ -0,0 +1,66 @@ +============== +volume service +============== + +Volume v1, v2 + +volume service list +------------------- + +List volume service + +.. program:: volume service list +.. code:: bash + + openstack volume service list + [--host ] + [--service ] + [--long] + +.. option:: --host + + List services on specified host (name only) + +.. option:: --service + + List only specified service (name only) + +.. option:: --long + + List additional fields in output + +volume service set +------------------ + +Set volume service properties + +.. program:: volume service set +.. code:: bash + + openstack volume service set + [--enable | --disable] + [--disable-reason ] + + + +.. option:: --enable + + Enable volume service + +.. option:: --disable + + Disable volume service + +.. option:: --disable-reason + + Reason for disabling the service + (should be used with :option:`--disable` option) + +.. _volume_service_set-host: +.. describe:: + + Name of host + +.. describe:: + + Name of service (Binary name) diff --git a/doc/source/cli/command-objects/volume-snapshot.rst b/doc/source/cli/command-objects/volume-snapshot.rst new file mode 100644 index 00000000..30cc77cc --- /dev/null +++ b/doc/source/cli/command-objects/volume-snapshot.rst @@ -0,0 +1,223 @@ +=============== +volume snapshot +=============== + +Block Storage v1, v2 + +volume snapshot create +---------------------- + +Create new volume snapshot + +.. program:: volume snapshot create +.. code:: bash + + openstack volume snapshot create + [--volume ] + [--description ] + [--force] + [--property [...] ] + [--remote-source [...]] + + +.. option:: --volume + + Volume to snapshot (name or ID) (default is ) + +.. option:: --description + + Description of the snapshot + +.. option:: --force + + Create a snapshot attached to an instance. Default is False + +.. option:: --property + + Set a property to this snapshot (repeat option to set multiple properties) + + *Volume version 2 only* + +.. option:: --remote-source + + The attribute(s) of the exsiting remote volume snapshot + (admin required) (repeat option to specify multiple attributes) + e.g.: '--remote-source source-name=test_name --remote-source source-id=test_id' + + *Volume version 2 only* + +.. _volume_snapshot_create-snapshot-name: +.. describe:: + + Name of the new snapshot + +volume snapshot delete +---------------------- + +Delete volume snapshot(s) + +.. program:: volume snapshot delete +.. code:: bash + + openstack volume snapshot delete + [--force] + [ ...] + +.. option:: --force + + Attempt forced removal of snapshot(s), regardless of state (defaults to False) + +.. _volume_snapshot_delete-snapshot: +.. describe:: + + Snapshot(s) to delete (name or ID) + +volume snapshot list +-------------------- + +List volume snapshots + +.. program:: volume snapshot list +.. code:: bash + + openstack volume snapshot list + [--all-projects] + [--project [--project-domain ]] + [--long] + [--limit ] + [--marker ] + [--name ] + [--status ] + [--volume ] + +.. option:: --all-projects + + Include all projects (admin only) + +.. option:: --project + + Filter results by project (name or ID) (admin only) + + *Volume version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + + This can be used in case collisions between project names exist. + + *Volume version 2 only* + +.. option:: --long + + List additional fields in output + +.. option:: --status + + Filters results by a status. + ('available', 'error', 'creating', 'deleting' or 'error-deleting') + +.. option:: --name + + Filters results by a name. + +.. option:: --volume + + Filters results by a volume (name or ID). + +.. option:: --limit + + Maximum number of snapshots to display + + *Volume version 2 only* + +.. option:: --marker + + The last snapshot ID of the previous page + + *Volume version 2 only* + +volume snapshot set +------------------- + +Set volume snapshot properties + +.. program:: volume snapshot set +.. code:: bash + + openstack volume snapshot set + [--name ] + [--description ] + [--no-property] + [--property [...] ] + [--state ] + + +.. option:: --name + + New snapshot name + +.. option:: --description + + New snapshot description + +.. option:: --no-property + + Remove all properties from :ref:`\ ` + (specify both :option:`--no-property` and :option:`--property` to + remove the current properties before setting new properties.) + +.. option:: --property + + Property to add or modify for this snapshot (repeat option to set multiple properties) + +.. option:: --state + + New snapshot state. + ("available", "error", "creating", "deleting", or "error_deleting") (admin only) + (This option simply changes the state of the snapshot in the database with + no regard to actual status, exercise caution when using) + + *Volume version 2 only* + +.. _volume_snapshot_set-snapshot: +.. describe:: + + Snapshot to modify (name or ID) + +volume snapshot show +-------------------- + +Display volume snapshot details + +.. program:: volume snapshot show +.. code:: bash + + openstack volume snapshot show + + +.. _volume_snapshot_show-snapshot: +.. describe:: + + Snapshot to display (name or ID) + +volume snapshot unset +--------------------- + +Unset volume snapshot properties + +.. program:: volume snapshot unset +.. code:: bash + + openstack volume snapshot unset + [--property ] + + +.. option:: --property + + Property to remove from snapshot (repeat option to remove multiple properties) + +.. _volume_snapshot_unset-snapshot: +.. describe:: + + Snapshot to modify (name or ID) diff --git a/doc/source/cli/command-objects/volume-transfer-request.rst b/doc/source/cli/command-objects/volume-transfer-request.rst new file mode 100644 index 00000000..23cd3d3e --- /dev/null +++ b/doc/source/cli/command-objects/volume-transfer-request.rst @@ -0,0 +1,96 @@ +======================= +volume transfer request +======================= + +Block Storage v1, v2 + +volume transfer request accept +------------------------------ + +Accept volume transfer request + +.. program:: volume transfer request accept +.. code:: bash + + openstack volume transfer request accept + --auth-key + + +.. option:: --auth-key + + Volume transfer request authentication key + +.. _volume_transfer_request_accept: +.. describe:: + + Volume transfer request to accept (ID only) + + Non-admin users are only able to specify the transfer request by ID. + +volume transfer request create +------------------------------ + +Create volume transfer request + +.. program:: volume transfer request create +.. code:: bash + + openstack volume transfer request create + [--name ] + + +.. option:: --name + + New transfer request name (default to None) + +.. _volume_transfer_request_create-volume: +.. describe:: + + Volume to transfer (name or ID) + +volume transfer request delete +------------------------------ + +Delete volume transfer request(s) + +.. program:: volume transfer request delete +.. code:: bash + + openstack volume transfer request delete + [ ...] + +.. _volume_transfer_request_delete-transfer-request: +.. describe:: + + Volume transfer request(s) to delete (name or ID) + +volume transfer request list +---------------------------- + +Lists all volume transfer requests + +.. program:: volume transfer request list +.. code:: bash + + openstack volume transfer request list + --all-projects + +.. option:: --all-projects + + Include all projects (admin only) + +volume transfer request show +---------------------------- + +Show volume transfer request details + +.. program:: volume transfer request show +.. code:: bash + + openstack volume transfer request show + + +.. _volume_transfer_request_show-transfer-request: +.. describe:: + + Volume transfer request to display (name or ID) diff --git a/doc/source/cli/command-objects/volume-type.rst b/doc/source/cli/command-objects/volume-type.rst new file mode 100644 index 00000000..afa293d7 --- /dev/null +++ b/doc/source/cli/command-objects/volume-type.rst @@ -0,0 +1,291 @@ +=========== +volume type +=========== + +Block Storage v1, v2 + +volume type create +------------------ + +Create new volume type + +.. program:: volume type create +.. code:: bash + + openstack volume type create + [--description ] + [--public | --private] + [--property [...] ] + [--project ] + [--project-domain ] + [--encryption-provider ] + [--encryption-cipher ] + [--encryption-key-size ] + [--encryption-control-location ] + + +.. option:: --description + + Volume type description + + .. versionadded:: 2 + +.. option:: --public + + Volume type is accessible to the public + + .. versionadded:: 2 + +.. option:: --private + + Volume type is not accessible to the public + + .. versionadded:: 2 + +.. option:: --property + + Set a property on this volume type (repeat option to set multiple properties) + +.. option:: --project + + Allow to access private type (name or ID) + (Must be used with :option:`--private` option) + + *Volume version 2 only* + +.. option:: --project-domain + + 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-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 + + Set the encryption algorithm or mode for this volume type + (e.g "aes-xts-plain64") (admin only) + +.. option:: --encryption-key-size + + Set the size of the encryption key of this volume type + (e.g "128" or "256") (admin only) + +.. option:: --encryption-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:: + + Volume type name + +volume type delete +------------------ + +Delete volume type(s) + +.. program:: volume type delete +.. code:: bash + + openstack volume type delete + [ ...] + +.. _volume_type_delete-volume-type: +.. describe:: + + Volume type(s) to delete (name or ID) + +volume type list +---------------- + +List volume types + +.. program:: volume type list +.. code:: bash + + openstack volume type list + [--long] + [--default | --public | --private] + [--encryption-type] + +.. option:: --long + + List additional fields in output + +.. option:: --public + + List only public types + + *Volume version 2 only* + +.. option:: --private + + List only private types (admin only) + + *Volume version 2 only* + +.. option:: --default + + List the default volume type + + *Volume version 2 only* + +.. option:: --encryption-type + + Display encryption information for each volume type (admin only) + +volume type set +--------------- + +Set volume type properties + +.. program:: volume type set +.. code:: bash + + openstack volume type set + [--name ] + [--description ] + [--property [...] ] + [--project ] + [--project-domain ] + [--encryption-provider ] + [--encryption-cipher ] + [--encryption-key-size ] + [--encryption-control-location ] + + +.. option:: --name + + Set volume type name + + .. versionadded:: 2 + +.. option:: --description + + Set volume type description + + .. versionadded:: 2 + +.. option:: --project + + Set volume type access to project (name or ID) (admin only) + + *Volume version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --property + + Set a property on this volume type (repeat option to set multiple properties) + +.. option:: --encryption-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 + + Set the encryption algorithm or mode for this volume type + (e.g "aes-xts-plain64") (admin only) + +.. option:: --encryption-key-size + + Set the size of the encryption key of this volume type + (e.g "128" or "256") (admin only) + +.. option:: --encryption-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 to modify (name or ID) + +volume type show +---------------- + +Display volume type details + +.. program:: volume type show +.. code:: bash + + openstack volume type show + [--encryption-type] + + +.. option:: --encryption-type + + Display encryption information of this volume type (admin only) + +.. _volume_type_show-volume-type: +.. describe:: + + Volume type to display (name or ID) + +volume type unset +----------------- + +Unset volume type properties + +.. program:: volume type unset +.. code:: bash + + openstack volume type unset + [--property [...] ] + [--project ] + [--project-domain ] + [--encryption-type] + + +.. option:: --property + + Property to remove from volume type (repeat option to remove multiple properties) + +.. option:: --project + + Removes volume type access from project (name or ID) (admin only) + + *Volume version 2 only* + +.. option:: --project-domain + + 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 to modify (name or ID) diff --git a/doc/source/cli/command-objects/volume.rst b/doc/source/cli/command-objects/volume.rst new file mode 100644 index 00000000..a06a5d40 --- /dev/null +++ b/doc/source/cli/command-objects/volume.rst @@ -0,0 +1,403 @@ +====== +volume +====== + +Block Storage v1, v2 + +volume create +------------- + +Create new volume + +.. program:: volume create +.. code:: bash + + openstack volume create + [--size ] + [--type ] + [--image | --snapshot | --source | --source-replicated ] + [--description ] + [--user ] + [--project ] + [--availability-zone ] + [--consistency-group ] + [--property [...] ] + [--hint [...] ] + [--multi-attach] + [--bootable | --non-bootable] + [--read-only | --read-write] + + +.. option:: --size + + Volume size in GB + (Required unless --snapshot or --source or --source-replicated is specified) + +.. option:: --type + + Set the type of volume + + Select ```` from the available types as shown + by ``volume type list``. + +.. option:: --image + + Use ```` as source of volume (name or ID) + + This is commonly used to create a boot volume for a server. + +.. option:: --snapshot + + Use ```` as source of volume (name or ID) + +.. option:: --source + + Volume to clone (name or ID) + +.. option:: --source-replicated + + Replicated volume to clone (name or ID) + +.. option:: --description + + Volume description + +.. option:: --user + + Specify an alternate user (name or ID) + +.. option:: --project + + Specify an alternate project (name or ID) + +.. option:: --availability-zone + + Create volume in ```` + +.. option:: --consistency-group + + Consistency group where the new volume belongs to + +.. option:: --property + + Set a property on this volume (repeat option to set multiple properties) + +.. option:: --hint + + Arbitrary scheduler hint key-value pairs to help boot an instance + (repeat option to set multiple hints) + +.. option:: --multi-attach + + Allow volume to be attached more than once (default to False) + +.. option:: --bootable + + Mark volume as bootable + +.. option:: --non-bootable + + Mark volume as non-bootable (default) + +.. option:: --read-only + + Set volume to read-only access mode + +.. option:: --read-write + + Set volume to read-write access mode (default) + +.. _volume_create-name: +.. describe:: + + 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 + + openstack volume delete + [--force | --purge] + [ ...] + +.. option:: --force + + Attempt forced removal of volume(s), regardless of state (defaults to False) + +.. option:: --purge + + Remove any snapshots along with volume(s) (defaults to False) + + *Volume version 2 only* + +.. _volume_delete-volume: +.. describe:: + + Volume(s) to delete (name or ID) + +volume list +----------- + +List volumes + +.. program:: volume list +.. code:: bash + + openstack volume list + [--project [--project-domain ]] + [--user [--user-domain ]] + [--name ] + [--status ] + [--all-projects] + [--long] + [--limit ] + [--marker ] + +.. option:: --project + + Filter results by ```` (name or ID) (admin only) + + *Volume version 2 only* + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + + This can be used in case collisions between project names exist. + + *Volume version 2 only* + +.. option:: --user + + Filter results by ```` (name or ID) (admin only) + + *Volume version 2 only* + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + + This can be used in case collisions between user names exist. + + *Volume version 2 only* + +.. option:: --name + + Filter results by volume name + +.. option:: --status + + Filter results by status + +.. option:: --all-projects + + Include all projects (admin only) + +.. option:: --long + + List additional fields in output + +.. option:: --limit + + Maximum number of volumes to display + +.. option:: --marker + + The last volume ID of the previous page + + *Volume version 2 only* + +volume migrate +-------------- + +Migrate volume to a new host + +.. program:: volume migrate +.. code:: bash + + openstack volume migrate + --host + [--force-host-copy] + [--lock-volume | --unlock-volume] + + +.. option:: --host + + Destination host (takes the form: host@backend-name#pool) (required) + +.. option:: --force-host-copy + + Enable generic host-based force-migration, + which bypasses driver optimizations + +.. option:: --lock-volume + + If specified, the volume state will be locked and will not allow + a migration to be aborted (possibly by another operation) + + *Volume version 2 only* + +.. option:: --unlock-volume + + If specified, the volume state will not be locked and the a + migration can be aborted (default) (possibly by another operation) + + *Volume version 2 only* + +.. _volume_migrate-volume: +.. describe:: + + Volume to migrate (name or ID) + +volume set +---------- + +Set volume properties + +.. program:: volume set +.. code:: bash + + openstack volume set + [--name ] + [--size ] + [--description ] + [--no-property] + [--property [...] ] + [--image-property [...] ] + [--state ] + [--type ] + [--retype-policy ] + [--bootable | --non-bootable] + [--read-only | --read-write] + + +.. option:: --name + + New volume name + +.. option:: --size + + Extend volume size in GB + +.. option:: --description + + New volume description + +.. option:: --no-property + + Remove all properties from :ref:`\ ` + (specify both :option:`--no-property` and :option:`--property` to + remove the current properties before setting new properties.) + +.. option:: --property + + Set a property on this volume (repeat option to set multiple properties) + +.. option:: --type + + New volume type (name or ID) + + *Volume version 2 only* + +.. option:: --retype-policy + + Migration policy while re-typing volume + ("never" or "on-demand", default is "never" ) + (available only when :option:`--type` option is specified) + + *Volume version 2 only* + +.. option:: --bootable + + Mark volume as bootable + +.. option:: --non-bootable + + Mark volume as non-bootable + +.. option:: --read-only + + Set volume to read-only access mode + +.. option:: --read-write + + Set volume to read-write access mode + +.. option:: --image-property + + Set an image property on this volume + (repeat option to set multiple image properties) + + Image properties are copied along with the image when creating a volume + using ``--image``. Note that these properties are immutable on the image + itself, this option updates the copy attached to this volume. + + *Volume version 2 only* + +.. option:: --state + + New volume state + ("available", "error", "creating", "deleting", "in-use", + "attaching", "detaching", "error_deleting" or "maintenance") (admin only) + (This option simply changes the state of the volume in the database with + no regard to actual status, exercise caution when using) + + *Volume version 2 only* + +.. _volume_set-volume: +.. describe:: + + Volume to modify (name or ID) + +volume show +----------- + +Show volume details + +.. program:: volume show +.. code:: bash + + openstack volume show + + +.. _volume_show-volume: +.. describe:: + + Volume to display (name or ID) + +volume unset +------------ + +Unset volume properties + +.. program:: volume unset +.. code:: bash + + openstack volume unset + [--property ] + [--image-property ] + + +.. option:: --property + + Remove a property from volume (repeat option to remove multiple properties) + +.. option:: --image-property + + Remove an image property from volume + (repeat option to remove multiple image properties) + + *Volume version 2 only* + +.. _volume_unset-volume: +.. describe:: + + Volume to modify (name or ID) -- cgit v1.2.1