From 446e6f2fa8a14efd49b42e09c13a45e9e1eec22c Mon Sep 17 00:00:00 2001 From: Kevin_Zheng Date: Tue, 20 Dec 2016 09:26:15 +0800 Subject: [PATCH] change os in command example to openstack(3) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1 --- .../command-objects/security-group-rule.rst | 8 +-- doc/source/command-objects/security-group.rst | 10 +-- doc/source/command-objects/server-backup.rst | 2 +- doc/source/command-objects/server-group.rst | 8 +-- doc/source/command-objects/server-image.rst | 2 +- doc/source/command-objects/server.rst | 66 +++++++++---------- .../command-objects/service-provider.rst | 10 +-- doc/source/command-objects/service.rst | 10 +-- doc/source/command-objects/snapshot.rst | 10 +-- doc/source/command-objects/subnet-pool.rst | 12 ++-- doc/source/command-objects/subnet.rst | 12 ++-- doc/source/command-objects/token.rst | 4 +- doc/source/command-objects/trust.rst | 8 +-- doc/source/command-objects/usage.rst | 4 +- doc/source/command-objects/user-role.rst | 2 +- doc/source/command-objects/user.rst | 10 +-- doc/source/command-objects/volume-backup.rst | 10 +-- doc/source/command-objects/volume-host.rst | 2 +- doc/source/command-objects/volume-qos.rst | 16 ++--- doc/source/command-objects/volume-service.rst | 4 +- .../command-objects/volume-snapshot.rst | 10 +-- .../volume-transfer-request.rst | 10 +-- doc/source/command-objects/volume-type.rst | 12 ++-- doc/source/command-objects/volume.rst | 14 ++-- doc/source/specs/command-objects/example.rst | 10 +-- doc/source/specs/network-topology.rst | 4 +- 26 files changed, 135 insertions(+), 135 deletions(-) diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index f53389cc05..1dbf16d22b 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 | --remote-group ] [--dst-port | [--icmp-type [--icmp-code ]]] [--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 [ ...] .. describe:: @@ -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 ] [--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 .. describe:: diff --git a/doc/source/command-objects/security-group.rst b/doc/source/command-objects/security-group.rst index 5157f53096..a95a96f49f 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 ] [--project [--project-domain ]] @@ -50,7 +50,7 @@ Delete security group(s) .. program:: security group delete .. code:: bash - os security group delete + openstack security group delete [ ...] .. describe:: @@ -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-domain ]] @@ -97,7 +97,7 @@ Set security group properties .. program:: security group set .. code:: bash - os security group set + openstack security group set [--name ] [--description ] @@ -122,7 +122,7 @@ Display security group details .. program:: security group show .. code:: bash - os security group show + openstack security group show .. describe:: diff --git a/doc/source/command-objects/server-backup.rst b/doc/source/command-objects/server-backup.rst index 23e17d5f5d..9ddb2cdfab 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 ] [--type ] [--rotate ] diff --git a/doc/source/command-objects/server-group.rst b/doc/source/command-objects/server-group.rst index 414f49b1aa..77c6431c1e 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 ] ... @@ -36,7 +36,7 @@ Delete existing server group(s) .. program:: server group delete .. code-block:: bash - os server group delete + openstack server group delete [ ...] .. describe:: @@ -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 .. describe:: diff --git a/doc/source/command-objects/server-image.rst b/doc/source/command-objects/server-image.rst index eb44e47e07..7e625d9e42 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 ] [--wait] diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index f099c271c9..c61153feaa 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -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 @@ -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 @@ -72,7 +72,7 @@ Add volume to server .. program:: server add volume .. code:: bash - os server add volume + openstack server add volume [--device ] @@ -97,7 +97,7 @@ Create a new server .. program:: server create .. code:: bash - os server create + openstack server create --image | --volume --flavor [--security-group [...] ] @@ -199,7 +199,7 @@ Delete server(s) .. program:: server delete .. code:: bash - os server delete + openstack server delete [ ...] [--wait] .. option:: --wait @@ -222,7 +222,7 @@ resource. .. program:: server dump create .. code:: bash - os server dump create + openstack server dump create [ ...] .. describe:: @@ -236,7 +236,7 @@ List servers .. code:: bash - os server list + openstack server list [--reservation-id ] [--ip ] [--ip6 ] @@ -333,7 +333,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 [ ...] .. describe:: @@ -348,7 +348,7 @@ Migrate server to different host .. program:: server migrate .. code:: bash - os server migrate + openstack server migrate --live [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] @@ -391,7 +391,7 @@ Pause server(s) .. program:: server pause .. code:: bash - os server pause + openstack server pause [ ...] .. describe:: @@ -406,7 +406,7 @@ Perform a hard or soft server reboot .. program:: server reboot .. code:: bash - os server reboot + openstack server reboot [--hard | --soft] [--wait] @@ -435,7 +435,7 @@ Rebuild server .. program:: server rebuild .. code:: bash - os server rebuild + openstack server rebuild [--image ] [--password ] [--wait] @@ -466,7 +466,7 @@ Remove fixed IP address from server .. program:: server remove fixed ip .. code:: bash - os server remove fixed ip + openstack server remove fixed ip @@ -486,7 +486,7 @@ Remove floating IP address from server .. program:: server remove floating ip .. code:: bash - os server remove floating ip + openstack server remove floating ip @@ -506,7 +506,7 @@ Remove security group from server .. program:: server remove security group .. code:: bash - os server remove security group + openstack server remove security group @@ -526,7 +526,7 @@ Remove volume from server .. program:: server remove volume .. code:: bash - os server remove volume + openstack server remove volume @@ -546,7 +546,7 @@ Put server in rescue mode .. program:: server rescue .. code:: bash - os server rescue + openstack server rescue .. describe:: @@ -561,12 +561,12 @@ Scale server to a new flavor .. program:: server resize .. code:: bash - os server resize + openstack server resize --flavor [--wait] - os server resize + openstack server resize --confirm | --revert @@ -604,7 +604,7 @@ Restore server(s) from soft-deleted state .. program:: server restore .. code:: bash - os server restore + openstack server restore [ ...] .. describe:: @@ -619,7 +619,7 @@ Resume server(s) .. program:: server resume .. code:: bash - os server resume + openstack server resume [ ...] .. describe:: @@ -634,7 +634,7 @@ Set server properties .. program:: server set .. code:: bash - os server set + openstack server set --name --property [--property ] ... @@ -671,7 +671,7 @@ Shelve server(s) .. program:: server shelve .. code:: bash - os server shelve + openstack server shelve [ ...] .. describe:: @@ -686,7 +686,7 @@ Show server details .. program:: server show .. code:: bash - os server show + openstack server show [--diagnostics] @@ -706,7 +706,7 @@ SSH to server .. program:: server ssh .. code:: bash - os server ssh + openstack server ssh [--login ] [--port ] [--identity ] @@ -754,7 +754,7 @@ Start server(s) .. program:: server start .. code:: bash - os server start + openstack server start [ ...] .. describe:: @@ -769,7 +769,7 @@ Stop server(s) .. program:: server stop .. code:: bash - os server stop + openstack server stop [ ...] .. describe:: @@ -784,7 +784,7 @@ Suspend server(s) .. program:: server suspend .. code:: bash - os server suspend + openstack server suspend [ ...] .. describe:: @@ -799,7 +799,7 @@ Unlock server(s) .. program:: server unlock .. code:: bash - os server unlock + openstack server unlock [ ...] .. describe:: @@ -814,7 +814,7 @@ Unpause server(s) .. program:: server unpause .. code:: bash - os server unpause + openstack server unpause [ ...] .. describe:: @@ -829,7 +829,7 @@ Restore server from rescue mode .. program:: server unrescue .. code:: bash - os server unrescue + openstack server unrescue .. describe:: @@ -844,7 +844,7 @@ Unset server properties .. program:: server unset .. code:: bash - os server unset + openstack server unset --property [--property ] ... @@ -866,7 +866,7 @@ Unshelve server(s) .. program:: server unshelve .. code:: bash - os server unshelve + openstack server unshelve [ ...] .. describe:: diff --git a/doc/source/command-objects/service-provider.rst b/doc/source/command-objects/service-provider.rst index e0fbba2fe9..63ef44e1f2 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 ] [--enable | --disable] --auth-url @@ -53,7 +53,7 @@ Delete service provider(s) .. program:: service provider delete .. code:: bash - os service provider delete + openstack service provider delete [ ...] .. describe:: @@ -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 ] [--auth-url ] @@ -117,7 +117,7 @@ Display service provider details .. program:: service provider show .. code:: bash - os service provider show + openstack service provider show .. describe:: diff --git a/doc/source/command-objects/service.rst b/doc/source/command-objects/service.rst index b5ec2d9962..250d19ec3d 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 ] [--description ] [--enable | --disable] @@ -51,7 +51,7 @@ Delete service(s) .. program:: service delete .. code-block:: bash - os service delete + openstack service delete [ ...] .. _service_delete-type: @@ -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 ] [--name ] [--description ] @@ -127,7 +127,7 @@ Display service details .. program:: service show .. code-block:: bash - os service show + openstack service show [--catalog] diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst index e75693ca18..e4a5be6d10 100644 --- a/doc/source/command-objects/snapshot.rst +++ b/doc/source/command-objects/snapshot.rst @@ -52,7 +52,7 @@ Delete snapshot(s) .. program:: snapshot delete .. code:: bash - os snapshot delete + openstack snapshot delete [ ...] .. _snapshot_delete-snapshot: @@ -69,7 +69,7 @@ List snapshots .. program:: snapshot list .. code:: bash - os snapshot list + openstack snapshot list [--all-projects] [--long] [--limit ] @@ -104,7 +104,7 @@ Set snapshot properties .. program:: snapshot set .. code:: bash - os snapshot set + openstack snapshot set [--name ] [--description ] [--property [...] ] @@ -146,7 +146,7 @@ Display snapshot details .. program:: snapshot show .. code:: bash - os snapshot show + openstack snapshot show .. _snapshot_show-snapshot: @@ -163,7 +163,7 @@ Unset snapshot properties .. program:: snapshot unset .. code:: bash - os snapshot unset + openstack snapshot unset [--property ] diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index bd1356f394..8b59bf8a65 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 ] [--min-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_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 ] [--pool-prefix [...]] [--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_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 [...]] diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 6152619292..fb28793e76 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-domain ]] [--subnet-pool | --use-default-subnet-pool [--prefix-length ]] [--subnet-range ] @@ -142,7 +142,7 @@ Delete subnet(s) .. program:: subnet delete .. code:: bash - os subnet delete + openstack subnet delete [ ...] .. _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=,end=] [--no-allocation-pool] [--dhcp | --no-dhcp] @@ -319,7 +319,7 @@ Display subnet details .. program:: subnet show .. code:: bash - os subnet show + openstack subnet show .. _subnet_show-subnet: @@ -335,7 +335,7 @@ Unset subnet properties .. program:: subnet unset .. code:: bash - os subnet unset + openstack subnet unset [--allocation-pool start=,end= [...]] [--dns-nameserver [...]] [--host-route destination=,gateway= [...]] diff --git a/doc/source/command-objects/token.rst b/doc/source/command-objects/token.rst index 5e7c7b2686..b4b14cd9fd 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 .. describe:: diff --git a/doc/source/command-objects/trust.rst b/doc/source/command-objects/trust.rst index cb44c6b6cd..28459bcaf6 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 --role [--impersonate] @@ -69,7 +69,7 @@ Delete trust(s) .. program:: trust delete .. code:: bash - os trust delete + openstack trust delete [ ...] .. describe:: @@ -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 .. describe:: diff --git a/doc/source/command-objects/usage.rst b/doc/source/command-objects/usage.rst index 589123a65b..9cd0f70eb3 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 ] [--end ] @@ -32,7 +32,7 @@ Show resource usage for a single project .. program:: usage show .. code:: bash - os usage show + openstack usage show [--project ] [--start ] [--end ] diff --git a/doc/source/command-objects/user-role.rst b/doc/source/command-objects/user-role.rst index 8283f91110..4f443f3126 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 ] [] diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst index a9fee72811..7e0ee21b0f 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 ] [--project [--project-domain ]] [--password ] @@ -82,7 +82,7 @@ Delete user(s) .. program:: user delete .. code:: bash - os user delete + openstack user delete [--domain ] [ ...] @@ -105,7 +105,7 @@ List users .. program:: user list .. code:: bash - os user list + openstack user list [--project ] [--domain ] [--group | --project ] @@ -139,7 +139,7 @@ Set user properties .. program:: user set .. code:: bash - os user set + openstack user set [--name ] [--project [--project-domain ]] [--password ] @@ -200,7 +200,7 @@ Display user details .. program:: user show .. code:: bash - os user show + openstack user show [--domain ] diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst index 2cccffae93..3c329b94df 100644 --- a/doc/source/command-objects/volume-backup.rst +++ b/doc/source/command-objects/volume-backup.rst @@ -64,7 +64,7 @@ Delete volume backup(s) .. program:: volume backup delete .. code:: bash - os volume backup delete + openstack volume backup delete [--force] [ ...] @@ -87,7 +87,7 @@ List volume backups .. program:: volume backup list .. code:: bash - os volume backup list + openstack volume backup list [--long] [--name ] [--status ] @@ -138,7 +138,7 @@ Restore volume backup .. program:: volume backup restore .. code:: bash - os volume backup restore + openstack volume backup restore @@ -159,7 +159,7 @@ Set volume backup properties .. program:: volume backup set .. code:: bash - os volume backup set + openstack volume backup set [--name ] [--description ] [--state ] @@ -192,7 +192,7 @@ Display volume backup details .. program:: volume backup show .. code:: bash - os volume backup show + openstack volume backup show .. _volume_backup_show-backup: diff --git a/doc/source/command-objects/volume-host.rst b/doc/source/command-objects/volume-host.rst index 956fce525b..a225e53e58 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] diff --git a/doc/source/command-objects/volume-qos.rst b/doc/source/command-objects/volume-qos.rst index 620c26bafb..8fdbc12284 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 @@ -33,7 +33,7 @@ Create new QoS Specification .. program:: volume qos create .. code:: bash - os volume qos create + openstack volume qos create [--consumer ] [--property [...] ] @@ -59,7 +59,7 @@ Delete QoS specification .. program:: volume qos delete .. code:: bash - os volume qos delete + openstack volume qos delete [--force] [ ...] @@ -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 | --all @@ -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 [...] ] @@ -136,7 +136,7 @@ Display QoS specification details .. program:: volume qos show .. code:: bash - os volume qos show + openstack volume qos show .. _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 [...] ] diff --git a/doc/source/command-objects/volume-service.rst b/doc/source/command-objects/volume-service.rst index 4fea41fe26..842d9cb23a 100644 --- a/doc/source/command-objects/volume-service.rst +++ b/doc/source/command-objects/volume-service.rst @@ -12,7 +12,7 @@ List volume service .. program:: volume service list .. code:: bash - os volume service list + openstack volume service list [--host ] [--service ] [--long] @@ -38,7 +38,7 @@ Set volume service properties .. program:: volume service set .. code:: bash - os volume service set + openstack volume service set [--enable | --disable] [--disable-reason ] diff --git a/doc/source/command-objects/volume-snapshot.rst b/doc/source/command-objects/volume-snapshot.rst index 1744903515..e34bad0042 100644 --- a/doc/source/command-objects/volume-snapshot.rst +++ b/doc/source/command-objects/volume-snapshot.rst @@ -59,7 +59,7 @@ Delete volume snapshot(s) .. program:: volume snapshot delete .. code:: bash - os volume snapshot delete + openstack volume snapshot delete [--force] [ ...] @@ -80,7 +80,7 @@ List volume snapshots .. program:: volume snapshot list .. code:: bash - os volume snapshot list + openstack volume snapshot list [--all-projects] [--long] [--limit ] @@ -130,7 +130,7 @@ Set volume snapshot properties .. program:: volume snapshot set .. code:: bash - os volume snapshot set + openstack volume snapshot set [--name ] [--description ] [--property [...] ] @@ -171,7 +171,7 @@ Display volume snapshot details .. program:: volume snapshot show .. code:: bash - os volume snapshot show + openstack volume snapshot show .. _volume_snapshot_show-snapshot: @@ -187,7 +187,7 @@ Unset volume snapshot properties .. program:: volume snapshot unset .. code:: bash - os volume snapshot unset + openstack volume snapshot unset [--property ] diff --git a/doc/source/command-objects/volume-transfer-request.rst b/doc/source/command-objects/volume-transfer-request.rst index b89289a81e..77c3642964 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 @@ -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 ] @@ -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 [ ...] .. _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 .. _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 72422b5c25..40e9825c87 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 ] [--public | --private] [--property [...] ] @@ -69,7 +69,7 @@ Delete volume type(s) .. program:: volume type delete .. code:: bash - os volume type delete + openstack volume type delete [ ...] .. _volume_type_delete-volume-type: @@ -85,7 +85,7 @@ List volume types .. program:: volume type list .. code:: bash - os volume type list + openstack volume type list [--long] [--default | --public | --private] @@ -119,7 +119,7 @@ Set volume type properties .. program:: volume type set .. code:: bash - os volume type set + openstack volume type set [--name ] [--description ] [--property [...] ] @@ -167,7 +167,7 @@ Display volume type details .. program:: volume type show .. code:: bash - os volume type show + openstack volume type show .. _volume_type_show-volume-type: @@ -183,7 +183,7 @@ Unset volume type properties .. program:: volume type unset .. code:: bash - os volume type unset + openstack volume type unset [--property [...] ] [--project ] [--project-domain ] diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index 5383386f5b..56c5455283 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 ] [--type ] [--image | --snapshot | --source | --source-replicated ] @@ -124,7 +124,7 @@ Delete volume(s) .. program:: volume delete .. code:: bash - os volume delete + openstack volume delete [--force | --purge] [ ...] @@ -151,7 +151,7 @@ List volumes .. program:: volume list .. code:: bash - os volume list + openstack volume list [--project [--project-domain ]] [--user [--user-domain ]] [--name ] @@ -223,7 +223,7 @@ Migrate volume to a new host .. program:: volume migrate .. code:: bash - os volume migrate + openstack volume migrate --host [--force-host-copy] [--lock-volume | --unlock-volume] @@ -265,7 +265,7 @@ Set volume properties .. program:: volume set .. code:: bash - os volume set + openstack volume set [--name ] [--size ] [--description ] @@ -358,7 +358,7 @@ Show volume details .. program:: volume show .. code:: bash - os volume show + openstack volume show .. _volume_show-volume: @@ -374,7 +374,7 @@ Unset volume properties .. program:: volume unset .. code:: bash - os volume unset + openstack volume unset [--property ] [--image-property ] diff --git a/doc/source/specs/command-objects/example.rst b/doc/source/specs/command-objects/example.rst index f596978f41..fa559433e2 100644 --- a/doc/source/specs/command-objects/example.rst +++ b/doc/source/specs/command-objects/example.rst @@ -18,7 +18,7 @@ Create new example .. program:: example create .. code:: bash - os example create + openstack example create .. describe:: @@ -33,7 +33,7 @@ Delete example(s) .. program:: example delete .. code:: bash - os example delete + openstack example delete [ ...] .. describe:: @@ -48,7 +48,7 @@ List examples .. program:: example list .. code:: bash - os example list + openstack example list example set ----------- @@ -58,7 +58,7 @@ Set example properties .. program:: example set .. code:: bash - os example set + openstack example set [--name ] @@ -78,7 +78,7 @@ Display example details .. program:: example show .. code:: bash - os example show + openstack example show .. describe:: diff --git a/doc/source/specs/network-topology.rst b/doc/source/specs/network-topology.rst index 6f9c8532d6..a0218a1e1b 100755 --- a/doc/source/specs/network-topology.rst +++ b/doc/source/specs/network-topology.rst @@ -19,7 +19,7 @@ List network topologies .. program:: network topology list .. code:: bash - os network topology list + openstack network topology list [--project ] .. option:: --project @@ -35,7 +35,7 @@ Show network topology details .. program:: network topology show .. code:: bash - os network topology show + openstack network topology show .. _network_topology_show-network