ceph/doc/cephfs
Nikhilkumar Shelke 59a0cbc14b docs: set, get, list and remove custom metadata for snapshot
Set custom metadata on the snapshot as a key-value pair using
    $ ceph fs subvolume snapshot metadata set <vol_name> <subvol_name> <snap_name> <key_name> <value> [--group_name <subvol_group_name>]
    note: If the key_name already exists then the old value will get replaced by the new value.
    note: The key_name and value should be a string of ASCII characters (as specified in python's string.printable). The key_name is case-insensitive and always stored in lower case.
    note: Custom metadata on a snapshots is not preserved when snapshotting the subvolume, and hence, is also not preserved when cloning the subvolume snapshot.

Get custom metadata set on the snapshot using the metadata key::
    $ ceph fs subvolume snapshot metadata get <vol_name> <subvol_name> <snap_name> <key_name> [--group_name <subvol_group_name>]

List custom metadata (key-value pairs) set on the snapshot using::
    $ ceph fs subvolume snapshot metadata ls <vol_name> <subvol_name> <snap_name> [--group_name <subvol_group_name>]

Remove custom metadata set on the snapshot using the metadata key::
    $ ceph fs subvolume snapshot metadata rm <vol_name> <subvol_name> <snap_name> <key_name> [--group_name <subvol_group_name>] [--force]
    Using the '--force' flag allows the command to succeed that would otherwise fail if the metadata key did not exist.

Fixes: https://tracker.ceph.com/issues/55401
Signed-off-by: Nikhilkumar Shelke <nshelke@redhat.com>
2022-05-25 14:59:53 +05:30
..
api
.gitignore
add-remove-mds.rst doc/cephfs/add-remove-mds: added cephadm note, refined "Adding an MDS" 2022-04-04 14:57:34 +05:30
administration.rst mon/FSCommands: add 'recover' flag in fs new command 2021-09-13 00:15:39 -04:00
app-best-practices.rst
cache-configuration.rst doc/cephfs: fix typos 2021-09-13 09:40:17 +08:00
capabilities.rst doc,man: typos found by codespell 2021-12-15 12:04:36 +01:00
ceph-dokan.rst
cephfs-architecture.svg
cephfs-io-path.rst
cephfs-journal-tool.rst
cephfs-mirroring.rst doc/cephfs: Clean up mirroring 2022-01-26 12:10:05 -08:00
cephfs-top.png doc: include read, write, metadata average latencies in doc/man. 2022-02-09 02:51:25 -05:00
cephfs-top.rst Merge pull request #41397 from vshankar/wip-48619 2022-03-07 10:34:15 +05:30
client-auth.rst
client-config-ref.rst
createfs.rst doc/cephfs: Clarify CephFS pool guidance 2022-01-21 12:28:05 -08:00
dirfrags.rst
disaster-recovery-experts.rst doc,man: typos found by codespell 2021-12-15 12:04:36 +01:00
disaster-recovery.rst
dynamic-metadata-management.rst doc: Fix links to CRUSH, RADOS and DSP research papers. 2022-01-30 17:23:33 +01:00
eviction.rst
experimental-features.rst
file-layouts.rst doc: describe json, pool_id and pool_name layout fields 2022-02-11 16:05:54 +05:30
fs-volumes.rst docs: set, get, list and remove custom metadata for snapshot 2022-05-25 14:59:53 +05:30
full.rst
health-messages.rst Merge PR #44315 into master 2021-12-20 14:41:43 -05:00
index.rst Merge PR #42295 into master 2021-07-21 13:13:43 -07:00
journaler.rst doc/cephfs/journaler: document options using confval directive 2021-07-22 11:16:56 +08:00
kernel-features.rst
lazyio.rst doc,man: typos found by codespell 2021-12-15 12:04:36 +01:00
mantle.rst
mdcache.rst
mds-config-ref.rst mds: Store symlink target on the first data object 2021-12-07 15:39:52 +05:30
mds-journaling.rst
mds-state-diagram.dot
mds-states.rst docs/cephfs: fix typos 2022-03-16 17:39:21 +08:00
mount-prerequisites.rst doc: prerequisites fix for cephFS mount 2021-11-17 00:32:55 +05:30
mount-using-fuse.rst doc: prerequisites fix for cephFS mount 2021-11-17 00:32:55 +05:30
mount-using-kernel-driver.rst doc/cephfs: mds default cache memory limit is now 4GB 2021-12-15 14:18:41 +08:00
multifs.rst
multimds.rst doc: document subvolume (group) pins 2021-11-11 12:30:02 -05:00
nfs.rst doc/cephadm: Add lots of links to other chapters 2021-09-11 20:04:14 +02:00
posix.rst doc: cephfs: update with atime not supporting explaination 2022-04-21 14:10:24 +08:00
quota.rst
recover-fs-after-mon-store-loss.rst mon/FSCommands: add 'recover' flag in fs new command 2021-09-13 00:15:39 -04:00
scrub.rst
snap-schedule.rst doc/cephfs: remove subvol support from snap-schedule 2022-05-16 12:24:42 +05:30
standby.rst doc: fixed typo in terminology 2021-10-01 16:04:44 +05:30
subtree-partitioning.svg
troubleshooting.rst doc: document that NEARFULL conditions can result in slow writes 2021-08-11 09:29:16 -04:00
upgrading.rst doc: clarify MDS failed state 2021-09-19 21:22:14 +08:00