openstack/python-openstackclient
Code Issues Proposed changes

Merge "change os in command example to openstack"

Browse Source
This commit is contained in:
Jenkins 2016-12-20 16:00:50 +00:00 committed by Gerrit Code Review
commit 898c6a316a
22 changed files with 76 additions and 76 deletions

2
doc/source/command-objects/access-token.rst

@ -14,7 +14,7 @@ Create an access token
.. program:: access token create
.. code:: bash
os access token create
openstack access token create
--consumer-key <consumer-key>
--consumer-secret <consumer-secret>
--request-key <request-key>

10
doc/source/command-objects/address-scope.rst

@ -15,7 +15,7 @@ Create new address scope
.. program:: address scope create
.. code:: bash
os address scope create
openstack address scope create
[--project <project> [--project-domain <project-domain>]]
[--ip-version <ip-version>]
[--share | --no-share]
@ -55,7 +55,7 @@ Delete address scope(s)
.. program:: address scope delete
.. code:: bash
os address scope delete
openstack address scope delete
<address-scope> [<address-scope> ...]
.. _address_scope_delete-address-scope:
@ -71,7 +71,7 @@ List address scopes
.. program:: address scope list
.. code:: bash
os address scope list
openstack address scope list
[--name <name>]
[--ip-version <ip-version>]
[--project <project> [--project-domain <project-domain>]]
@ -110,7 +110,7 @@ Set address scope properties
.. program:: address scope set
.. code:: bash
os address scope set
openstack address scope set
[--name <name>]
[--share | --no-share]
<address-scope>
@ -140,7 +140,7 @@ Display address scope details
.. program:: address scope show
.. code:: bash
os address scope show
openstack address scope show
<address-scope>
.. _address_scope_show-address-scope:

16
doc/source/command-objects/aggregate.rst

@ -15,7 +15,7 @@ Add host to aggregate
.. program:: aggregate add host
.. code:: bash
os aggregate add host
openstack aggregate add host
<aggregate>
<host>
@ -36,7 +36,7 @@ Create a new aggregate
.. program:: aggregate create
.. code:: bash
os aggregate create
openstack aggregate create
[--zone <availability-zone>]
[--property <key=value> [...] ]
<name>
@ -61,7 +61,7 @@ Delete existing aggregate(s)
.. program:: aggregate delete
.. code:: bash
os aggregate delete
openstack aggregate delete
<aggregate> [<aggregate> ...]
.. describe:: <aggregate>
@ -76,7 +76,7 @@ List all aggregates
.. program:: aggregate list
.. code:: bash
os aggregate list
openstack aggregate list
[--long]
.. option:: --long
@ -91,7 +91,7 @@ Remove host from aggregate
.. program:: aggregate remove host
.. code:: bash
os aggregate remove host
openstack aggregate remove host
<aggregate>
<host>
@ -112,7 +112,7 @@ Set aggregate properties
.. program:: aggregate set
.. code:: bash
os aggregate set
openstack aggregate set
[--name <new-name>]
[--zone <availability-zone>]
[--property <key=value> [...] ]
@ -151,7 +151,7 @@ Display aggregate details
.. program:: aggregate show
.. code:: bash
os aggregate show
openstack aggregate show
<aggregate>
.. describe:: <aggregate>
@ -166,7 +166,7 @@ Unset aggregate properties
.. program:: aggregate unset
.. code-block:: bash
os aggregate unset
openstack aggregate unset
[--property <key> [...] ]
<aggregate>

2
doc/source/command-objects/availability-zone.rst

@ -15,7 +15,7 @@ List availability zones and their status
.. program availability zone list
.. code:: bash
os availability zone list
openstack availability zone list
[--compute]
[--network]
[--volume]

10
doc/source/command-objects/backup.rst

@ -13,7 +13,7 @@ Create new backup
.. program:: backup create
.. code:: bash
os backup create
openstack backup create
[--container <container>]
[--name <name>]
[--description <description>]
@ -66,7 +66,7 @@ Delete backup(s)
.. program:: backup delete
.. code:: bash
os backup delete
openstack backup delete
[--force]
<backup> [<backup> ...]
@ -90,7 +90,7 @@ List backups
.. program:: backup list
.. code:: bash
os backup list
openstack backup list
.. _backup_list-backup:
.. option:: --long
@ -106,7 +106,7 @@ Restore backup
.. program:: backup restore
.. code:: bash
os backup restore
openstack backup restore
<backup>
<volume>
@ -128,7 +128,7 @@ Display backup details
.. program:: backup show
.. code:: bash
os backup show
openstack backup show
<backup>
.. _backup_show-backup:

4
doc/source/command-objects/catalog.rst

@ -12,7 +12,7 @@ List services in the service catalog
.. program:: catalog list
.. code:: bash
os catalog list
openstack catalog list
catalog show
------------
@ -22,7 +22,7 @@ Display service catalog details
.. program:: catalog show
.. code:: bash
os catalog show
openstack catalog show
<service>
.. describe:: <service>

2
doc/source/command-objects/command.rst

@ -14,4 +14,4 @@ List recognized commands by group
.. program:: command list
.. code:: bash
os command list
openstack command list

2
doc/source/command-objects/complete.rst

@ -22,4 +22,4 @@ print bash completion command
.. program:: complete
.. code:: bash
os complete
openstack complete

8
doc/source/command-objects/compute-agent.rst

@ -12,7 +12,7 @@ Create compute agent
.. program:: compute agent create
.. code:: bash
os compute agent create
openstack compute agent create
<os> <architecture> <version> <url> <md5hash>
<hypervisor>
@ -49,7 +49,7 @@ Delete compute agent(s)
.. program:: compute agent delete
.. code:: bash
os compute agent delete <id> [<id> ...]
openstack compute agent delete <id> [<id> ...]
.. _compute_agent-delete:
.. describe:: <id>
@ -64,7 +64,7 @@ List compute agents
.. program:: compute agent list
.. code:: bash
os compute agent list [--hypervisor <hypervisor>]
openstack compute agent list [--hypervisor <hypervisor>]
.. option:: --hypervisor <hypervisor>
@ -78,7 +78,7 @@ Set compute agent properties
.. program:: agent set
.. code:: bash
os compute agent set
openstack compute agent set
[--agent-version <version>]
[--url <url]
[--md5hash <md5hash>]

6
doc/source/command-objects/compute-service.rst

@ -12,7 +12,7 @@ Delete compute service(s)
.. program:: compute service delete
.. code:: bash
os compute service delete
openstack compute service delete
<service> [<service> ...]
.. _compute-service-delete:
@ -28,7 +28,7 @@ List compute services
.. program:: compute service list
.. code:: bash
os compute service list
openstack compute service list
[--host <host>]
[--service <service>]
[--long]
@ -55,7 +55,7 @@ Set compute service properties
.. program:: compute service set
.. code:: bash
os compute service set
openstack compute service set
[--enable | --disable]
[--disable-reason <reason>]
[--up | --down]

2
doc/source/command-objects/configuration.rst

@ -15,7 +15,7 @@ show different configurations.
.. program:: configuration show
.. code:: bash
os configuration show
openstack configuration show
[--mask | --unmask]
.. option:: --mask

8
doc/source/command-objects/consistency-group-snapshot.rst

@ -12,7 +12,7 @@ Create new consistency group snapshot.
.. program:: consistency group snapshot create
.. code:: bash
os consistency group snapshot create
openstack consistency group snapshot create
[--consistency-group <consistency-group>]
[--description <description>]
[<snapshot-name>]
@ -39,7 +39,7 @@ Delete consistency group snapshot(s)
.. program:: consistency group snapshot delete
.. code:: bash
os consistency group snapshot delete
openstack consistency group snapshot delete
<consistency-group-snapshot> [<consistency-group-snapshot> ...]
.. _consistency_group_snapshot_delete-consistency-group-snapshot:
@ -55,7 +55,7 @@ List consistency group snapshots.
.. program:: consistency group snapshot list
.. code:: bash
os consistency group snapshot list
openstack consistency group snapshot list
[--all-projects]
[--long]
[--status <status>]
@ -87,7 +87,7 @@ Display consistency group snapshot details.
.. program:: consistency group snapshot show
.. code:: bash
os consistency group snapshot show
openstack consistency group snapshot show
<consistency-group-snapshot>
.. _consistency_group_snapshot_show-consistency-group-snapshot:

10
doc/source/command-objects/consistency-group.rst

@ -12,7 +12,7 @@ Create new consistency group.
.. program:: consistency group create
.. code:: bash
os consistency group create
openstack consistency group create
--volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>
[--description <description>]
[--availability-zone <availability-zone>]
@ -52,7 +52,7 @@ Delete consistency group(s).
.. program:: consistency group delete
.. code:: bash
os consistency group delete
openstack consistency group delete
[--force]
<consistency-group> [<consistency-group> ...]
@ -73,7 +73,7 @@ List consistency groups.
.. program:: consistency group list
.. code:: bash
os consistency group list
openstack consistency group list
[--all-projects]
[--long]
@ -94,7 +94,7 @@ Set consistency group properties.
.. program:: consistency group set
.. code:: bash
os consistency group set
openstack consistency group set
[--name <name>]
[--description <description>]
<consistency-group>
@ -120,7 +120,7 @@ Display consistency group details.
.. program:: consistency group show
.. code:: bash
os consistency group show
openstack consistency group show
<consistency-group>
.. _consistency_group_show-consistency-group:

2
doc/source/command-objects/console-log.rst

@ -14,7 +14,7 @@ Show server's console output
.. program:: console log show
.. code:: bash
os console log show
openstack console log show
[--lines <num-lines>]
<server>

2
doc/source/command-objects/console-url.rst

@ -14,7 +14,7 @@ Show server's remote console URL
.. program:: console url show
.. code:: bash
os console url show
openstack console url show
[--novnc | --xvpvnc | --spice]
[--rdp | --serial | --mks]
<server>

10
doc/source/command-objects/consumer.rst

@ -14,7 +14,7 @@ Create new consumer
.. program:: consumer create
.. code:: bash
os consumer create
openstack consumer create
[--description <description>]
.. option:: --description <description>
@ -29,7 +29,7 @@ Delete consumer(s)
.. program:: consumer delete
.. code:: bash
os consumer delete
openstack consumer delete
<consumer> [<consumer> ...]
.. describe:: <consumer>
@ -44,7 +44,7 @@ List consumers
.. program:: consumer list
.. code:: bash
os consumer list
openstack consumer list
consumer set
------------
@ -54,7 +54,7 @@ Set consumer properties
.. program:: consumer set
.. code:: bash
os consumer set
openstack consumer set
[--description <description>]
<consumer>
@ -74,7 +74,7 @@ Display consumer details
.. program:: consumer show
.. code:: bash
os consumer show
openstack consumer show
<consumer>
.. _consumer_show-consumer:

14
doc/source/command-objects/container.rst

@ -12,7 +12,7 @@ Create new container
.. program:: container create
.. code:: bash
os container create
openstack container create
<container-name> [<container-name> ...]
.. describe:: <container-name>
@ -27,7 +27,7 @@ Delete container
.. program:: container delete
.. code:: bash
os container delete
openstack container delete
[-r] | [--recursive]
<container> [<container> ...]
@ -47,7 +47,7 @@ List containers
.. program:: container list
.. code:: bash
os container list
openstack container list
[--prefix <prefix>]
[--marker <marker>]
[--end-marker <end-marker>]
@ -87,7 +87,7 @@ Save container contents locally
.. program:: container save
.. code:: bash
os container save
openstack container save
<container>
.. describe:: <container>
@ -102,7 +102,7 @@ Set container properties
.. program:: container set
.. code:: bash
os container set
openstack container set
[--property <key=value> [...] ]
<container>
@ -122,7 +122,7 @@ Display container details
.. program:: container show
.. code:: bash
os container show
openstack container show
<container>
.. describe:: <container>
@ -137,7 +137,7 @@ Unset container properties
.. program:: container unset
.. code:: bash
os container unset
openstack container unset
[--property <key>]
<container>

10
doc/source/command-objects/credential.rst

@ -12,7 +12,7 @@ Create new credential
.. program:: credential create
.. code:: bash
os credential create
openstack credential create
[--type <type>]
[--project <project>]
<user> <data>
@ -42,7 +42,7 @@ Delete credential(s)
.. program:: credential delete
.. code:: bash
os credential delete
openstack credential delete
<credential-id> [<credential-id> ...]
.. _credential_delete:
@ -58,7 +58,7 @@ List credentials
.. program:: credential list
.. code:: bash
os credential list
openstack credential list
credential set
--------------
@ -68,7 +68,7 @@ Set credential properties
.. program:: credential set
.. code:: bash
os credential set
openstack credential set
[--user <user>]
[--type <type>]
[--data <data>]
@ -104,7 +104,7 @@ Display credential details
.. program:: credential show
.. code:: bash
os credential show
openstack credential show
<credential-id>
.. _credential_show:

10
doc/source/command-objects/domain.rst

@ -12,7 +12,7 @@ Create new domain
.. program:: domain create
.. code:: bash
os domain create
openstack domain create
[--description <description>]
[--enable | --disable]
[--or-show]
@ -48,7 +48,7 @@ Delete domain(s)
.. program:: domain delete
.. code:: bash
os domain delete
openstack domain delete
<domain> [<domain> ...]
.. describe:: <domain>
@ -63,7 +63,7 @@ List domains
.. program:: domain list
.. code:: bash
os domain list
openstack domain list
domain set
----------
@ -73,7 +73,7 @@ Set domain properties
.. program:: domain set
.. code:: bash
os domain set
openstack domain set
[--name <name>]
[--description <description>]
[--enable | --disable]
@ -107,7 +107,7 @@ Display domain details
.. program:: domain show
.. code:: bash
os domain show
openstack domain show
<domain>
.. describe:: <domain>

8
doc/source/command-objects/ec2-credentials.rst

@ -12,7 +12,7 @@ Create EC2 credentials
.. program:: ec2 credentials create
.. code-block:: bash
os ec2 credentials create
openstack ec2 credentials create
[--project <project>]
[--user <user>]
[--user-domain <user-domain>]
@ -52,7 +52,7 @@ Delete EC2 credentials
.. program:: ec2 credentials delete
.. code-block:: bash
os ec2 credentials delete
openstack ec2 credentials delete
[--user <user>]
[--user-domain <user-domain>]
<access-key> [<access-key> ...]
@ -85,7 +85,7 @@ List EC2 credentials
.. program:: ec2 credentials list
.. code-block:: bash
os ec2 credentials list
openstack ec2 credentials list
[--user <user>]
[--user-domain <user-domain>]
@ -112,7 +112,7 @@ Display EC2 credentials details
.. program:: ec2 credentials show
.. code-block:: bash
os ec2 credentials show
openstack ec2 credentials show
[--user <user>]
[--user-domain <user-domain>]
<access-key>

12
doc/source/command-objects/endpoint.rst

@ -14,7 +14,7 @@ Create new endpoint
.. program:: endpoint create
.. code:: bash
os endpoint create
openstack endpoint create
--publicurl <url>
[--adminurl <url>]
[--internalurl <url>]
@ -47,7 +47,7 @@ Create new endpoint
.. program:: endpoint create
.. code:: bash
os endpoint create
openstack endpoint create
[--region <region-id>]
[--enable | --disable]
<service>
@ -86,7 +86,7 @@ Delete endpoint(s)
.. program:: endpoint delete
.. code:: bash
os endpoint delete
openstack endpoint delete
<endpoint-id> [<endpoint-id> ...]
.. _endpoint_delete-endpoint:
@ -102,7 +102,7 @@ List endpoints
.. program:: endpoint list
.. code:: bash
os endpoint list
openstack endpoint list
[--service <service]
[--interface <interface>]
[--region <region-id>]
@ -142,7 +142,7 @@ Set endpoint properties
.. program:: endpoint set
.. code:: bash
os endpoint set
openstack endpoint set
[--region <region-id>]
[--interface <interface>]
[--url <url>]
@ -187,7 +187,7 @@ Display endpoint details
.. program:: endpoint show
.. code:: bash
os endpoint show
openstack endpoint show
<endpoint>
.. _endpoint_show-endpoint:

2
doc/source/command-objects/extension.rst

@ -13,7 +13,7 @@ List API extensions
.. program:: extension list
.. code:: bash
os extension list
openstack extension list
[--compute]
[--identity]
[--network]