fixup: s/devies/devices/
[pve-docs.git] / pveceph.1-synopsis.adoc
1 *pveceph* `<COMMAND> [ARGS] [OPTIONS]`
2
3 *pveceph createmgr*
4
5 An alias for 'pveceph mgr create'.
6
7 *pveceph createmon*
8
9 An alias for 'pveceph mon create'.
10
11 *pveceph createosd*
12
13 An alias for 'pveceph osd create'.
14
15 *pveceph createpool*
16
17 An alias for 'pveceph pool create'.
18
19 *pveceph destroymgr*
20
21 An alias for 'pveceph mgr destroy'.
22
23 *pveceph destroymon*
24
25 An alias for 'pveceph mon destroy'.
26
27 *pveceph destroyosd*
28
29 An alias for 'pveceph osd destroy'.
30
31 *pveceph destroypool*
32
33 An alias for 'pveceph pool destroy'.
34
35 *pveceph fs create* `[OPTIONS]`
36
37 Create a Ceph filesystem
38
39 `--add-storage` `<boolean>` ('default =' `0`)::
40
41 Configure the created CephFS as storage for this cluster.
42
43 `--name` `<string>` ('default =' `cephfs`)::
44
45 The ceph filesystem name.
46
47 `--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
48
49 Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
50
51 *pveceph help* `[OPTIONS]`
52
53 Get help about specified command.
54
55 `--extra-args` `<array>` ::
56
57 Shows help for a specific command
58
59 `--verbose` `<boolean>` ::
60
61 Verbose output format.
62
63 *pveceph init* `[OPTIONS]`
64
65 Create initial ceph default configuration and setup symlinks.
66
67 `--cluster-network` `<string>` ::
68
69 Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it
70 +
71 NOTE: Requires option(s): `network`
72
73 `--disable_cephx` `<boolean>` ('default =' `0`)::
74
75 Disable cephx authentification.
76 +
77 WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!
78
79 `--min_size` `<integer> (1 - 7)` ('default =' `2`)::
80
81 Minimum number of available replicas per object to allow I/O
82
83 `--network` `<string>` ::
84
85 Use specific network for all ceph related traffic
86
87 `--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
88
89 Placement group bits, used to specify the default number of placement groups.
90 +
91 NOTE: 'osd pool default pg num' does not work for default pools.
92
93 `--size` `<integer> (1 - 7)` ('default =' `3`)::
94
95 Targeted number of replicas per object
96
97 *pveceph install* `[OPTIONS]`
98
99 Install ceph related packages.
100
101 `--version` `<luminous>` ::
102
103 no description available
104
105 *pveceph lspools*
106
107 An alias for 'pveceph pool ls'.
108
109 *pveceph mds create* `[OPTIONS]`
110
111 Create Ceph Metadata Server (MDS)
112
113 `--hotstandby` `<boolean>` ('default =' `0`)::
114
115 Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources.
116
117 `--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::
118
119 The ID for the mds, when omitted the same as the nodename
120
121 *pveceph mds destroy* `<name>`
122
123 Destroy Ceph Metadata Server
124
125 `<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
126
127 The name (ID) of the mds
128
129 *pveceph mgr create* `[OPTIONS]`
130
131 Create Ceph Manager
132
133 `--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
134
135 The ID for the manager, when omitted the same as the nodename
136
137 *pveceph mgr destroy* `<id>`
138
139 Destroy Ceph Manager.
140
141 `<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
142
143 The ID of the manager
144
145 *pveceph mon create* `[OPTIONS]`
146
147 Create Ceph Monitor and Manager
148
149 `--exclude-manager` `<boolean>` ('default =' `0`)::
150
151 When set, only a monitor will be created.
152
153 `--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
154
155 The ID for the monitor, when omitted the same as the nodename
156
157 `--mon-address` `<string>` ::
158
159 Overwrites autodetected monitor IP address. Must be in the public network of ceph.
160
161 *pveceph mon destroy* `<monid>` `[OPTIONS]`
162
163 Destroy Ceph Monitor and Manager.
164
165 `<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
166
167 Monitor ID
168
169 `--exclude-manager` `<boolean>` ('default =' `0`)::
170
171 When set, removes only the monitor, not the manager
172
173 *pveceph osd create* `<dev>` `[OPTIONS]`
174
175 Create OSD
176
177 `<dev>`: `<string>` ::
178
179 Block device name.
180
181 `--bluestore` `<boolean>` ('default =' `1`)::
182
183 Use bluestore instead of filestore. This is the default.
184
185 `--fstype` `<ext4 | xfs>` ('default =' `xfs`)::
186
187 File system type (filestore only).
188
189 `--journal_dev` `<string>` ::
190
191 Block device name for journal (filestore) or block.db (bluestore).
192
193 `--wal_dev` `<string>` ::
194
195 Block device name for block.wal (bluestore only).
196
197 *pveceph osd destroy* `<osdid>` `[OPTIONS]`
198
199 Destroy OSD
200
201 `<osdid>`: `<integer>` ::
202
203 OSD ID
204
205 `--cleanup` `<boolean>` ('default =' `0`)::
206
207 If set, we remove partition table entries.
208
209 *pveceph pool create* `<name>` `[OPTIONS]`
210
211 Create POOL
212
213 `<name>`: `<string>` ::
214
215 The name of the pool. It must be unique.
216
217 `--add_storages` `<boolean>` ::
218
219 Configure VM and CT storage using the new pool.
220
221 `--application` `<cephfs | rbd | rgw>` ::
222
223 The application of the pool, 'rbd' by default.
224
225 `--crush_rule` `<string>` ::
226
227 The rule to use for mapping object placement in the cluster.
228
229 `--min_size` `<integer> (1 - 7)` ('default =' `2`)::
230
231 Minimum number of replicas per object
232
233 `--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
234
235 Number of placement groups.
236
237 `--size` `<integer> (1 - 7)` ('default =' `3`)::
238
239 Number of replicas per object
240
241 *pveceph pool destroy* `<name>` `[OPTIONS]`
242
243 Destroy pool
244
245 `<name>`: `<string>` ::
246
247 The name of the pool. It must be unique.
248
249 `--force` `<boolean>` ('default =' `0`)::
250
251 If true, destroys pool even if in use
252
253 `--remove_storages` `<boolean>` ('default =' `0`)::
254
255 Remove all pveceph-managed storages configured for this pool
256
257 *pveceph pool ls*
258
259 List all pools.
260
261 *pveceph purge*
262
263 Destroy ceph related data and configuration files.
264
265 *pveceph start* `[<service>]`
266
267 Start ceph services.
268
269 `<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
270
271 Ceph service name.
272
273 *pveceph status*
274
275 Get ceph status.
276
277 *pveceph stop* `[<service>]`
278
279 Stop ceph services.
280
281 `<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
282
283 Ceph service name.
284
285