You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

pveceph.1-synopsis.adoc 5.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. *pveceph* `<COMMAND> [ARGS] [OPTIONS]`
  2. *pveceph createmgr*
  3. An alias for 'pveceph mgr create'.
  4. *pveceph createmon*
  5. An alias for 'pveceph mon create'.
  6. *pveceph createosd*
  7. An alias for 'pveceph osd create'.
  8. *pveceph createpool*
  9. An alias for 'pveceph pool create'.
  10. *pveceph destroymgr*
  11. An alias for 'pveceph mgr destroy'.
  12. *pveceph destroymon*
  13. An alias for 'pveceph mon destroy'.
  14. *pveceph destroyosd*
  15. An alias for 'pveceph osd destroy'.
  16. *pveceph destroypool*
  17. An alias for 'pveceph pool destroy'.
  18. *pveceph fs create* `[OPTIONS]`
  19. Create a Ceph filesystem
  20. `--add-storage` `<boolean>` ('default =' `0`)::
  21. Configure the created CephFS as storage for this cluster.
  22. `--name` `<string>` ('default =' `cephfs`)::
  23. The ceph filesystem name.
  24. `--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
  25. Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
  26. *pveceph help* `[OPTIONS]`
  27. Get help about specified command.
  28. `--extra-args` `<array>` ::
  29. Shows help for a specific command
  30. `--verbose` `<boolean>` ::
  31. Verbose output format.
  32. *pveceph init* `[OPTIONS]`
  33. Create initial ceph default configuration and setup symlinks.
  34. `--cluster-network` `<string>` ::
  35. Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it
  36. +
  37. NOTE: Requires option(s): `network`
  38. `--disable_cephx` `<boolean>` ('default =' `0`)::
  39. Disable cephx authentication.
  40. +
  41. WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!
  42. `--min_size` `<integer> (1 - 7)` ('default =' `2`)::
  43. Minimum number of available replicas per object to allow I/O
  44. `--network` `<string>` ::
  45. Use specific network for all ceph related traffic
  46. `--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
  47. Placement group bits, used to specify the default number of placement groups.
  48. +
  49. NOTE: 'osd pool default pg num' does not work for default pools.
  50. `--size` `<integer> (1 - 7)` ('default =' `3`)::
  51. Targeted number of replicas per object
  52. *pveceph install* `[OPTIONS]`
  53. Install ceph related packages.
  54. `--version` `<luminous | nautilus>` ('default =' `nautilus`)::
  55. Ceph version to install.
  56. *pveceph lspools*
  57. An alias for 'pveceph pool ls'.
  58. *pveceph mds create* `[OPTIONS]`
  59. Create Ceph Metadata Server (MDS)
  60. `--hotstandby` `<boolean>` ('default =' `0`)::
  61. 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.
  62. `--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::
  63. The ID for the mds, when omitted the same as the nodename
  64. *pveceph mds destroy* `<name>`
  65. Destroy Ceph Metadata Server
  66. `<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
  67. The name (ID) of the mds
  68. *pveceph mgr create* `[OPTIONS]`
  69. Create Ceph Manager
  70. `--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
  71. The ID for the manager, when omitted the same as the nodename
  72. *pveceph mgr destroy* `<id>`
  73. Destroy Ceph Manager.
  74. `<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
  75. The ID of the manager
  76. *pveceph mon create* `[OPTIONS]`
  77. Create Ceph Monitor and Manager
  78. `--mon-address` `<string>` ::
  79. Overwrites autodetected monitor IP address. Must be in the public network of ceph.
  80. `--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
  81. The ID for the monitor, when omitted the same as the nodename
  82. *pveceph mon destroy* `<monid>`
  83. Destroy Ceph Monitor and Manager.
  84. `<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
  85. Monitor ID
  86. *pveceph osd create* `<dev>` `[OPTIONS]`
  87. Create OSD
  88. `<dev>`: `<string>` ::
  89. Block device name.
  90. `--db_dev` `<string>` ::
  91. Block device name for block.db.
  92. `--db_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
  93. Size in GiB for block.db.
  94. +
  95. NOTE: Requires option(s): `db_dev`
  96. `--encrypted` `<boolean>` ('default =' `0`)::
  97. Enables encryption of the OSD.
  98. `--wal_dev` `<string>` ::
  99. Block device name for block.wal.
  100. `--wal_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
  101. Size in GiB for block.wal.
  102. +
  103. NOTE: Requires option(s): `wal_dev`
  104. *pveceph osd destroy* `<osdid>` `[OPTIONS]`
  105. Destroy OSD
  106. `<osdid>`: `<integer>` ::
  107. OSD ID
  108. `--cleanup` `<boolean>` ('default =' `0`)::
  109. If set, we remove partition table entries.
  110. *pveceph pool create* `<name>` `[OPTIONS]`
  111. Create POOL
  112. `<name>`: `<string>` ::
  113. The name of the pool. It must be unique.
  114. `--add_storages` `<boolean>` ::
  115. Configure VM and CT storage using the new pool.
  116. `--application` `<cephfs | rbd | rgw>` ::
  117. The application of the pool, 'rbd' by default.
  118. `--crush_rule` `<string>` ::
  119. The rule to use for mapping object placement in the cluster.
  120. `--min_size` `<integer> (1 - 7)` ('default =' `2`)::
  121. Minimum number of replicas per object
  122. `--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
  123. Number of placement groups.
  124. `--size` `<integer> (1 - 7)` ('default =' `3`)::
  125. Number of replicas per object
  126. *pveceph pool destroy* `<name>` `[OPTIONS]`
  127. Destroy pool
  128. `<name>`: `<string>` ::
  129. The name of the pool. It must be unique.
  130. `--force` `<boolean>` ('default =' `0`)::
  131. If true, destroys pool even if in use
  132. `--remove_storages` `<boolean>` ('default =' `0`)::
  133. Remove all pveceph-managed storages configured for this pool
  134. *pveceph pool ls*
  135. List all pools.
  136. *pveceph purge*
  137. Destroy ceph related data and configuration files.
  138. *pveceph start* `[<service>]`
  139. Start ceph services.
  140. `<service>`: `(ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
  141. Ceph service name.
  142. *pveceph status*
  143. Get ceph status.
  144. *pveceph stop* `[<service>]`
  145. Stop ceph services.
  146. `<service>`: `(ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
  147. Ceph service name.