summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/container.rst
blob: 3372f4d9bd5bae84581d4b01f09e9c8f6449e4c5 (plain)
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
=========
container
=========

Object Store v1

container create
----------------

Create new container

.. program:: container create
.. code:: bash

    os container create
        <container-name> [<container-name> ...]

.. describe:: <container-name>

    New container name(s)

container delete
----------------

Delete container

.. program:: container delete
.. code:: bash

    os container delete
        <container> [<container> ...]

.. describe:: <container>

    Container(s) to delete

container list
--------------

List containers

.. program:: container list
.. code::bash

    os container list
        [--prefix <prefix>]
        [--marker <marker>]
        [--end-marker <end-marker>]
        [--limit <limit>]
        [--long]
        [--all]

.. option:: --prefix <prefix>

    Filter list using <prefix>

.. option:: --marker <marker>

    Anchor for paging

.. option:: --end-marker <end-marker>

    End anchor for paging

.. option:: --limit <limit>

    Limit the number of containers returned

.. option:: --long

    List additional fields in output

.. option:: --all

    List all containers (default is 10000)

container save
--------------

Save container contents locally

.. program:: container save
.. code:: bash

    os container save
        <container>

.. describe:: <container>

    Container to save

container show
--------------

Display container details

.. program:: container show
.. code:: bash

    os container show
        [<container>]

.. describe:: <container>

    Container to display