5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-24 02:03:59 +03:00
pve-docs/pveceph.1-synopsis.adoc
2018-02-12 09:50:48 +01:00

208 lines
4.0 KiB
Plaintext

*pveceph* `<COMMAND> [ARGS] [OPTIONS]`
*pveceph createmgr* `[OPTIONS]`
Create Ceph Manager
`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
The ID for the manager, when omitted the same as the nodename
*pveceph createmon* `[OPTIONS]`
Create Ceph Monitor and Manager
`--exclude-manager` `<boolean>` ('default =' `0`)::
When set, only a monitor will be created.
`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
The ID for the monitor, when omitted the same as the nodename
`--mon-address` `<string>` ::
Overwrites autodetected monitor IP address. Must be in the public network of ceph.
*pveceph createosd* `<dev>` `[OPTIONS]`
Create OSD
`<dev>`: `<string>` ::
Block device name.
`--bluestore` `<boolean>` ('default =' `1`)::
Use bluestore instead of filestore. This is the default.
`--fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
File system type (filestore only).
`--journal_dev` `<string>` ::
Block device name for journal (filestore) or block.db (bluestore).
`--wal_dev` `<string>` ::
Block device name for block.wal (bluestore only).
*pveceph createpool* `<name>` `[OPTIONS]`
Create POOL
`<name>`: `<string>` ::
The name of the pool. It must be unique.
`--add_storages` `<boolean>` ::
Configure VM and CT storages using the new pool.
`--application` `<cephfs | rbd | rgw>` ::
The application of the pool, 'rbd' by default.
`--crush_rule` `<string>` ::
The rule to use for mapping object placement in the cluster.
`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
Minimum number of replicas per object
`--pg_num` `<integer> (8 - 32768)` ('default =' `64`)::
Number of placement groups.
`--size` `<integer> (1 - 7)` ('default =' `3`)::
Number of replicas per object
*pveceph destroymgr* `<id>`
Destroy Ceph Manager.
`<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
The ID of the manager
*pveceph destroymon* `<monid>` `[OPTIONS]`
Destroy Ceph Monitor and Manager.
`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
Monitor ID
`--exclude-manager` `<boolean>` ('default =' `0`)::
When set, removes only the monitor, not the manager
*pveceph destroyosd* `<osdid>` `[OPTIONS]`
Destroy OSD
`<osdid>`: `<integer>` ::
OSD ID
`--cleanup` `<boolean>` ('default =' `0`)::
If set, we remove partition table entries.
*pveceph destroypool* `<name>` `[OPTIONS]`
Destroy pool
`<name>`: `<string>` ::
The name of the pool. It must be unique.
`--force` `<boolean>` ('default =' `0`)::
If true, destroys pool even if in use
`--remove_storages` `<boolean>` ('default =' `0`)::
Remove all pveceph-managed storages configured for this pool
*pveceph help* `[OPTIONS]`
Get help about specified command.
`--extra-args` `<array>` ::
Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
*pveceph init* `[OPTIONS]`
Create initial ceph default configuration and setup symlinks.
`--disable_cephx` `<boolean>` ('default =' `0`)::
Disable cephx authentification.
+
WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!
`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
Minimum number of available replicas per object to allow I/O
`--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 default pools.
`--size` `<integer> (1 - 7)` ('default =' `3`)::
Targeted number of replicas per object
*pveceph install* `[OPTIONS]`
Install ceph related packages.
`--version` `<luminous>` ::
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|mgr)\.[A-Za-z0-9\-]{1,32}` ::
Ceph service name.
*pveceph status*
Get ceph status.
*pveceph stop* `[<service>]`
Stop ceph services.
`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ::
Ceph service name.