*pveceph* ` [ARGS] [OPTIONS]` *pveceph createmgr* An alias for 'pveceph mgr create'. *pveceph createmon* An alias for 'pveceph mon create'. *pveceph createosd* An alias for 'pveceph osd create'. *pveceph createpool* An alias for 'pveceph pool create'. *pveceph destroymgr* An alias for 'pveceph mgr destroy'. *pveceph destroymon* An alias for 'pveceph mon destroy'. *pveceph destroyosd* An alias for 'pveceph osd destroy'. *pveceph destroypool* An alias for 'pveceph pool destroy'. *pveceph fs create* `[OPTIONS]` Create a Ceph filesystem `--add-storage` `` ('default =' `0`):: Configure the created CephFS as storage for this cluster. `--name` `` ('default =' `cephfs`):: The ceph filesystem name. `--pg_num` ` (8 - 32768)` ('default =' `128`):: Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. *pveceph fs destroy* `` `[OPTIONS]` Destroy a Ceph filesystem ``: `` :: The ceph filesystem name. `--remove-pools` `` ('default =' `0`):: Remove data and metadata pools configured for this fs. `--remove-storages` `` ('default =' `0`):: Remove all pveceph-managed storages configured for this fs. *pveceph help* `[OPTIONS]` Get help about specified command. `--extra-args` `` :: Shows help for a specific command `--verbose` `` :: Verbose output format. *pveceph init* `[OPTIONS]` Create initial ceph default configuration and setup symlinks. `--cluster-network` `` :: Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it + NOTE: Requires option(s): `network` `--disable_cephx` `` ('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` ` (1 - 7)` ('default =' `2`):: Minimum number of available replicas per object to allow I/O `--network` `` :: Use specific network for all ceph related traffic `--pg_bits` ` (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` ` (1 - 7)` ('default =' `3`):: Targeted number of replicas per object *pveceph install* `[OPTIONS]` Install ceph related packages. `--allow-experimental` `` ('default =' `0`):: Allow experimental versions. Use with care! `--repository` `` ('default =' `enterprise`):: Ceph repository to use. `--version` `` ('default =' `quincy`):: Ceph version to install. *pveceph lspools* An alias for 'pveceph pool ls'. *pveceph mds create* `[OPTIONS]` Create Ceph Metadata Server (MDS) `--hotstandby` `` ('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* `` Destroy Ceph Metadata Server ``: `[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* `` Destroy Ceph Manager. ``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: The ID of the manager *pveceph mon create* `[OPTIONS]` Create Ceph Monitor and Manager `--mon-address` `` :: 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* `` Destroy Ceph Monitor and Manager. ``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: Monitor ID *pveceph osd create* `` `[OPTIONS]` Create OSD ``: `` :: Block device name. `--crush-device-class` `` :: Set the device class of the OSD in crush. `--db_dev` `` :: Block device name for block.db. `--db_dev_size` ` (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`):: Size in GiB for block.db. + NOTE: Requires option(s): `db_dev` `--encrypted` `` ('default =' `0`):: Enables encryption of the OSD. `--osds-per-device` ` (1 - N)` :: OSD services per physical device. Only useful for fast NVMe devices" ." to utilize their performance better. `--wal_dev` `` :: Block device name for block.wal. `--wal_dev_size` ` (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* `` `[OPTIONS]` Destroy OSD ``: `` :: OSD ID `--cleanup` `` ('default =' `0`):: If set, we remove partition table entries. *pveceph osd details* `` `[OPTIONS]` `[FORMAT_OPTIONS]` Get OSD details. ``: `` :: ID of the OSD `--verbose` `` ('default =' `0`):: Print verbose information, same as json-pretty output format. *pveceph pool create* `` `[OPTIONS]` Create Ceph pool ``: `` :: The name of the pool. It must be unique. `--add_storages` `` ('default =' `0; for erasure coded pools: 1`):: Configure VM and CT storage using the new pool. `--application` `` ('default =' `rbd`):: The application of the pool. `--crush_rule` `` :: The rule to use for mapping object placement in the cluster. `--erasure-coding` `k= ,m= [,device-class=] [,failure-domain=] [,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` ` (1 - 7)` ('default =' `2`):: Minimum number of replicas per object `--pg_autoscale_mode` `` ('default =' `warn`):: The automatic PG scaling mode of the pool. `--pg_num` ` (1 - 32768)` ('default =' `128`):: Number of placement groups. `--pg_num_min` ` (-N - 32768)` :: Minimal number of placement groups. `--size` ` (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` `` :: The estimated target ratio of the pool for the PG autoscaler. *pveceph pool destroy* `` `[OPTIONS]` Destroy pool ``: `` :: The name of the pool. It must be unique. `--force` `` ('default =' `0`):: If true, destroys pool even if in use `--remove_ecprofile` `` ('default =' `1`):: Remove the erasure code profile. Defaults to true, if applicable. `--remove_storages` `` ('default =' `0`):: Remove all pveceph-managed storages configured for this pool *pveceph pool get* `` `[OPTIONS]` `[FORMAT_OPTIONS]` Show the current pool status. ``: `` :: The name of the pool. It must be unique. `--verbose` `` ('default =' `0`):: If enabled, will display additional data(eg. statistics). *pveceph pool ls* `[FORMAT_OPTIONS]` List all pools and their settings (which are settable by the POST/PUT endpoints). *pveceph pool set* `` `[OPTIONS]` Change POOL settings ``: `` :: The name of the pool. It must be unique. `--application` `` :: The application of the pool. `--crush_rule` `` :: The rule to use for mapping object placement in the cluster. `--min_size` ` (1 - 7)` :: Minimum number of replicas per object `--pg_autoscale_mode` `` :: The automatic PG scaling mode of the pool. `--pg_num` ` (1 - 32768)` :: Number of placement groups. `--pg_num_min` ` (-N - 32768)` :: Minimal number of placement groups. `--size` ` (1 - 7)` :: Number of replicas per object `--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: The estimated target size of the pool for the PG autoscaler. `--target_size_ratio` `` :: The estimated target ratio of the pool for the PG autoscaler. *pveceph purge* `[OPTIONS]` Destroy ceph related data and configuration files. `--crash` `` :: Additionally purge Ceph crash logs, /var/lib/ceph/crash. `--logs` `` :: Additionally purge Ceph logs, /var/log/ceph. *pveceph start* `[OPTIONS]` Start ceph services. `--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. *pveceph stop* `[OPTIONS]` Stop ceph services. `--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`):: Ceph service name.