pveceph.1-synopsis.adoc

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