File: example.rst

package info (click to toggle)
python-openstackclient 7.4.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 11,012 kB
  • sloc: python: 135,291; makefile: 140; sh: 22
file content (86 lines) | stat: -rw-r--r-- 1,416 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
=======
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
.. code:: bash

    openstack example create
        <name>

.. describe:: <name>

    New example name

example delete
--------------

Delete example(s)

.. program:: example delete
.. code:: bash

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

.. describe:: <example>

    Example(s) to delete (name or ID)

example list
------------

List examples

.. program:: example list
.. code:: bash

    openstack example list

example set
-----------

Set example properties

.. program:: example set
.. code:: bash

    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
.. code:: bash

    openstack example show
        <example>

.. describe:: <example>

    Example to display (name or ID)