OCF_HEARTBEAT_DUMMY(7)

πŸ’– OCF_HEARTBEAT_DUMMY(7) πŸ’–

okay bestie, so this is a page from the OCF resource agents manual set β€” yes that's the whole manual name, we're just vibing with it up here instead of doing a boring header line 🫢


✨ NAME ✨

ocf_heartbeat_Dummy β€” the Example stateless resource agent. that's it. that's the name. iconic behavior honestly πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

Dummy [start | stop | monitor | migrate_to | migrate_from | meta-data |
      validate-all]

πŸ¦‹ DESCRIPTION πŸ¦‹

So like… this is a Dummy Resource Agent. It does absolutely nothing except keep track of whether it's running or not πŸ’€ no cap, that's the entire job. Its whole purpose in life is to be used for testing and to serve as a template for RA writers. main character energy of a mannequin, but make it cluster-aware ✨

NB: bestie please pay attention to the timeouts specified in the actions section below. They should be meaningful for the kind of resource the agent manages. They should be the minimum advised timeouts, but they shouldn't/cannot cover _all_ possible resource instances. So try to be neither overly generous nor too stingy β€” be moderate, fr fr. And the minimum timeouts should never be below 10 seconds. periodt.

This resource agent may be configured for native migration if available in the cluster manager. For Pacemaker, the allow-migrate="true" meta attribute enables native migration 🌈


🌸 SUPPORTED PARAMETERS 🌸

  • state β€” Location to store the resource state in. (unique, optional, string, default "/run/resource-agents/Dummy-RESOURCE_ID.state")
  • fake β€” Fake attribute that can be changed to cause a reload 😭 (optional, string, default "dummy")

πŸ’… SUPPORTED ACTIONS πŸ’…

This resource agent supports the following actions (operations):

  • start β€” Starts the resource. Suggested minimum timeout: 20s.
  • stop β€” Stops the resource. Suggested minimum timeout: 20s.
  • monitor β€” Performs a detailed status check. Suggested minimum timeout: 20s. Suggested interval: 10s.
  • reload β€” Suggested minimum timeout: 20s.
  • migrate_to β€” Executes steps necessary for migrating the resource to the node. Suggested minimum timeout: 20s.
  • migrate_from β€” Executes steps necessary for migrating the resource away from the node. Suggested minimum timeout: 20s.
  • meta-data β€” Retrieves resource agent metadata (internal use only πŸ™ˆ). Suggested minimum timeout: 5s.
  • validate-all β€” Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

πŸ“ EXAMPLE CRM SHELL πŸ“

Here's an example config for a Dummy resource using the crm(8) shell, copy-paste ready bb:

primitive p_Dummy ocf:heartbeat:Dummy \
  meta allow-migrate="true" \
  op monitor timeout="20s" interval="10s" depth="0"

🧚 EXAMPLE PCS 🧚

And here's the same vibe but for pcs(8):

pcs resource create p_Dummy ocf:heartbeat:Dummy \
  op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"

⭐ SEE ALSO ⭐


πŸ‘‘ AUTHOR πŸ‘‘

ClusterLabs contributors (see the resource agent source for information about individual authors) πŸ’œ


aaaand that's the whole page bestie, you ate that 🫢 this cutie was brought to you by resource-agents UNKNOWN, dated 10/01/2026 β€” go forth and test your clusters, mwah πŸ’‹πŸŽ€

πŸ“¦ where this page comes from