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