Skip to content

Latest commit

 

History

History
285 lines (147 loc) · 5.66 KB

pveceph.1-synopsis.adoc

File metadata and controls

285 lines (147 loc) · 5.66 KB
Raw

pveceph <COMMAND> [ARGS] [OPTIONS]

pveceph createmgr

An alias for 'pveceph mgr create'.

pveceph createmon

An alias for 'pveceph mon create'.

pveceph createosd

An alias for 'pveceph osd create'.

pveceph createpool

An alias for 'pveceph pool create'.

pveceph destroymgr

An alias for 'pveceph mgr destroy'.

pveceph destroymon

An alias for 'pveceph mon destroy'.

pveceph destroyosd

An alias for 'pveceph osd destroy'.

pveceph destroypool

An alias for 'pveceph pool destroy'.

pveceph fs create [OPTIONS]

Create a Ceph filesystem

--add-storage <boolean> ('default =' 0)

Configure the created CephFS as storage for this cluster.

--name <string> ('default =' cephfs)

The ceph filesystem name.

--pg_num <integer> (8 - 32768) ('default =' 128)

Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.

pveceph help [OPTIONS]

Get help about specified command.

--extra-args <array>

Shows help for a specific command

--verbose <boolean>

Verbose output format.

pveceph init [OPTIONS]

Create initial ceph default configuration and setup symlinks.

--cluster-network <string>

Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it

Note
 Requires option(s): network
--disable_cephx <boolean> ('default =' 0)

Disable cephx authentication.

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)

Minimum number of available replicas per object to allow I/O

--network <string>

Use specific network for all ceph related traffic

--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)

Targeted number of replicas per object

pveceph install [OPTIONS]

Install ceph related packages.

--version <luminous | nautilus> ('default =' nautilus)

Ceph version to install.

pveceph lspools

An alias for 'pveceph pool ls'.

pveceph mds create [OPTIONS]

Create Ceph Metadata Server (MDS)

--hotstandby <boolean> ('default =' 0)

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.

--name [a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])? ('default =' nodename)

The ID for the mds, when omitted the same as the nodename

pveceph mds destroy <name>

Destroy Ceph Metadata Server

<name>: [a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?

The name (ID) of the mds

pveceph mgr create [OPTIONS]

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 mgr destroy <id>

Destroy Ceph Manager.

<id>: [a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?

The ID of the manager

pveceph mon create [OPTIONS]

Create Ceph Monitor and Manager

--mon-address <string>

Overwrites autodetected monitor IP address. Must be in the public network of ceph.

--monid [a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?

The ID for the monitor, when omitted the same as the nodename

pveceph mon destroy <monid>

Destroy Ceph Monitor and Manager.

<monid>: [a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?

Monitor ID

pveceph osd create <dev> [OPTIONS]

Create OSD

<dev>: <string>

Block device name.

--db_dev <string>

Block device name for block.db.

--db_size <number> (1 - N) ('default =' bluestore_block_db_size or 10% of OSD size)

Size in GiB for block.db.

Note
 Requires option(s): db_dev
--encrypted <boolean> ('default =' 0)

Enables encryption of the OSD.

--wal_dev <string>

Block device name for block.wal.

--wal_size <number> (0.5 - N) ('default =' bluestore_block_wal_size or 1% of OSD size)

Size in GiB for block.wal.

Note
 Requires option(s): wal_dev

pveceph osd destroy <osdid> [OPTIONS]

Destroy OSD

<osdid>: <integer>

OSD ID

--cleanup <boolean> ('default =' 0)

If set, we remove partition table entries.

pveceph pool create <name> [OPTIONS]

Create POOL

<name>: <string>

The name of the pool. It must be unique.

--add_storages <boolean>

Configure VM and CT storage using the new pool.

--application <cephfs | rbd | rgw>

The application of the pool, 'rbd' by default.

--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 =' 128)

Number of placement groups.

--size <integer> (1 - 7) ('default =' 3)

Number of replicas per object

pveceph pool destroy <name> [OPTIONS]

Destroy pool

<name>: <string>

The name of the pool. It must be unique.

--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 pool ls

List all pools.

pveceph purge

Destroy ceph related data and configuration files.

pveceph start [<service>]

Start ceph services.

<service>: (ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32} ('default =' ceph.target)

Ceph service name.

pveceph status

Get ceph status.

pveceph stop [<service>]

Stop ceph services.

<service>: (ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32} ('default =' ceph.target)

Ceph service name.