*pveceph* `<COMMAND> [ARGS] [OPTIONS]`
-*pveceph createmgr* `[OPTIONS]`
+*pveceph createmgr*
-Create Ceph Manager
+An alias for 'pveceph mgr create'.
-`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+*pveceph createmon*
-The ID for the manager, when omitted the same as the nodename
+An alias for 'pveceph mon create'.
-*pveceph createmon* `[OPTIONS]`
+*pveceph createosd*
-Create Ceph Monitor and Manager
+An alias for 'pveceph osd create'.
-`--exclude-manager` `<boolean>` ('default =' `0`)::
+*pveceph createpool*
-When set, only a monitor will be created.
+An alias for 'pveceph pool create'.
-`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+*pveceph destroymgr*
-The ID for the monitor, when omitted the same as the nodename
+An alias for 'pveceph mgr destroy'.
-`--mon-address` `<string>` ::
+*pveceph destroymon*
-Overwrites autodetected monitor IP address. Must be in the public network of ceph.
+An alias for 'pveceph mon destroy'.
-*pveceph createosd* `<dev>` `[OPTIONS]`
+*pveceph destroyosd*
-Create OSD
+An alias for 'pveceph osd destroy'.
-`<dev>`: `<string>` ::
+*pveceph destroypool*
-Block device name.
+An alias for 'pveceph pool destroy'.
-`--bluestore` `<boolean>` ('default =' `1`)::
+*pveceph fs create* `[OPTIONS]`
-Use bluestore instead of filestore. This is the default.
+Create a Ceph filesystem
-`--fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
+`--add-storage` `<boolean>` ('default =' `0`)::
-File system type (filestore only).
+Configure the created CephFS as storage for this cluster.
-`--journal_dev` `<string>` ::
+`--name` `<string>` ('default =' `cephfs`)::
-Block device name for journal (filestore) or block.db (bluestore).
+The ceph filesystem name.
-`--wal_dev` `<string>` ::
+`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
-Block device name for block.wal (bluestore only).
+Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
-*pveceph createpool* `<name>` `[OPTIONS]`
+*pveceph fs destroy* `<name>` `[OPTIONS]`
-Create POOL
+Destroy a Ceph filesystem
`<name>`: `<string>` ::
-The name of the pool. It must be unique.
+The ceph filesystem name.
-`--add_storages` `<boolean>` ::
+`--remove-pools` `<boolean>` ('default =' `0`)::
-Configure VM and CT storages using the new pool.
+Remove data and metadata pools configured for this fs.
-`--application` `<cephfs | rbd | rgw>` ::
+`--remove-storages` `<boolean>` ('default =' `0`)::
-The application of the pool, 'rbd' by default.
+Remove all pveceph-managed storages configured for this fs.
-`--crush_rule` `<string>` ::
+*pveceph help* `[OPTIONS]`
-The rule to use for mapping object placement in the cluster.
+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.
+
+`--cluster-network` `<string>` ::
+
+Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it
++
+NOTE: Requires option(s): `network`
+
+`--disable_cephx` `<boolean>` ('default =' `0`)::
+
+Disable cephx authentication.
++
+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 replicas per object
+Minimum number of available replicas per object to allow I/O
+
+`--network` `<string>` ::
-`--pg_num` `<integer> (8 - 32768)` ('default =' `64`)::
+Use specific network for all ceph related traffic
-Number of placement groups.
+`--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
+
+Placement group bits, used to specify the default number of placement groups.
++
+Depreacted. This setting was deprecated in recent Ceph versions.
`--size` `<integer> (1 - 7)` ('default =' `3`)::
-Number of replicas per object
+Targeted number of replicas per object
-*pveceph destroymgr* `<id>`
+*pveceph install* `[OPTIONS]`
+
+Install ceph related packages.
+
+`--allow-experimental` `<boolean>` ('default =' `0`)::
+
+Allow experimental versions. Use with care!
+
+`--repository` `<enterprise | no-subscription | test>` ('default =' `enterprise`)::
+
+Ceph repository to use.
+
+`--version` `<quincy | reef>` ('default =' `quincy`)::
+
+Ceph version to install.
+
+*pveceph lspools*
+
+An alias for 'pveceph pool ls'.
+
+*pveceph mds create* `[OPTIONS]`
+
+Create Ceph Metadata Server (MDS)
+
+`--hotstandby` `<boolean>` ('default =' `0`)::
+
+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.
+
+`--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::
+
+The ID for the mds, when omitted the same as the nodename
+
+*pveceph mds destroy* `<name>`
+
+Destroy Ceph Metadata Server
+
+`<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+
+The name (ID) of the mds
+
+*pveceph mgr create* `[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 mgr destroy* `<id>`
Destroy Ceph Manager.
The ID of the manager
-*pveceph destroymon* `<monid>` `[OPTIONS]`
+*pveceph mon create* `[OPTIONS]`
+
+Create Ceph Monitor and Manager
+
+`--mon-address` `<string>` ::
+
+Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph.
+
+`--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+
+The ID for the monitor, when omitted the same as the nodename
+
+*pveceph mon destroy* `<monid>`
Destroy Ceph Monitor and Manager.
Monitor ID
-`--exclude-manager` `<boolean>` ('default =' `0`)::
+*pveceph osd create* `<dev>` `[OPTIONS]`
+
+Create OSD
+
+`<dev>`: `<string>` ::
+
+Block device name.
+
+`--crush-device-class` `<string>` ::
+
+Set the device class of the OSD in crush.
+
+`--db_dev` `<string>` ::
+
+Block device name for block.db.
-When set, removes only the monitor, not the manager
+`--db_dev_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
-*pveceph destroyosd* `<osdid>` `[OPTIONS]`
+Size in GiB for block.db.
++
+NOTE: Requires option(s): `db_dev`
+
+`--encrypted` `<boolean>` ('default =' `0`)::
+
+Enables encryption of the OSD.
+
+`--osds-per-device` `<integer> (1 - N)` ::
+
+OSD services per physical device. Only useful for fast NVMe devices"
+ ." to utilize their performance better.
+
+`--wal_dev` `<string>` ::
+
+Block device name for block.wal.
+
+`--wal_dev_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
+
+Size in GiB for block.wal.
++
+NOTE: Requires option(s): `wal_dev`
+
+*pveceph osd destroy* `<osdid>` `[OPTIONS]`
Destroy OSD
If set, we remove partition table entries.
-*pveceph destroypool* `<name>` `[OPTIONS]`
+*pveceph osd details* `<osdid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Get OSD details.
+
+`<osdid>`: `<string>` ::
+
+ID of the OSD
+
+`--verbose` `<boolean>` ('default =' `0`)::
+
+Print verbose information, same as json-pretty output format.
+
+*pveceph pool create* `<name>` `[OPTIONS]`
+
+Create Ceph pool
+
+`<name>`: `<string>` ::
+
+The name of the pool. It must be unique.
+
+`--add_storages` `<boolean>` ('default =' `0; for erasure coded pools: 1`)::
+
+Configure VM and CT storage using the new pool.
+
+`--application` `<cephfs | rbd | rgw>` ('default =' `rbd`)::
+
+The application of the pool.
+
+`--crush_rule` `<string>` ::
+
+The rule to use for mapping object placement in the cluster.
+
+`--erasure-coding` `k=<integer> ,m=<integer> [,device-class=<class>] [,failure-domain=<domain>] [,profile=<profile>]` ::
+
+Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool.
+
+`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
+
+Minimum number of replicas per object
+
+`--pg_autoscale_mode` `<off | on | warn>` ('default =' `warn`)::
+
+The automatic PG scaling mode of the pool.
+
+`--pg_num` `<integer> (1 - 32768)` ('default =' `128`)::
+
+Number of placement groups.
+
+`--pg_num_min` `<integer> (-N - 32768)` ::
+
+Minimal number of placement groups.
+
+`--size` `<integer> (1 - 7)` ('default =' `3`)::
+
+Number of replicas per object
+
+`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
+
+The estimated target size of the pool for the PG autoscaler.
+
+`--target_size_ratio` `<number>` ::
+
+The estimated target ratio of the pool for the PG autoscaler.
+
+*pveceph pool destroy* `<name>` `[OPTIONS]`
Destroy pool
If true, destroys pool even if in use
+`--remove_ecprofile` `<boolean>` ('default =' `1`)::
+
+Remove the erasure code profile. Defaults to true, if applicable.
+
`--remove_storages` `<boolean>` ('default =' `0`)::
Remove all pveceph-managed storages configured for this pool
-*pveceph help* `[OPTIONS]`
+*pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`
-Get help about specified command.
+Show the current pool status.
-`--extra-args` `<array>` ::
+`<name>`: `<string>` ::
-Shows help for a specific command
+The name of the pool. It must be unique.
-`--verbose` `<boolean>` ::
+`--verbose` `<boolean>` ('default =' `0`)::
-Verbose output format.
+If enabled, will display additional data(eg. statistics).
-*pveceph init* `[OPTIONS]`
+*pveceph pool ls* `[FORMAT_OPTIONS]`
-Create initial ceph default configuration and setup symlinks.
+List all pools and their settings (which are settable by the POST/PUT
+endpoints).
-`--disable_cephx` `<boolean>` ('default =' `0`)::
+*pveceph pool set* `<name>` `[OPTIONS]`
-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!
+Change POOL settings
-`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
+`<name>`: `<string>` ::
-Minimum number of available replicas per object to allow I/O
+The name of the pool. It must be unique.
-`--network` `<string>` ::
+`--application` `<cephfs | rbd | rgw>` ::
-Use specific network for all ceph related traffic
+The application of the pool.
-`--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
+`--crush_rule` `<string>` ::
-Placement group bits, used to specify the default number of placement groups.
-+
-NOTE: 'osd pool default pg num' does not work for default pools.
+The rule to use for mapping object placement in the cluster.
-`--size` `<integer> (1 - 7)` ('default =' `3`)::
+`--min_size` `<integer> (1 - 7)` ::
-Targeted number of replicas per object
+Minimum number of replicas per object
-*pveceph install* `[OPTIONS]`
+`--pg_autoscale_mode` `<off | on | warn>` ::
-Install ceph related packages.
+The automatic PG scaling mode of the pool.
+
+`--pg_num` `<integer> (1 - 32768)` ::
-`--version` `<luminous>` ::
+Number of placement groups.
-no description available
+`--pg_num_min` `<integer> (-N - 32768)` ::
-*pveceph lspools*
+Minimal number of placement groups.
+
+`--size` `<integer> (1 - 7)` ::
+
+Number of replicas per object
+
+`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
-List all pools.
+The estimated target size of the pool for the PG autoscaler.
-*pveceph purge*
+`--target_size_ratio` `<number>` ::
+
+The estimated target ratio of the pool for the PG autoscaler.
+
+*pveceph purge* `[OPTIONS]`
Destroy ceph related data and configuration files.
-*pveceph start* `[<service>]`
+`--crash` `<boolean>` ::
+
+Additionally purge Ceph crash logs, /var/lib/ceph/crash.
+
+`--logs` `<boolean>` ::
+
+Additionally purge Ceph logs, /var/log/ceph.
+
+*pveceph start* `[OPTIONS]`
Start ceph services.
-`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ::
+`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
Ceph service name.
*pveceph status*
-Get ceph status.
+Get Ceph Status.
-*pveceph stop* `[<service>]`
+*pveceph stop* `[OPTIONS]`
Stop ceph services.
-`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ::
+`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
Ceph service name.
projects / pve-docs.git / blobdiff