openstack/python-openstackclient
Code Issues Proposed changes

change os in command example to openstack(3)

Browse Source 
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
This commit is contained in:
Kevin_Zheng 2016-12-20 09:26:15 +08:00
parent e51a2b3b17
commit 446e6f2fa8
26 changed files with 135 additions and 135 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/command-objects/security-group-rule.rst
View File

@ -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>

10
doc/source/command-objects/security-group.rst
View File

@ -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>

2
doc/source/command-objects/server-backup.rst
View File

@ -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>]

8
doc/source/command-objects/server-group.rst
View File

@ -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>

2
doc/source/command-objects/server-image.rst
View File

@ -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>

66
doc/source/command-objects/server.rst
View File

@ -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> [...] ]
@ -199,7 +199,7 @@ Delete server(s)
.. program:: server delete
.. code:: bash
os server delete
openstack server delete
<server> [<server> ...] [--wait]
.. option:: --wait
@ -222,7 +222,7 @@ resource.
.. program:: server dump create
.. code:: bash
os server dump create
openstack server dump create
<server> [<server> ...]
.. describe:: <server>
@ -236,7 +236,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 +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
<server> [<server> ...]
.. describe:: <server>
@ -348,7 +348,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]
@ -391,7 +391,7 @@ Pause server(s)
.. program:: server pause
.. code:: bash
os server pause
openstack server pause
<server> [<server> ...]
.. describe:: <server>
@ -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]
<server>
@ -435,7 +435,7 @@ Rebuild server
.. program:: server rebuild
.. code:: bash
os server rebuild
openstack server rebuild
[--image <image>]
[--password <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
<server>
<ip-address>
@ -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
<server>
<ip-address>
@ -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
<server>
<group>
@ -526,7 +526,7 @@ Remove volume from server
.. program:: server remove volume
.. code:: bash
os server remove volume
openstack server remove volume
<server>
<volume>
@ -546,7 +546,7 @@ Put server in rescue mode
.. program:: server rescue
.. code:: bash
os server rescue
openstack server rescue
<server>
.. describe:: <server>
@ -561,12 +561,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 +604,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 +619,7 @@ Resume server(s)
.. program:: server resume
.. code:: bash
os server resume
openstack server resume
<server> [<server> ...]
.. describe:: <server>
@ -634,7 +634,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 +671,7 @@ Shelve server(s)
.. program:: server shelve
.. code:: bash
os server shelve
openstack server shelve
<server> [<server> ...]
.. describe:: <server>
@ -686,7 +686,7 @@ Show server details
.. program:: server show
.. code:: bash
os server show
openstack server show
[--diagnostics]
<server>
@ -706,7 +706,7 @@ SSH to server
.. program:: server ssh
.. code:: bash
os server ssh
openstack server ssh
[--login <login-name>]
[--port <port>]
[--identity <keyfile>]
@ -754,7 +754,7 @@ Start server(s)
.. program:: server start
.. code:: bash
os server start
openstack server start
<server> [<server> ...]
.. describe:: <server>
@ -769,7 +769,7 @@ Stop server(s)
.. program:: server stop
.. code:: bash
os server stop
openstack server stop
<server> [<server> ...]
.. describe:: <server>
@ -784,7 +784,7 @@ Suspend server(s)
.. program:: server suspend
.. code:: bash
os server suspend
openstack server suspend
<server> [<server> ...]
.. describe:: <server>
@ -799,7 +799,7 @@ Unlock server(s)
.. program:: server unlock
.. code:: bash
os server unlock
openstack server unlock
<server> [<server> ...]
.. describe:: <server>
@ -814,7 +814,7 @@ Unpause server(s)
.. program:: server unpause
.. code:: bash
os server unpause
openstack server unpause
<server> [<server> ...]
.. describe:: <server>
@ -829,7 +829,7 @@ Restore server from rescue mode
.. program:: server unrescue
.. code:: bash
os server unrescue
openstack server unrescue
<server>
.. describe:: <server>
@ -844,7 +844,7 @@ Unset server properties
.. program:: server unset
.. code:: bash
os server unset
openstack server unset
--property <key>
[--property <key>] ...
<server>
@ -866,7 +866,7 @@ Unshelve server(s)
.. program:: server unshelve
.. code:: bash
os server unshelve
openstack server unshelve
<server> [<server> ...]
.. describe:: <server>

10
doc/source/command-objects/service-provider.rst
View File

@ -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>

10
doc/source/command-objects/service.rst
View File

@ -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,7 +51,7 @@ Delete service(s)
.. program:: service delete
.. code-block:: bash
os service delete
openstack service delete
<service> [<service> ...]
.. _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 <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>

10
doc/source/command-objects/snapshot.rst
View File

@ -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>

12
doc/source/command-objects/subnet-pool.rst
View File

@ -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>

12
doc/source/command-objects/subnet.rst
View File

@ -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>]
@ -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]
@ -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> [...]]

4
doc/source/command-objects/token.rst
View File

@ -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>

8
doc/source/command-objects/trust.rst
View File

@ -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>

4
doc/source/command-objects/usage.rst
View File

@ -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>]

2
doc/source/command-objects/user-role.rst
View File

@ -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>]

10
doc/source/command-objects/user.rst
View File

@ -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>

10
doc/source/command-objects/volume-backup.rst
View File

@ -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:

2
doc/source/command-objects/volume-host.rst
View File

@ -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>

16
doc/source/command-objects/volume-qos.rst
View File

@ -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>

4
doc/source/command-objects/volume-service.rst
View File

@ -12,7 +12,7 @@ List volume service
.. program:: volume service list
.. code:: bash
os volume service list
openstack volume service list
[--host <host>]
[--service <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 <reason>]
<host>

10
doc/source/command-objects/volume-snapshot.rst
View File

@ -59,7 +59,7 @@ Delete volume snapshot(s)
.. program:: volume snapshot delete
.. code:: bash
os volume snapshot delete
openstack volume snapshot delete
[--force]
<snapshot> [<snapshot> ...]
@ -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 <limit>]
@ -130,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> [...] ]
@ -171,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:
@ -187,7 +187,7 @@ Unset volume snapshot properties
.. program:: volume snapshot unset
.. code:: bash
os volume snapshot unset
openstack volume snapshot unset
[--property <key>]
<snapshot>

10
doc/source/command-objects/volume-transfer-request.rst
View File

@ -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:

12
doc/source/command-objects/volume-type.rst
View File

@ -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,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 <name>]
[--description <description>]
[--property <key=value> [...] ]
@ -167,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:
@ -183,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>]

14
doc/source/command-objects/volume.rst
View File

@ -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>]
@ -124,7 +124,7 @@ Delete volume(s)
.. program:: volume delete
.. code:: bash
os volume delete
openstack volume delete
[--force | --purge]
<volume> [<volume> ...]
@ -151,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>]
@ -223,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]
@ -265,7 +265,7 @@ Set volume properties
.. program:: volume set
.. code:: bash
os volume set
openstack volume set
[--name <name>]
[--size <size>]
[--description <description>]
@ -358,7 +358,7 @@ Show volume details
.. program:: volume show
.. code:: bash
os volume show
openstack volume show
<volume>
.. _volume_show-volume:
@ -374,7 +374,7 @@ Unset volume properties
.. program:: volume unset
.. code:: bash
os volume unset
openstack volume unset
[--property <key>]
[--image-property <key>]
<volume>

10
doc/source/specs/command-objects/example.rst
View File

@ -18,7 +18,7 @@ Create new example
.. program:: example create
.. code:: bash
os example create
openstack example create
<name>
.. describe:: <name>
@ -33,7 +33,7 @@ Delete example(s)
.. program:: example delete
.. code:: bash
os example delete
openstack example delete
<example> [<example> ...]
.. describe:: <example>
@ -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 <new-name>]
<example>
@ -78,7 +78,7 @@ Display example details
.. program:: example show
.. code:: bash
os example show
openstack example show
<example>
.. describe:: <example>

4
doc/source/specs/network-topology.rst
View File

@ -19,7 +19,7 @@ List network topologies
.. program:: network topology list
.. code:: bash
os network topology list
openstack network topology list
[--project <project>]
.. option:: --project <project>
@ -35,7 +35,7 @@ Show network topology details
.. program:: network topology show
.. code:: bash
os network topology show
openstack network topology show
<network>
.. _network_topology_show-network