doc: Clarify VSS extended options

This commit is contained in:
Leo R. Lundgren 2024-07-23 00:37:56 +02:00
parent fa5ff0873a
commit c54d5a8eca

View file

@ -58,38 +58,38 @@ snapshot for each volume that contains files to backup. Files are read from the
VSS snapshot instead of the regular filesystem. This allows to backup files that are VSS snapshot instead of the regular filesystem. This allows to backup files that are
exclusively locked by another process during the backup. exclusively locked by another process during the backup.
You can use additional options to change VSS behaviour: You can use the following extended options to change the VSS behavior:
* ``-o vss.timeout`` specifies timeout for VSS snapshot creation, the default value is 120 seconds * ``-o vss.timeout`` specifies timeout for VSS snapshot creation, default value being 120 seconds
* ``-o vss.exclude-all-mount-points`` disable auto snapshotting of all volume mount points * ``-o vss.exclude-all-mount-points`` disable auto snapshotting of all volume mount points
* ``-o vss.exclude-volumes`` allows excluding specific volumes or volume mount points from snapshotting * ``-o vss.exclude-volumes`` allows excluding specific volumes or volume mount points from snapshotting
* ``-o vss.provider`` specifies VSS provider used for snapshotting * ``-o vss.provider`` specifies VSS provider used for snapshotting
For example a 2.5 minutes timeout with snapshotting of mount points disabled can be specified as For example a 2.5 minutes timeout with snapshotting of mount points disabled can be specified as:
.. code-block:: console .. code-block:: console
-o vss.timeout=2m30s -o vss.exclude-all-mount-points=true -o vss.timeout=2m30s -o vss.exclude-all-mount-points=true
and excluding drive ``d:\``, mount point ``c:\mnt`` and volume ``\\?\Volume{04ce0545-3391-11e0-ba2f-806e6f6e6963}\`` as and excluding drive ``d:\``, mount point ``c:\mnt`` and volume ``\\?\Volume{04ce0545-3391-11e0-ba2f-806e6f6e6963}\`` as:
.. code-block:: console .. code-block:: console
-o vss.exclude-volumes="d:;c:\mnt\;\\?\volume{04ce0545-3391-11e0-ba2f-806e6f6e6963}" -o vss.exclude-volumes="d:;c:\mnt\;\\?\volume{04ce0545-3391-11e0-ba2f-806e6f6e6963}"
VSS provider can be specified by GUID VSS provider can be specified by GUID:
.. code-block:: console .. code-block:: console
-o vss.provider={3f900f90-00e9-440e-873a-96ca5eb079e5} -o vss.provider={3f900f90-00e9-440e-873a-96ca5eb079e5}
or by name or by name:
.. code-block:: console .. code-block:: console
-o vss.provider="Hyper-V IC Software Shadow Copy Provider" -o vss.provider="Hyper-V IC Software Shadow Copy Provider"
Also ``MS`` can be used as alias for ``Microsoft Software Shadow Copy provider 1.0``. Also, ``MS`` can be used as alias for ``Microsoft Software Shadow Copy provider 1.0``.
By default VSS ignores Outlook OST files. This is not a restriction of restic By default VSS ignores Outlook OST files. This is not a restriction of restic
but the default Windows VSS configuration. The files not to snapshot are but the default Windows VSS configuration. The files not to snapshot are