[pve-docs.git] / pveceph.1-synopsis.adoc

*pveceph* `<COMMAND> [ARGS] [OPTIONS]`

*pveceph createmon*

Create Ceph Monitor


*pveceph createosd* `<dev>` `[OPTIONS]`

Create OSD

`<dev>` `string` ::

Block device name.

`-fstype` `(btrfs | ext4 | xfs)` (default=`xfs`)::

File system type.

`-journal_dev` `string` ::

Block device name for journal.


*pveceph createpool* `<name>` `[OPTIONS]`

Create POOL

`<name>` `string` ::

The name of the pool. It must be unique.

`-crush_ruleset` `integer (0 - 32768)` (default=`0`)::

The ruleset to use for mapping object placement in the cluster.

`-min_size` `integer (1 - 3)` (default=`1`)::

Minimum number of replicas per object

`-pg_num` `integer (8 - 32768)` (default=`64`)::

Number of placement groups.

`-size` `integer (1 - 3)` (default=`2`)::

Number of replicas per object


*pveceph destroymon* `<monid>`

Destroy Ceph monitor.

`<monid>` `integer` ::

Monitor ID


*pveceph destroyosd* `<osdid>` `[OPTIONS]`

Destroy OSD

`<osdid>` `integer` ::

OSD ID

`-cleanup` `boolean` (default=`0`)::

If set, we remove partition table entries.


*pveceph destroypool* `<name>`

Destroy pool

`<name>` `string` ::

The name of the pool. It must be unique.


*pveceph help* `[<cmd>]` `[OPTIONS]`

Get help about specified command.

`<cmd>` `string` ::

Command name

`-verbose` `boolean` ::

Verbose output format.


*pveceph init* `[OPTIONS]`

Create initial ceph default configuration and setup symlinks.

`-network` `string` ::

Use specific network for all ceph related traffic

`-pg_bits` `integer (6 - 14)` (default=`6`)::

Placement group bits, used to specify the default number of placement
groups (Note: 'osd pool default pg num' does not work for deafult pools)

`-size` `integer (1 - 3)` (default=`2`)::

Number of replicas per object


*pveceph install* `[OPTIONS]`

Install ceph related packages.

`-version` `(hammer)` ::

no description available


*pveceph lspools*

List all pools.


*pveceph purge*

Destroy ceph related data and configuration files.


*pveceph start* `[<service>]`

Start ceph services.

`<service>` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::

Ceph service name.


*pveceph status*

Get ceph status.


*pveceph stop* `[<service>]`

Stop ceph services.

`<service>` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::

Ceph service name.
Commit	Line	Data
0840a663 DM	1	pveceph `<COMMAND> [ARGS] [OPTIONS]`
	2
	3	pveceph createmon
	4
	5	Create Ceph Monitor
	6
	7
	8
	9
	10	pveceph createosd `<dev>` `[OPTIONS]`
	11
	12	Create OSD
	13
	14	`<dev>` `string` ::
	15
	16	Block device name.
	17
	18	`-fstype` `(btrfs \| ext4 \| xfs)` (default=`xfs`)::
	19
	20	File system type.
	21
	22	`-journal_dev` `string` ::
	23
	24	Block device name for journal.
	25
	26
	27
	28
	29	pveceph createpool `<name>` `[OPTIONS]`
	30
	31	Create POOL
	32
	33	`<name>` `string` ::
	34
	35	The name of the pool. It must be unique.
	36
	37	`-crush_ruleset` `integer (0 - 32768)` (default=`0`)::
	38
	39	The ruleset to use for mapping object placement in the cluster.
	40
	41	`-min_size` `integer (1 - 3)` (default=`1`)::
	42
	43	Minimum number of replicas per object
	44
	45	`-pg_num` `integer (8 - 32768)` (default=`64`)::
	46
	47	Number of placement groups.
	48
	49	`-size` `integer (1 - 3)` (default=`2`)::
	50
	51	Number of replicas per object
	52
	53
	54
	55	pveceph destroymon `<monid>`
	56
	57	Destroy Ceph monitor.
	58
	59	`<monid>` `integer` ::
	60
	61	Monitor ID
	62
	63
	64
65
66	pveceph destroyosd `<osdid>` `[OPTIONS]`
67
68	Destroy OSD
69
70	`<osdid>` `integer` ::
71
72	OSD ID
73
74	`-cleanup` `boolean` (default=`0`)::
75
76	If set, we remove partition table entries.
77
78
79
80
81	pveceph destroypool `<name>`
82
83	Destroy pool
84
85	`<name>` `string` ::
86
87	The name of the pool. It must be unique.
88
89
90
91
92	pveceph help `[<cmd>]` `[OPTIONS]`
93
94	Get help about specified command.
95
96	`<cmd>` `string` ::
97
98	Command name
99
100	`-verbose` `boolean` ::
101
102	Verbose output format.
103
104
105
106
107	pveceph init `[OPTIONS]`
108
109	Create initial ceph default configuration and setup symlinks.
110
111	`-network` `string` ::
112
113	Use specific network for all ceph related traffic
114
115	`-pg_bits` `integer (6 - 14)` (default=`6`)::
116
117	Placement group bits, used to specify the default number of placement
118	groups (Note: 'osd pool default pg num' does not work for deafult pools)
119
120	`-size` `integer (1 - 3)` (default=`2`)::
121
122	Number of replicas per object
123
124
125
126
127	pveceph install `[OPTIONS]`
128
129	Install ceph related packages.
130
131	`-version` `(hammer)` ::
132
133	no description available
134
135
136
137
138	pveceph lspools
139
140	List all pools.
141
142
143
144
145	pveceph purge
146
147	Destroy ceph related data and configuration files.
148
149
150
151
152	pveceph start `[<service>]`
153
154	Start ceph services.
155
156	`<service>` `(mon\|mds\|osd)\.[A-Za-z0-9]{1,32}` ::
157
158	Ceph service name.
159
160
161
162	pveceph status
163
164	Get ceph status.
165
166
167
168	pveceph stop `[<service>]`
169
170	Stop ceph services.
171
172	`<service>` `(mon\|mds\|osd)\.[A-Za-z0-9]{1,32}` ::
173
174	Ceph service name.
175
176
177
178