Skip to content

example.rst

Latest commit

 

History

History
86 lines (54 loc) · 1.38 KB

example.rst

File metadata and controls

86 lines (54 loc) · 1.38 KB

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

.. program:: example create

openstack example create
    <name>
.. describe:: <name>

    New example name

example delete

Delete example(s)

.. program:: example delete

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

    Example(s) to delete (name or ID)

example list

List examples

.. program:: example list

openstack example list

example set

Set example properties

.. program:: example set

openstack example set
    [--name <new-name>]
    <example>
.. option:: --name <new-name>

    New example name


.. describe:: <example>

    Example to modify (name or ID)

example show

Display example details

.. program:: example show

openstack example show
    <example>
.. describe:: <example>

    Example to display (name or ID)