1STRATIS(8) STRATIS(8)
2
6 stratis - Configure Stratis local storage pools
7
9 stratis [GLOBAL OPTIONS] pool <command> [args] [COMMAND OPTIONS]
10 stratis [GLOBAL OPTIONS] filesystem|fs <command> [args] [COMMAND OPTIONS]
11 stratis [GLOBAL OPTIONS] blockdev <command> [args] [COMMAND OPTIONS]
12 stratis [GLOBAL OPTIONS] daemon <redundancy|version>
13
15 stratis is a command-line tool to create, modify, and destroy Stratis
16 pools, and the filesystems allocated from the pool.
17 Stratis creates a pool from one or more block devices (blockdevs), and
19 then enables multiple filesystems to be created from the pool.
20
22 --version
23 Show stratis-cli version.
24 --help, -h
26 Show help on command.
27 --propagate
29 (For debugging.) Allow exceptions raised during execution to
30 propagate.
31
33 pool create <pool_name> <blockdev> [<blockdev>..]
34 Create a pool from one or more block devices, with the given pool
35 name.
36 pool list
38 List all pools on the system.
39 pool rename <old_pool_name> <new_pool_name>
41 Rename a pool.
42 pool destroy <pool_name>
44 Destroy a pool and all the filesystems created from it.
45 pool add-data <pool_name> <blockdev> [<blockdev>..]
47 Add one or more blockdevs to an existing pool, to enlarge its
48 storage capacity.
49 pool add-cache <pool_name> <blockdev> [<blockdev>..]
51 Add one or more blockdevs to an existing pool, to be used as a
52 cache instead of additional storage. Typically, smaller and faster
53 drives, such as SSDs, are used for this purpose. NOTE: There is a
54 temporary restriction on the total size of the cache device of 32
55 TiB. Adding devices to the cache so that the cumulative size of all
56 the devices in the cache exceeds 32 TiB will result in an error.
57 filesystem create <pool_name> <fs_name> [<fs_name>..]
59 Create one or more filesystems from the specified pool. NOTE: There
60 is a temporary restriction on the number of filesystems that can be
61 specified with this command. Specifying more than one filesystem
62 will result in an error.
63 filesystem snapshot <pool_name> <fs_name> <snapshot_name>
65 Snapshot the filesystem in the specified pool.
66 filesystem list [pool_name]
68 List all filesystems that exist in the specified pool, or all
69 pools, if no pool name is given.
70 filesystem destroy <pool_name> <fs_name> [<fs_name>..]
72 Destroy one or more filesystems that exist in the specified pool.
73 filesystem rename <pool_name> <fs_name> <new_name>
75 Rename a filesystem.
76 blockdev list [pool_name]
78 List all blockdevs that make up the specified pool, or all pools,
79 if no pool name is given.
80 daemon redundancy
82 List the redundancy levels that the Stratis service supports.
83 daemon version
85 Show the Stratis service’s version.
86
88 STRATIS_DBUS_TIMEOUT
89 Sets a timeout for any Stratis D-Bus call. If this environment
90 variable is not set, a default value of 120 seconds is used for the
91 timeout. The accepted STRATIS_DBUS_TIMEOUT environment variable
92 values are:
93 1. an integer between 0 (inclusive) and 1073741823 (inclusive),
95 which represents the timeout length in milliseconds
96 2. -1, which represents the libdbus default timeout
98
100 FIELDS for stratis pool list
101 Name
103 The name of the pool.
104 Total Physical
106 The physical usage statistics for the pool (Total / Used / Free).
107 FIELDS for stratis filesystem list
109 Pool Name
111 The name of the pool containing the filesystem.
112 Used
114 The amount of storage space used in the pool by this filesystem.
115 Created
117 The time the filesystem was created.
118 Device
120 The device path to use for mounting the filesystem.
121 UUID
123 The UUID of the filesystem.
124 FIELDS for stratis blockdev list
126 Pool Name
128 The name of the pool using the block device.
129 Device Node
131 The device node of the block device.
132 Physical Size
134 The size of the device.
135 Tier
137 The data tier type ("Data" or "Cache")
138
140 If a block device appears to be already in use, stratisd will refuse to
141 claim it. To allow use with stratisd, any signature on the device must
142 first be erased. Please carefully verify the identity and availability
143 of the device before taking such a step.
144
146 Example 1. Creating a Stratis pool
147 stratis pool create mypool /dev/sdb /dev/sdc
149 Example 2. Creating a filesystem from a pool
151 stratis filesystem create mypool data1
153
155 mount(8), umount(8), fstab(5)
156
158 GitHub for issues and development
159 https://github.com/stratis-storage, against either stratis-cli or
160 stratisd projects, based on likelihood of issue being with the
161 command-line tool or the service daemon.
162 Mailing list
164 stratis-devel@lists.fedorahosted.org for general development
165 discussion
166 Unknown values
168 If the stratisd D-Bus API returns values that stratis-cli cannot
169 interpret, stratis-cli will substitute "???". If encountered,
170 upgrading to the latest version of stratis-cli, or filing an issue,
171 is recommended.
172 Unobtainable values
174 If the stratisd D-Bus API indicates that a value is unobtainable,
175 stratis-cli will substitute "FAILURE". This may indicate something
176 wrong with the pool, blockdev, or filesystem. In some cases,
177 restarting stratisd may resolve the issue.
178
180 stratis-cli is licensed under the Apache License, Version 2.0. Software
181 distributed under this license is distributed on an "AS IS" BASIS,
182 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or
183 implied.
184 02/19/2020 STRATIS(8)