diff options
Diffstat (limited to 'doc/source/command-objects')
57 files changed, 227 insertions, 222 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 f7572d97..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,7 @@ 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>]] @@ -110,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> @@ -140,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..0d2926db 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> @@ -36,7 +36,7 @@ Create a new aggregate .. program:: aggregate create .. code:: bash - os aggregate create + openstack aggregate create [--zone <availability-zone>] [--property <key=value> [...] ] <name> @@ -61,7 +61,7 @@ Delete existing aggregate(s) .. program:: aggregate delete .. code:: bash - os aggregate delete + openstack aggregate delete <aggregate> [<aggregate> ...] .. describe:: <aggregate> @@ -76,7 +76,7 @@ List all aggregates .. program:: aggregate list .. code:: bash - os aggregate list + openstack aggregate list [--long] .. option:: --long @@ -91,7 +91,7 @@ Remove host from aggregate .. program:: aggregate remove host .. code:: bash - os aggregate remove host + openstack aggregate remove host <aggregate> <host> @@ -112,7 +112,7 @@ Set aggregate properties .. program:: aggregate set .. code:: bash - os aggregate set + openstack aggregate set [--name <new-name>] [--zone <availability-zone>] [--property <key=value> [...] ] @@ -151,7 +151,7 @@ Display aggregate details .. program:: aggregate show .. code:: bash - os aggregate show + openstack aggregate show <aggregate> .. describe:: <aggregate> @@ -166,7 +166,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..66347214 100644 --- a/doc/source/command-objects/compute-service.rst +++ b/doc/source/command-objects/compute-service.rst @@ -12,7 +12,7 @@ Delete compute service(s) .. program:: compute service delete .. code:: bash - os compute service delete + openstack compute service delete <service> [<service> ...] .. _compute-service-delete: @@ -28,7 +28,7 @@ List compute services .. program:: compute service list .. code:: bash - os compute service list + openstack compute service list [--host <host>] [--service <service>] [--long] @@ -55,7 +55,7 @@ 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] 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 910fbba9..658d9425 100644 --- a/doc/source/command-objects/consistency-group.rst +++ b/doc/source/command-objects/consistency-group.rst @@ -12,7 +12,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>] @@ -52,7 +52,7 @@ Delete consistency group(s). .. program:: consistency group delete .. code:: bash - os consistency group delete + openstack consistency group delete [--force] <consistency-group> [<consistency-group> ...] @@ -73,7 +73,7 @@ List consistency groups. .. program:: consistency group list .. code:: bash - os consistency group list + openstack consistency group list [--all-projects] [--long] @@ -94,7 +94,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> @@ -120,7 +120,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..a4b26635 100644 --- a/doc/source/command-objects/group.rst +++ b/doc/source/command-objects/group.rst @@ -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 9564f099..1913355e 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> @@ -41,7 +41,7 @@ Create/upload an image .. program:: image create .. code:: bash - os image create + openstack image create [--id <id>] [--store <store>] [--container-format <container-format>] @@ -175,7 +175,7 @@ Delete image(s) .. program:: image delete .. code:: bash - os image delete + openstack image delete <image> .. describe:: <image> @@ -190,7 +190,7 @@ List available images .. program:: image list .. code:: bash - os image list + openstack image list [--public | --private | --shared] [--property <key=value>] [--long] @@ -244,7 +244,7 @@ Disassociate project with image .. program:: image remove project .. code:: bash - os image remove remove + openstack image remove remove [--project-domain <project-domain>] <image> <project> @@ -269,7 +269,7 @@ Save an image locally .. program:: image save .. code:: bash - os image save + openstack image save --file <filename> <image> @@ -291,7 +291,7 @@ Set image properties .. program:: image set .. code:: bash - os image set + openstack image set [--name <name>] [--min-disk <disk-gb>] [--min-ram <disk-ram>] @@ -495,7 +495,7 @@ Display image details .. program:: image show .. code:: bash - os image show + openstack image show <image> .. describe:: <image> @@ -512,7 +512,7 @@ Unset image tags or properties .. program:: image unset .. code:: bash - os image set + openstack image set [--tag <tag>] [--property <property>] <image> 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..9a302fbf 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>] 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/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..b95f2e50 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,7 @@ List network agents .. program:: network agent list .. code:: bash - os network agent list + openstack network agent list network agent set ----------------- @@ -44,7 +44,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 +74,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-rbac.rst b/doc/source/command-objects/network-rbac.rst index 113242f4..33fa6af4 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,7 @@ List network RBAC policies .. program:: network rbac list .. code:: bash - os network rbac list + openstack network rbac list network rbac set ---------------- @@ -88,7 +88,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 +114,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..3f6e3fc0 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] @@ -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 16a8258d..13e0a88d 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,7 +216,7 @@ Set router properties .. program:: router set .. code:: bash - os router set + openstack router set [--name <name>] [--enable | --disable] [--distributed | --centralized] @@ -300,7 +300,7 @@ Display router details .. program:: router show .. code:: bash - os router show + openstack router show <router> .. _router_show-router: @@ -316,8 +316,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> @@ -327,6 +328,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> |