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

View File

@ -15,7 +15,7 @@ Create a new security group rule
.. program:: security group rule create .. program:: security group rule create
.. code:: bash .. code:: bash
os security group rule create openstack security group rule create
[--remote-ip <ip-address> | --remote-group <group>] [--remote-ip <ip-address> | --remote-group <group>]
[--dst-port <port-range> | [--icmp-type <icmp-type> [--icmp-code <icmp-code>]]] [--dst-port <port-range> | [--icmp-type <icmp-type> [--icmp-code <icmp-code>]]]
[--protocol <protocol>] [--protocol <protocol>]
@ -116,7 +116,7 @@ Delete security group rule(s)
.. program:: security group rule delete .. program:: security group rule delete
.. code:: bash .. code:: bash
os security group rule delete openstack security group rule delete
<rule> [<rule> ...] <rule> [<rule> ...]
.. describe:: <rule> .. describe:: <rule>
@ -131,7 +131,7 @@ List security group rules
.. program:: security group rule list .. program:: security group rule list
.. code:: bash .. code:: bash
os security group rule list openstack security group rule list
[--all-projects] [--all-projects]
[--protocol <protocol>] [--protocol <protocol>]
[--ingress | --egress] [--ingress | --egress]
@ -185,7 +185,7 @@ Display security group rule details
.. program:: security group rule show .. program:: security group rule show
.. code:: bash .. code:: bash
os security group rule show openstack security group rule show
<rule> <rule>
.. describe:: <rule> .. describe:: <rule>

View File

@ -16,7 +16,7 @@ Create a new security group
.. program:: security group create .. program:: security group create
.. code:: bash .. code:: bash
os security group create openstack security group create
[--description <description>] [--description <description>]
[--project <project> [--project-domain <project-domain>]] [--project <project> [--project-domain <project-domain>]]
<name> <name>
@ -50,7 +50,7 @@ Delete security group(s)
.. program:: security group delete .. program:: security group delete
.. code:: bash .. code:: bash
os security group delete openstack security group delete
<group> [<group> ...] <group> [<group> ...]
.. describe:: <group> .. describe:: <group>
@ -65,7 +65,7 @@ List security groups
.. program:: security group list .. program:: security group list
.. code:: bash .. code:: bash
os security group list openstack security group list
[--all-projects] [--all-projects]
[--project <project> [--project-domain <project-domain>]] [--project <project> [--project-domain <project-domain>]]
@ -97,7 +97,7 @@ Set security group properties
.. program:: security group set .. program:: security group set
.. code:: bash .. code:: bash
os security group set openstack security group set
[--name <new-name>] [--name <new-name>]
[--description <description>] [--description <description>]
<group> <group>
@ -122,7 +122,7 @@ Display security group details
.. program:: security group show .. program:: security group show
.. code:: bash .. code:: bash
os security group show openstack security group show
<group> <group>
.. describe:: <group> .. describe:: <group>

View File

@ -15,7 +15,7 @@ Create a server backup image
.. program:: server create .. program:: server create
.. code:: bash .. code:: bash
os server backup create openstack server backup create
[--name <image-name>] [--name <image-name>]
[--type <backup-type>] [--type <backup-type>]
[--rotate <count>] [--rotate <count>]

View File

@ -14,7 +14,7 @@ Create a new server group
.. program:: server group create .. program:: server group create
.. code-block:: bash .. code-block:: bash
os server group create openstack server group create
--policy <policy> [--policy <policy>] ... --policy <policy> [--policy <policy>] ...
<name> <name>
@ -36,7 +36,7 @@ Delete existing server group(s)
.. program:: server group delete .. program:: server group delete
.. code-block:: bash .. code-block:: bash
os server group delete openstack server group delete
<server-group> [<server-group> ...] <server-group> [<server-group> ...]
.. describe:: <server-group> .. describe:: <server-group>
@ -52,7 +52,7 @@ List all server groups
.. program:: server group list .. program:: server group list
.. code-block:: bash .. code-block:: bash
os server group list openstack server group list
[--all-projects] [--all-projects]
[--long] [--long]
@ -72,7 +72,7 @@ Display server group details
.. program:: server group show .. program:: server group show
.. code-block:: bash .. code-block:: bash
os server group show openstack server group show
<server-group> <server-group>
.. describe:: <server-group> .. describe:: <server-group>

View File

@ -15,7 +15,7 @@ Create a new server disk image from an existing server
.. program:: server image create .. program:: server image create
.. code:: bash .. code:: bash
os server image create openstack server image create
[--name <image-name>] [--name <image-name>]
[--wait] [--wait]
<server> <server>

View File

@ -32,7 +32,7 @@ Add floating IP address to server
.. program:: server add floating ip .. program:: server add floating ip
.. code:: bash .. code:: bash
os server add floating ip openstack server add floating ip
<server> <server>
<ip-address> <ip-address>
@ -52,7 +52,7 @@ Add security group to server
.. program:: server add security group .. program:: server add security group
.. code:: bash .. code:: bash
os server add security group openstack server add security group
<server> <server>
<group> <group>
@ -72,7 +72,7 @@ Add volume to server
.. program:: server add volume .. program:: server add volume
.. code:: bash .. code:: bash
os server add volume openstack server add volume
[--device <device>] [--device <device>]
<server> <server>
<volume> <volume>
@ -97,7 +97,7 @@ Create a new server
.. program:: server create .. program:: server create
.. code:: bash .. code:: bash
os server create openstack server create
--image <image> | --volume <volume> --image <image> | --volume <volume>
--flavor <flavor> --flavor <flavor>
[--security-group <security-group-name> [...] ] [--security-group <security-group-name> [...] ]
@ -199,7 +199,7 @@ Delete server(s)
.. program:: server delete .. program:: server delete
.. code:: bash .. code:: bash
os server delete openstack server delete
<server> [<server> ...] [--wait] <server> [<server> ...] [--wait]
.. option:: --wait .. option:: --wait
@ -222,7 +222,7 @@ resource.
.. program:: server dump create .. program:: server dump create
.. code:: bash .. code:: bash
os server dump create openstack server dump create
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -236,7 +236,7 @@ List servers
.. code:: bash .. code:: bash
os server list openstack server list
[--reservation-id <reservation-id>] [--reservation-id <reservation-id>]
[--ip <ip-address-regex>] [--ip <ip-address-regex>]
[--ip6 <ip6-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 .. program:: server lock
.. code:: bash .. code:: bash
os server lock openstack server lock
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -348,7 +348,7 @@ Migrate server to different host
.. program:: server migrate .. program:: server migrate
.. code:: bash .. code:: bash
os server migrate openstack server migrate
--live <host> --live <host>
[--shared-migration | --block-migration] [--shared-migration | --block-migration]
[--disk-overcommit | --no-disk-overcommit] [--disk-overcommit | --no-disk-overcommit]
@ -391,7 +391,7 @@ Pause server(s)
.. program:: server pause .. program:: server pause
.. code:: bash .. code:: bash
os server pause openstack server pause
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -406,7 +406,7 @@ Perform a hard or soft server reboot
.. program:: server reboot .. program:: server reboot
.. code:: bash .. code:: bash
os server reboot openstack server reboot
[--hard | --soft] [--hard | --soft]
[--wait] [--wait]
<server> <server>
@ -435,7 +435,7 @@ Rebuild server
.. program:: server rebuild .. program:: server rebuild
.. code:: bash .. code:: bash
os server rebuild openstack server rebuild
[--image <image>] [--image <image>]
[--password <password>] [--password <password>]
[--wait] [--wait]
@ -466,7 +466,7 @@ Remove fixed IP address from server
.. program:: server remove fixed ip .. program:: server remove fixed ip
.. code:: bash .. code:: bash
os server remove fixed ip openstack server remove fixed ip
<server> <server>
<ip-address> <ip-address>
@ -486,7 +486,7 @@ Remove floating IP address from server
.. program:: server remove floating ip .. program:: server remove floating ip
.. code:: bash .. code:: bash
os server remove floating ip openstack server remove floating ip
<server> <server>
<ip-address> <ip-address>
@ -506,7 +506,7 @@ Remove security group from server
.. program:: server remove security group .. program:: server remove security group
.. code:: bash .. code:: bash
os server remove security group openstack server remove security group
<server> <server>
<group> <group>
@ -526,7 +526,7 @@ Remove volume from server
.. program:: server remove volume .. program:: server remove volume
.. code:: bash .. code:: bash
os server remove volume openstack server remove volume
<server> <server>
<volume> <volume>
@ -546,7 +546,7 @@ Put server in rescue mode
.. program:: server rescue .. program:: server rescue
.. code:: bash .. code:: bash
os server rescue openstack server rescue
<server> <server>
.. describe:: <server> .. describe:: <server>
@ -561,12 +561,12 @@ Scale server to a new flavor
.. program:: server resize .. program:: server resize
.. code:: bash .. code:: bash
os server resize openstack server resize
--flavor <flavor> --flavor <flavor>
[--wait] [--wait]
<server> <server>
os server resize openstack server resize
--confirm | --revert --confirm | --revert
<server> <server>
@ -604,7 +604,7 @@ Restore server(s) from soft-deleted state
.. program:: server restore .. program:: server restore
.. code:: bash .. code:: bash
os server restore openstack server restore
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -619,7 +619,7 @@ Resume server(s)
.. program:: server resume .. program:: server resume
.. code:: bash .. code:: bash
os server resume openstack server resume
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -634,7 +634,7 @@ Set server properties
.. program:: server set .. program:: server set
.. code:: bash .. code:: bash
os server set openstack server set
--name <new-name> --name <new-name>
--property <key=value> --property <key=value>
[--property <key=value>] ... [--property <key=value>] ...
@ -671,7 +671,7 @@ Shelve server(s)
.. program:: server shelve .. program:: server shelve
.. code:: bash .. code:: bash
os server shelve openstack server shelve
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -686,7 +686,7 @@ Show server details
.. program:: server show .. program:: server show
.. code:: bash .. code:: bash
os server show openstack server show
[--diagnostics] [--diagnostics]
<server> <server>
@ -706,7 +706,7 @@ SSH to server
.. program:: server ssh .. program:: server ssh
.. code:: bash .. code:: bash
os server ssh openstack server ssh
[--login <login-name>] [--login <login-name>]
[--port <port>] [--port <port>]
[--identity <keyfile>] [--identity <keyfile>]
@ -754,7 +754,7 @@ Start server(s)
.. program:: server start .. program:: server start
.. code:: bash .. code:: bash
os server start openstack server start
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -769,7 +769,7 @@ Stop server(s)
.. program:: server stop .. program:: server stop
.. code:: bash .. code:: bash
os server stop openstack server stop
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -784,7 +784,7 @@ Suspend server(s)
.. program:: server suspend .. program:: server suspend
.. code:: bash .. code:: bash
os server suspend openstack server suspend
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -799,7 +799,7 @@ Unlock server(s)
.. program:: server unlock .. program:: server unlock
.. code:: bash .. code:: bash
os server unlock openstack server unlock
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -814,7 +814,7 @@ Unpause server(s)
.. program:: server unpause .. program:: server unpause
.. code:: bash .. code:: bash
os server unpause openstack server unpause
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>
@ -829,7 +829,7 @@ Restore server from rescue mode
.. program:: server unrescue .. program:: server unrescue
.. code:: bash .. code:: bash
os server unrescue openstack server unrescue
<server> <server>
.. describe:: <server> .. describe:: <server>
@ -844,7 +844,7 @@ Unset server properties
.. program:: server unset .. program:: server unset
.. code:: bash .. code:: bash
os server unset openstack server unset
--property <key> --property <key>
[--property <key>] ... [--property <key>] ...
<server> <server>
@ -866,7 +866,7 @@ Unshelve server(s)
.. program:: server unshelve .. program:: server unshelve
.. code:: bash .. code:: bash
os server unshelve openstack server unshelve
<server> [<server> ...] <server> [<server> ...]
.. describe:: <server> .. describe:: <server>

View File

@ -14,7 +14,7 @@ Create new service provider
.. program:: service provider create .. program:: service provider create
.. code:: bash .. code:: bash
os service provider create openstack service provider create
[--description <description>] [--description <description>]
[--enable | --disable] [--enable | --disable]
--auth-url <auth-url> --auth-url <auth-url>
@ -53,7 +53,7 @@ Delete service provider(s)
.. program:: service provider delete .. program:: service provider delete
.. code:: bash .. code:: bash
os service provider delete openstack service provider delete
<service-provider> [<service-provider> ...] <service-provider> [<service-provider> ...]
.. describe:: <service-provider> .. describe:: <service-provider>
@ -68,7 +68,7 @@ List service providers
.. program:: service provider list .. program:: service provider list
.. code:: bash .. code:: bash
os service provider list openstack service provider list
service provider set service provider set
-------------------- --------------------
@ -78,7 +78,7 @@ Set service provider properties
.. program:: service provider set .. program:: service provider set
.. code:: bash .. code:: bash
os service provider set openstack service provider set
[--enable | --disable] [--enable | --disable]
[--description <description>] [--description <description>]
[--auth-url <auth-url>] [--auth-url <auth-url>]
@ -117,7 +117,7 @@ Display service provider details
.. program:: service provider show .. program:: service provider show
.. code:: bash .. code:: bash
os service provider show openstack service provider show
<service-provider> <service-provider>
.. describe:: <service-provider> .. describe:: <service-provider>

View File

@ -12,7 +12,7 @@ Create new service
.. program:: service create .. program:: service create
.. code-block:: bash .. code-block:: bash
os service create openstack service create
[--name <name>] [--name <name>]
[--description <description>] [--description <description>]
[--enable | --disable] [--enable | --disable]
@ -51,7 +51,7 @@ Delete service(s)
.. program:: service delete .. program:: service delete
.. code-block:: bash .. code-block:: bash
os service delete openstack service delete
<service> [<service> ...] <service> [<service> ...]
.. _service_delete-type: .. _service_delete-type:
@ -67,7 +67,7 @@ List services
.. program:: service list .. program:: service list
.. code-block:: bash .. code-block:: bash
os service list openstack service list
[--long] [--long]
.. option:: --long .. option:: --long
@ -87,7 +87,7 @@ Set service properties
.. program:: service set .. program:: service set
.. code-block:: bash .. code-block:: bash
os service set openstack service set
[--type <type>] [--type <type>]
[--name <name>] [--name <name>]
[--description <description>] [--description <description>]
@ -127,7 +127,7 @@ Display service details
.. program:: service show .. program:: service show
.. code-block:: bash .. code-block:: bash
os service show openstack service show
[--catalog] [--catalog]
<service> <service>

View File

@ -52,7 +52,7 @@ Delete snapshot(s)
.. program:: snapshot delete .. program:: snapshot delete
.. code:: bash .. code:: bash
os snapshot delete openstack snapshot delete
<snapshot> [<snapshot> ...] <snapshot> [<snapshot> ...]
.. _snapshot_delete-snapshot: .. _snapshot_delete-snapshot:
@ -69,7 +69,7 @@ List snapshots
.. program:: snapshot list .. program:: snapshot list
.. code:: bash .. code:: bash
os snapshot list openstack snapshot list
[--all-projects] [--all-projects]
[--long] [--long]
[--limit <limit>] [--limit <limit>]
@ -104,7 +104,7 @@ Set snapshot properties
.. program:: snapshot set .. program:: snapshot set
.. code:: bash .. code:: bash
os snapshot set openstack snapshot set
[--name <name>] [--name <name>]
[--description <description>] [--description <description>]
[--property <key=value> [...] ] [--property <key=value> [...] ]
@ -146,7 +146,7 @@ Display snapshot details
.. program:: snapshot show .. program:: snapshot show
.. code:: bash .. code:: bash
os snapshot show openstack snapshot show
<snapshot> <snapshot>
.. _snapshot_show-snapshot: .. _snapshot_show-snapshot:
@ -163,7 +163,7 @@ Unset snapshot properties
.. program:: snapshot unset .. program:: snapshot unset
.. code:: bash .. code:: bash
os snapshot unset openstack snapshot unset
[--property <key>] [--property <key>]
<snapshot> <snapshot>

View File

@ -15,7 +15,7 @@ Create subnet pool
.. program:: subnet pool create .. program:: subnet pool create
.. code:: bash .. code:: bash
os subnet pool create openstack subnet pool create
[--default-prefix-length <default-prefix-length>] [--default-prefix-length <default-prefix-length>]
[--min-prefix-length <min-prefix-length>] [--min-prefix-length <min-prefix-length>]
[--max-prefix-length <max-prefix-length>] [--max-prefix-length <max-prefix-length>]
@ -91,7 +91,7 @@ Delete subnet pool(s)
.. program:: subnet pool delete .. program:: subnet pool delete
.. code:: bash .. code:: bash
os subnet pool delete openstack subnet pool delete
<subnet-pool> [<subnet-pool> ...] <subnet-pool> [<subnet-pool> ...]
.. _subnet_pool_delete-subnet-pool: .. _subnet_pool_delete-subnet-pool:
@ -107,7 +107,7 @@ List subnet pools
.. program:: subnet pool list .. program:: subnet pool list
.. code:: bash .. code:: bash
os subnet pool list openstack subnet pool list
[--long] [--long]
[--share | --no-share] [--share | --no-share]
[--default | --no-default] [--default | --no-default]
@ -160,7 +160,7 @@ Set subnet pool properties
.. program:: subnet pool set .. program:: subnet pool set
.. code:: bash .. code:: bash
os subnet pool set openstack subnet pool set
[--name <name>] [--name <name>]
[--pool-prefix <pool-prefix> [...]] [--pool-prefix <pool-prefix> [...]]
[--default-prefix-length <default-prefix-length>] [--default-prefix-length <default-prefix-length>]
@ -226,7 +226,7 @@ Display subnet pool details
.. program:: subnet pool show .. program:: subnet pool show
.. code:: bash .. code:: bash
os subnet pool show openstack subnet pool show
<subnet-pool> <subnet-pool>
.. _subnet_pool_show-subnet-pool: .. _subnet_pool_show-subnet-pool:
@ -242,7 +242,7 @@ Unset subnet pool properties
.. program:: subnet pool unset .. program:: subnet pool unset
.. code:: bash .. code:: bash
os subnet pool unset openstack subnet pool unset
[--pool-prefix <pool-prefix> [...]] [--pool-prefix <pool-prefix> [...]]
<subnet-pool> <subnet-pool>

View File

@ -16,7 +16,7 @@ Create new subnet
.. program:: subnet create .. program:: subnet create
.. code:: bash .. code:: bash
os subnet create openstack subnet create
[--project <project> [--project-domain <project-domain>]] [--project <project> [--project-domain <project-domain>]]
[--subnet-pool <subnet-pool> | --use-default-subnet-pool [--prefix-length <prefix-length>]] [--subnet-pool <subnet-pool> | --use-default-subnet-pool [--prefix-length <prefix-length>]]
[--subnet-range <subnet-range>] [--subnet-range <subnet-range>]
@ -142,7 +142,7 @@ Delete subnet(s)
.. program:: subnet delete .. program:: subnet delete
.. code:: bash .. code:: bash
os subnet delete openstack subnet delete
<subnet> [<subnet> ...] <subnet> [<subnet> ...]
.. _subnet_delete-subnet: .. _subnet_delete-subnet:
@ -158,7 +158,7 @@ List subnets
.. program:: subnet list .. program:: subnet list
.. code:: bash .. code:: bash
os subnet list openstack subnet list
[--long] [--long]
[--ip-version {4,6}] [--ip-version {4,6}]
[--dhcp | --no-dhcp] [--dhcp | --no-dhcp]
@ -226,7 +226,7 @@ Set subnet properties
.. program:: subnet set .. program:: subnet set
.. code:: bash .. code:: bash
os subnet set openstack subnet set
[--allocation-pool start=<ip-address>,end=<ip-address>] [--allocation-pool start=<ip-address>,end=<ip-address>]
[--no-allocation-pool] [--no-allocation-pool]
[--dhcp | --no-dhcp] [--dhcp | --no-dhcp]
@ -319,7 +319,7 @@ Display subnet details
.. program:: subnet show .. program:: subnet show
.. code:: bash .. code:: bash
os subnet show openstack subnet show
<subnet> <subnet>
.. _subnet_show-subnet: .. _subnet_show-subnet:
@ -335,7 +335,7 @@ Unset subnet properties
.. program:: subnet unset .. program:: subnet unset
.. code:: bash .. code:: bash
os subnet unset openstack subnet unset
[--allocation-pool start=<ip-address>,end=<ip-address> [...]] [--allocation-pool start=<ip-address>,end=<ip-address> [...]]
[--dns-nameserver <dns-nameserver> [...]] [--dns-nameserver <dns-nameserver> [...]]
[--host-route destination=<subnet>,gateway=<ip-address> [...]] [--host-route destination=<subnet>,gateway=<ip-address> [...]]

View File

@ -12,7 +12,7 @@ Issue new token
.. program:: token issue .. program:: token issue
.. code:: bash .. code:: bash
os token issue openstack token issue
token revoke token revoke
------------ ------------
@ -22,7 +22,7 @@ Revoke existing token
.. program:: token revoke .. program:: token revoke
.. code:: bash .. code:: bash
os token revoke openstack token revoke
<token> <token>
.. describe:: <token> .. describe:: <token>

View File

@ -12,7 +12,7 @@ Create new trust
.. program:: trust create .. program:: trust create
.. code:: bash .. code:: bash
os trust create openstack trust create
--project <project> --project <project>
--role <role> --role <role>
[--impersonate] [--impersonate]
@ -69,7 +69,7 @@ Delete trust(s)
.. program:: trust delete .. program:: trust delete
.. code:: bash .. code:: bash
os trust delete openstack trust delete
<trust> [<trust> ...] <trust> [<trust> ...]
.. describe:: <trust> .. describe:: <trust>
@ -84,7 +84,7 @@ List trusts
.. program:: trust list .. program:: trust list
.. code:: bash .. code:: bash
os trust list openstack trust list
trust show trust show
---------- ----------
@ -94,7 +94,7 @@ Display trust details
.. program:: trust show .. program:: trust show
.. code:: bash .. code:: bash
os trust show openstack trust show
<trust> <trust>
.. describe:: <trust> .. describe:: <trust>

View File

@ -12,7 +12,7 @@ List resource usage per project
.. program:: usage list .. program:: usage list
.. code:: bash .. code:: bash
os usage list openstack usage list
[--start <start>] [--start <start>]
[--end <end>] [--end <end>]
@ -32,7 +32,7 @@ Show resource usage for a single project
.. program:: usage show .. program:: usage show
.. code:: bash .. code:: bash
os usage show openstack usage show
[--project <project>] [--project <project>]
[--start <start>] [--start <start>]
[--end <end>] [--end <end>]

View File

@ -14,7 +14,7 @@ List user-role assignments
.. program:: user role list .. program:: user role list
.. code:: bash .. code:: bash
os user role list openstack user role list
[--project <project>] [--project <project>]
[<user>] [<user>]

View File

@ -12,7 +12,7 @@ Create new user
.. program:: user create .. program:: user create
.. code:: bash .. code:: bash
os user create openstack user create
[--domain <domain>] [--domain <domain>]
[--project <project> [--project-domain <project-domain>]] [--project <project> [--project-domain <project-domain>]]
[--password <password>] [--password <password>]
@ -82,7 +82,7 @@ Delete user(s)
.. program:: user delete .. program:: user delete
.. code:: bash .. code:: bash
os user delete openstack user delete
[--domain <domain>] [--domain <domain>]
<user> [<user> ...] <user> [<user> ...]
@ -105,7 +105,7 @@ List users
.. program:: user list .. program:: user list
.. code:: bash .. code:: bash
os user list openstack user list
[--project <project>] [--project <project>]
[--domain <domain>] [--domain <domain>]
[--group <group> | --project <project>] [--group <group> | --project <project>]
@ -139,7 +139,7 @@ Set user properties
.. program:: user set .. program:: user set
.. code:: bash .. code:: bash
os user set openstack user set
[--name <name>] [--name <name>]
[--project <project> [--project-domain <project-domain>]] [--project <project> [--project-domain <project-domain>]]
[--password <password>] [--password <password>]
@ -200,7 +200,7 @@ Display user details
.. program:: user show .. program:: user show
.. code:: bash .. code:: bash
os user show openstack user show
[--domain <domain>] [--domain <domain>]
<user> <user>

View File

@ -64,7 +64,7 @@ Delete volume backup(s)
.. program:: volume backup delete .. program:: volume backup delete
.. code:: bash .. code:: bash
os volume backup delete openstack volume backup delete
[--force] [--force]
<backup> [<backup> ...] <backup> [<backup> ...]
@ -87,7 +87,7 @@ List volume backups
.. program:: volume backup list .. program:: volume backup list
.. code:: bash .. code:: bash
os volume backup list openstack volume backup list
[--long] [--long]
[--name <name>] [--name <name>]
[--status <status>] [--status <status>]
@ -138,7 +138,7 @@ Restore volume backup
.. program:: volume backup restore .. program:: volume backup restore
.. code:: bash .. code:: bash
os volume backup restore openstack volume backup restore
<backup> <backup>
<volume> <volume>
@ -159,7 +159,7 @@ Set volume backup properties
.. program:: volume backup set .. program:: volume backup set
.. code:: bash .. code:: bash
os volume backup set openstack volume backup set
[--name <name>] [--name <name>]
[--description <description>] [--description <description>]
[--state <state>] [--state <state>]
@ -192,7 +192,7 @@ Display volume backup details
.. program:: volume backup show .. program:: volume backup show
.. code:: bash .. code:: bash
os volume backup show openstack volume backup show
<backup> <backup>
.. _volume_backup_show-backup: .. _volume_backup_show-backup:

View File

@ -12,7 +12,7 @@ Set volume host properties
.. program:: volume host set .. program:: volume host set
.. code:: bash .. code:: bash
os volume host set openstack volume host set
[--enable | --disable] [--enable | --disable]
<host-name> <host-name>

View File

@ -12,7 +12,7 @@ Associate a QoS specification to a volume type
.. program:: volume qos associate .. program:: volume qos associate
.. code:: bash .. code:: bash
os volume qos associate openstack volume qos associate
<qos-spec> <qos-spec>
<volume-type> <volume-type>
@ -33,7 +33,7 @@ Create new QoS Specification
.. program:: volume qos create .. program:: volume qos create
.. code:: bash .. code:: bash
os volume qos create openstack volume qos create
[--consumer <consumer>] [--consumer <consumer>]
[--property <key=value> [...] ] [--property <key=value> [...] ]
<name> <name>
@ -59,7 +59,7 @@ Delete QoS specification
.. program:: volume qos delete .. program:: volume qos delete
.. code:: bash .. code:: bash
os volume qos delete openstack volume qos delete
[--force] [--force]
<qos-spec> [<qos-spec> ...] <qos-spec> [<qos-spec> ...]
@ -80,7 +80,7 @@ Disassociate a QoS specification from a volume type
.. program:: volume qos disassociate .. program:: volume qos disassociate
.. code:: bash .. code:: bash
os volume qos disassociate openstack volume qos disassociate
--volume-type <volume-type> | --all --volume-type <volume-type> | --all
<qos-spec> <qos-spec>
@ -105,7 +105,7 @@ List QoS specifications
.. program:: volume qos list .. program:: volume qos list
.. code:: bash .. code:: bash
os volume qos list openstack volume qos list
volume qos set volume qos set
-------------- --------------
@ -115,7 +115,7 @@ Set QoS specification properties
.. program:: volume qos set .. program:: volume qos set
.. code:: bash .. code:: bash
os volume qos set openstack volume qos set
[--property <key=value> [...] ] [--property <key=value> [...] ]
<qos-spec> <qos-spec>
@ -136,7 +136,7 @@ Display QoS specification details
.. program:: volume qos show .. program:: volume qos show
.. code:: bash .. code:: bash
os volume qos show openstack volume qos show
<qos-spec> <qos-spec>
.. _volume_qos_show-qos-spec: .. _volume_qos_show-qos-spec:
@ -152,7 +152,7 @@ Unset QoS specification properties
.. program:: volume qos unset .. program:: volume qos unset
.. code:: bash .. code:: bash
os volume qos unset openstack volume qos unset
[--property <key> [...] ] [--property <key> [...] ]
<qos-spec> <qos-spec>

View File

@ -12,7 +12,7 @@ List volume service
.. program:: volume service list .. program:: volume service list
.. code:: bash .. code:: bash
os volume service list openstack volume service list
[--host <host>] [--host <host>]
[--service <service>] [--service <service>]
[--long] [--long]
@ -38,7 +38,7 @@ Set volume service properties
.. program:: volume service set .. program:: volume service set
.. code:: bash .. code:: bash
os volume service set openstack volume service set
[--enable | --disable] [--enable | --disable]
[--disable-reason <reason>] [--disable-reason <reason>]
<host> <host>

View File

@ -59,7 +59,7 @@ Delete volume snapshot(s)
.. program:: volume snapshot delete .. program:: volume snapshot delete
.. code:: bash .. code:: bash
os volume snapshot delete openstack volume snapshot delete
[--force] [--force]
<snapshot> [<snapshot> ...] <snapshot> [<snapshot> ...]
@ -80,7 +80,7 @@ List volume snapshots
.. program:: volume snapshot list .. program:: volume snapshot list
.. code:: bash .. code:: bash
os volume snapshot list openstack volume snapshot list
[--all-projects] [--all-projects]
[--long] [--long]
[--limit <limit>] [--limit <limit>]
@ -130,7 +130,7 @@ Set volume snapshot properties
.. program:: volume snapshot set .. program:: volume snapshot set
.. code:: bash .. code:: bash
os volume snapshot set openstack volume snapshot set
[--name <name>] [--name <name>]
[--description <description>] [--description <description>]
[--property <key=value> [...] ] [--property <key=value> [...] ]
@ -171,7 +171,7 @@ Display volume snapshot details
.. program:: volume snapshot show .. program:: volume snapshot show
.. code:: bash .. code:: bash
os volume snapshot show openstack volume snapshot show
<snapshot> <snapshot>
.. _volume_snapshot_show-snapshot: .. _volume_snapshot_show-snapshot:
@ -187,7 +187,7 @@ Unset volume snapshot properties
.. program:: volume snapshot unset .. program:: volume snapshot unset
.. code:: bash .. code:: bash
os volume snapshot unset openstack volume snapshot unset
[--property <key>] [--property <key>]
<snapshot> <snapshot>

View File

@ -12,7 +12,7 @@ Accept volume transfer request
.. program:: volume transfer request accept .. program:: volume transfer request accept
.. code:: bash .. code:: bash
os volume transfer request accept openstack volume transfer request accept
<transfer-request> <transfer-request>
<auth-key> <auth-key>
@ -33,7 +33,7 @@ Create volume transfer request
.. program:: volume transfer request create .. program:: volume transfer request create
.. code:: bash .. code:: bash
os volume transfer request create openstack volume transfer request create
[--name <name>] [--name <name>]
<volume> <volume>
@ -54,7 +54,7 @@ Delete volume transfer request(s)
.. program:: volume transfer request delete .. program:: volume transfer request delete
.. code:: bash .. code:: bash
os volume transfer request delete openstack volume transfer request delete
<transfer-request> [<transfer-request> ...] <transfer-request> [<transfer-request> ...]
.. _volume_transfer_request_delete-transfer-request: .. _volume_transfer_request_delete-transfer-request:
@ -70,7 +70,7 @@ Lists all volume transfer requests.
.. program:: volume transfer request list .. program:: volume transfer request list
.. code:: bash .. code:: bash
os volume transfer request list openstack volume transfer request list
--all-projects --all-projects
.. option:: --all-projects .. option:: --all-projects
@ -86,7 +86,7 @@ Show volume transfer request details
.. program:: volume transfer request show .. program:: volume transfer request show
.. code:: bash .. code:: bash
os volume transfer request show openstack volume transfer request show
<transfer-request> <transfer-request>
.. _volume_transfer_request_show-transfer-request: .. _volume_transfer_request_show-transfer-request:

View File

@ -12,7 +12,7 @@ Create new volume type
.. program:: volume type create .. program:: volume type create
.. code:: bash .. code:: bash
os volume type create openstack volume type create
[--description <description>] [--description <description>]
[--public | --private] [--public | --private]
[--property <key=value> [...] ] [--property <key=value> [...] ]
@ -69,7 +69,7 @@ Delete volume type(s)
.. program:: volume type delete .. program:: volume type delete
.. code:: bash .. code:: bash
os volume type delete openstack volume type delete
<volume-type> [<volume-type> ...] <volume-type> [<volume-type> ...]
.. _volume_type_delete-volume-type: .. _volume_type_delete-volume-type:
@ -85,7 +85,7 @@ List volume types
.. program:: volume type list .. program:: volume type list
.. code:: bash .. code:: bash
os volume type list openstack volume type list
[--long] [--long]
[--default | --public | --private] [--default | --public | --private]
@ -119,7 +119,7 @@ Set volume type properties
.. program:: volume type set .. program:: volume type set
.. code:: bash .. code:: bash
os volume type set openstack volume type set
[--name <name>] [--name <name>]
[--description <description>] [--description <description>]
[--property <key=value> [...] ] [--property <key=value> [...] ]
@ -167,7 +167,7 @@ Display volume type details
.. program:: volume type show .. program:: volume type show
.. code:: bash .. code:: bash
os volume type show openstack volume type show
<volume-type> <volume-type>
.. _volume_type_show-volume-type: .. _volume_type_show-volume-type:
@ -183,7 +183,7 @@ Unset volume type properties
.. program:: volume type unset .. program:: volume type unset
.. code:: bash .. code:: bash
os volume type unset openstack volume type unset
[--property <key> [...] ] [--property <key> [...] ]
[--project <project>] [--project <project>]
[--project-domain <project-domain>] [--project-domain <project-domain>]

View File

@ -12,7 +12,7 @@ Create new volume
.. program:: volume create .. program:: volume create
.. code:: bash .. code:: bash
os volume create openstack volume create
[--size <size>] [--size <size>]
[--type <volume-type>] [--type <volume-type>]
[--image <image> | --snapshot <snapshot> | --source <volume> | --source-replicated <replicated-volume>] [--image <image> | --snapshot <snapshot> | --source <volume> | --source-replicated <replicated-volume>]
@ -124,7 +124,7 @@ Delete volume(s)
.. program:: volume delete .. program:: volume delete
.. code:: bash .. code:: bash
os volume delete openstack volume delete
[--force | --purge] [--force | --purge]
<volume> [<volume> ...] <volume> [<volume> ...]
@ -151,7 +151,7 @@ List volumes
.. program:: volume list .. program:: volume list
.. code:: bash .. code:: bash
os volume list openstack volume list
[--project <project> [--project-domain <project-domain>]] [--project <project> [--project-domain <project-domain>]]
[--user <user> [--user-domain <user-domain>]] [--user <user> [--user-domain <user-domain>]]
[--name <name>] [--name <name>]
@ -223,7 +223,7 @@ Migrate volume to a new host
.. program:: volume migrate .. program:: volume migrate
.. code:: bash .. code:: bash
os volume migrate openstack volume migrate
--host <host> --host <host>
[--force-host-copy] [--force-host-copy]
[--lock-volume | --unlock-volume] [--lock-volume | --unlock-volume]
@ -265,7 +265,7 @@ Set volume properties
.. program:: volume set .. program:: volume set
.. code:: bash .. code:: bash
os volume set openstack volume set
[--name <name>] [--name <name>]
[--size <size>] [--size <size>]
[--description <description>] [--description <description>]
@ -358,7 +358,7 @@ Show volume details
.. program:: volume show .. program:: volume show
.. code:: bash .. code:: bash
os volume show openstack volume show
<volume> <volume>
.. _volume_show-volume: .. _volume_show-volume:
@ -374,7 +374,7 @@ Unset volume properties
.. program:: volume unset .. program:: volume unset
.. code:: bash .. code:: bash
os volume unset openstack volume unset
[--property <key>] [--property <key>]
[--image-property <key>] [--image-property <key>]
<volume> <volume>

View File

@ -18,7 +18,7 @@ Create new example
.. program:: example create .. program:: example create
.. code:: bash .. code:: bash
os example create openstack example create
<name> <name>
.. describe:: <name> .. describe:: <name>
@ -33,7 +33,7 @@ Delete example(s)
.. program:: example delete .. program:: example delete
.. code:: bash .. code:: bash
os example delete openstack example delete
<example> [<example> ...] <example> [<example> ...]
.. describe:: <example> .. describe:: <example>
@ -48,7 +48,7 @@ List examples
.. program:: example list .. program:: example list
.. code:: bash .. code:: bash
os example list openstack example list
example set example set
----------- -----------
@ -58,7 +58,7 @@ Set example properties
.. program:: example set .. program:: example set
.. code:: bash .. code:: bash
os example set openstack example set
[--name <new-name>] [--name <new-name>]
<example> <example>
@ -78,7 +78,7 @@ Display example details
.. program:: example show .. program:: example show
.. code:: bash .. code:: bash
os example show openstack example show
<example> <example>
.. describe:: <example> .. describe:: <example>

View File

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