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