]> git.proxmox.com Git - pve-docs.git/blobdiff - pveceph.1-synopsis.adoc
update generated docs
[pve-docs.git] / pveceph.1-synopsis.adoc
index a1ee3ee52c9bd1627ae14122ea9fac2f264eff89..ddb8eec02937c8bbdd4cfe9c021fc9d928c79643 100644 (file)
@@ -1,11 +1,28 @@
 *pveceph* `<COMMAND> [ARGS] [OPTIONS]`
 
-*pveceph createmon*
+*pveceph createmgr* `[OPTIONS]`
 
-Create Ceph Monitor
+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]`
 
@@ -15,20 +32,21 @@ Create OSD
 
 Block device name.
 
-`-bluestore` `<boolean>` ('default =' `0`)::
+`--bluestore` `<boolean>` ('default =' `1`)::
 
-Use bluestore instead of filestore.
+Use bluestore instead of filestore. This is the default.
 
-`-fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
+`--fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
 
 File system type (filestore only).
 
-`-journal_dev` `<string>` ::
-
-Block device name for journal.
+`--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]`
 
@@ -38,34 +56,49 @@ Create POOL
 
 The name of the pool. It must be unique.
 
-`-crush_ruleset` `<integer> (0 - 32768)` ('default =' `0`)::
+`--add_storages` `<boolean>` ::
+
+Configure VM and CT storages using the new pool.
+
+`--application` `<cephfs | rbd | rgw>` ::
 
-The ruleset to use for mapping object placement in the cluster.
+The application of the pool, 'rbd' by default.
 
-`-min_size` `<integer> (1 - 7)` ('default =' `1`)::
+`--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`)::
+`--pg_num` `<integer> (8 - 32768)` ('default =' `64`)::
 
 Number of placement groups.
 
-`-size` `<integer> (1 - 7)` ('default =' `2`)::
+`--size` `<integer> (1 - 7)` ('default =' `3`)::
 
 Number of replicas per object
 
+*pveceph destroymgr* `<id>`
 
+Destroy Ceph Manager.
 
-*pveceph destroymon* `<monid>`
+`<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
 
-Destroy Ceph monitor.
+The ID of the manager
 
-`<monid>`: `<integer>` ::
+*pveceph destroymon* `<monid>` `[OPTIONS]`
 
-Monitor ID
+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]`
 
@@ -75,13 +108,10 @@ Destroy OSD
 
 OSD ID
 
-`-cleanup` `<boolean>` ('default =' `0`)::
+`--cleanup` `<boolean>` ('default =' `0`)::
 
 If set, we remove partition table entries.
 
-
-
-
 *pveceph destroypool* `<name>` `[OPTIONS]`
 
 Destroy pool
@@ -90,108 +120,88 @@ Destroy pool
 
 The name of the pool. It must be unique.
 
-`-force` `<boolean>` ('default =' `0`)::
+`--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* `[<cmd>]` `[OPTIONS]`
+*pveceph help* `[OPTIONS]`
 
 Get help about specified command.
 
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
 
-Command name
+Shows help for a specific command
 
-`-verbose` `<boolean>` ::
+`--verbose` `<boolean>` ::
 
 Verbose output format.
 
-
-
-
 *pveceph init* `[OPTIONS]`
 
 Create initial ceph default configuration and setup symlinks.
 
-`-disable_cephx` `<boolean>` ('default =' `0`)::
+`--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`)::
+`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
 
 Minimum number of available replicas per object to allow I/O
 
-`-network` `<string>` ::
+`--network` `<string>` ::
 
 Use specific network for all ceph related traffic
 
-`-pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
+`--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`)::
+`--size` `<integer> (1 - 7)` ('default =' `3`)::
 
 Targeted number of replicas per object
 
-
-
-
 *pveceph install* `[OPTIONS]`
 
 Install ceph related packages.
 
-`-version` `<luminous>` ::
+`--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)\.[A-Za-z0-9]{1,32}` ::
+`<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)\.[A-Za-z0-9]{1,32}` ::
+`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ::
 
 Ceph service name.
 
 
-
-