python-openstackclient/doc/source/specs/command-objects/example.rst
Kevin_Zheng 446e6f2fa8 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
2016-12-20 09:26:15 +08:00

1.4 KiB

example

This is a specification for the example command object. It is not intended to be a complete template for new commands since other actions, options and/or arguments may be used. You can include general specification information before the commands below. This information could include links to related material or descriptions of similar commands.

[example API name] [example API version]

example create

Create new example

example create

openstack example create
    <name>

<name>

New example name

example delete

Delete example(s)

example delete

openstack example delete
    <example> [<example> ...]

<example>

Example(s) to delete (name or ID)

example list

List examples

example list

openstack example list

example set

Set example properties

example set

openstack example set
    [--name <new-name>]
    <example>

--name <new-name>

New example name

<example>

Example to modify (name or ID)

example show

Display example details

example show

openstack example show
    <example>

<example>

Example to display (name or ID)