]> git.proxmox.com Git - ceph.git/blob - ceph/doc/man/8/cephfs-mirror.rst
update ceph source to reef 18.1.2
[ceph.git] / ceph / doc / man / 8 / cephfs-mirror.rst
1 :orphan:
2
3 ============================================================
4 cephfs-mirror -- Ceph daemon for mirroring CephFS snapshots
5 ============================================================
6
7 .. program:: cephfs-mirror
8
9 Synopsis
10 ========
11
12 | **cephfs-mirror**
13
14
15 Description
16 ===========
17
18 :program:`cephfs-mirror` is a daemon for asynchronous mirroring of Ceph
19 Filesystem snapshots among Ceph clusters.
20
21 It connects to remote clusters via libcephfs, relying on default search
22 paths to find ceph.conf files, i.e. ``/etc/ceph/$cluster.conf`` where
23 ``$cluster`` is the human-friendly name of the cluster.
24
25
26 Options
27 =======
28
29 .. option:: --mon-host monaddress[:port]
30
31 Connect to specified monitor (instead of looking through
32 ``ceph.conf``).
33
34 .. option:: --keyring=<path-to-keyring>
35
36 Provide path to keyring; useful when it's absent in standard locations.
37
38 .. option:: --log-file=<logfile>
39
40 file to log debug output
41
42 .. option:: --debug-cephfs-mirror=<log-level>/<memory-level>
43
44 set cephfs-mirror debug level
45
46 .. option:: -c ceph.conf, --conf=ceph.conf
47
48 Use ``ceph.conf`` configuration file instead of the default
49 ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
50
51 .. option:: -i ID, --id ID
52
53 Set the ID portion of name for cephfs-mirror
54
55 .. option:: -n TYPE.ID, --name TYPE.ID
56
57 Set the rados user name (eg. client.mirror)
58
59 .. option:: --cluster NAME
60
61 Set the cluster name (default: ceph)
62
63 .. option:: -d
64
65 Run in foreground, log to stderr
66
67 .. option:: -f
68
69 Run in foreground, log to usual location
70
71
72 Availability
73 ============
74
75 :program:`cephfs-mirror` is part of Ceph, a massively scalable, open-source, distributed
76 storage system. Please refer to the Ceph documentation at https://docs.ceph.com for
77 more information.
78
79
80 See also
81 ========
82
83 :doc:`ceph <ceph>`\(8)