Ceph M版本命令整理

bench
--io-type < read | write | readwrite | rw> [--io-size size-in-B/K/M/G/T] [--io-threads num-ios-in-flight] [--io-total size-in-B/K/M/G/T] [--io-pattern seq | rand] [--rw-mix-read read proportion in readwrite] image-spec

    生成一系列IO和IO吞吐量以及延迟的图表，如果没有指定的单位（B/K/M），则假--io-size和--io-total为B，默认的数值分别为：--io-size 4096, --io-threads 16, --io-total 1G, --io-pattern seq, --rw-mix-read 50

children snap-spec

     列出该快照的克隆卷，这个操作会检查所有的pool，之后会输出结果pool-name/image-name.

     但是需要这个image的format是2. 

clone
[–object-size size-in-B/K/M] [–stripe-unit size-in-B/K/M –stripe-count num] [–image-feature feature-name] [–image-shared] parent-snap-spec child-image-spec

     创建一个父快照的克隆卷，除非另外指定，否则object大小与父image和父快照的大小是相同的，--stripe-unit和     --stripe-count参数是可选的，但是必须同时使用。

     父快照的状态需要是被保护的（protected）。

config global get config-entity key

     获取覆盖全局的配置。

config global list [--format plain|json|xml] [--pretty-format] config-entity

     列出覆盖全局的配置。

config global set config-entity key value

     设置覆盖全局的配置。

config global remove config-entity key

     删除覆盖全局的配置。

config image get image-spec key

     获取覆盖image级别的配置。

config image list [--format plain|json|xml] [--pretty-format] image-spec

     列出覆盖image界别的配置。

config image set image-spec key value

     设置覆盖image级别的设置。

config image remove image-spec key

     删除覆盖image级别的配置。

config pool get pool-name key

     获取覆盖pool级别的配置。

config pool set pool-name key value

     设置覆盖pool级别的配置。

config pool remove pool-name key

     删除覆盖pool级别的配置。

cp (src-image-spec|sec-snap-spec) dest-image-spec

     将原image的内容复制到目标image中，目标imgae具有和源image相同的大小、对象大小和image format。

create
 (-s | --size size-in-M/G/T) [–image-format format-id] [–object-size size-in-B/K/M] [--stripe-unit size-in-B/K/M –stripe-count num] [--thick-provision] [--no-progress] [--image-feature feature-name]… [--image-shared] image-spec

     将会创建一个新的rbd image，需要在创建的同时指定image的大小。--stripe-unit and --stripe-count 是可选的，但是必须同时使用

deep cp (src-image-spec | src-snap-spec) dest-image-spec

     将源image的内容深度复制到新创建的目标image中，目标image将会和源image有相同的大小、对象大小、format和快照

device list [-t | --device-type device-type] [--format plain | json | xml] --pretty-format

     显示通过rbd内核模块（默认）映射的rbd image或其他支持的设备。

device map 
[-t | --device-type device-type] [--read-only] [–exclusive] [-o | --options device-options] image-spec| snap-spec

指定的rbd image通过内核模式映射到一个块设备上或其他支持的设备上（linux上的nbd或FreeBSD伤的ggate）。

     选项参数是一个逗号分隔的设备类型特定选项列表（opt1,opt2=val,…）。

device unmap
 [-t | –device-type device-type] [-o | --options device-options] image-spec | snap-spec | device-path

     取消通过内核模块(默认)或支持的其他设备上映射的rbd image。

     选项参数是一个逗号分隔的设备类型特定 选项列表（opt1,opt2=val,…）。

diff [--from-snap snap-name] [–whole-object] image-spec | snap-spec

    列出这个image从指定的快照创建时或从创建后已经更改的字节区段列表，输出行包括起始偏移量（以字节为单位），区域长度（以字节为单位）和“0”或“data”，以显示该区域是已知的0还是可能包含其他的数据。

du [-p | --pool pool-name] [image-spec | snap-spec]

       该命令将会计算指定的存储池中所有image和相关快照的实际磁盘使用情况，还可以用于单个image和快照。

       如果RBD image的fast-diff特性没有启用，这个操作将会查询每个存在该image对象的OSD。

export [--export-format format (1 or 2)] (image-spec | snap-spec) [dest-path]

     导出image到指定的路径中（用于标准输出），--export-format目前接受“1”或者“2”，format 2不仅允许到处image的内容，还允许导出快照的其他属性，比如image_order，features。

export-diff [--from-snap snap-name] [–whole-object] (image-spec | snap-spec) dest-path

    导出image中的增量部分到指定的路径下（用于标准输出

），如果指定了初始快照，则只更改快照以后的增量，原本包含了image中任何包含数据的区域。使用标准的--snap选项或@snap语法指定快照。Image diff format 包含了元数据，image的大小改变以及开始和结束的快照，它有效的表示了image的废弃或“0”区域。

feature disable image-spec feature-name…

     禁用指定image上的指定特性，可以指定多个特性。

feature enable image-spec feature-name

     启用指定image上的指定特性，可以指定多个特性。

flatten image-spec

     如果image是克隆的，从父快照复制了所有的共享块，使子image独立于父快照，该命令可以截断父快照和子image之间的联系，如果父快照没有进一步的依赖克隆，则可以是unprotected并删除它。

     这个命令需要image的format 是2.

group create group-spec

     创建一个image组。

group image add group-spec image-spec

     添加一个image到一个组中。

group image list group-spec

     列出这个组中的所有image。

group image remove group-spec image-spec

    将一个image从组中删除。

group ls [-p|--pool pool-name]

     列出一个存储池中的image组。

group rename src-group-spec dest-group-spec

     重命名一个image组。注意：不支持跨存储池重命名。

group rm group-spec

     删除一个image组。

group snap create group-snap-spec

     为一个组创建快照。

group snap list group-spec

     列出组的所有快照。

group snap rm goup-snap-spec

     删除组的快照。

group snap rename group-snap-spec snap-name

    重命名一个组的快照。

group snap rollback group-snap-spec

     将image组回滚到快照位置。

image-meta get image-spec key

     获取元数据键。

image-meta list image-spec

     显示image中的元数据，第一列是键，第二列是值。

image-meta remove image-spec key

     删除原数据的键值。

image-meta set image-spec key value

     设置原数据的键值，设置的键值可以使用image-meta list列出。

import
 [–export-format format (1 or 2)] [–image-format format-id] [–object-size size-in-B/K/M] [–stripe-unit size-in-B/K/M –stripe-count num] [–image-feature feature-name]… [–image-shared] src-path [image-spec]

     创建一个新的image并将指定位置的数据（用于标准输入）导入到该image中，如果可能，导入操作将尝试创建稀疏rbd image。对于从标准输入的导入，稀疏单元是目标image的数据块大小（对象大小）。

     --stripe-unit和—stripe-count 是可选项，但是必须同时使用。

     --export-format的可以是“1”或者“2”，但是format 2不仅允许导入image的内容，还可以导入快照的其他属性，例如image_order、feature。

import-diff src-path image-spec

     导入image的增量差异并将其应用于当前image。如果diff基于快照产生的，则在继续之前验证快照已经存在。如果有一个结束快照，我们将在应用更改之前验证它不存在，并在完成更改后创建快照。

info image-spec|snap-spec

     将列出指定的image的信息（如大小，对象大小等），如果这个image是克隆卷，也会显示其父对象信息；如果指定了一个快照则会显示它是否是protected状态。

journal client disconnect journal-spec

     标记imgae客户端为断开连接。

journal export [--verbose] [--no-error] src-journal-spec path-name

     导出image日志到指定路径下（用于标准输出），在做危险操作之前可以备份image的日志。

     注意：如果日志严重损坏，这个命令可能不生效。

journal import [--verbose] [--no-error] path-name dest-journal-spec

     从指定的路径导入image的日志（用于标准输入）。

journal info  journal-spec

     显示image的日志信息。

journal inspect [--verbose] journal-spec

     检查和报告image日志的结构误差。

journal reset journal-spec

     重置image的日志。

journal status journal-spec

     查看image日志的状态。

lock add [--shared lock-tag] image-spec lock-id

     锁定一个image，lock-id是为了方便用户而设置的任意名称。默认情况下这是一个独占锁，这意味着如果在该image已经锁定的情况下再次执行该操作将会失败。参数--shared可以使这个image被多次锁定。

注意：添加锁之外不会影响任何操作，锁不能保护image不被删除。

lock ls imgae-spec

列出image上的锁，第一列是与锁删除命令一起使用的锁库。 

lock rm image-spec lock-id locker

  释放image上的锁，lock-id和locker可以通过查看lock ls的输出获得。

ls [-l | –long] [pool-name]

     可以rbd image所有的rbd_directory对象。使用-l可以列出快照，并使用长格式输出还会显示包含大小、父image（如果是克隆）、format等。

merge-diff first-diff-path second-diff-path merged-diff-path

     把两个连续的增量差异合并为单个差异。前一个差异的结束快照必须与后一个差异的起始快照相同。前一个差异可以是标准输入，合并后的差异可以是标准输出，这样就可以合并多个差异文件，像这样：“rbd merge-diff first second - | rbd merge-diff - third result”，注意，当前次命令仅支持stripe_count== 1这样的源增量差异。

migration abort image-spec

     取消image的迁移操作。此步骤可能在准备迁移成功或失败后执行，并将image返回初始（迁移前）状态，对目标image所有的修改都将丢失。 

migration commit image-spec

     提交image迁移。这一步是在准备迁移成功和迁移步骤后删除源image数据后执行的

migration execute image-spec

     执行image的迁移操作。这个步骤是在迁移工作准备成功并将image数据复制到目标image后执行的。

migration prepare [–order order] [–object-size object-size] [–image-feature image-feature] [–image-shared] [–stripe-unit stripe-unit] [–stripe-count stripe-count] [–data-pool data-pool] src-image-spec [dest-image-spec]

    准备image迁移。这个迁移image的第一步，即更改image位置、format或者其他不能动态更改的参数。目标可以与源匹配，在这种情况下，可以省略dest-image-spec。在此步骤之后，源image被设置为目标image的父image，并且根据目标image规范该image可以在copy-on-write模式下访问。

mirror image demote image-spec

     将主image降级为非主iamge。

mirror image disable [–force] image-spec

    为image禁用RBD mirror。如果mirror是以image pool的模式设置的，则可以现实禁用池中的每个image的mirror。

mirror image enable image-spec

为image启用RBD mirror。如果mirror是以image pool的模式配置的，则可以显示为启用池中的每个image的mirror。

mirror image promote [--force] image-spec

为RBD image将非主image升级为主image。

mirror image resync image-spec

强制对RBDimage的主image进行重新同步。

mirror image status image-spec

 显示image的mirror状态。

mirror pool demote [pool-name]

将RBD image的pool降级为非主要pool

mirror pool disable [pool-name]

默认是池的情况下禁用RBD mirror，以这种方式禁用存储池的mirror时，对于已明确启用的mirror的任何image（存储池内）也将禁用mirror。

mirror pool enable [pool-name] mode

默认时存储池的情况下启用RBD mirror。Mirror模式可以是存储池或者是image，如果在存储池模式下配置，则会启用存储池中具有启用日志功能的所有image。如果在mirror模式下配置，则需要在每image上启用mirror（通过mirror image enabl命令）。

mirror pool info [pool-name]

显示有关存储池mirror配置的信息。它包括mirror模式，对等UUID，远程集群名称和远程客户端名称

mirror pool peer add [pool-name] remote-cluster-spec

将mirror对等体添加到存储池中。Remot-cluster-spec是[远程客户端名称@]远程集群名称。

默认的远程客户端名称是“client.admin”。

需要启用mirror模式。 

mirror pool peer remove [pool-name] uuid

从存储池中删除mirror对等体，对等UUID可以通过mirror pool info命令获得。 

mirror pool peer set [pool-name] uuid key value

更新mirror对等设置。密钥可以是客户端或集群，该值对应于远程客户端名称或远程集群名称。

mirror pool promote [--force] [pool-name]

将存储池中的每个非主image提升为主iamge，每个启用mirror的image都将在存储池中升级。 

mirror pool status [--verbose] [pool-name]

显示存储池中所有的image mirror的状态，使用 –verbose还会为存储池中的每个image mirror显示输出另外的详细状态信息。

mv src-image-spec dest-image-spec

     命名一个image，注意，不支持跨池重命名。

object-map check imag-spec | snap-spec

     验证对象映射是否正确

object-map rebuild imag-spec | snap-spec

     为指定的image重建无效的对象映射。可以为指定的iamge快照以重建快照的无效对象映射。

pool init [pool-name] [--force]

初始化存储池以供RBD使用。新创建的存储池必须在使用前初始化。 

resize (-s | –size size-in-M/G/T) [–allow-shrink] image-spec

     调整rbd image的大小，还需要指定--size参数，--all-shrink选项可以减小大小。

rm image-spec

     删除rbd image（包含所有的数据块），如果这个image有快照则无法删除。

snap create snap-spec

     创建一个新快照，需要指定快照名称参数。 

snap limit clear image-spec

     删除以前对image允许创建的快照数量的限制。

snap ls image-spec

     显示指定的image的快照。

snap protect snap-spec

     保护快照不被删除，以便可以对其进行克隆。在科隆生成之前必须保护快照，保护意味着存在以来克隆的子节点来引用此快照，如果快照是不被保护的rbd clone命令将会失败。

snap purge image-spec

     删除image中所有不受保护的快照。

snap rename src-snap-spec dest-snap-spec

     重命名一个快照，注意，不支持跨池重命名。

snap rm [--force] snap-spec

     删除指定的快照。

snap rollback snap-spec

     将image内容会滚到快照阶段，这将遍历整个块阵列并将数据头内容更新为快照版本。

snap unprotect snap-spec

     删除快照保护（撤销快照保护），如果克隆的子项仍然存在，则snap unprotect将失败（请注意，克隆可能存在于与富快照不同的存储池中。）

     需要image的format 是2.

status image-spec

     显示image的状态，包括哪些客户端正在使用/打开。

trash ls [pool-name]

     列出延迟删除的所有条目。

trash mv image-spec

     列出垃圾桶中的所有条目。

trash mv image-spec

     将image移动到垃圾桶中，image即使是克隆正在使用的image可以克移动到垃圾桶后再删除。

trash purge [pool-name]

     删除垃圾桶中所有过期的image。

trash restore image-id

     从垃圾桶中恢复某个image。

trash rm image-id

     从垃圾桶中删除image，如果image掩饰删除时间尚未到期，除非强制删除，否则无法将其删除，但是无法主动删除正在使用中的克隆或快照。

watch image-spec

     查看image上的活动事件。

***转载请注明出处***