*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 createosd*
+An alias for 'pveceph osd create'.
-*pveceph createmon* `[OPTIONS]`
+*pveceph createpool*
-Create Ceph Monitor and Manager
+An alias for 'pveceph pool create'.
-`--exclude-manager` `<boolean>` ('default =' `0`)::
+*pveceph destroymgr*
-When set, only a monitor will be created.
+An alias for 'pveceph mgr destroy'.
-`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+*pveceph destroymon*
-The ID for the monitor, when omitted the same as the nodename
+An alias for 'pveceph mon destroy'.
+*pveceph destroyosd*
+An alias for 'pveceph osd destroy'.
+*pveceph destroypool*
-*pveceph createosd* `<dev>` `[OPTIONS]`
+An alias for 'pveceph pool destroy'.
-Create OSD
+*pveceph fs create* `[OPTIONS]`
-`<dev>`: `<string>` ::
+Create a Ceph filesystem
-Block device name.
+`--add-storage` `<boolean>` ('default =' `0`)::
-`--bluestore` `<boolean>` ('default =' `0`)::
+Configure the created CephFS as storage for this cluster.
-Use bluestore instead of filestore.
+`--name` `<string>` ('default =' `cephfs`)::
-`--fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
+The ceph filesystem name.
-File system type (filestore only).
+`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
-`--journal_dev` `<string>` ::
+Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
-Block device name for journal (filestore) or block.db (bluestore).
+*pveceph help* `[OPTIONS]`
-`--wal_dev` `<string>` ::
+Get help about specified command.
-Block device name for block.wal (bluestore only).
+`--extra-args` `<array>` ::
+Shows help for a specific command
+`--verbose` `<boolean>` ::
+Verbose output format.
-*pveceph createpool* `<name>` `[OPTIONS]`
+*pveceph init* `[OPTIONS]`
-Create POOL
+Create initial ceph default configuration and setup symlinks.
-`<name>`: `<string>` ::
+`--cluster-network` `<string>` ::
-The name of the pool. It must be unique.
+Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it
++
+NOTE: Requires option(s): `network`
-`--add_storages` `<boolean>` ::
+`--disable_cephx` `<boolean>` ('default =' `0`)::
-Configure VM and CT storages using the new pool.
+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!
-`--application` `<cephfs | rbd | rgw>` ::
+`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
-The application of the pool, 'rbd' by default.
+Minimum number of available replicas per object to allow I/O
-`--crush_rule` `<string>` ::
+`--network` `<string>` ::
-The rule to use for mapping object placement in the cluster.
+Use specific network for all ceph related traffic
-`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
+`--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
-Minimum number of replicas per object
+Placement group bits, used to specify the default number of placement groups.
++
+NOTE: 'osd pool default pg num' does not work for default pools.
-`--pg_num` `<integer> (8 - 32768)` ('default =' `64`)::
+`--size` `<integer> (1 - 7)` ('default =' `3`)::
-Number of placement groups.
+Targeted number of replicas per object
-`--size` `<integer> (1 - 7)` ('default =' `3`)::
+*pveceph install* `[OPTIONS]`
-Number of replicas per object
+Install ceph related packages.
+`--allow-experimental` `<boolean>` ('default =' `0`)::
+Allow experimental versions. Use with care!
-*pveceph destroymgr* `<id>`
+`--version` `<luminous | nautilus | octopus>` ('default =' `nautilus`)::
-Destroy Ceph Manager.
+Ceph version to install.
-`<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+*pveceph lspools*
-The ID of the manager
+An alias for 'pveceph pool ls'.
+*pveceph mds create* `[OPTIONS]`
+Create Ceph Metadata Server (MDS)
-*pveceph destroymon* `<monid>` `[OPTIONS]`
+`--hotstandby` `<boolean>` ('default =' `0`)::
-Destroy Ceph Monitor and Manager.
+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.
-`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+`--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::
-Monitor ID
+The ID for the mds, when omitted the same as the nodename
-`--exclude-manager` `<boolean>` ('default =' `0`)::
+*pveceph mds destroy* `<name>`
-When set, removes only the monitor, not the manager
+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]`
-*pveceph destroyosd* `<osdid>` `[OPTIONS]`
+Create Ceph Manager
-Destroy OSD
+`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
-`<osdid>`: `<integer>` ::
+The ID for the manager, when omitted the same as the nodename
-OSD ID
+*pveceph mgr destroy* `<id>`
-`--cleanup` `<boolean>` ('default =' `0`)::
+Destroy Ceph Manager.
-If set, we remove partition table entries.
+`<id>`: `[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
-*pveceph destroypool* `<name>` `[OPTIONS]`
+`--mon-address` `<string>` ::
-Destroy pool
+Overwrites autodetected monitor IP address. Must be in the public network of ceph.
-`<name>`: `<string>` ::
+`--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
-The name of the pool. It must be unique.
+The ID for the monitor, when omitted the same as the nodename
-`--force` `<boolean>` ('default =' `0`)::
+*pveceph mon destroy* `<monid>`
-If true, destroys pool even if in use
+Destroy Ceph Monitor and Manager.
-`--remove_storages` `<boolean>` ('default =' `0`)::
+`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
-Remove all pveceph-managed storages configured for this pool
+Monitor ID
+*pveceph osd create* `<dev>` `[OPTIONS]`
+Create OSD
+`<dev>`: `<string>` ::
-*pveceph help* `[<cmd>]` `[OPTIONS]`
+Block device name.
-Get help about specified command.
+`--crush-device-class` `<string>` ::
-`<cmd>`: `<string>` ::
+Set the device class of the OSD in crush.
-Command name
+`--db_dev` `<string>` ::
-`--verbose` `<boolean>` ::
+Block device name for block.db.
-Verbose output format.
+`--db_size` `<number> (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` `<boolean>` ('default =' `0`)::
+Enables encryption of the OSD.
-*pveceph init* `[OPTIONS]`
+`--wal_dev` `<string>` ::
-Create initial ceph default configuration and setup symlinks.
+Block device name for block.wal.
-`--disable_cephx` `<boolean>` ('default =' `0`)::
+`--wal_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
-Disable cephx authentification.
+Size in GiB for block.wal.
+
-WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!
+NOTE: Requires option(s): `wal_dev`
-`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
+*pveceph osd destroy* `<osdid>` `[OPTIONS]`
-Minimum number of available replicas per object to allow I/O
+Destroy OSD
-`--network` `<string>` ::
+`<osdid>`: `<integer>` ::
-Use specific network for all ceph related traffic
+OSD ID
-`--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
+`--cleanup` `<boolean>` ('default =' `0`)::
-Placement group bits, used to specify the default number of placement groups.
-+
-NOTE: 'osd pool default pg num' does not work for default pools.
+If set, we remove partition table entries.
-`--size` `<integer> (1 - 7)` ('default =' `3`)::
+*pveceph pool create* `<name>` `[OPTIONS]`
-Targeted number of replicas per object
+Create POOL
+`<name>`: `<string>` ::
+The name of the pool. It must be unique.
+`--add_storages` `<boolean>` ::
-*pveceph install* `[OPTIONS]`
+Configure VM and CT storage using the new pool.
-Install ceph related packages.
+`--application` `<cephfs | rbd | rgw>` ::
-`--version` `<luminous>` ::
+The application of the pool, 'rbd' by default.
-no description available
+`--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
-*pveceph lspools*
+`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
-List all pools.
+Number of placement groups.
+`--size` `<integer> (1 - 7)` ('default =' `3`)::
+Number of replicas per object
+*pveceph pool destroy* `<name>` `[OPTIONS]`
-*pveceph purge*
+Destroy pool
-Destroy ceph related data and configuration files.
+`<name>`: `<string>` ::
+The name of the pool. It must be unique.
+`--force` `<boolean>` ('default =' `0`)::
+If true, destroys pool even if in use
-*pveceph start* `[<service>]`
+`--remove_storages` `<boolean>` ('default =' `0`)::
-Start ceph services.
+Remove all pveceph-managed storages configured for this pool
-`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ::
+*pveceph pool ls* `[FORMAT_OPTIONS]`
-Ceph service name.
+List all pools.
+*pveceph purge* `[OPTIONS]`
+Destroy ceph related data and configuration files.
-*pveceph status*
+`--crash` `<boolean>` ::
-Get ceph status.
+Additionally purge Ceph crash logs, /var/lib/ceph/crash.
+`--logs` `<boolean>` ::
+Additionally purge Ceph logs, /var/log/ceph.
-*pveceph stop* `[<service>]`
+*pveceph start* `[OPTIONS]`
-Stop ceph services.
+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.
+
+*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.
projects / pve-docs.git / blobdiff