diff options
Diffstat (limited to 'doc/source/command-objects')
83 files changed, 661 insertions, 391 deletions
diff --git a/doc/source/command-objects/access-token.rst b/doc/source/command-objects/access-token.rst index fd22e761..b1400412 100644 --- a/doc/source/command-objects/access-token.rst +++ b/doc/source/command-objects/access-token.rst @@ -14,7 +14,7 @@ Create an access token .. program:: access token create .. code:: bash - os access token create + openstack access token create --consumer-key <consumer-key> --consumer-secret <consumer-secret> --request-key <request-key> diff --git a/doc/source/command-objects/address-scope.rst b/doc/source/command-objects/address-scope.rst index 7481ed53..9155d09e 100644 --- a/doc/source/command-objects/address-scope.rst +++ b/doc/source/command-objects/address-scope.rst @@ -15,7 +15,7 @@ Create new address scope .. program:: address scope create .. code:: bash - os address scope create + openstack address scope create [--project <project> [--project-domain <project-domain>]] [--ip-version <ip-version>] [--share | --no-share] @@ -55,7 +55,7 @@ Delete address scope(s) .. program:: address scope delete .. code:: bash - os address scope delete + openstack address scope delete <address-scope> [<address-scope> ...] .. _address_scope_delete-address-scope: @@ -71,7 +71,36 @@ List address scopes .. program:: address scope list .. code:: bash - os address scope list + openstack address scope list + [--name <name>] + [--ip-version <ip-version>] + [--project <project> [--project-domain <project-domain>]] + [--share | --no-share] + +.. option:: --name <name> + + List only address scopes of given name in output + +.. option:: --ip-version <ip-version> + + List address scopes of given IP version networks (4 or 6) + +.. option:: --project <project> + + List address scopes according to their project (name or ID) + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --share + + List address scopes shared between projects + +.. option:: --no-share + + List address scopes not shared between projects address scope set ----------------- @@ -81,7 +110,7 @@ Set address scope properties .. program:: address scope set .. code:: bash - os address scope set + openstack address scope set [--name <name>] [--share | --no-share] <address-scope> @@ -111,7 +140,7 @@ Display address scope details .. program:: address scope show .. code:: bash - os address scope show + openstack address scope show <address-scope> .. _address_scope_show-address-scope: diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 642942d4..2029a6c8 100644 --- a/doc/source/command-objects/aggregate.rst +++ b/doc/source/command-objects/aggregate.rst @@ -15,7 +15,7 @@ Add host to aggregate .. program:: aggregate add host .. code:: bash - os aggregate add host + openstack aggregate add host <aggregate> <host> @@ -24,6 +24,7 @@ Add host to aggregate Aggregate (name or ID) +.. _aggregate_add_host-host: .. describe:: <host> Host to add to :ref:`\<aggregate\> <aggregate_add_host-aggregate>` @@ -36,7 +37,7 @@ Create a new aggregate .. program:: aggregate create .. code:: bash - os aggregate create + openstack aggregate create [--zone <availability-zone>] [--property <key=value> [...] ] <name> @@ -49,6 +50,7 @@ Create a new aggregate Property to add to this aggregate (repeat option to set multiple properties) +.. _aggregate_create-name: .. describe:: <name> New aggregate name @@ -61,9 +63,10 @@ Delete existing aggregate(s) .. program:: aggregate delete .. code:: bash - os aggregate delete + openstack aggregate delete <aggregate> [<aggregate> ...] +.. _aggregate_delete-aggregate: .. describe:: <aggregate> Aggregate(s) to delete (name or ID) @@ -76,7 +79,7 @@ List all aggregates .. program:: aggregate list .. code:: bash - os aggregate list + openstack aggregate list [--long] .. option:: --long @@ -91,7 +94,7 @@ Remove host from aggregate .. program:: aggregate remove host .. code:: bash - os aggregate remove host + openstack aggregate remove host <aggregate> <host> @@ -100,6 +103,7 @@ Remove host from aggregate Aggregate (name or ID) +.. _aggregate_remove_host-host: .. describe:: <host> Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>` @@ -112,7 +116,7 @@ Set aggregate properties .. program:: aggregate set .. code:: bash - os aggregate set + openstack aggregate set [--name <new-name>] [--zone <availability-zone>] [--property <key=value> [...] ] @@ -135,7 +139,7 @@ Set aggregate properties .. option:: --no-property Remove all properties from :ref:`\<aggregate\> <aggregate_set-aggregate>` - (specify both --property and --no-property to + (specify both :option:`--property` and :option:`--no-property` to overwrite the current properties) .. _aggregate_set-aggregate: @@ -151,9 +155,10 @@ Display aggregate details .. program:: aggregate show .. code:: bash - os aggregate show + openstack aggregate show <aggregate> +.. _aggregate_show-aggregate: .. describe:: <aggregate> Aggregate to display (name or ID) @@ -166,7 +171,7 @@ Unset aggregate properties .. program:: aggregate unset .. code-block:: bash - os aggregate unset + openstack aggregate unset [--property <key> [...] ] <aggregate> diff --git a/doc/source/command-objects/availability-zone.rst b/doc/source/command-objects/availability-zone.rst index 149e1081..d4c117a0 100644 --- a/doc/source/command-objects/availability-zone.rst +++ b/doc/source/command-objects/availability-zone.rst @@ -15,7 +15,7 @@ List availability zones and their status .. program availability zone list .. code:: bash - os availability zone list + openstack availability zone list [--compute] [--network] [--volume] diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst index ac887086..f8923276 100644 --- a/doc/source/command-objects/backup.rst +++ b/doc/source/command-objects/backup.rst @@ -13,7 +13,7 @@ Create new backup .. program:: backup create .. code:: bash - os backup create + openstack backup create [--container <container>] [--name <name>] [--description <description>] @@ -66,7 +66,7 @@ Delete backup(s) .. program:: backup delete .. code:: bash - os backup delete + openstack backup delete [--force] <backup> [<backup> ...] @@ -90,7 +90,7 @@ List backups .. program:: backup list .. code:: bash - os backup list + openstack backup list .. _backup_list-backup: .. option:: --long @@ -106,7 +106,7 @@ Restore backup .. program:: backup restore .. code:: bash - os backup restore + openstack backup restore <backup> <volume> @@ -128,7 +128,7 @@ Display backup details .. program:: backup show .. code:: bash - os backup show + openstack backup show <backup> .. _backup_show-backup: diff --git a/doc/source/command-objects/catalog.rst b/doc/source/command-objects/catalog.rst index 4319fb11..dccf7801 100644 --- a/doc/source/command-objects/catalog.rst +++ b/doc/source/command-objects/catalog.rst @@ -12,7 +12,7 @@ List services in the service catalog .. program:: catalog list .. code:: bash - os catalog list + openstack catalog list catalog show ------------ @@ -22,7 +22,7 @@ Display service catalog details .. program:: catalog show .. code:: bash - os catalog show + openstack catalog show <service> .. describe:: <service> diff --git a/doc/source/command-objects/command.rst b/doc/source/command-objects/command.rst index ac4f8514..34c07da6 100644 --- a/doc/source/command-objects/command.rst +++ b/doc/source/command-objects/command.rst @@ -14,4 +14,4 @@ List recognized commands by group .. program:: command list .. code:: bash - os command list + openstack command list diff --git a/doc/source/command-objects/complete.rst b/doc/source/command-objects/complete.rst index 8f84eec1..20e5c41d 100644 --- a/doc/source/command-objects/complete.rst +++ b/doc/source/command-objects/complete.rst @@ -22,4 +22,4 @@ print bash completion command .. program:: complete .. code:: bash - os complete + openstack complete diff --git a/doc/source/command-objects/compute-agent.rst b/doc/source/command-objects/compute-agent.rst index 239a24e8..e8317b48 100644 --- a/doc/source/command-objects/compute-agent.rst +++ b/doc/source/command-objects/compute-agent.rst @@ -12,7 +12,7 @@ Create compute agent .. program:: compute agent create .. code:: bash - os compute agent create + openstack compute agent create <os> <architecture> <version> <url> <md5hash> <hypervisor> @@ -49,7 +49,7 @@ Delete compute agent(s) .. program:: compute agent delete .. code:: bash - os compute agent delete <id> [<id> ...] + openstack compute agent delete <id> [<id> ...] .. _compute_agent-delete: .. describe:: <id> @@ -64,7 +64,7 @@ List compute agents .. program:: compute agent list .. code:: bash - os compute agent list [--hypervisor <hypervisor>] + openstack compute agent list [--hypervisor <hypervisor>] .. option:: --hypervisor <hypervisor> @@ -78,7 +78,7 @@ Set compute agent properties .. program:: agent set .. code:: bash - os compute agent set + openstack compute agent set [--agent-version <version>] [--url <url] [--md5hash <md5hash>] diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst index 57dd2ba5..ba624ea0 100644 --- a/doc/source/command-objects/compute-service.rst +++ b/doc/source/command-objects/compute-service.rst @@ -12,10 +12,10 @@ Delete compute service(s) .. program:: compute service delete .. code:: bash - os compute service delete + openstack compute service delete <service> [<service> ...] -.. _compute-service-delete: +.. _compute_service_delete-service: .. describe:: <service> Compute service(s) to delete (ID only) @@ -28,12 +28,11 @@ List compute services .. program:: compute service list .. code:: bash - os compute service list + openstack compute service list [--host <host>] [--service <service>] [--long] -.. _compute-service-list: .. option:: --host <host> List services on specified host (name only) @@ -46,7 +45,6 @@ List compute services List additional fields in output - compute service set ------------------- @@ -55,13 +53,12 @@ Set compute service properties .. program:: compute service set .. code:: bash - os compute service set + openstack compute service set [--enable | --disable] [--disable-reason <reason>] [--up | --down] <host> <service> -.. _compute-service-set: .. option:: --enable Enable service @@ -72,7 +69,7 @@ Set compute service properties .. option:: --disable-reason <reason> - Reason for disabling the service (in quotes). Should be used with --disable option. + Reason for disabling the service (in quotes). Should be used with :option:`--disable` option. .. option:: --up @@ -82,6 +79,7 @@ Set compute service properties Force down service +.. _compute_service_set-host: .. describe:: <host> Name of host @@ -89,4 +87,3 @@ Set compute service properties .. describe:: <service> Name of service (Binary name) - diff --git a/doc/source/command-objects/configuration.rst b/doc/source/command-objects/configuration.rst index 7bf054c0..0e00bbe9 100644 --- a/doc/source/command-objects/configuration.rst +++ b/doc/source/command-objects/configuration.rst @@ -15,7 +15,7 @@ show different configurations. .. program:: configuration show .. code:: bash - os configuration show + openstack configuration show [--mask | --unmask] .. option:: --mask diff --git a/doc/source/command-objects/consistency-group-snapshot.rst b/doc/source/command-objects/consistency-group-snapshot.rst index b7b1423e..3d455038 100644 --- a/doc/source/command-objects/consistency-group-snapshot.rst +++ b/doc/source/command-objects/consistency-group-snapshot.rst @@ -12,7 +12,7 @@ Create new consistency group snapshot. .. program:: consistency group snapshot create .. code:: bash - os consistency group snapshot create + openstack consistency group snapshot create [--consistency-group <consistency-group>] [--description <description>] [<snapshot-name>] @@ -39,7 +39,7 @@ Delete consistency group snapshot(s) .. program:: consistency group snapshot delete .. code:: bash - os consistency group snapshot delete + openstack consistency group snapshot delete <consistency-group-snapshot> [<consistency-group-snapshot> ...] .. _consistency_group_snapshot_delete-consistency-group-snapshot: @@ -55,7 +55,7 @@ List consistency group snapshots. .. program:: consistency group snapshot list .. code:: bash - os consistency group snapshot list + openstack consistency group snapshot list [--all-projects] [--long] [--status <status>] @@ -87,7 +87,7 @@ Display consistency group snapshot details. .. program:: consistency group snapshot show .. code:: bash - os consistency group snapshot show + openstack consistency group snapshot show <consistency-group-snapshot> .. _consistency_group_snapshot_show-consistency-group-snapshot: diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst index b3af60b4..e54ac65f 100644 --- a/doc/source/command-objects/consistency-group.rst +++ b/doc/source/command-objects/consistency-group.rst @@ -34,7 +34,7 @@ Create new consistency group. .. program:: consistency group create .. code:: bash - os consistency group create + openstack consistency group create --volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot> [--description <description>] [--availability-zone <availability-zone>] @@ -74,7 +74,7 @@ Delete consistency group(s). .. program:: consistency group delete .. code:: bash - os consistency group delete + openstack consistency group delete [--force] <consistency-group> [<consistency-group> ...] @@ -95,7 +95,7 @@ List consistency groups. .. program:: consistency group list .. code:: bash - os consistency group list + openstack consistency group list [--all-projects] [--long] @@ -138,7 +138,7 @@ Set consistency group properties. .. program:: consistency group set .. code:: bash - os consistency group set + openstack consistency group set [--name <name>] [--description <description>] <consistency-group> @@ -164,7 +164,7 @@ Display consistency group details. .. program:: consistency group show .. code:: bash - os consistency group show + openstack consistency group show <consistency-group> .. _consistency_group_show-consistency-group: diff --git a/doc/source/command-objects/console-log.rst b/doc/source/command-objects/console-log.rst index 9eafb61a..bcb23e70 100644 --- a/doc/source/command-objects/console-log.rst +++ b/doc/source/command-objects/console-log.rst @@ -14,7 +14,7 @@ Show server's console output .. program:: console log show .. code:: bash - os console log show + openstack console log show [--lines <num-lines>] <server> diff --git a/doc/source/command-objects/console-url.rst b/doc/source/command-objects/console-url.rst index 08c83332..8a5807b6 100644 --- a/doc/source/command-objects/console-url.rst +++ b/doc/source/command-objects/console-url.rst @@ -14,7 +14,7 @@ Show server's remote console URL .. program:: console url show .. code:: bash - os console url show + openstack console url show [--novnc | --xvpvnc | --spice] [--rdp | --serial | --mks] <server> diff --git a/doc/source/command-objects/consumer.rst b/doc/source/command-objects/consumer.rst index 335eaea3..d4ce5dc5 100644 --- a/doc/source/command-objects/consumer.rst +++ b/doc/source/command-objects/consumer.rst @@ -14,7 +14,7 @@ Create new consumer .. program:: consumer create .. code:: bash - os consumer create + openstack consumer create [--description <description>] .. option:: --description <description> @@ -29,7 +29,7 @@ Delete consumer(s) .. program:: consumer delete .. code:: bash - os consumer delete + openstack consumer delete <consumer> [<consumer> ...] .. describe:: <consumer> @@ -44,7 +44,7 @@ List consumers .. program:: consumer list .. code:: bash - os consumer list + openstack consumer list consumer set ------------ @@ -54,7 +54,7 @@ Set consumer properties .. program:: consumer set .. code:: bash - os consumer set + openstack consumer set [--description <description>] <consumer> @@ -74,7 +74,7 @@ Display consumer details .. program:: consumer show .. code:: bash - os consumer show + openstack consumer show <consumer> .. _consumer_show-consumer: diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst index adcf0961..c4310472 100644 --- a/doc/source/command-objects/container.rst +++ b/doc/source/command-objects/container.rst @@ -12,7 +12,7 @@ Create new container .. program:: container create .. code:: bash - os container create + openstack container create <container-name> [<container-name> ...] .. describe:: <container-name> @@ -27,7 +27,7 @@ Delete container .. program:: container delete .. code:: bash - os container delete + openstack container delete [-r] | [--recursive] <container> [<container> ...] @@ -47,7 +47,7 @@ List containers .. program:: container list .. code:: bash - os container list + openstack container list [--prefix <prefix>] [--marker <marker>] [--end-marker <end-marker>] @@ -87,7 +87,7 @@ Save container contents locally .. program:: container save .. code:: bash - os container save + openstack container save <container> .. describe:: <container> @@ -102,7 +102,7 @@ Set container properties .. program:: container set .. code:: bash - os container set + openstack container set [--property <key=value> [...] ] <container> @@ -122,7 +122,7 @@ Display container details .. program:: container show .. code:: bash - os container show + openstack container show <container> .. describe:: <container> @@ -137,7 +137,7 @@ Unset container properties .. program:: container unset .. code:: bash - os container unset + openstack container unset [--property <key>] <container> diff --git a/doc/source/command-objects/credential.rst b/doc/source/command-objects/credential.rst index 538362a8..0b835c73 100644 --- a/doc/source/command-objects/credential.rst +++ b/doc/source/command-objects/credential.rst @@ -12,7 +12,7 @@ Create new credential .. program:: credential create .. code:: bash - os credential create + openstack credential create [--type <type>] [--project <project>] <user> <data> @@ -42,7 +42,7 @@ Delete credential(s) .. program:: credential delete .. code:: bash - os credential delete + openstack credential delete <credential-id> [<credential-id> ...] .. _credential_delete: @@ -58,7 +58,7 @@ List credentials .. program:: credential list .. code:: bash - os credential list + openstack credential list credential set -------------- @@ -68,7 +68,7 @@ Set credential properties .. program:: credential set .. code:: bash - os credential set + openstack credential set [--user <user>] [--type <type>] [--data <data>] @@ -104,7 +104,7 @@ Display credential details .. program:: credential show .. code:: bash - os credential show + openstack credential show <credential-id> .. _credential_show: diff --git a/doc/source/command-objects/domain.rst b/doc/source/command-objects/domain.rst index 573a78cb..70a3e733 100644 --- a/doc/source/command-objects/domain.rst +++ b/doc/source/command-objects/domain.rst @@ -12,7 +12,7 @@ Create new domain .. program:: domain create .. code:: bash - os domain create + openstack domain create [--description <description>] [--enable | --disable] [--or-show] @@ -48,7 +48,7 @@ Delete domain(s) .. program:: domain delete .. code:: bash - os domain delete + openstack domain delete <domain> [<domain> ...] .. describe:: <domain> @@ -63,7 +63,7 @@ List domains .. program:: domain list .. code:: bash - os domain list + openstack domain list domain set ---------- @@ -73,7 +73,7 @@ Set domain properties .. program:: domain set .. code:: bash - os domain set + openstack domain set [--name <name>] [--description <description>] [--enable | --disable] @@ -107,7 +107,7 @@ Display domain details .. program:: domain show .. code:: bash - os domain show + openstack domain show <domain> .. describe:: <domain> diff --git a/doc/source/command-objects/ec2-credentials.rst b/doc/source/command-objects/ec2-credentials.rst index caf7fd69..9174b041 100644 --- a/doc/source/command-objects/ec2-credentials.rst +++ b/doc/source/command-objects/ec2-credentials.rst @@ -12,7 +12,7 @@ Create EC2 credentials .. program:: ec2 credentials create .. code-block:: bash - os ec2 credentials create + openstack ec2 credentials create [--project <project>] [--user <user>] [--user-domain <user-domain>] @@ -52,7 +52,7 @@ Delete EC2 credentials .. program:: ec2 credentials delete .. code-block:: bash - os ec2 credentials delete + openstack ec2 credentials delete [--user <user>] [--user-domain <user-domain>] <access-key> [<access-key> ...] @@ -85,7 +85,7 @@ List EC2 credentials .. program:: ec2 credentials list .. code-block:: bash - os ec2 credentials list + openstack ec2 credentials list [--user <user>] [--user-domain <user-domain>] @@ -112,7 +112,7 @@ Display EC2 credentials details .. program:: ec2 credentials show .. code-block:: bash - os ec2 credentials show + openstack ec2 credentials show [--user <user>] [--user-domain <user-domain>] <access-key> diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst index c058c844..d6eb362a 100644 --- a/doc/source/command-objects/endpoint.rst +++ b/doc/source/command-objects/endpoint.rst @@ -14,7 +14,7 @@ Create new endpoint .. program:: endpoint create .. code:: bash - os endpoint create + openstack endpoint create --publicurl <url> [--adminurl <url>] [--internalurl <url>] @@ -47,7 +47,7 @@ Create new endpoint .. program:: endpoint create .. code:: bash - os endpoint create + openstack endpoint create [--region <region-id>] [--enable | --disable] <service> @@ -86,7 +86,7 @@ Delete endpoint(s) .. program:: endpoint delete .. code:: bash - os endpoint delete + openstack endpoint delete <endpoint-id> [<endpoint-id> ...] .. _endpoint_delete-endpoint: @@ -102,7 +102,7 @@ List endpoints .. program:: endpoint list .. code:: bash - os endpoint list + openstack endpoint list [--service <service] [--interface <interface>] [--region <region-id>] @@ -142,7 +142,7 @@ Set endpoint properties .. program:: endpoint set .. code:: bash - os endpoint set + openstack endpoint set [--region <region-id>] [--interface <interface>] [--url <url>] @@ -187,7 +187,7 @@ Display endpoint details .. program:: endpoint show .. code:: bash - os endpoint show + openstack endpoint show <endpoint> .. _endpoint_show-endpoint: diff --git a/doc/source/command-objects/extension.rst b/doc/source/command-objects/extension.rst index dff30fa1..b7ba5c0a 100644 --- a/doc/source/command-objects/extension.rst +++ b/doc/source/command-objects/extension.rst @@ -13,7 +13,7 @@ List API extensions .. program:: extension list .. code:: bash - os extension list + openstack extension list [--compute] [--identity] [--network] diff --git a/doc/source/command-objects/federation-protocol.rst b/doc/source/command-objects/federation-protocol.rst index 911d4e99..e1f98174 100644 --- a/doc/source/command-objects/federation-protocol.rst +++ b/doc/source/command-objects/federation-protocol.rst @@ -14,7 +14,7 @@ Create new federation protocol .. program:: federation protocol create .. code:: bash - os federation protocol create + openstack federation protocol create --identity-provider <identity-provider> --mapping <mapping> <name> @@ -39,7 +39,7 @@ Delete federation protocol(s) .. program:: federation protocol delete .. code:: bash - os federation protocol delete + openstack federation protocol delete --identity-provider <identity-provider> <federation-protocol> [<federation-protocol> ...] @@ -59,7 +59,7 @@ List federation protocols .. program:: federation protocol list .. code:: bash - os federation protocol list + openstack federation protocol list --identity-provider <identity-provider> .. option:: --identity-provider <identity-provider> @@ -74,7 +74,7 @@ Set federation protocol properties .. program:: federation protocol set .. code:: bash - os federation protocol set + openstack federation protocol set --identity-provider <identity-provider> [--mapping <mapping>] <federation-protocol> @@ -99,7 +99,7 @@ Display federation protocol details .. program:: federation protocol show .. code:: bash - os federation protocol show + openstack federation protocol show --identity-provider <identity-provider> <federation-protocol> diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index 9ea504c1..0900f2ed 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -12,7 +12,7 @@ Create new flavor .. program:: flavor create .. code:: bash - os flavor create + openstack flavor create [--id <id>] [--ram <size-mb>] [--disk <size-gb>] @@ -89,7 +89,7 @@ Delete flavor(s) .. program:: flavor delete .. code:: bash - os flavor delete + openstack flavor delete <flavor> [<flavor> ...] .. _flavor_delete-flavor: @@ -105,7 +105,7 @@ List flavors .. program:: flavor list .. code:: bash - os flavor list + openstack flavor list [--public | --private | --all] [--long] [--marker <marker>] @@ -143,7 +143,7 @@ Set flavor properties .. program:: flavor set .. code:: bash - os flavor set + openstack flavor set [--property <key=value> [...] ] [--project <project>] [--project-domain <project-domain>] @@ -174,7 +174,7 @@ Display flavor details .. program:: flavor show .. code:: bash - os flavor show + openstack flavor show <flavor> .. _flavor_show-flavor: @@ -190,7 +190,7 @@ Unset flavor properties .. program:: flavor unset .. code:: bash - os flavor unset + openstack flavor unset [--property <key> [...] ] [--project <project>] [--project-domain <project-domain>] diff --git a/doc/source/command-objects/floating-ip-pool.rst b/doc/source/command-objects/floating-ip-pool.rst index 6f074d2d..9213b86d 100644 --- a/doc/source/command-objects/floating-ip-pool.rst +++ b/doc/source/command-objects/floating-ip-pool.rst @@ -12,4 +12,4 @@ List pools of floating IP addresses .. program:: floating ip pool list .. code:: bash - os floating ip pool list + openstack floating ip pool list diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst index 57dc0ccb..5a38bc1b 100644 --- a/doc/source/command-objects/floating-ip.rst +++ b/doc/source/command-objects/floating-ip.rst @@ -12,7 +12,7 @@ Create floating IP .. program:: floating ip create .. code:: bash - os floating ip create + openstack floating ip create [--subnet <subnet>] [--port <port>] [--floating-ip-address <floating-ip-address>] @@ -71,7 +71,7 @@ Delete floating IP(s) .. program:: floating ip delete .. code:: bash - os floating ip delete <floating-ip> [<floating-ip> ...] + openstack floating ip delete <floating-ip> [<floating-ip> ...] .. describe:: <floating-ip> @@ -85,7 +85,7 @@ List floating IP(s) .. program:: floating ip list .. code:: bash - os floating ip list + openstack floating ip list [--network <network>] [--port <port>] [--fixed-ip-address <fixed-ip-address>] @@ -151,7 +151,7 @@ Display floating IP details .. program:: floating ip show .. code:: bash - os floating ip show <floating-ip> + openstack floating ip show <floating-ip> .. describe:: <floating-ip> diff --git a/doc/source/command-objects/group.rst b/doc/source/command-objects/group.rst index 0f2c5cd1..3c3199cf 100644 --- a/doc/source/command-objects/group.rst +++ b/doc/source/command-objects/group.rst @@ -12,7 +12,7 @@ Add user to group .. program:: group add user .. code:: bash - os group add user + openstack group add user [--group-domain <group-domain>] [--user-domain <user-domain>] <group> @@ -48,7 +48,7 @@ Check user membership in group .. program:: group contains user .. code:: bash - os group contains user + openstack group contains user [--group-domain <group-domain>] [--user-domain <user-domain>] <group> @@ -84,7 +84,7 @@ Create new group .. program:: group create .. code:: bash - os group create + openstack group create [--domain <domain>] [--description <description>] [--or-show] @@ -116,7 +116,7 @@ Delete group .. program:: group delete .. code:: bash - os group delete + openstack group delete [--domain <domain>] <group> [<group> ...] @@ -136,7 +136,7 @@ List groups .. program:: group list .. code:: bash - os group list + openstack group list [--domain <domain>] [--user <user> [--user-domain <user-domain>]] [--long] @@ -168,7 +168,7 @@ Remove user from group .. program:: group remove user .. code:: bash - os group remove user + openstack group remove user [--group-domain <group-domain>] [--user-domain <user-domain>] <group> @@ -204,7 +204,7 @@ Set group properties .. program:: group set .. code:: bash - os group set + openstack group set [--domain <domain>] [--name <name>] [--description <description>] @@ -234,7 +234,7 @@ Display group details .. program:: group show .. code:: bash - os group show + openstack group show [--domain <domain>] <group> diff --git a/doc/source/command-objects/host.rst b/doc/source/command-objects/host.rst index 409b834b..cbf34398 100644 --- a/doc/source/command-objects/host.rst +++ b/doc/source/command-objects/host.rst @@ -14,7 +14,7 @@ List hosts .. program:: host list .. code:: bash - os host list + openstack host list [--zone <availability-zone>] .. option:: --zone <availability-zone> @@ -29,7 +29,7 @@ Set host properties .. program:: host set .. code:: bash - os host set + openstack host set [--enable | --disable] [--enable-maintenance | --disable-maintenance] <host> @@ -64,7 +64,7 @@ Display host details .. program:: host show .. code:: bash - os host show + openstack host show <host> .. describe:: <host> diff --git a/doc/source/command-objects/hypervisor-stats.rst b/doc/source/command-objects/hypervisor-stats.rst index 06edf7a1..89faf135 100644 --- a/doc/source/command-objects/hypervisor-stats.rst +++ b/doc/source/command-objects/hypervisor-stats.rst @@ -12,5 +12,5 @@ Display hypervisor stats details .. program:: hypervisor stats show .. code:: bash - os hypervisor stats show + openstack hypervisor stats show diff --git a/doc/source/command-objects/hypervisor.rst b/doc/source/command-objects/hypervisor.rst index 3053a758..9db384a2 100644 --- a/doc/source/command-objects/hypervisor.rst +++ b/doc/source/command-objects/hypervisor.rst @@ -12,7 +12,7 @@ List hypervisors .. program:: hypervisor list .. code:: bash - os hypervisor list + openstack hypervisor list [--matching <hostname>] [--long] @@ -32,7 +32,7 @@ Display hypervisor details .. program:: hypervisor show .. code:: bash - os hypervisor show + openstack hypervisor show <hypervisor> .. _hypervisor_show-flavor: diff --git a/doc/source/command-objects/identity-provider.rst b/doc/source/command-objects/identity-provider.rst index f772511d..0c2d02bd 100644 --- a/doc/source/command-objects/identity-provider.rst +++ b/doc/source/command-objects/identity-provider.rst @@ -14,7 +14,7 @@ Create new identity provider .. program:: identity provider create .. code:: bash - os identity provider create + openstack identity provider create [--remote-id <remote-id> [...] | --remote-id-file <file-name>] [--description <description>] [--enable | --disable] @@ -54,7 +54,7 @@ Delete identity provider(s) .. program:: identity provider delete .. code:: bash - os identity provider delete + openstack identity provider delete <identity-provider> [<identity-provider> ...] .. describe:: <identity-provider> @@ -69,7 +69,7 @@ List identity providers .. program:: identity provider list .. code:: bash - os identity provider list + openstack identity provider list identity provider set --------------------- @@ -79,7 +79,7 @@ Set identity provider properties .. program:: identity provider set .. code:: bash - os identity provider set + openstack identity provider set [--remote-id <remote-id> [...] | --remote-id-file <file-name>] [--description <description>] [--enable | --disable] @@ -119,7 +119,7 @@ Display identity provider details .. program:: identity provider show .. code:: bash - os identity provider show + openstack identity provider show <identity-provider> .. describe:: <identity-provider> diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 7fc33c69..999842af 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -14,7 +14,7 @@ Associate project with image .. program:: image add project .. code:: bash - os image add project + openstack image add project [--project-domain <project-domain>] <image> <project> @@ -23,10 +23,12 @@ Associate project with image 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> Image to share (name or ID). +.. _image_add_project-project: .. describe:: <project> Project to associate with image (name or ID) @@ -41,7 +43,7 @@ Create/upload an image .. program:: image create .. code:: bash - os image create + openstack image create [--id <id>] [--store <store>] [--container-format <container-format>] @@ -79,11 +81,11 @@ Create/upload an image .. option:: --disk-format <disk-format> Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, - raw, qcow2, vhdx, vdi, and iso. The default format is: raw + raw, qcow2, vhdx, vdi, iso, and ploop. The default format is: raw .. option:: --size <size> - Image size, in bytes (only used with --location and --copy-from) + Image size, in bytes (only used with :option:`--location` and :option:`--copy-from`) *Image version 1 only.* @@ -91,7 +93,7 @@ Create/upload an image Minimum disk size needed to boot image, in gigabytes -.. option:: --min-ram <disk-ram> +.. option:: --min-ram <ram-mb> Minimum RAM size needed to boot image, in megabytes @@ -103,7 +105,7 @@ Create/upload an image .. option:: --copy-from <image-url> - Copy image from the data store (similar to --location) + Copy image from the data store (similar to :option:`--location`) *Image version 1 only.* @@ -117,7 +119,7 @@ Create/upload an image .. option:: --force - Force image creation if volume is in use (only meaningful with --volume) + Force image creation if volume is in use (only meaningful with :option:`--volume`) .. option:: --checksum <checksum> @@ -163,6 +165,7 @@ Create/upload an image .. versionadded:: 2 +.. _image_create-image-name: .. describe:: <image-name> New image name @@ -175,9 +178,10 @@ Delete image(s) .. program:: image delete .. code:: bash - os image delete + openstack image delete <image> +.. _image_delete-image: .. describe:: <image> Image(s) to delete (name or ID) @@ -190,7 +194,7 @@ List available images .. program:: image list .. code:: bash - os image list + openstack image list [--public | --private | --shared] [--property <key=value>] [--long] @@ -244,15 +248,17 @@ Disassociate project with image .. program:: image remove project .. code:: bash - os image remove remove + openstack image remove remove [--project-domain <project-domain>] - <image> <project> + <image> + <project> .. option:: --project-domain <project-domain> Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. +.. _image_remove_project: .. describe:: <image> Image to unshare (name or ID). @@ -269,7 +275,7 @@ Save an image locally .. program:: image save .. code:: bash - os image save + openstack image save --file <filename> <image> @@ -277,6 +283,7 @@ Save an image locally Downloaded image save filename (default: stdout) +.. _image_save-image: .. describe:: <image> Image to save (name or ID) @@ -291,10 +298,10 @@ Set image properties .. program:: image set .. code:: bash - os image set + openstack image set [--name <name>] [--min-disk <disk-gb>] - [--min-ram <disk-ram>] + [--min-ram <ram-mb>] [--container-format <container-format>] [--disk-format <disk-format>] [--size <size>] @@ -318,6 +325,7 @@ Set image properties [--ramdisk-id <ramdisk-id>] [--activate|--deactivate] [--project <project> [--project-domain <project-domain>]] + [--accept | --reject | --pending] <image> .. option:: --name <name> @@ -328,7 +336,7 @@ Set image properties Minimum disk size needed to boot image, in gigabytes -.. option:: --min-ram <disk-ram> +.. option:: --min-ram <ram-mb> Minimum RAM size needed to boot image, in megabytes @@ -339,7 +347,7 @@ Set image properties .. option:: --disk-format <disk-format> Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, - raw, qcow2, vhdx, vdi, and iso. + raw, qcow2, vhdx, vdi, iso, and ploop. .. option:: --size <size> @@ -377,7 +385,7 @@ Set image properties .. option:: --copy-from <image-url> - Copy image from the data store (similar to --location) + Copy image from the data store (similar to :option:`--location`) *Image version 1 only.* @@ -395,7 +403,7 @@ Set image properties .. option:: --force - Force image update if volume is in use (only meaningful with --volume) + Force image update if volume is in use (only meaningful with :option:`--volume`) *Image version 1 only.* @@ -483,6 +491,37 @@ Set image properties .. 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> Image to modify (name or ID) @@ -495,9 +534,10 @@ Display image details .. program:: image show .. code:: bash - os image show + openstack image show <image> +.. _image_show-image: .. describe:: <image> Image to display (name or ID) @@ -512,7 +552,7 @@ Unset image tags or properties .. program:: image unset .. code:: bash - os image set + openstack image set [--tag <tag>] [--property <property>] <image> @@ -525,6 +565,7 @@ Unset image tags or properties Unset a property on this image (repeat option to unset multiple properties) +.. _image_unset-image: .. describe:: <image> Image to modify (name or ID) diff --git a/doc/source/command-objects/ip-availability.rst b/doc/source/command-objects/ip-availability.rst index f200ab13..73d0599a 100644 --- a/doc/source/command-objects/ip-availability.rst +++ b/doc/source/command-objects/ip-availability.rst @@ -18,7 +18,7 @@ number of allocated IP addresses from that pool. .. program:: ip availability list .. code:: bash - os ip availability list + openstack ip availability list [--ip-version {4,6}] [--project <project>] @@ -51,7 +51,7 @@ subnet within the network as well. .. program:: ip availability show .. code:: bash - os ip availability show + openstack ip availability show <network> .. _ip_availability_show-network diff --git a/doc/source/command-objects/ip-fixed.rst b/doc/source/command-objects/ip-fixed.rst index c2447b28..f5b11dc6 100644 --- a/doc/source/command-objects/ip-fixed.rst +++ b/doc/source/command-objects/ip-fixed.rst @@ -13,7 +13,7 @@ Add fixed IP address to server .. program:: ip fixed add .. code:: bash - os ip fixed add + openstack ip fixed add <network> <server> @@ -34,7 +34,7 @@ Remove fixed IP address from server .. program:: ip fixed remove .. code:: bash - os ip fixed remove + openstack ip fixed remove <ip-address> <server> diff --git a/doc/source/command-objects/ip-floating-pool.rst b/doc/source/command-objects/ip-floating-pool.rst index 310974c6..6d00355a 100644 --- a/doc/source/command-objects/ip-floating-pool.rst +++ b/doc/source/command-objects/ip-floating-pool.rst @@ -13,4 +13,4 @@ List pools of floating IP addresses .. program:: ip floating pool list .. code:: bash - os ip floating pool list + openstack ip floating pool list diff --git a/doc/source/command-objects/ip-floating.rst b/doc/source/command-objects/ip-floating.rst index 7b38a382..4e5f7b00 100644 --- a/doc/source/command-objects/ip-floating.rst +++ b/doc/source/command-objects/ip-floating.rst @@ -13,7 +13,7 @@ Add floating IP address to server .. program:: ip floating add .. code:: bash - os ip floating add + openstack ip floating add <ip-address> <server> @@ -34,7 +34,7 @@ Create new floating IP address .. program:: ip floating create .. code:: bash - os ip floating create + openstack ip floating create [--subnet <subnet>] [--port <port>] [--floating-ip-address <floating-ip-address>] @@ -74,7 +74,7 @@ Delete floating IP(s) .. program:: ip floating delete .. code:: bash - os ip floating delete + openstack ip floating delete <floating-ip> [<floating-ip> ...] .. describe:: <floating-ip> @@ -90,7 +90,7 @@ List floating IP addresses .. program:: ip floating list .. code:: bash - os ip floating list + openstack ip floating list ip floating remove ------------------ @@ -101,7 +101,7 @@ Remove floating IP address from server .. program:: ip floating remove .. code:: bash - os ip floating remove + openstack ip floating remove <ip-address> <server> @@ -122,7 +122,7 @@ Display floating IP details .. program:: ip floating show .. code:: bash - os ip floating show <floating-ip> + openstack ip floating show <floating-ip> .. describe:: <floating-ip> diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst index c9bf085b..47acf7f2 100644 --- a/doc/source/command-objects/keypair.rst +++ b/doc/source/command-objects/keypair.rst @@ -17,7 +17,7 @@ Create new public or private key for server ssh access .. program:: keypair create .. code:: bash - os keypair create + openstack keypair create [--public-key <file>] <name> @@ -37,7 +37,7 @@ Delete public or private key(s) .. program:: keypair delete .. code:: bash - os keypair delete + openstack keypair delete <key> [<key> ...] .. describe:: <key> @@ -52,7 +52,7 @@ List key fingerprints .. program:: keypair list .. code:: bash - os keypair list + openstack keypair list keypair show ------------ @@ -62,7 +62,7 @@ Display key details .. program:: keypair show .. code:: bash - os keypair show + openstack keypair show [--public-key] <key> diff --git a/doc/source/command-objects/limits.rst b/doc/source/command-objects/limits.rst index ef4171ac..92614209 100644 --- a/doc/source/command-objects/limits.rst +++ b/doc/source/command-objects/limits.rst @@ -14,7 +14,7 @@ Show compute and block storage limits .. program:: limits show .. code:: bash - os limits show + openstack limits show --absolute | --rate [--reserved] [--project <project>] @@ -34,8 +34,8 @@ Show compute and block storage limits .. option:: --project <project> - Show limits for a specific project (name or ID) [only valid with --absolute] + Show limits for a specific project (name or ID) [only valid with :option:`--absolute`] .. option:: --domain <domain> - Domain the project belongs to (name or ID) [only valid with --absolute] + Domain the project belongs to (name or ID) [only valid with :option:`--absolute`] diff --git a/doc/source/command-objects/mapping.rst b/doc/source/command-objects/mapping.rst index 7f61366e..1f657ed2 100644 --- a/doc/source/command-objects/mapping.rst +++ b/doc/source/command-objects/mapping.rst @@ -14,7 +14,7 @@ Create new mapping .. program:: mapping create .. code:: bash - os mapping create + openstack mapping create --rules <filename> <name> @@ -35,7 +35,7 @@ Delete mapping(s) .. program:: mapping delete .. code:: bash - os mapping delete + openstack mapping delete <mapping> [<mapping> ...] .. _mapping_delete-mapping: @@ -51,7 +51,7 @@ List mappings .. program:: mapping list .. code:: bash - os mapping list + openstack mapping list mapping set ----------- @@ -61,7 +61,7 @@ Set mapping properties .. program:: mapping set .. code:: bash - os mapping set + openstack mapping set [--rules <filename>] <mapping> @@ -82,7 +82,7 @@ Display mapping details .. program:: mapping show .. code:: bash - os mapping show + openstack mapping show <mapping> .. _mapping_show-mapping: diff --git a/doc/source/command-objects/meter.rst b/doc/source/command-objects/meter.rst new file mode 100644 index 00000000..6077ce92 --- /dev/null +++ b/doc/source/command-objects/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> [--project-domain <project-domain>]] + [--description <description>] + [--share | --no-share] + <name> + +.. option:: --project <project> + + Owner's project (name of ID) + + *Network version 2 only* + +.. option:: --description <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:: <name> + + New meter name + +network meter delete +-------------------- + +Delete network meter(s) + +.. program:: network meter delete +.. code:: bash + + openstack network meter delete + <meter> [<meter> ...] + +.. _network_meter_delete: +.. describe:: <meter> + + 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 + <meter> + +.. _network_meter_show: +.. describe:: <meter> + + Meter to display (name or ID) diff --git a/doc/source/command-objects/module.rst b/doc/source/command-objects/module.rst index c3bc1372..f4b32e75 100644 --- a/doc/source/command-objects/module.rst +++ b/doc/source/command-objects/module.rst @@ -14,7 +14,7 @@ List module versions .. program:: module list .. code:: bash - os module list + openstack module list [--all] .. option:: --all diff --git a/doc/source/command-objects/network-agent.rst b/doc/source/command-objects/network-agent.rst index 9d158ba0..947e07cf 100644 --- a/doc/source/command-objects/network-agent.rst +++ b/doc/source/command-objects/network-agent.rst @@ -18,7 +18,7 @@ Delete network agent(s) .. program:: network agent delete .. code:: bash - os network agent delete + openstack network agent delete <network-agent> [<network-agent> ...] .. _network_agent_delete-network-agent: @@ -34,7 +34,20 @@ List network agents .. program:: network agent list .. code:: bash - os network agent list + openstack network agent list + [--agent-type <agent-type>] + [--host <host>] + +.. option:: --agent-type <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 <host> + + List only agents running on the specified host network agent set ----------------- @@ -44,7 +57,7 @@ Set network agent properties .. program:: network agent set .. code:: bash - os network agent set + openstack network agent set [--description <description>] [--enable | --disable] <network-agent> @@ -74,7 +87,7 @@ Display network agent details .. program:: network agent show .. code:: bash - os network agent show + openstack network agent show <network-agent> .. _network_agent_show-network-agent: diff --git a/doc/source/command-objects/network-qos-policy.rst b/doc/source/command-objects/network-qos-policy.rst index f1e54976..cf594497 100644 --- a/doc/source/command-objects/network-qos-policy.rst +++ b/doc/source/command-objects/network-qos-policy.rst @@ -15,7 +15,7 @@ Create new Network QoS policy .. program:: network qos policy create .. code:: bash - os network qos policy create + openstack network qos policy create [--description <description>] [--share | --no-share] [--project <project>] @@ -55,7 +55,7 @@ Delete Network QoS policy .. program:: network qos policy delete .. code:: bash - os network qos policy delete + openstack network qos policy delete <qos-policy> [<qos-policy> ...] .. describe:: <qos-policy> @@ -70,7 +70,7 @@ List Network QoS policies .. program:: network qos policy list .. code:: bash - os network qos policy list + openstack network qos policy list network qos policy set ---------------------- @@ -80,7 +80,7 @@ Set Network QoS policy properties .. program:: network qos policy set .. code:: bash - os network qos policy set + openstack network qos policy set [--name <name>] [--description <description>] [--share | --no-share] @@ -114,7 +114,7 @@ Display Network QoS policy details .. program:: network qos policy show .. code:: bash - os network qos policy show + openstack network qos policy show <qos-policy> .. describe:: <qos-policy> diff --git a/doc/source/command-objects/network-qos-rule-type.rst b/doc/source/command-objects/network-qos-rule-type.rst new file mode 100644 index 00000000..020a05cd --- /dev/null +++ b/doc/source/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 + + os network qos rule type list diff --git a/doc/source/command-objects/network-rbac.rst b/doc/source/command-objects/network-rbac.rst index 113242f4..c49f29bb 100644 --- a/doc/source/command-objects/network-rbac.rst +++ b/doc/source/command-objects/network-rbac.rst @@ -16,7 +16,7 @@ Create network RBAC policy .. program:: network rbac create .. code:: bash - os network rbac create + openstack network rbac create --type <type> --action <action> --target-project <target-project> [--target-project-domain <target-project-domain>] @@ -62,7 +62,7 @@ Delete network RBAC policy(s) .. program:: network rbac delete .. code:: bash - os network rbac delete + openstack network rbac delete <rbac-policy> [<rbac-policy> ...] .. _network_rbac_delete-rbac-policy: @@ -78,7 +78,22 @@ List network RBAC policies .. program:: network rbac list .. code:: bash - os network rbac list + openstack network rbac list + [--type <type>] + [--action <action>] + [--long] + +.. option:: --type <type> + + List network RBAC policies according to given object type ("qos_policy" or "network") + +.. option:: --action <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 ---------------- @@ -88,7 +103,7 @@ Set network RBAC policy properties .. program:: network rbac set .. code:: bash - os network rbac set + openstack network rbac set [--target-project <target-project> [--target-project-domain <target-project-domain>]] <rbac-policy> @@ -114,7 +129,7 @@ Display network RBAC policy details .. program:: network rbac show .. code:: bash - os network rbac show + openstack network rbac show <rbac-policy> .. _network_rbac_show-rbac-policy: diff --git a/doc/source/command-objects/network-segment.rst b/doc/source/command-objects/network-segment.rst index d0434651..d6a66aa0 100644 --- a/doc/source/command-objects/network-segment.rst +++ b/doc/source/command-objects/network-segment.rst @@ -17,7 +17,7 @@ Create new network segment .. program:: network segment create .. code:: bash - os network segment create + openstack network segment create [--description <description>] [--physical-network <physical-network>] [--segment <segment>] @@ -62,7 +62,7 @@ Delete network segment(s) .. program:: network segment delete .. code:: bash - os network segment delete + openstack network segment delete <network-segment> [<network-segment> ...] .. _network_segment_delete-segment: @@ -78,7 +78,7 @@ List network segments .. program:: network segment list .. code:: bash - os network segment list + openstack network segment list [--long] [--network <network>] @@ -98,7 +98,7 @@ Set network segment properties .. program:: network segment set .. code:: bash - os network segment set + openstack network segment set [--description <description>] [--name <name>] <network-segment> @@ -124,7 +124,7 @@ Display network segment details .. program:: network segment show .. code:: bash - os network segment show + openstack network segment show <network-segment> .. _network_segment_show-segment: diff --git a/doc/source/command-objects/network-service-provider.rst b/doc/source/command-objects/network-service-provider.rst index 344bb880..8db2ab44 100644 --- a/doc/source/command-objects/network-service-provider.rst +++ b/doc/source/command-objects/network-service-provider.rst @@ -15,4 +15,4 @@ List service providers .. program:: network service provider list .. code:: bash - os network service provider list + openstack network service provider list diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 06a5247a..dc597443 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -19,7 +19,7 @@ Create new network .. program:: network create .. code:: bash - os network create + openstack network create [--project <project> [--project-domain <project-domain>]] [--enable | --disable] [--share | --no-share] @@ -176,7 +176,7 @@ Delete network(s) .. program:: network delete .. code:: bash - os network delete + openstack network delete <network> [<network> ...] .. _network_delete-network: @@ -192,7 +192,7 @@ List networks .. program:: network list .. code:: bash - os network list + openstack network list [--external | --internal] [--long] [--name <name>] @@ -300,7 +300,7 @@ Set network properties .. program:: network set .. code:: bash - os network set + openstack network set [--name <name>] [--enable | --disable] [--share | --no-share] @@ -407,7 +407,7 @@ Display network details .. program:: network show .. code:: bash - os network show + openstack network show <network> .. _network_show-network: diff --git a/doc/source/command-objects/object-store-account.rst b/doc/source/command-objects/object-store-account.rst index ba37078e..e8f09d45 100644 --- a/doc/source/command-objects/object-store-account.rst +++ b/doc/source/command-objects/object-store-account.rst @@ -12,7 +12,7 @@ Set account properties .. program:: object store account set .. code:: bash - os object store account set + openstack object store account set [--property <key=value> [...] ] .. option:: --property <key=value> @@ -27,7 +27,7 @@ Display account details .. program:: object store account show .. code:: bash - os object store account show + openstack object store account show object store account unset -------------------------- @@ -37,7 +37,7 @@ Unset account properties .. program:: object store account unset .. code:: bash - os object store account unset + openstack object store account unset [--property <key>] .. option:: --property <key> diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst index d02ac9bc..0a32a827 100644 --- a/doc/source/command-objects/object.rst +++ b/doc/source/command-objects/object.rst @@ -12,7 +12,7 @@ Upload object to container .. program:: object create .. code:: bash - os object create + openstack object create [--name <name>] <container> <filename> [<filename> ...] @@ -37,7 +37,7 @@ Delete object from container .. program:: object delete .. code:: bash - os object delete + openstack object delete <container> <object> [<object> ...] @@ -57,7 +57,7 @@ List objects .. program object list .. code:: bash - os object list + openstack object list [--prefix <prefix>] [--delimiter <delimiter>] [--marker <marker>] @@ -107,7 +107,7 @@ Save object locally .. program:: object save .. code:: bash - os object save + openstack object save [--file <filename>] <container> <object> @@ -132,7 +132,7 @@ Set object properties .. program:: object set .. code:: bash - os object set + openstack object set [--property <key=value> [...] ] <container> <object> @@ -157,7 +157,7 @@ Display object details .. program:: object show .. code:: bash - os object show + openstack object show <container> <object> @@ -177,7 +177,7 @@ Unset object properties .. program:: object unset .. code:: bash - os object unset + openstack object unset [--property <key>] <container> <object> diff --git a/doc/source/command-objects/policy.rst b/doc/source/command-objects/policy.rst index 757b1c53..deddf2c4 100644 --- a/doc/source/command-objects/policy.rst +++ b/doc/source/command-objects/policy.rst @@ -12,7 +12,7 @@ Create new policy .. program:: policy create .. code:: bash - os policy create + openstack policy create [--type <type>] <filename> @@ -32,7 +32,7 @@ Delete policy(s) .. program:: policy delete .. code:: bash - os policy delete + openstack policy delete <policy> [<policy> ...] .. describe:: <policy> @@ -47,7 +47,7 @@ List policies .. program:: policy list .. code:: bash - os policy list + openstack policy list [--long] .. option:: --long @@ -62,7 +62,7 @@ Set policy properties .. program:: policy set .. code:: bash - os policy set + openstack policy set [--type <type>] [--rules <filename>] <policy> @@ -87,7 +87,7 @@ Display policy details .. program:: policy show .. code:: bash - os policy show + openstack policy show <policy> .. describe:: <policy> diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 73c53290..34656f32 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -16,7 +16,7 @@ Create new port .. program:: port create .. code:: bash - os port create + openstack port create --network <network> [--description <description>] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] @@ -127,7 +127,7 @@ Delete port(s) .. program:: port delete .. code:: bash - os port delete + openstack port delete <port> [<port> ...] .. _port_delete-port: @@ -143,7 +143,7 @@ List ports .. program:: port list .. code:: bash - os port list + openstack port list [--device-owner <device-owner>] [--router <router> | --server <server>] [--network <network>] @@ -183,7 +183,7 @@ Set port properties .. program:: port set .. code:: bash - os port set + openstack port set [--description <description>] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] [--no-fixed-ip] @@ -214,7 +214,7 @@ Set port properties .. option:: --no-fixed-ip Clear existing information of fixed IP addresses. - Specify both --fixed-ip and --no-fixed-ip + Specify both :option:`--fixed-ip` and :option:`--no-fixed-ip` to overwrite the current fixed IP addresses. .. option:: --device <device-id> @@ -240,7 +240,7 @@ Set port properties .. option:: --no-binding-profile Clear existing information of binding:profile. - Specify both --binding-profile and --no-binding-profile + Specify both :option:`--binding-profile` and :option:`--no-binding-profile` to overwrite the current binding:profile information. .. option:: --host <host-id> @@ -294,7 +294,7 @@ Display port details .. program:: port show .. code:: bash - os port show + openstack port show <port> .. _port_show-port: @@ -310,7 +310,7 @@ Unset port properties .. program:: port unset .. code:: bash - os port unset + openstack port unset [--fixed-ip subnet=<subnet>,ip-address=<ip-address> [...]] [--binding-profile <binding-profile-key> [...]] [--security-group <security-group> [...]] diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index f76f79ff..1111fa59 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -12,7 +12,7 @@ Create new project .. program:: project create .. code:: bash - os project create + openstack project create [--domain <domain>] [--parent <project>] [--description <description>] @@ -69,7 +69,7 @@ Delete project(s) .. program:: project delete .. code:: bash - os project delete + openstack project delete [--domain <domain>] <project> [<project> ...] @@ -92,7 +92,7 @@ List projects .. program:: project list .. code:: bash - os project list + openstack project list [--domain <domain>] [--user <user>] [--long] @@ -121,7 +121,7 @@ Set project properties .. program:: project set .. code:: bash - os project set + openstack project set [--name <name>] [--domain <domain>] [--description <description>] @@ -171,7 +171,7 @@ Display project details .. program:: project show .. code:: bash - os project show + openstack project show [--domain <domain>] <project> @@ -208,7 +208,7 @@ Unset project properties .. program:: project unset .. code:: bash - os project unset + openstack project unset --property <key> [--property <key> ...] <project> diff --git a/doc/source/command-objects/quota.rst b/doc/source/command-objects/quota.rst index 4dc5b171..70e28dd8 100644 --- a/doc/source/command-objects/quota.rst +++ b/doc/source/command-objects/quota.rst @@ -15,7 +15,7 @@ Set quotas for project .. program:: quota set .. code:: bash - os quota set + openstack quota set # Compute settings [--cores <num-cores>] [--fixed-ips <num-fixed-ips>] @@ -58,7 +58,7 @@ Set quotas for class .. code:: bash - os quota set + openstack quota set --class # Compute settings [--cores <num-cores>] @@ -216,7 +216,7 @@ Show quotas for project or class .. program:: quota show .. code:: bash - os quota show + openstack quota show [--default] [<project>] @@ -232,7 +232,7 @@ Show quotas for project or class .. code:: bash - os quota show + openstack quota show --class [<class>] diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst index b74821a9..d2c63c1b 100644 --- a/doc/source/command-objects/region.rst +++ b/doc/source/command-objects/region.rst @@ -12,7 +12,7 @@ Create new region .. program:: region create .. code:: bash - os region create + openstack region create [--parent-region <region-id>] [--description <description>] <region-id> @@ -38,7 +38,7 @@ Delete region(s) .. program:: region delete .. code:: bash - os region delete + openstack region delete <region-id> [<region-id> ...] .. _region_delete-region-id: @@ -54,7 +54,7 @@ List regions .. program:: region list .. code:: bash - os region list + openstack region list [--parent-region <region-id>] .. option:: --parent-region <region-id> @@ -69,7 +69,7 @@ Set region properties .. program:: region set .. code:: bash - os region set + openstack region set [--parent-region <region-id>] [--description <description>] <region-id> @@ -95,7 +95,7 @@ Display region details .. program:: region show .. code:: bash - os region show + openstack region show <region-id> .. _region_show-region-id: diff --git a/doc/source/command-objects/request-token.rst b/doc/source/command-objects/request-token.rst index 84081cb1..ec72dd14 100644 --- a/doc/source/command-objects/request-token.rst +++ b/doc/source/command-objects/request-token.rst @@ -14,7 +14,7 @@ Authorize a request token .. program:: request token authorize .. code:: bash - os request token authorize + openstack request token authorize --request-key <consumer-key> --role <role> @@ -34,7 +34,7 @@ Create a request token .. program:: request token create .. code:: bash - os request token create + openstack request token create --consumer-key <consumer-key> --consumer-secret <consumer-secret> --project <project> diff --git a/doc/source/command-objects/role-assignment.rst b/doc/source/command-objects/role-assignment.rst index dc970ed5..b29f32c6 100644 --- a/doc/source/command-objects/role-assignment.rst +++ b/doc/source/command-objects/role-assignment.rst @@ -12,7 +12,7 @@ List role assignments .. program:: role assignment list .. code:: bash - os role assignment list + openstack role assignment list [--role <role>] [--role-domain <role-domain>] [--user <user>] diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst index 2ff1f13a..fe3126c0 100644 --- a/doc/source/command-objects/role.rst +++ b/doc/source/command-objects/role.rst @@ -12,7 +12,7 @@ Add role assignment to a user or group in a project or domain .. program:: role add .. code:: bash - os role add + openstack role add --domain <domain> | --project <project> [--project-domain <project-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] --role-domain <role-domain> @@ -85,7 +85,7 @@ Create new role .. program:: role create .. code:: bash - os role create + openstack role create [--or-show] [--domain <domain>] <name> @@ -114,7 +114,7 @@ Delete role(s) .. program:: role delete .. code:: bash - os role delete + openstack role delete <role> [<role> ...] [--domain <domain>] @@ -136,7 +136,7 @@ List roles .. program:: role list .. code:: bash - os role list + openstack role list --domain <domain> | --project <project> [--project-domain <project-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] --inherited @@ -209,7 +209,7 @@ Remove role assignment from domain/project : user/group .. program:: role remove .. code:: bash - os role remove + openstack role remove --domain <domain> | --project <project> [--project-domain <project-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] --role-domain <role-domain> @@ -284,7 +284,7 @@ Set role properties .. program:: role set .. code:: bash - os role set + openstack role set [--name <name>] [--domain <domain>] <role> @@ -311,7 +311,7 @@ Display role details .. program:: role show .. code:: bash - os role show + openstack role show [--domain <domain>] <role> diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index 059d1a3f..9e8007af 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -16,7 +16,7 @@ Add a port to a router .. program:: router add port .. code:: bash - os router add port + openstack router add port <router> <port> @@ -38,7 +38,7 @@ Add a subnet to a router .. program:: router add subnet .. code:: bash - os router add subnet + openstack router add subnet <router> <subnet> @@ -60,7 +60,7 @@ Create new router .. program:: router create .. code:: bash - os router create + openstack router create [--project <project> [--project-domain <project-domain>]] [--enable | --disable] [--distributed] @@ -117,7 +117,7 @@ Delete router(s) .. program:: router delete .. code:: bash - os router delete + openstack router delete <router> [<router> ...] .. _router_delete-router: @@ -133,7 +133,7 @@ List routers .. program:: router list .. code:: bash - os router list + openstack router list [--name <name>] [--enable | --disable] [--long] @@ -172,7 +172,7 @@ Remove a port from a router .. program:: router remove port .. code:: bash - os router remove port + openstack router remove port <router> <port> @@ -194,7 +194,7 @@ Remove a subnet from a router .. program:: router remove subnet .. code:: bash - os router remove subnet + openstack router remove subnet <router> <subnet> @@ -216,13 +216,14 @@ Set router properties .. program:: router set .. code:: bash - os router set + openstack router set [--name <name>] [--enable | --disable] [--distributed | --centralized] [--description <description>] [--route destination=<subnet>,gateway=<ip-address> | --no-route] [--ha | --no-ha] + [--external-gateway <network> [--enable-snat|--disable-snat] [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]] <router> .. option:: --name <name> @@ -258,7 +259,9 @@ Set router properties .. option:: --no-route - Clear routes associated with the router + Clear routes associated with the router. + Specify both --route and --no-route to overwrite + current value of route. .. option:: --ha @@ -268,6 +271,24 @@ Set router properties Clear high availablability attribute of the router (disabled router only) +.. option:: --external-gateway <network> + + 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=<subnet>,ip-address=<ip-address> + + Desired IP and/or subnet (name or ID) on external gateway: + subnet=<subnet>,ip-address=<ip-address> + (repeat option to set multiple fixed IP addresses) + .. _router_set-router: .. describe:: <router> @@ -281,7 +302,7 @@ Display router details .. program:: router show .. code:: bash - os router show + openstack router show <router> .. _router_show-router: @@ -297,8 +318,9 @@ Unset router properties .. program:: router unset .. code:: bash - os router unset + openstack router unset [--route destination=<subnet>,gateway=<ip-address>] + [--external-gateway] <router> .. option:: --route destination=<subnet>,gateway=<ip-address> @@ -308,6 +330,10 @@ Unset router properties 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> diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index f53389cc..1dbf16d2 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -15,7 +15,7 @@ Create a new security group rule .. program:: security group rule create .. code:: bash - os security group rule create + openstack security group rule create [--remote-ip <ip-address> | --remote-group <group>] [--dst-port <port-range> | [--icmp-type <icmp-type> [--icmp-code <icmp-code>]]] [--protocol <protocol>] @@ -116,7 +116,7 @@ Delete security group rule(s) .. program:: security group rule delete .. code:: bash - os security group rule delete + openstack security group rule delete <rule> [<rule> ...] .. describe:: <rule> @@ -131,7 +131,7 @@ List security group rules .. program:: security group rule list .. code:: bash - os security group rule list + openstack security group rule list [--all-projects] [--protocol <protocol>] [--ingress | --egress] @@ -185,7 +185,7 @@ Display security group rule details .. program:: security group rule show .. code:: bash - os security group rule show + openstack security group rule show <rule> .. describe:: <rule> diff --git a/doc/source/command-objects/security-group.rst b/doc/source/command-objects/security-group.rst index 5157f530..a95a96f4 100644 --- a/doc/source/command-objects/security-group.rst +++ b/doc/source/command-objects/security-group.rst @@ -16,7 +16,7 @@ Create a new security group .. program:: security group create .. code:: bash - os security group create + openstack security group create [--description <description>] [--project <project> [--project-domain <project-domain>]] <name> @@ -50,7 +50,7 @@ Delete security group(s) .. program:: security group delete .. code:: bash - os security group delete + openstack security group delete <group> [<group> ...] .. describe:: <group> @@ -65,7 +65,7 @@ List security groups .. program:: security group list .. code:: bash - os security group list + openstack security group list [--all-projects] [--project <project> [--project-domain <project-domain>]] @@ -97,7 +97,7 @@ Set security group properties .. program:: security group set .. code:: bash - os security group set + openstack security group set [--name <new-name>] [--description <description>] <group> @@ -122,7 +122,7 @@ Display security group details .. program:: security group show .. code:: bash - os security group show + openstack security group show <group> .. describe:: <group> diff --git a/doc/source/command-objects/server-backup.rst b/doc/source/command-objects/server-backup.rst index 23e17d5f..9ddb2cdf 100644 --- a/doc/source/command-objects/server-backup.rst +++ b/doc/source/command-objects/server-backup.rst @@ -15,7 +15,7 @@ Create a server backup image .. program:: server create .. code:: bash - os server backup create + openstack server backup create [--name <image-name>] [--type <backup-type>] [--rotate <count>] diff --git a/doc/source/command-objects/server-group.rst b/doc/source/command-objects/server-group.rst index 414f49b1..77c6431c 100644 --- a/doc/source/command-objects/server-group.rst +++ b/doc/source/command-objects/server-group.rst @@ -14,7 +14,7 @@ Create a new server group .. program:: server group create .. code-block:: bash - os server group create + openstack server group create --policy <policy> [--policy <policy>] ... <name> @@ -36,7 +36,7 @@ Delete existing server group(s) .. program:: server group delete .. code-block:: bash - os server group delete + openstack server group delete <server-group> [<server-group> ...] .. describe:: <server-group> @@ -52,7 +52,7 @@ List all server groups .. program:: server group list .. code-block:: bash - os server group list + openstack server group list [--all-projects] [--long] @@ -72,7 +72,7 @@ Display server group details .. program:: server group show .. code-block:: bash - os server group show + openstack server group show <server-group> .. describe:: <server-group> diff --git a/doc/source/command-objects/server-image.rst b/doc/source/command-objects/server-image.rst index eb44e47e..7e625d9e 100644 --- a/doc/source/command-objects/server-image.rst +++ b/doc/source/command-objects/server-image.rst @@ -15,7 +15,7 @@ Create a new server disk image from an existing server .. program:: server image create .. code:: bash - os server image create + openstack server image create [--name <image-name>] [--wait] <server> diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index f099c271..40ecc047 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -12,7 +12,7 @@ Add fixed IP address to server .. program:: server add fixed ip .. code:: bash - os server add fixed ip + openstack server add fixed ip <server> <network> @@ -32,7 +32,7 @@ Add floating IP address to server .. program:: server add floating ip .. code:: bash - os server add floating ip + openstack server add floating ip <server> <ip-address> @@ -52,7 +52,7 @@ Add security group to server .. program:: server add security group .. code:: bash - os server add security group + openstack server add security group <server> <group> @@ -72,7 +72,7 @@ Add volume to server .. program:: server add volume .. code:: bash - os server add volume + openstack server add volume [--device <device>] <server> <volume> @@ -97,7 +97,7 @@ Create a new server .. program:: server create .. code:: bash - os server create + openstack server create --image <image> | --volume <volume> --flavor <flavor> [--security-group <security-group-name> [...] ] @@ -107,7 +107,7 @@ Create a new server [--user-data <user-data>] [--availability-zone <zone-name>] [--block-device-mapping <dev-name=mapping> [...] ] - [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid> [...] ] + [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none> [...] ] [--hint <key=value> [...] ] [--config-drive <value>|True ] [--min <count>] @@ -158,7 +158,7 @@ Create a new server Map block devices; map is <id>:<type>:<size(GB)>:<delete_on_terminate> (optional extension) -.. option:: --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid> +.. option:: --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid,auto,none> 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. @@ -166,6 +166,8 @@ Create a new server 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. .. option:: --hint <key=value> @@ -199,7 +201,7 @@ Delete server(s) .. program:: server delete .. code:: bash - os server delete + openstack server delete <server> [<server> ...] [--wait] .. option:: --wait @@ -222,7 +224,7 @@ resource. .. program:: server dump create .. code:: bash - os server dump create + openstack server dump create <server> [<server> ...] .. describe:: <server> @@ -236,7 +238,7 @@ List servers .. code:: bash - os server list + openstack server list [--reservation-id <reservation-id>] [--ip <ip-address-regex>] [--ip6 <ip6-address-regex>] @@ -333,7 +335,7 @@ Lock server(s). A non-admin user will not be able to execute actions .. program:: server lock .. code:: bash - os server lock + openstack server lock <server> [<server> ...] .. describe:: <server> @@ -348,7 +350,7 @@ Migrate server to different host .. program:: server migrate .. code:: bash - os server migrate + openstack server migrate --live <host> [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] @@ -377,7 +379,7 @@ Migrate server to different host .. option:: --wait - Wait for resize to complete + Wait for migrate to complete .. describe:: <server> @@ -391,7 +393,7 @@ Pause server(s) .. program:: server pause .. code:: bash - os server pause + openstack server pause <server> [<server> ...] .. describe:: <server> @@ -406,7 +408,7 @@ Perform a hard or soft server reboot .. program:: server reboot .. code:: bash - os server reboot + openstack server reboot [--hard | --soft] [--wait] <server> @@ -435,7 +437,7 @@ Rebuild server .. program:: server rebuild .. code:: bash - os server rebuild + openstack server rebuild [--image <image>] [--password <password>] [--wait] @@ -466,7 +468,7 @@ Remove fixed IP address from server .. program:: server remove fixed ip .. code:: bash - os server remove fixed ip + openstack server remove fixed ip <server> <ip-address> @@ -486,7 +488,7 @@ Remove floating IP address from server .. program:: server remove floating ip .. code:: bash - os server remove floating ip + openstack server remove floating ip <server> <ip-address> @@ -506,7 +508,7 @@ Remove security group from server .. program:: server remove security group .. code:: bash - os server remove security group + openstack server remove security group <server> <group> @@ -526,7 +528,7 @@ Remove volume from server .. program:: server remove volume .. code:: bash - os server remove volume + openstack server remove volume <server> <volume> @@ -546,7 +548,7 @@ Put server in rescue mode .. program:: server rescue .. code:: bash - os server rescue + openstack server rescue <server> .. describe:: <server> @@ -561,12 +563,12 @@ Scale server to a new flavor .. program:: server resize .. code:: bash - os server resize + openstack server resize --flavor <flavor> [--wait] <server> - os server resize + openstack server resize --confirm | --revert <server> @@ -604,7 +606,7 @@ Restore server(s) from soft-deleted state .. program:: server restore .. code:: bash - os server restore + openstack server restore <server> [<server> ...] .. describe:: <server> @@ -619,7 +621,7 @@ Resume server(s) .. program:: server resume .. code:: bash - os server resume + openstack server resume <server> [<server> ...] .. describe:: <server> @@ -634,7 +636,7 @@ Set server properties .. program:: server set .. code:: bash - os server set + openstack server set --name <new-name> --property <key=value> [--property <key=value>] ... @@ -671,7 +673,7 @@ Shelve server(s) .. program:: server shelve .. code:: bash - os server shelve + openstack server shelve <server> [<server> ...] .. describe:: <server> @@ -686,7 +688,7 @@ Show server details .. program:: server show .. code:: bash - os server show + openstack server show [--diagnostics] <server> @@ -706,7 +708,7 @@ SSH to server .. program:: server ssh .. code:: bash - os server ssh + openstack server ssh [--login <login-name>] [--port <port>] [--identity <keyfile>] @@ -754,7 +756,7 @@ Start server(s) .. program:: server start .. code:: bash - os server start + openstack server start <server> [<server> ...] .. describe:: <server> @@ -769,7 +771,7 @@ Stop server(s) .. program:: server stop .. code:: bash - os server stop + openstack server stop <server> [<server> ...] .. describe:: <server> @@ -784,7 +786,7 @@ Suspend server(s) .. program:: server suspend .. code:: bash - os server suspend + openstack server suspend <server> [<server> ...] .. describe:: <server> @@ -799,7 +801,7 @@ Unlock server(s) .. program:: server unlock .. code:: bash - os server unlock + openstack server unlock <server> [<server> ...] .. describe:: <server> @@ -814,7 +816,7 @@ Unpause server(s) .. program:: server unpause .. code:: bash - os server unpause + openstack server unpause <server> [<server> ...] .. describe:: <server> @@ -829,7 +831,7 @@ Restore server from rescue mode .. program:: server unrescue .. code:: bash - os server unrescue + openstack server unrescue <server> .. describe:: <server> @@ -844,7 +846,7 @@ Unset server properties .. program:: server unset .. code:: bash - os server unset + openstack server unset --property <key> [--property <key>] ... <server> @@ -866,7 +868,7 @@ Unshelve server(s) .. program:: server unshelve .. code:: bash - os server unshelve + openstack server unshelve <server> [<server> ...] .. describe:: <server> diff --git a/doc/source/command-objects/service-provider.rst b/doc/source/command-objects/service-provider.rst index e0fbba2f..63ef44e1 100644 --- a/doc/source/command-objects/service-provider.rst +++ b/doc/source/command-objects/service-provider.rst @@ -14,7 +14,7 @@ Create new service provider .. program:: service provider create .. code:: bash - os service provider create + openstack service provider create [--description <description>] [--enable | --disable] --auth-url <auth-url> @@ -53,7 +53,7 @@ Delete service provider(s) .. program:: service provider delete .. code:: bash - os service provider delete + openstack service provider delete <service-provider> [<service-provider> ...] .. describe:: <service-provider> @@ -68,7 +68,7 @@ List service providers .. program:: service provider list .. code:: bash - os service provider list + openstack service provider list service provider set -------------------- @@ -78,7 +78,7 @@ Set service provider properties .. program:: service provider set .. code:: bash - os service provider set + openstack service provider set [--enable | --disable] [--description <description>] [--auth-url <auth-url>] @@ -117,7 +117,7 @@ Display service provider details .. program:: service provider show .. code:: bash - os service provider show + openstack service provider show <service-provider> .. describe:: <service-provider> diff --git a/doc/source/command-objects/service.rst b/doc/source/command-objects/service.rst index b5ec2d99..a69c6950 100644 --- a/doc/source/command-objects/service.rst +++ b/doc/source/command-objects/service.rst @@ -12,7 +12,7 @@ Create new service .. program:: service create .. code-block:: bash - os service create + openstack service create [--name <name>] [--description <description>] [--enable | --disable] @@ -51,10 +51,10 @@ Delete service(s) .. program:: service delete .. code-block:: bash - os service delete + openstack service delete <service> [<service> ...] -.. _service_delete-type: +.. _service_delete-service: .. describe:: <service> Service(s) to delete (type, name or ID) @@ -67,7 +67,7 @@ List services .. program:: service list .. code-block:: bash - os service list + openstack service list [--long] .. option:: --long @@ -87,7 +87,7 @@ Set service properties .. program:: service set .. code-block:: bash - os service set + openstack service set [--type <type>] [--name <name>] [--description <description>] @@ -127,7 +127,7 @@ Display service details .. program:: service show .. code-block:: bash - os service show + openstack service show [--catalog] <service> diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst index e75693ca..c5c431d0 100644 --- a/doc/source/command-objects/snapshot.rst +++ b/doc/source/command-objects/snapshot.rst @@ -13,7 +13,7 @@ Create new snapshot .. program:: snapshot create .. code:: bash - os snapshot create + openstack snapshot create [--name <name>] [--description <description>] [--force] @@ -52,7 +52,7 @@ Delete snapshot(s) .. program:: snapshot delete .. code:: bash - os snapshot delete + openstack snapshot delete <snapshot> [<snapshot> ...] .. _snapshot_delete-snapshot: @@ -69,7 +69,7 @@ List snapshots .. program:: snapshot list .. code:: bash - os snapshot list + openstack snapshot list [--all-projects] [--long] [--limit <limit>] @@ -104,7 +104,7 @@ Set snapshot properties .. program:: snapshot set .. code:: bash - os snapshot set + openstack snapshot set [--name <name>] [--description <description>] [--property <key=value> [...] ] @@ -146,7 +146,7 @@ Display snapshot details .. program:: snapshot show .. code:: bash - os snapshot show + openstack snapshot show <snapshot> .. _snapshot_show-snapshot: @@ -163,7 +163,7 @@ Unset snapshot properties .. program:: snapshot unset .. code:: bash - os snapshot unset + openstack snapshot unset [--property <key>] <snapshot> diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index bd1356f3..8b59bf8a 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -15,7 +15,7 @@ Create subnet pool .. program:: subnet pool create .. code:: bash - os subnet pool create + openstack subnet pool create [--default-prefix-length <default-prefix-length>] [--min-prefix-length <min-prefix-length>] [--max-prefix-length <max-prefix-length>] @@ -91,7 +91,7 @@ Delete subnet pool(s) .. program:: subnet pool delete .. code:: bash - os subnet pool delete + openstack subnet pool delete <subnet-pool> [<subnet-pool> ...] .. _subnet_pool_delete-subnet-pool: @@ -107,7 +107,7 @@ List subnet pools .. program:: subnet pool list .. code:: bash - os subnet pool list + openstack subnet pool list [--long] [--share | --no-share] [--default | --no-default] @@ -160,7 +160,7 @@ Set subnet pool properties .. program:: subnet pool set .. code:: bash - os subnet pool set + openstack subnet pool set [--name <name>] [--pool-prefix <pool-prefix> [...]] [--default-prefix-length <default-prefix-length>] @@ -226,7 +226,7 @@ Display subnet pool details .. program:: subnet pool show .. code:: bash - os subnet pool show + openstack subnet pool show <subnet-pool> .. _subnet_pool_show-subnet-pool: @@ -242,7 +242,7 @@ Unset subnet pool properties .. program:: subnet pool unset .. code:: bash - os subnet pool unset + openstack subnet pool unset [--pool-prefix <pool-prefix> [...]] <subnet-pool> diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 61526192..5eb55c23 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -16,7 +16,7 @@ Create new subnet .. program:: subnet create .. code:: bash - os subnet create + openstack subnet create [--project <project> [--project-domain <project-domain>]] [--subnet-pool <subnet-pool> | --use-default-subnet-pool [--prefix-length <prefix-length>]] [--subnet-range <subnet-range>] @@ -49,7 +49,7 @@ Create new subnet .. option:: --use-default-subnet-pool - Use default subnet pool for ``--ip-version`` + Use default subnet pool for :option:`--ip-version` .. option:: --prefix-length <prefix-length> @@ -58,7 +58,7 @@ Create new subnet .. option:: --subnet-range <subnet-range> Subnet range in CIDR notation - (required if ``--subnet-pool`` is not specified, optional otherwise) + (required if :option:`--subnet-pool` is not specified, optional otherwise) .. option:: --allocation-pool start=<ip-address>,end=<ip-address> @@ -142,7 +142,7 @@ Delete subnet(s) .. program:: subnet delete .. code:: bash - os subnet delete + openstack subnet delete <subnet> [<subnet> ...] .. _subnet_delete-subnet: @@ -158,7 +158,7 @@ List subnets .. program:: subnet list .. code:: bash - os subnet list + openstack subnet list [--long] [--ip-version {4,6}] [--dhcp | --no-dhcp] @@ -226,7 +226,7 @@ Set subnet properties .. program:: subnet set .. code:: bash - os subnet set + openstack subnet set [--allocation-pool start=<ip-address>,end=<ip-address>] [--no-allocation-pool] [--dhcp | --no-dhcp] @@ -249,7 +249,7 @@ Set subnet properties .. option:: --no-allocation-pool Clear associated allocation pools from this subnet. - Specify both --allocation-pool and --no-allocation-pool + Specify both :option:`--allocation-pool` and :option:`--no-allocation-pool` to overwrite the current allocation pool information. .. option:: --dhcp @@ -267,7 +267,7 @@ Set subnet properties .. option:: --no-dns-nameservers Clear existing information of DNS servers. - Specify both --dns-nameserver and --no-dns-nameservers + Specify both :option:`--dns-nameserver` and :option:`--no-dns-nameservers` to overwrite the current DNS server information. .. option:: --gateway <gateway> @@ -287,7 +287,7 @@ Set subnet properties .. option:: --no-host-route Clear associated host routes from this subnet. - Specify both --host-route and --no-host-route + Specify both :option:`--host-route` and :option:`--no-host-route` to overwrite the current host route information. .. option:: --service-type <service-type> @@ -319,7 +319,7 @@ Display subnet details .. program:: subnet show .. code:: bash - os subnet show + openstack subnet show <subnet> .. _subnet_show-subnet: @@ -335,7 +335,7 @@ Unset subnet properties .. program:: subnet unset .. code:: bash - os subnet unset + openstack subnet unset [--allocation-pool start=<ip-address>,end=<ip-address> [...]] [--dns-nameserver <dns-nameserver> [...]] [--host-route destination=<subnet>,gateway=<ip-address> [...]] diff --git a/doc/source/command-objects/token.rst b/doc/source/command-objects/token.rst index 5e7c7b26..b4b14cd9 100644 --- a/doc/source/command-objects/token.rst +++ b/doc/source/command-objects/token.rst @@ -12,7 +12,7 @@ Issue new token .. program:: token issue .. code:: bash - os token issue + openstack token issue token revoke ------------ @@ -22,7 +22,7 @@ Revoke existing token .. program:: token revoke .. code:: bash - os token revoke + openstack token revoke <token> .. describe:: <token> diff --git a/doc/source/command-objects/trust.rst b/doc/source/command-objects/trust.rst index cb44c6b6..28459bca 100644 --- a/doc/source/command-objects/trust.rst +++ b/doc/source/command-objects/trust.rst @@ -12,7 +12,7 @@ Create new trust .. program:: trust create .. code:: bash - os trust create + openstack trust create --project <project> --role <role> [--impersonate] @@ -69,7 +69,7 @@ Delete trust(s) .. program:: trust delete .. code:: bash - os trust delete + openstack trust delete <trust> [<trust> ...] .. describe:: <trust> @@ -84,7 +84,7 @@ List trusts .. program:: trust list .. code:: bash - os trust list + openstack trust list trust show ---------- @@ -94,7 +94,7 @@ Display trust details .. program:: trust show .. code:: bash - os trust show + openstack trust show <trust> .. describe:: <trust> diff --git a/doc/source/command-objects/usage.rst b/doc/source/command-objects/usage.rst index 589123a6..9cd0f70e 100644 --- a/doc/source/command-objects/usage.rst +++ b/doc/source/command-objects/usage.rst @@ -12,7 +12,7 @@ List resource usage per project .. program:: usage list .. code:: bash - os usage list + openstack usage list [--start <start>] [--end <end>] @@ -32,7 +32,7 @@ Show resource usage for a single project .. program:: usage show .. code:: bash - os usage show + openstack usage show [--project <project>] [--start <start>] [--end <end>] diff --git a/doc/source/command-objects/user-role.rst b/doc/source/command-objects/user-role.rst index 8283f911..4f443f31 100644 --- a/doc/source/command-objects/user-role.rst +++ b/doc/source/command-objects/user-role.rst @@ -14,7 +14,7 @@ List user-role assignments .. program:: user role list .. code:: bash - os user role list + openstack user role list [--project <project>] [<user>] diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst index a9fee728..7e0ee21b 100644 --- a/doc/source/command-objects/user.rst +++ b/doc/source/command-objects/user.rst @@ -12,7 +12,7 @@ Create new user .. program:: user create .. code:: bash - os user create + openstack user create [--domain <domain>] [--project <project> [--project-domain <project-domain>]] [--password <password>] @@ -82,7 +82,7 @@ Delete user(s) .. program:: user delete .. code:: bash - os user delete + openstack user delete [--domain <domain>] <user> [<user> ...] @@ -105,7 +105,7 @@ List users .. program:: user list .. code:: bash - os user list + openstack user list [--project <project>] [--domain <domain>] [--group <group> | --project <project>] @@ -139,7 +139,7 @@ Set user properties .. program:: user set .. code:: bash - os user set + openstack user set [--name <name>] [--project <project> [--project-domain <project-domain>]] [--password <password>] @@ -200,7 +200,7 @@ Display user details .. program:: user show .. code:: bash - os user show + openstack user show [--domain <domain>] <user> diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst index 2cccffae..5e41e695 100644 --- a/doc/source/command-objects/volume-backup.rst +++ b/doc/source/command-objects/volume-backup.rst @@ -12,7 +12,7 @@ Create new volume backup .. program:: volume backup create .. code:: bash - os volume backup create + openstack volume backup create [--container <container>] [--name <name>] [--description <description>] @@ -64,7 +64,7 @@ Delete volume backup(s) .. program:: volume backup delete .. code:: bash - os volume backup delete + openstack volume backup delete [--force] <backup> [<backup> ...] @@ -87,7 +87,7 @@ List volume backups .. program:: volume backup list .. code:: bash - os volume backup list + openstack volume backup list [--long] [--name <name>] [--status <status>] @@ -138,7 +138,7 @@ Restore volume backup .. program:: volume backup restore .. code:: bash - os volume backup restore + openstack volume backup restore <backup> <volume> @@ -159,7 +159,7 @@ Set volume backup properties .. program:: volume backup set .. code:: bash - os volume backup set + openstack volume backup set [--name <name>] [--description <description>] [--state <state>] @@ -192,7 +192,7 @@ Display volume backup details .. program:: volume backup show .. code:: bash - os volume backup show + openstack volume backup show <backup> .. _volume_backup_show-backup: diff --git a/doc/source/command-objects/volume-host.rst b/doc/source/command-objects/volume-host.rst index 956fce52..a225e53e 100644 --- a/doc/source/command-objects/volume-host.rst +++ b/doc/source/command-objects/volume-host.rst @@ -12,7 +12,7 @@ Set volume host properties .. program:: volume host set .. code:: bash - os volume host set + openstack volume host set [--enable | --disable] <host-name> diff --git a/doc/source/command-objects/volume-qos.rst b/doc/source/command-objects/volume-qos.rst index 620c26ba..8fdbc122 100644 --- a/doc/source/command-objects/volume-qos.rst +++ b/doc/source/command-objects/volume-qos.rst @@ -12,7 +12,7 @@ Associate a QoS specification to a volume type .. program:: volume qos associate .. code:: bash - os volume qos associate + openstack volume qos associate <qos-spec> <volume-type> @@ -33,7 +33,7 @@ Create new QoS Specification .. program:: volume qos create .. code:: bash - os volume qos create + openstack volume qos create [--consumer <consumer>] [--property <key=value> [...] ] <name> @@ -59,7 +59,7 @@ Delete QoS specification .. program:: volume qos delete .. code:: bash - os volume qos delete + openstack volume qos delete [--force] <qos-spec> [<qos-spec> ...] @@ -80,7 +80,7 @@ Disassociate a QoS specification from a volume type .. program:: volume qos disassociate .. code:: bash - os volume qos disassociate + openstack volume qos disassociate --volume-type <volume-type> | --all <qos-spec> @@ -105,7 +105,7 @@ List QoS specifications .. program:: volume qos list .. code:: bash - os volume qos list + openstack volume qos list volume qos set -------------- @@ -115,7 +115,7 @@ Set QoS specification properties .. program:: volume qos set .. code:: bash - os volume qos set + openstack volume qos set [--property <key=value> [...] ] <qos-spec> @@ -136,7 +136,7 @@ Display QoS specification details .. program:: volume qos show .. code:: bash - os volume qos show + openstack volume qos show <qos-spec> .. _volume_qos_show-qos-spec: @@ -152,7 +152,7 @@ Unset QoS specification properties .. program:: volume qos unset .. code:: bash - os volume qos unset + openstack volume qos unset [--property <key> [...] ] <qos-spec> diff --git a/doc/source/command-objects/volume-service.rst b/doc/source/command-objects/volume-service.rst index 4fea41fe..2ad23240 100644 --- a/doc/source/command-objects/volume-service.rst +++ b/doc/source/command-objects/volume-service.rst @@ -12,12 +12,11 @@ List volume service .. program:: volume service list .. code:: bash - os volume service list + openstack volume service list [--host <host>] [--service <service>] [--long] -.. _volume-service-list: .. option:: --host <host> List services on specified host (name only) @@ -38,7 +37,7 @@ Set volume service properties .. program:: volume service set .. code:: bash - os volume service set + openstack volume service set [--enable | --disable] [--disable-reason <reason>] <host> @@ -54,9 +53,10 @@ Set volume service properties .. option:: --disable-reason <reason> - Reason for disabling the service (should be used with --disable option) + Reason for disabling the service + (should be used with :option:`--disable` option) -.. _volume-service-set: +.. _volume_service_set-host: .. describe:: <host> Name of host diff --git a/doc/source/command-objects/volume-snapshot.rst b/doc/source/command-objects/volume-snapshot.rst index 141e9f78..37a5088a 100644 --- a/doc/source/command-objects/volume-snapshot.rst +++ b/doc/source/command-objects/volume-snapshot.rst @@ -12,11 +12,12 @@ Create new volume snapshot .. program:: volume snapshot create .. code:: bash - os volume snapshot create + openstack volume snapshot create [--volume <volume>] [--description <description>] [--force] [--property <key=value> [...] ] + [--remote-source <key=value> [...]] <snapshot-name> .. option:: --volume <volume> @@ -37,6 +38,14 @@ Create new volume snapshot *Volume version 2 only* +.. option:: --remote-source <key=value> + + 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:: <snapshot-name> @@ -50,7 +59,7 @@ Delete volume snapshot(s) .. program:: volume snapshot delete .. code:: bash - os volume snapshot delete + openstack volume snapshot delete [--force] <snapshot> [<snapshot> ...] @@ -71,7 +80,7 @@ List volume snapshots .. program:: volume snapshot list .. code:: bash - os volume snapshot list + openstack volume snapshot list [--all-projects] [--long] [--limit <limit>] @@ -121,7 +130,7 @@ Set volume snapshot properties .. program:: volume snapshot set .. code:: bash - os volume snapshot set + openstack volume snapshot set [--name <name>] [--description <description>] [--property <key=value> [...] ] @@ -162,7 +171,7 @@ Display volume snapshot details .. program:: volume snapshot show .. code:: bash - os volume snapshot show + openstack volume snapshot show <snapshot> .. _volume_snapshot_show-snapshot: @@ -178,7 +187,7 @@ Unset volume snapshot properties .. program:: volume snapshot unset .. code:: bash - os volume snapshot unset + openstack volume snapshot unset [--property <key>] <snapshot> diff --git a/doc/source/command-objects/volume-transfer-request.rst b/doc/source/command-objects/volume-transfer-request.rst index b89289a8..77c36429 100644 --- a/doc/source/command-objects/volume-transfer-request.rst +++ b/doc/source/command-objects/volume-transfer-request.rst @@ -12,7 +12,7 @@ Accept volume transfer request .. program:: volume transfer request accept .. code:: bash - os volume transfer request accept + openstack volume transfer request accept <transfer-request> <auth-key> @@ -33,7 +33,7 @@ Create volume transfer request .. program:: volume transfer request create .. code:: bash - os volume transfer request create + openstack volume transfer request create [--name <name>] <volume> @@ -54,7 +54,7 @@ Delete volume transfer request(s) .. program:: volume transfer request delete .. code:: bash - os volume transfer request delete + openstack volume transfer request delete <transfer-request> [<transfer-request> ...] .. _volume_transfer_request_delete-transfer-request: @@ -70,7 +70,7 @@ Lists all volume transfer requests. .. program:: volume transfer request list .. code:: bash - os volume transfer request list + openstack volume transfer request list --all-projects .. option:: --all-projects @@ -86,7 +86,7 @@ Show volume transfer request details .. program:: volume transfer request show .. code:: bash - os volume transfer request show + openstack volume transfer request show <transfer-request> .. _volume_transfer_request_show-transfer-request: diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst index d93532c7..40e9825c 100644 --- a/doc/source/command-objects/volume-type.rst +++ b/doc/source/command-objects/volume-type.rst @@ -12,7 +12,7 @@ Create new volume type .. program:: volume type create .. code:: bash - os volume type create + openstack volume type create [--description <description>] [--public | --private] [--property <key=value> [...] ] @@ -69,7 +69,7 @@ Delete volume type(s) .. program:: volume type delete .. code:: bash - os volume type delete + openstack volume type delete <volume-type> [<volume-type> ...] .. _volume_type_delete-volume-type: @@ -85,9 +85,9 @@ List volume types .. program:: volume type list .. code:: bash - os volume type list + openstack volume type list [--long] - [--public | --private] + [--default | --public | --private] .. option:: --long @@ -105,6 +105,12 @@ List volume types *Volume version 2 only* +.. option:: --default + + List the default volume type + + *Volume version 2 only* + volume type set --------------- @@ -113,7 +119,7 @@ Set volume type properties .. program:: volume type set .. code:: bash - os volume type set + openstack volume type set [--name <name>] [--description <description>] [--property <key=value> [...] ] @@ -161,7 +167,7 @@ Display volume type details .. program:: volume type show .. code:: bash - os volume type show + openstack volume type show <volume-type> .. _volume_type_show-volume-type: @@ -177,7 +183,7 @@ Unset volume type properties .. program:: volume type unset .. code:: bash - os volume type unset + openstack volume type unset [--property <key> [...] ] [--project <project>] [--project-domain <project-domain>] diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index df4d6880..56c54552 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -12,7 +12,7 @@ Create new volume .. program:: volume create .. code:: bash - os volume create + openstack volume create [--size <size>] [--type <volume-type>] [--image <image> | --snapshot <snapshot> | --source <volume> | --source-replicated <replicated-volume>] @@ -24,6 +24,8 @@ Create new volume [--property <key=value> [...] ] [--hint <key=value> [...] ] [--multi-attach] + [--bootable | --non-bootable] + [--read-only | --read-write] <name> .. option:: --size <size> @@ -89,6 +91,22 @@ Create new volume 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:: <name> @@ -106,7 +124,7 @@ Delete volume(s) .. program:: volume delete .. code:: bash - os volume delete + openstack volume delete [--force | --purge] <volume> [<volume> ...] @@ -133,7 +151,7 @@ List volumes .. program:: volume list .. code:: bash - os volume list + openstack volume list [--project <project> [--project-domain <project-domain>]] [--user <user> [--user-domain <user-domain>]] [--name <name>] @@ -205,7 +223,7 @@ Migrate volume to a new host .. program:: volume migrate .. code:: bash - os volume migrate + openstack volume migrate --host <host> [--force-host-copy] [--lock-volume | --unlock-volume] @@ -247,7 +265,7 @@ Set volume properties .. program:: volume set .. code:: bash - os volume set + openstack volume set [--name <name>] [--size <size>] [--description <description>] @@ -340,7 +358,7 @@ Show volume details .. program:: volume show .. code:: bash - os volume show + openstack volume show <volume> .. _volume_show-volume: @@ -356,7 +374,7 @@ Unset volume properties .. program:: volume unset .. code:: bash - os volume unset + openstack volume unset [--property <key>] [--image-property <key>] <volume> |