sync.btrfssnap
**************

.. include:: template.service.sync.btrfssnap.example

.. _sync.btrfssnap.keep:

:kw:`keep`
==========

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       3
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       integer
================= ================================================================

The maximum number of snapshots to retain.

.. _sync.btrfssnap.name:

:kw:`name`
==========

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A name included in the snapshot name to avoid retention conflicts between multiple btrfs snapshot resources. A full snapshot name is formatted as ``<subvol>.<name>.snap.<datetime>``. Example: data.weekly.snap.2016-03-09.10:09:52

.. _sync.btrfssnap.recursive:

:kw:`recursive`
===============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       False
**inheritance**   leaf > head
**scope order**   specific > generic
**candidates**    True | False
**convert**       boolean
================= ================================================================

Also replicate subvolumes in the src tree.

.. _sync.btrfssnap.subvol:

:kw:`subvol`
============

================= ================================================================
**scopable**      True
**required**      True
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       list
================= ================================================================

A whitespace separated list of ``<label>:<subvol>`` to snapshot.

.. _sync.btrfssnap.blocking_post_provision:

:kw:`blocking_post_provision`
=============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`provision` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_post_start:

:kw:`blocking_post_start`
=========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`start` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_post_startstandby:

:kw:`blocking_post_startstandby`
================================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`startstandby` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_post_stop:

:kw:`blocking_post_stop`
========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`stop` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_post_sync_drp:

:kw:`blocking_post_sync_drp`
============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_drp` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_post_sync_nodes:

:kw:`blocking_post_sync_nodes`
==============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_nodes` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_post_sync_restore:

:kw:`blocking_post_sync_restore`
================================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_restore` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_post_sync_resync:

:kw:`blocking_post_sync_resync`
===============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_resync` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_post_sync_update:

:kw:`blocking_post_sync_update`
===============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_update` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_post_unprovision:

:kw:`blocking_post_unprovision`
===============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`unprovision` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_provision:

:kw:`blocking_pre_provision`
============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`provision` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_start:

:kw:`blocking_pre_start`
========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`start` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_startstandby:

:kw:`blocking_pre_startstandby`
===============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`startstandby` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_stop:

:kw:`blocking_pre_stop`
=======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`stop` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_sync_drp:

:kw:`blocking_pre_sync_drp`
===========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_drp` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_sync_nodes:

:kw:`blocking_pre_sync_nodes`
=============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_nodes` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_sync_restore:

:kw:`blocking_pre_sync_restore`
===============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_restore` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_sync_resync:

:kw:`blocking_pre_sync_resync`
==============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_resync` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_sync_update:

:kw:`blocking_pre_sync_update`
==============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_update` action. Errors interrupt the action.

.. _sync.btrfssnap.blocking_pre_unprovision:

:kw:`blocking_pre_unprovision`
==============================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`unprovision` action. Errors interrupt the action.

.. _sync.btrfssnap.comment:

:kw:`comment`
=============

================= ================================================================
**scopable**      False
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

Helps users understand the role of the service and resources, which is nice to on-call support people having to operate on a service they are not usually responsible for.

.. _sync.btrfssnap.disable:

:kw:`disable`
=============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       False
**inheritance**   leaf
**scope order**   specific > generic
**candidates**    True | False
**convert**       boolean
================= ================================================================

A disabled resource will be ignored on service startup and shutdown. Its status is always reported ``n/a``.

Set in DEFAULT, the whole service is disabled. A disabled service does not honor :c-action:`start` and :c-action:`stop` actions. These actions immediately return success.

:cmd:`om <path> disable` only sets :kw:`DEFAULT.disable`. As resources disabled state is not changed, :cmd:`om <path> enable` does not enable disabled resources.

.. _sync.btrfssnap.encap:

:kw:`encap`
===========

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       False
**inheritance**   leaf > head
**scope order**   specific > generic
**candidates**    True | False
**convert**       boolean
================= ================================================================

Set to ``true`` to ignore this resource in the nodes context and consider it in the encapnodes context. The resource is thus handled by the agents deployed in the service containers.

.. _sync.btrfssnap.monitor:

:kw:`monitor`
=============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       False
**inheritance**   leaf > head
**scope order**   specific > generic
**candidates**    True | False
**convert**       boolean
================= ================================================================

A down monitored resource will trigger a node suicide if the monitor thinks it should be up and the resource can not be restarted.

.. _sync.btrfssnap.optional:

:kw:`optional`
==============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       true for tasks, syncs and resources tagged 'noaction', else false
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       tristate
================= ================================================================

Action failures on optional resources are logged but do not stop the action sequence. Also the optional resource status is not aggregated to the instance 'availstatus', but aggregated to the 'overallstatus'. Resource tagged :c-tag:`noaction` and sync resources are automatically considered optional. Useful for resources like dump filesystems for example.

.. _sync.btrfssnap.pg_blkio_weight:

:kw:`pg_blkio_weight`
=====================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
**depends**       create_pg in [True]
**convert**       integer
================= ================================================================

Block IO relative weight. Value: between 10 and 1000. Kernel default: 1000.

.. _sync.btrfssnap.pg_cpu_quota:

:kw:`pg_cpu_quota`
==================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
**depends**       create_pg in [True]
================= ================================================================

The percent ratio of one core to allocate to the process group if % is specified, else the absolute value to set in the process group parameter. For example, on Linux cgroups, ``-1`` means unlimited, and a positive absolute value means the number of microseconds to allocate each period. ``50%@all`` means 50% of all cores, and ``50%@2`` means 50% of two cores.

.. _sync.btrfssnap.pg_cpu_shares:

:kw:`pg_cpu_shares`
===================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
**depends**       create_pg in [True]
**convert**       integer
================= ================================================================

Kernel default value is used, which usually is 1024 shares. In a cpu-bound situation, ensure the service does not use more than its share of cpu ressource. The actual percentile depends on shares allowed to other services.

.. _sync.btrfssnap.pg_cpus:

:kw:`pg_cpus`
=============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
**depends**       create_pg in [True]
================= ================================================================

Allow service process to bind only the specified cpus. Cpus are specified as list or range : 0,1,2 or 0-2

.. _sync.btrfssnap.pg_mem_limit:

:kw:`pg_mem_limit`
==================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
**depends**       create_pg in [True]
**convert**       size
================= ================================================================

Ensures the service does not use more than specified memory (in bytes). The Out-Of-Memory killer get triggered in case of tresspassing.

.. _sync.btrfssnap.pg_mem_oom_control:

:kw:`pg_mem_oom_control`
========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
**depends**       create_pg in [True]
**convert**       integer
================= ================================================================

A flag (0 or 1) that enables or disables the Out of Memory killer for a cgroup. If enabled (0), tasks that attempt to consume more memory than they are allowed are immediately killed by the OOM killer. The OOM killer is enabled by default in every cgroup using the memory subsystem; to disable it, write 1.

.. _sync.btrfssnap.pg_mem_swappiness:

:kw:`pg_mem_swappiness`
=======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
**depends**       create_pg in [True]
**convert**       integer
================= ================================================================

Set a swappiness value for the process group.

.. _sync.btrfssnap.pg_mems:

:kw:`pg_mems`
=============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
**depends**       create_pg in [True]
================= ================================================================

Allow service process to bind only the specified memory nodes. Memory nodes are specified as list or range : 0,1,2 or 0-2

.. _sync.btrfssnap.pg_vmem_limit:

:kw:`pg_vmem_limit`
===================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
**depends**       create_pg in [True]
**convert**       size
================= ================================================================

Ensures the service does not use more than specified memory+swap (in bytes). The Out-Of-Memory killer get triggered in case of tresspassing. The specified value must be greater than :kw:`pg_mem_limit`.

.. _sync.btrfssnap.post_provision:

:kw:`post_provision`
====================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`provision` action. Errors do not interrupt the action.

.. _sync.btrfssnap.post_start:

:kw:`post_start`
================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`start` action. Errors do not interrupt the action.

.. _sync.btrfssnap.post_startstandby:

:kw:`post_startstandby`
=======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`startstandby` action. Errors do not interrupt the action.

.. _sync.btrfssnap.post_stop:

:kw:`post_stop`
===============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`stop` action. Errors do not interrupt the action.

.. _sync.btrfssnap.post_sync_drp:

:kw:`post_sync_drp`
===================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_drp` action. Errors do not interrupt the action.

.. _sync.btrfssnap.post_sync_nodes:

:kw:`post_sync_nodes`
=====================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_nodes` action. Errors do not interrupt the action.

.. _sync.btrfssnap.post_sync_restore:

:kw:`post_sync_restore`
=======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_restore` action. Errors do not interrupt the action.

.. _sync.btrfssnap.post_sync_resync:

:kw:`post_sync_resync`
======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_resync` action. Errors do not interrupt the action.

.. _sync.btrfssnap.post_sync_update:

:kw:`post_sync_update`
======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`sync_update` action. Errors do not interrupt the action.

.. _sync.btrfssnap.post_unprovision:

:kw:`post_unprovision`
======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute after the resource :c-action:`unprovision` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_provision:

:kw:`pre_provision`
===================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`provision` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_start:

:kw:`pre_start`
===============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`start` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_startstandby:

:kw:`pre_startstandby`
======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`startstandby` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_stop:

:kw:`pre_stop`
==============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`stop` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_sync_drp:

:kw:`pre_sync_drp`
==================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_drp` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_sync_nodes:

:kw:`pre_sync_nodes`
====================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_nodes` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_sync_restore:

:kw:`pre_sync_restore`
======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_restore` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_sync_resync:

:kw:`pre_sync_resync`
=====================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_resync` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_sync_update:

:kw:`pre_sync_update`
=====================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`sync_update` action. Errors do not interrupt the action.

.. _sync.btrfssnap.pre_unprovision:

:kw:`pre_unprovision`
=====================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A command or script to execute before the resource :c-action:`unprovision` action. Errors do not interrupt the action.

.. _sync.btrfssnap.provision:

:kw:`provision`
===============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       True
**inheritance**   leaf > head
**scope order**   specific > generic
**candidates**    True | False
**convert**       boolean
================= ================================================================

Set to false to skip the resource on provision and unprovision actions. Warning: Provision implies destructive operations like formating. Unprovision destroys service data.

.. _sync.btrfssnap.provision_requires:

:kw:`provision_requires`
========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'provision' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.

.. _sync.btrfssnap.restart:

:kw:`restart`
=============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       0
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       integer
================= ================================================================

The agent will try to restart a resource <n> times before falling back to the monitor action. A resource restart is triggered if :the resource is not disabled and its status is not up, and the node is not frozen, and the service instance is not frozen and its local expect is set to ``started``. If a resource has a restart set to a value >0, its status is evaluated at the frequency defined by :kw:`DEFAULT.monitor_schedule` instead of the frequency defined by :kw:`DEFAULT.status_schedule`. :kw:`restart_delay` defines the interval between two restarts. Standby resources have a particular value to ensure best effort to restart standby resources, default value is 2, and value lower than 2 are changed to 2.

.. _sync.btrfssnap.restart_delay:

:kw:`restart_delay`
===================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       0
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       duration
================= ================================================================

Define minimum delay between two triggered restarts of a same resource (used when :kw:`restart`is defined). Default value is 0 (no delay).

.. _sync.btrfssnap.schedule:

:kw:`schedule`
==============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**default keyword** sync_schedule
**scope order**   specific > generic
================= ================================================================

Set the this resource synchronization schedule. See ``/usr/share/doc/opensvc/schedule`` for the schedule syntax reference.

.. _sync.btrfssnap.shared:

:kw:`shared`
============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       False
**inheritance**   leaf > head
**scope order**   specific > generic
**candidates**    True | False
**convert**       boolean
================= ================================================================

Set to ``true`` to skip the resource on provision and unprovision actions if the action has already been done by a peer. Shared resources, like vg built on SAN disks must be provisioned once. All resources depending on a shared resource must also be flagged as shared.

.. _sync.btrfssnap.standby:

:kw:`standby`
=============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       tristate
================= ================================================================

Always start the resource, even on standby instances. The daemon is responsible for starting standby resources. A resource can be set standby on a subset of nodes using keyword scoping.

A typical use-case is sync'ed fs on non-shared disks: the remote fs must be mounted to not overflow the underlying fs.

.. warning:: Don't set shared resources standby: fs on shared disks for example.

.. _sync.btrfssnap.start_requires:

:kw:`start_requires`
====================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'start' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.

.. _sync.btrfssnap.stop_requires:

:kw:`stop_requires`
===================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'stop' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.

.. _sync.btrfssnap.subset:

:kw:`subset`
============

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       None
**inheritance**   leaf
**scope order**   specific > generic
================= ================================================================

Assign the resource to a specific subset.

.. _sync.btrfssnap.sync_break_requires:

:kw:`sync_break_requires`
=========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'sync_break' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.

.. _sync.btrfssnap.sync_drp_requires:

:kw:`sync_drp_requires`
=======================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'sync_drp' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.

.. _sync.btrfssnap.sync_max_delay:

:kw:`sync_max_delay`
====================

================= ================================================================
**scopable**      False
**required**      False
**provisioning**  False
**default**       1d3h
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       duration_minute
================= ================================================================

Unit is minutes. This sets to delay above which the sync status of the resource is to be considered down. Should be set according to your application service level agreement. The scheduler task frequency should be set between :kw:`sync_min_delay` and :kw:`sync_max_delay`.

.. _sync.btrfssnap.sync_nodes_requires:

:kw:`sync_nodes_requires`
=========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'sync_nodes' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.

.. _sync.btrfssnap.sync_restore_requires:

:kw:`sync_restore_requires`
===========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'sync_restore' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.

.. _sync.btrfssnap.sync_resync_requires:

:kw:`sync_resync_requires`
==========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'sync_resync' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.

.. _sync.btrfssnap.sync_update_requires:

:kw:`sync_update_requires`
==========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'sync_update' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.

.. _sync.btrfssnap.tags:

:kw:`tags`
==========

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
**convert**       set
================= ================================================================

A list of tags. Arbitrary tags can be used to limit action scope to resources with a specific tag. Some tags can influence the driver behaviour. For example :c-tag:`noaction` avoids any state changing action from the driver and implies ``optional=true``, :c-tag:`nostatus` forces the status to n/a.

.. _sync.btrfssnap.unprovision:

:kw:`unprovision`
=================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       True
**inheritance**   leaf > head
**scope order**   specific > generic
**candidates**    True | False
**convert**       boolean
================= ================================================================

Set to false to skip the resource on unprovision actions. Warning: Unprovision destroys service data.

.. _sync.btrfssnap.unprovision_requires:

:kw:`unprovision_requires`
==========================

================= ================================================================
**scopable**      True
**required**      False
**provisioning**  False
**default**       
**inheritance**   leaf > head
**scope order**   specific > generic
================= ================================================================

A whitespace-separated list of conditions to meet to accept running a 'unprovision' action. A condition is expressed as ``<rid>(<state>,...)``. If states are omitted, ``up,stdby up`` is used as the default expected states.