pveceph.1-synopsis.adoc

   1 *pveceph* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *pveceph createmon*
   4
   5 Create Ceph Monitor
   6
   7
   8
   9
  10 *pveceph createosd* `<dev>` `[OPTIONS]`
  11
  12 Create OSD
  13
  14 `<dev>`: `<string>` ::
  15
  16 Block device name.
  17
  18 `-bluestore` `<boolean>` ('default =' `0`)::
  19
  20 Use bluestore instead of filestore.
  21
  22 `-fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
  23
  24 File system type (filestore only).
  25
  26 `-journal_dev` `<string>` ::
  27
  28 Block device name for journal.
  29
  30
  31
  32
  33 *pveceph createpool* `<name>` `[OPTIONS]`
  34
  35 Create POOL
  36
  37 `<name>`: `<string>` ::
  38
  39 The name of the pool. It must be unique.
  40
  41 `-crush_ruleset` `<integer> (0 - 32768)` ('default =' `0`)::
  42
  43 The ruleset to use for mapping object placement in the cluster.
  44
  45 `-min_size` `<integer> (1 - 7)` ('default =' `1`)::
  46
  47 Minimum number of replicas per object
  48
  49 `-pg_num` `<integer> (8 - 32768)` ('default =' `64`)::
  50
  51 Number of placement groups.
  52
  53 `-size` `<integer> (1 - 7)` ('default =' `2`)::
  54
  55 Number of replicas per object
  56
  57
  58
  59 *pveceph destroymon* `<monid>`
  60
  61 Destroy Ceph monitor.
  62
  63 `<monid>`: `<integer>` ::
  64
  65 Monitor ID
  66
  67
  68
  69
  70 *pveceph destroyosd* `<osdid>` `[OPTIONS]`
  71
  72 Destroy OSD
  73
  74 `<osdid>`: `<integer>` ::
  75
  76 OSD ID
  77
  78 `-cleanup` `<boolean>` ('default =' `0`)::
  79
  80 If set, we remove partition table entries.
  81
  82
  83
  84
  85 *pveceph destroypool* `<name>` `[OPTIONS]`
  86
  87 Destroy pool
  88
  89 `<name>`: `<string>` ::
  90
  91 The name of the pool. It must be unique.
  92
  93 `-force` `<boolean>` ('default =' `0`)::
  94
  95 If true, destroys pool even if in use
  96
  97
  98
  99
 100 *pveceph help* `[<cmd>]` `[OPTIONS]`
 101
 102 Get help about specified command.
 103
 104 `<cmd>`: `<string>` ::
 105
 106 Command name
 107
 108 `-verbose` `<boolean>` ::
 109
 110 Verbose output format.
 111
 112
 113
 114
 115 *pveceph init* `[OPTIONS]`
 116
 117 Create initial ceph default configuration and setup symlinks.
 118
 119 `-disable_cephx` `<boolean>` ('default =' `0`)::
 120
 121 Disable cephx authentification.
 122 +
 123 WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!
 124
 125 `-min_size` `<integer> (1 - 7)` ('default =' `2`)::
 126
 127 Minimum number of available replicas per object to allow I/O
 128
 129 `-network` `<string>` ::
 130
 131 Use specific network for all ceph related traffic
 132
 133 `-pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
 134
 135 Placement group bits, used to specify the default number of placement groups.
 136 +
 137 NOTE: 'osd pool default pg num' does not work for default pools.
 138
 139 `-size` `<integer> (1 - 7)` ('default =' `3`)::
 140
 141 Targeted number of replicas per object
 142
 143
 144
 145
 146 *pveceph install* `[OPTIONS]`
 147
 148 Install ceph related packages.
 149
 150 `-version` `<luminous>` ::
 151
 152 no description available
 153
 154
 155
 156
 157 *pveceph lspools*
 158
 159 List all pools.
 160
 161
 162
 163
 164 *pveceph purge*
 165
 166 Destroy ceph related data and configuration files.
 167
 168
 169
 170
 171 *pveceph start* `[<service>]`
 172
 173 Start ceph services.
 174
 175 `<service>`: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
 176
 177 Ceph service name.
 178
 179
 180
 181 *pveceph status*
 182
 183 Get ceph status.
 184
 185
 186
 187 *pveceph stop* `[<service>]`
 188
 189 Stop ceph services.
 190
 191 `<service>`: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
 192
 193 Ceph service name.
 194
 195
 196
 197