openstack/python-openstackclient
Code Issues Proposed changes

change os in command example to openstack(2)

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: I80c96f0938cec382f2f714a500138bd5a2c81aa0
This commit is contained in:
Kevin_Zheng 2016-12-20 09:18:55 +08:00
parent e51a2b3b17
commit 847da51dea
35 changed files with 146 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/command-objects/federation-protocol.rst
View File

@ -14,7 +14,7 @@ Create new federation protocol
.. program:: federation protocol create
.. code:: bash
os federation protocol create
openstack federation protocol create
--identity-provider <identity-provider>
--mapping <mapping>
<name>
@ -39,7 +39,7 @@ Delete federation protocol(s)
.. program:: federation protocol delete
.. code:: bash
os federation protocol delete
openstack federation protocol delete
--identity-provider <identity-provider>
<federation-protocol> [<federation-protocol> ...]
@ -59,7 +59,7 @@ List federation protocols
.. program:: federation protocol list
.. code:: bash
os federation protocol list
openstack federation protocol list
--identity-provider <identity-provider>
.. option:: --identity-provider <identity-provider>
@ -74,7 +74,7 @@ Set federation protocol properties
.. program:: federation protocol set
.. code:: bash
os federation protocol set
openstack federation protocol set
--identity-provider <identity-provider>
[--mapping <mapping>]
<federation-protocol>
@ -99,7 +99,7 @@ Display federation protocol details
.. program:: federation protocol show
.. code:: bash
os federation protocol show
openstack federation protocol show
--identity-provider <identity-provider>
<federation-protocol>

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

@ -12,7 +12,7 @@ Create new flavor
.. program:: flavor create
.. code:: bash
os flavor create
openstack flavor create
[--id <id>]
[--ram <size-mb>]
[--disk <size-gb>]
@ -89,7 +89,7 @@ Delete flavor(s)
.. program:: flavor delete
.. code:: bash
os flavor delete
openstack flavor delete
<flavor> [<flavor> ...]
.. _flavor_delete-flavor:
@ -105,7 +105,7 @@ List flavors
.. program:: flavor list
.. code:: bash
os flavor list
openstack flavor list
[--public | --private | --all]
[--long]
[--marker <marker>]
@ -143,7 +143,7 @@ Set flavor properties
.. program:: flavor set
.. code:: bash
os flavor set
openstack flavor set
[--property <key=value> [...] ]
[--project <project>]
[--project-domain <project-domain>]
@ -174,7 +174,7 @@ Display flavor details
.. program:: flavor show
.. code:: bash
os flavor show
openstack flavor show
<flavor>
.. _flavor_show-flavor:
@ -190,7 +190,7 @@ Unset flavor properties
.. program:: flavor unset
.. code:: bash
os flavor unset
openstack flavor unset
[--property <key> [...] ]
[--project <project>]
[--project-domain <project-domain>]

2
doc/source/command-objects/floating-ip-pool.rst
View File

@ -12,4 +12,4 @@ List pools of floating IP addresses
.. program:: floating ip pool list
.. code:: bash
os floating ip pool list
openstack floating ip pool list

8
doc/source/command-objects/floating-ip.rst
View File

@ -12,7 +12,7 @@ Create floating IP
.. program:: floating ip create
.. code:: bash
os floating ip create
openstack floating ip create
[--subnet <subnet>]
[--port <port>]
[--floating-ip-address <floating-ip-address>]
@ -71,7 +71,7 @@ Delete floating IP(s)
.. program:: floating ip delete
.. code:: bash
os floating ip delete <floating-ip> [<floating-ip> ...]
openstack floating ip delete <floating-ip> [<floating-ip> ...]
.. describe:: <floating-ip>
@ -85,7 +85,7 @@ List floating IP(s)
.. program:: floating ip list
.. code:: bash
os floating ip list
openstack floating ip list
[--network <network>]
[--port <port>]
[--fixed-ip-address <fixed-ip-address>]
@ -151,7 +151,7 @@ Display floating IP details
.. program:: floating ip show
.. code:: bash
os floating ip show <floating-ip>
openstack floating ip show <floating-ip>
.. describe:: <floating-ip>

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

@ -48,7 +48,7 @@ Check user membership in group
.. program:: group contains user
.. code:: bash
os group contains user
openstack group contains user
[--group-domain <group-domain>]
[--user-domain <user-domain>]
<group>
@ -84,7 +84,7 @@ Create new group
.. program:: group create
.. code:: bash
os group create
openstack group create
[--domain <domain>]
[--description <description>]
[--or-show]
@ -116,7 +116,7 @@ Delete group
.. program:: group delete
.. code:: bash
os group delete
openstack group delete
[--domain <domain>]
<group> [<group> ...]
@ -136,7 +136,7 @@ List groups
.. program:: group list
.. code:: bash
os group list
openstack group list
[--domain <domain>]
[--user <user> [--user-domain <user-domain>]]
[--long]
@ -168,7 +168,7 @@ Remove user from group
.. program:: group remove user
.. code:: bash
os group remove user
openstack group remove user
[--group-domain <group-domain>]
[--user-domain <user-domain>]
<group>
@ -204,7 +204,7 @@ Set group properties
.. program:: group set
.. code:: bash
os group set
openstack group set
[--domain <domain>]
[--name <name>]
[--description <description>]
@ -234,7 +234,7 @@ Display group details
.. program:: group show
.. code:: bash
os group show
openstack group show
[--domain <domain>]
<group>

6
doc/source/command-objects/host.rst
View File

@ -14,7 +14,7 @@ List hosts
.. program:: host list
.. code:: bash
os host list
openstack host list
[--zone <availability-zone>]
.. option:: --zone <availability-zone>
@ -29,7 +29,7 @@ Set host properties
.. program:: host set
.. code:: bash
os host set
openstack host set
[--enable | --disable]
[--enable-maintenance | --disable-maintenance]
<host>
@ -64,7 +64,7 @@ Display host details
.. program:: host show
.. code:: bash
os host show
openstack host show
<host>
.. describe:: <host>

2
doc/source/command-objects/hypervisor-stats.rst
View File

@ -12,5 +12,5 @@ Display hypervisor stats details
.. program:: hypervisor stats show
.. code:: bash
os hypervisor stats show
openstack hypervisor stats show

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

@ -12,7 +12,7 @@ List hypervisors
.. program:: hypervisor list
.. code:: bash
os hypervisor list
openstack hypervisor list
[--matching <hostname>]
[--long]
@ -32,7 +32,7 @@ Display hypervisor details
.. program:: hypervisor show
.. code:: bash
os hypervisor show
openstack hypervisor show
<hypervisor>
.. _hypervisor_show-flavor:

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

@ -14,7 +14,7 @@ Create new identity provider
.. program:: identity provider create
.. code:: bash
os identity provider create
openstack identity provider create
[--remote-id <remote-id> [...] | --remote-id-file <file-name>]
[--description <description>]
[--enable | --disable]
@ -54,7 +54,7 @@ Delete identity provider(s)
.. program:: identity provider delete
.. code:: bash
os identity provider delete
openstack identity provider delete
<identity-provider> [<identity-provider> ...]
.. describe:: <identity-provider>
@ -69,7 +69,7 @@ List identity providers
.. program:: identity provider list
.. code:: bash
os identity provider list
openstack identity provider list
identity provider set
---------------------
@ -79,7 +79,7 @@ Set identity provider properties
.. program:: identity provider set
.. code:: bash
os identity provider set
openstack identity provider set
[--remote-id <remote-id> [...] | --remote-id-file <file-name>]
[--description <description>]
[--enable | --disable]
@ -119,7 +119,7 @@ Display identity provider details
.. program:: identity provider show
.. code:: bash
os identity provider show
openstack identity provider show
<identity-provider>
.. describe:: <identity-provider>

18
doc/source/command-objects/image.rst
View File

@ -14,7 +14,7 @@ Associate project with image
.. program:: image add project
.. code:: bash
os image add project
openstack image add project
[--project-domain <project-domain>]
<image> <project>
@ -41,7 +41,7 @@ Create/upload an image
.. program:: image create
.. code:: bash
os image create
openstack image create
[--id <id>]
[--store <store>]
[--container-format <container-format>]
@ -175,7 +175,7 @@ Delete image(s)
.. program:: image delete
.. code:: bash
os image delete
openstack image delete
<image>
.. describe:: <image>
@ -190,7 +190,7 @@ List available images
.. program:: image list
.. code:: bash
os image list
openstack image list
[--public | --private | --shared]
[--property <key=value>]
[--long]
@ -244,7 +244,7 @@ Disassociate project with image
.. program:: image remove project
.. code:: bash
os image remove remove
openstack image remove remove
[--project-domain <project-domain>]
<image> <project>
@ -269,7 +269,7 @@ Save an image locally
.. program:: image save
.. code:: bash
os image save
openstack image save
--file <filename>
<image>
@ -291,7 +291,7 @@ Set image properties
.. program:: image set
.. code:: bash
os image set
openstack image set
[--name <name>]
[--min-disk <disk-gb>]
[--min-ram <disk-ram>]
@ -495,7 +495,7 @@ Display image details
.. program:: image show
.. code:: bash
os image show
openstack image show
<image>
.. describe:: <image>
@ -512,7 +512,7 @@ Unset image tags or properties
.. program:: image unset
.. code:: bash
os image set
openstack image set
[--tag <tag>]
[--property <property>]
<image>

4
doc/source/command-objects/ip-availability.rst
View File

@ -18,7 +18,7 @@ number of allocated IP addresses from that pool.
.. program:: ip availability list
.. code:: bash
os ip availability list
openstack ip availability list
[--ip-version {4,6}]
[--project <project>]
@ -51,7 +51,7 @@ subnet within the network as well.
.. program:: ip availability show
.. code:: bash
os ip availability show
openstack ip availability show
<network>
.. _ip_availability_show-network

4
doc/source/command-objects/ip-fixed.rst
View File

@ -13,7 +13,7 @@ Add fixed IP address to server
.. program:: ip fixed add
.. code:: bash
os ip fixed add
openstack ip fixed add
<network>
<server>
@ -34,7 +34,7 @@ Remove fixed IP address from server
.. program:: ip fixed remove
.. code:: bash
os ip fixed remove
openstack ip fixed remove
<ip-address>
<server>

2
doc/source/command-objects/ip-floating-pool.rst
View File

@ -13,4 +13,4 @@ List pools of floating IP addresses
.. program:: ip floating pool list
.. code:: bash
os ip floating pool list
openstack ip floating pool list

12
doc/source/command-objects/ip-floating.rst
View File

@ -13,7 +13,7 @@ Add floating IP address to server
.. program:: ip floating add
.. code:: bash
os ip floating add
openstack ip floating add
<ip-address>
<server>
@ -34,7 +34,7 @@ Create new floating IP address
.. program:: ip floating create
.. code:: bash
os ip floating create
openstack ip floating create
[--subnet <subnet>]
[--port <port>]
[--floating-ip-address <floating-ip-address>]
@ -74,7 +74,7 @@ Delete floating IP(s)
.. program:: ip floating delete
.. code:: bash
os ip floating delete
openstack ip floating delete
<floating-ip> [<floating-ip> ...]
.. describe:: <floating-ip>
@ -90,7 +90,7 @@ List floating IP addresses
.. program:: ip floating list
.. code:: bash
os ip floating list
openstack ip floating list
ip floating remove
------------------
@ -101,7 +101,7 @@ Remove floating IP address from server
.. program:: ip floating remove
.. code:: bash
os ip floating remove
openstack ip floating remove
<ip-address>
<server>
@ -122,7 +122,7 @@ Display floating IP details
.. program:: ip floating show
.. code:: bash
os ip floating show <floating-ip>
openstack ip floating show <floating-ip>
.. describe:: <floating-ip>

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

@ -17,7 +17,7 @@ Create new public or private key for server ssh access
.. program:: keypair create
.. code:: bash
os keypair create
openstack keypair create
[--public-key <file>]
<name>
@ -37,7 +37,7 @@ Delete public or private key(s)
.. program:: keypair delete
.. code:: bash
os keypair delete
openstack keypair delete
<key> [<key> ...]
.. describe:: <key>
@ -52,7 +52,7 @@ List key fingerprints
.. program:: keypair list
.. code:: bash
os keypair list
openstack keypair list
keypair show
------------
@ -62,7 +62,7 @@ Display key details
.. program:: keypair show
.. code:: bash
os keypair show
openstack keypair show
[--public-key]
<key>

2
doc/source/command-objects/limits.rst
View File

@ -14,7 +14,7 @@ Show compute and block storage limits
.. program:: limits show
.. code:: bash
os limits show
openstack limits show
--absolute | --rate
[--reserved]
[--project <project>]

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

@ -14,7 +14,7 @@ Create new mapping
.. program:: mapping create
.. code:: bash
os mapping create
openstack mapping create
--rules <filename>
<name>
@ -35,7 +35,7 @@ Delete mapping(s)
.. program:: mapping delete
.. code:: bash
os mapping delete
openstack mapping delete
<mapping> [<mapping> ...]
.. _mapping_delete-mapping:
@ -51,7 +51,7 @@ List mappings
.. program:: mapping list
.. code:: bash
os mapping list
openstack mapping list
mapping set
-----------
@ -61,7 +61,7 @@ Set mapping properties
.. program:: mapping set
.. code:: bash
os mapping set
openstack mapping set
[--rules <filename>]
<mapping>
@ -82,7 +82,7 @@ Display mapping details
.. program:: mapping show
.. code:: bash
os mapping show
openstack mapping show
<mapping>
.. _mapping_show-mapping:

2
doc/source/command-objects/module.rst
View File

@ -14,7 +14,7 @@ List module versions
.. program:: module list
.. code:: bash
os module list
openstack module list
[--all]
.. option:: --all

8
doc/source/command-objects/network-agent.rst
View File

@ -18,7 +18,7 @@ Delete network agent(s)
.. program:: network agent delete
.. code:: bash
os network agent delete
openstack network agent delete
<network-agent> [<network-agent> ...]
.. _network_agent_delete-network-agent:
@ -34,7 +34,7 @@ List network agents
.. program:: network agent list
.. code:: bash
os network agent list
openstack network agent list
network agent set
-----------------
@ -44,7 +44,7 @@ Set network agent properties
.. program:: network agent set
.. code:: bash
os network agent set
openstack network agent set
[--description <description>]
[--enable | --disable]
<network-agent>
@ -74,7 +74,7 @@ Display network agent details
.. program:: network agent show
.. code:: bash
os network agent show
openstack network agent show
<network-agent>
.. _network_agent_show-network-agent:

10
doc/source/command-objects/network-qos-policy.rst
View File

@ -15,7 +15,7 @@ Create new Network QoS policy
.. program:: network qos policy create
.. code:: bash
os network qos policy create
openstack network qos policy create
[--description <description>]
[--share | --no-share]
[--project <project>]
@ -55,7 +55,7 @@ Delete Network QoS policy
.. program:: network qos policy delete
.. code:: bash
os network qos policy delete
openstack network qos policy delete
<qos-policy> [<qos-policy> ...]
.. describe:: <qos-policy>
@ -70,7 +70,7 @@ List Network QoS policies
.. program:: network qos policy list
.. code:: bash
os network qos policy list
openstack network qos policy list
network qos policy set
----------------------
@ -80,7 +80,7 @@ Set Network QoS policy properties
.. program:: network qos policy set
.. code:: bash
os network qos policy set
openstack network qos policy set
[--name <name>]
[--description <description>]
[--share | --no-share]
@ -114,7 +114,7 @@ Display Network QoS policy details
.. program:: network qos policy show
.. code:: bash
os network qos policy show
openstack network qos policy show
<qos-policy>
.. describe:: <qos-policy>

10
doc/source/command-objects/network-rbac.rst
View File

@ -16,7 +16,7 @@ Create network RBAC policy
.. program:: network rbac create
.. code:: bash
os network rbac create
openstack network rbac create
--type <type>
--action <action>
--target-project <target-project> [--target-project-domain <target-project-domain>]
@ -62,7 +62,7 @@ Delete network RBAC policy(s)
.. program:: network rbac delete
.. code:: bash
os network rbac delete
openstack network rbac delete
<rbac-policy> [<rbac-policy> ...]
.. _network_rbac_delete-rbac-policy:
@ -78,7 +78,7 @@ List network RBAC policies
.. program:: network rbac list
.. code:: bash
os network rbac list
openstack network rbac list
network rbac set
----------------
@ -88,7 +88,7 @@ Set network RBAC policy properties
.. program:: network rbac set
.. code:: bash
os network rbac set
openstack network rbac set
[--target-project <target-project> [--target-project-domain <target-project-domain>]]
<rbac-policy>
@ -114,7 +114,7 @@ Display network RBAC policy details
.. program:: network rbac show
.. code:: bash
os network rbac show
openstack network rbac show
<rbac-policy>
.. _network_rbac_show-rbac-policy:

10
doc/source/command-objects/network-segment.rst
View File

@ -17,7 +17,7 @@ Create new network segment
.. program:: network segment create
.. code:: bash
os network segment create
openstack network segment create
[--description <description>]
[--physical-network <physical-network>]
[--segment <segment>]
@ -62,7 +62,7 @@ Delete network segment(s)
.. program:: network segment delete
.. code:: bash
os network segment delete
openstack network segment delete
<network-segment> [<network-segment> ...]
.. _network_segment_delete-segment:
@ -78,7 +78,7 @@ List network segments
.. program:: network segment list
.. code:: bash
os network segment list
openstack network segment list
[--long]
[--network <network>]
@ -98,7 +98,7 @@ Set network segment properties
.. program:: network segment set
.. code:: bash
os network segment set
openstack network segment set
[--description <description>]
[--name <name>]
<network-segment>
@ -124,7 +124,7 @@ Display network segment details
.. program:: network segment show
.. code:: bash
os network segment show
openstack network segment show
<network-segment>
.. _network_segment_show-segment:

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

@ -15,4 +15,4 @@ List service providers
.. program:: network service provider list
.. code:: bash
os network service provider list
openstack network service provider list

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

@ -19,7 +19,7 @@ Create new network
.. program:: network create
.. code:: bash
os network create
openstack network create
[--project <project> [--project-domain <project-domain>]]
[--enable | --disable]
[--share | --no-share]
@ -176,7 +176,7 @@ Delete network(s)
.. program:: network delete
.. code:: bash
os network delete
openstack network delete
<network> [<network> ...]
.. _network_delete-network:
@ -192,7 +192,7 @@ List networks
.. program:: network list
.. code:: bash
os network list
openstack network list
[--external | --internal]
[--long]
[--name <name>]
@ -300,7 +300,7 @@ Set network properties
.. program:: network set
.. code:: bash
os network set
openstack network set
[--name <name>]
[--enable | --disable]
[--share | --no-share]
@ -407,7 +407,7 @@ Display network details
.. program:: network show
.. code:: bash
os network show
openstack network show
<network>
.. _network_show-network:

6
doc/source/command-objects/object-store-account.rst
View File

@ -12,7 +12,7 @@ Set account properties
.. program:: object store account set
.. code:: bash
os object store account set
openstack object store account set
[--property <key=value> [...] ]
.. option:: --property <key=value>
@ -27,7 +27,7 @@ Display account details
.. program:: object store account show
.. code:: bash
os object store account show
openstack object store account show
object store account unset
--------------------------
@ -37,7 +37,7 @@ Unset account properties
.. program:: object store account unset
.. code:: bash
os object store account unset
openstack object store account unset
[--property <key>]
.. option:: --property <key>

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

@ -12,7 +12,7 @@ Upload object to container
.. program:: object create
.. code:: bash
os object create
openstack object create
[--name <name>]
<container>
<filename> [<filename> ...]
@ -37,7 +37,7 @@ Delete object from container
.. program:: object delete
.. code:: bash
os object delete
openstack object delete
<container>
<object> [<object> ...]
@ -57,7 +57,7 @@ List objects
.. program object list
.. code:: bash
os object list
openstack object list
[--prefix <prefix>]
[--delimiter <delimiter>]
[--marker <marker>]
@ -107,7 +107,7 @@ Save object locally
.. program:: object save
.. code:: bash
os object save
openstack object save
[--file <filename>]
<container>
<object>
@ -132,7 +132,7 @@ Set object properties
.. program:: object set
.. code:: bash
os object set
openstack object set
[--property <key=value> [...] ]
<container>
<object>
@ -157,7 +157,7 @@ Display object details
.. program:: object show
.. code:: bash
os object show
openstack object show
<container>
<object>
@ -177,7 +177,7 @@ Unset object properties
.. program:: object unset
.. code:: bash
os object unset
openstack object unset
[--property <key>]
<container>
<object>

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

@ -12,7 +12,7 @@ Create new policy
.. program:: policy create
.. code:: bash
os policy create
openstack policy create
[--type <type>]
<filename>
@ -32,7 +32,7 @@ Delete policy(s)
.. program:: policy delete
.. code:: bash
os policy delete
openstack policy delete
<policy> [<policy> ...]
.. describe:: <policy>
@ -47,7 +47,7 @@ List policies
.. program:: policy list
.. code:: bash
os policy list
openstack policy list
[--long]
.. option:: --long
@ -62,7 +62,7 @@ Set policy properties
.. program:: policy set
.. code:: bash
os policy set
openstack policy set
[--type <type>]
[--rules <filename>]
<policy>
@ -87,7 +87,7 @@ Display policy details
.. program:: policy show
.. code:: bash
os policy show
openstack policy show
<policy>
.. describe:: <policy>

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

@ -16,7 +16,7 @@ Create new port
.. program:: port create
.. code:: bash
os port create
openstack port create
--network <network>
[--description <description>]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
@ -127,7 +127,7 @@ Delete port(s)
.. program:: port delete
.. code:: bash
os port delete
openstack port delete
<port> [<port> ...]
.. _port_delete-port:
@ -143,7 +143,7 @@ List ports
.. program:: port list
.. code:: bash
os port list
openstack port list
[--device-owner <device-owner>]
[--router <router> | --server <server>]
[--network <network>]
@ -183,7 +183,7 @@ Set port properties
.. program:: port set
.. code:: bash
os port set
openstack port set
[--description <description>]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
[--no-fixed-ip]
@ -294,7 +294,7 @@ Display port details
.. program:: port show
.. code:: bash
os port show
openstack port show
<port>
.. _port_show-port:
@ -310,7 +310,7 @@ Unset port properties
.. program:: port unset
.. code:: bash
os port unset
openstack port unset
[--fixed-ip subnet=<subnet>,ip-address=<ip-address> [...]]
[--binding-profile <binding-profile-key> [...]]
[--security-group <security-group> [...]]

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

@ -12,7 +12,7 @@ Create new project
.. program:: project create
.. code:: bash
os project create
openstack project create
[--domain <domain>]
[--parent <project>]
[--description <description>]
@ -69,7 +69,7 @@ Delete project(s)
.. program:: project delete
.. code:: bash
os project delete
openstack project delete
[--domain <domain>]
<project> [<project> ...]
@ -92,7 +92,7 @@ List projects
.. program:: project list
.. code:: bash
os project list
openstack project list
[--domain <domain>]
[--user <user>]
[--long]
@ -121,7 +121,7 @@ Set project properties
.. program:: project set
.. code:: bash
os project set
openstack project set
[--name <name>]
[--domain <domain>]
[--description <description>]
@ -171,7 +171,7 @@ Display project details
.. program:: project show
.. code:: bash
os project show
openstack project show
[--domain <domain>]
<project>
@ -208,7 +208,7 @@ Unset project properties
.. program:: project unset
.. code:: bash
os project unset
openstack project unset
--property <key> [--property <key> ...]
<project>

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

@ -15,7 +15,7 @@ Set quotas for project
.. program:: quota set
.. code:: bash
os quota set
openstack quota set
# Compute settings
[--cores <num-cores>]
[--fixed-ips <num-fixed-ips>]
@ -58,7 +58,7 @@ Set quotas for class
.. code:: bash
os quota set
openstack quota set
--class
# Compute settings
[--cores <num-cores>]
@ -216,7 +216,7 @@ Show quotas for project or class
.. program:: quota show
.. code:: bash
os quota show
openstack quota show
[--default]
[<project>]
@ -232,7 +232,7 @@ Show quotas for project or class
.. code:: bash
os quota show
openstack quota show
--class
[<class>]

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

@ -12,7 +12,7 @@ Create new region
.. program:: region create
.. code:: bash
os region create
openstack region create
[--parent-region <region-id>]
[--description <description>]
<region-id>
@ -38,7 +38,7 @@ Delete region(s)
.. program:: region delete
.. code:: bash
os region delete
openstack region delete
<region-id> [<region-id> ...]
.. _region_delete-region-id:
@ -54,7 +54,7 @@ List regions
.. program:: region list
.. code:: bash
os region list
openstack region list
[--parent-region <region-id>]
.. option:: --parent-region <region-id>
@ -69,7 +69,7 @@ Set region properties
.. program:: region set
.. code:: bash
os region set
openstack region set
[--parent-region <region-id>]
[--description <description>]
<region-id>
@ -95,7 +95,7 @@ Display region details
.. program:: region show
.. code:: bash
os region show
openstack region show
<region-id>
.. _region_show-region-id:

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

@ -14,7 +14,7 @@ Authorize a request token
.. program:: request token authorize
.. code:: bash
os request token authorize
openstack request token authorize
--request-key <consumer-key>
--role <role>
@ -34,7 +34,7 @@ Create a request token
.. program:: request token create
.. code:: bash
os request token create
openstack request token create
--consumer-key <consumer-key>
--consumer-secret <consumer-secret>
--project <project>

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

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

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

@ -12,7 +12,7 @@ Add role assignment to a user or group in a project or domain
.. program:: role add
.. code:: bash
os role add
openstack role add
--domain <domain> | --project <project> [--project-domain <project-domain>]
--user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
--role-domain <role-domain>
@ -85,7 +85,7 @@ Create new role
.. program:: role create
.. code:: bash
os role create
openstack role create
[--or-show]
[--domain <domain>]
<name>
@ -114,7 +114,7 @@ Delete role(s)
.. program:: role delete
.. code:: bash
os role delete
openstack role delete
<role> [<role> ...]
[--domain <domain>]
@ -136,7 +136,7 @@ List roles
.. program:: role list
.. code:: bash
os role list
openstack role list
--domain <domain> | --project <project> [--project-domain <project-domain>]
--user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
--inherited
@ -209,7 +209,7 @@ Remove role assignment from domain/project : user/group
.. program:: role remove
.. code:: bash
os role remove
openstack role remove
--domain <domain> | --project <project> [--project-domain <project-domain>]
--user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
--role-domain <role-domain>
@ -284,7 +284,7 @@ Set role properties
.. program:: role set
.. code:: bash
os role set
openstack role set
[--name <name>]
[--domain <domain>]
<role>
@ -311,7 +311,7 @@ Display role details
.. program:: role show
.. code:: bash
os role show
openstack role show
[--domain <domain>]
<role>

20
doc/source/command-objects/router.rst
View File

@ -16,7 +16,7 @@ Add a port to a router
.. program:: router add port
.. code:: bash
os router add port
openstack router add port
<router>
<port>
@ -38,7 +38,7 @@ Add a subnet to a router
.. program:: router add subnet
.. code:: bash
os router add subnet
openstack router add subnet
<router>
<subnet>
@ -60,7 +60,7 @@ Create new router
.. program:: router create
.. code:: bash
os router create
openstack router create
[--project <project> [--project-domain <project-domain>]]
[--enable | --disable]
[--distributed]
@ -117,7 +117,7 @@ Delete router(s)
.. program:: router delete
.. code:: bash
os router delete
openstack router delete
<router> [<router> ...]
.. _router_delete-router:
@ -133,7 +133,7 @@ List routers
.. program:: router list
.. code:: bash
os router list
openstack router list
[--name <name>]
[--enable | --disable]
[--long]
@ -172,7 +172,7 @@ Remove a port from a router
.. program:: router remove port
.. code:: bash
os router remove port
openstack router remove port
<router>
<port>
@ -194,7 +194,7 @@ Remove a subnet from a router
.. program:: router remove subnet
.. code:: bash
os router remove subnet
openstack router remove subnet
<router>
<subnet>
@ -216,7 +216,7 @@ Set router properties
.. program:: router set
.. code:: bash
os router set
openstack router set
[--name <name>]
[--enable | --disable]
[--distributed | --centralized]
@ -300,7 +300,7 @@ Display router details
.. program:: router show
.. code:: bash
os router show
openstack router show
<router>
.. _router_show-router:
@ -316,7 +316,7 @@ Unset router properties
.. program:: router unset
.. code:: bash
os router unset
openstack router unset
[--route destination=<subnet>,gateway=<ip-address>]
<router>