OCF_HEARTBEAT_RSYNCD(7)

πŸ’– ocf_heartbeat_rsyncd β€” the girlies' guide to managing an rsync daemon πŸ’–

okay so bestie, this page lives in the OCF resource agents manual (section 7, for the pedants keeping score ✨), and it's literally all about one little resource agent called ocf_heartbeat_rsyncd that runs your rsync daemon for you. she's lowkey simple and highkey iconic, let's get into it πŸŽ€


✨ NAME ✨

ocf_heartbeat_rsyncd β€” she manages an rsync daemon. that's the whole vibe. no cap πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

rsyncd [start | stop | monitor | meta-data | validate-all]

look at her go, five whole actions, main character energy fr fr πŸ‘‘


🌸 DESCRIPTION 🌸

okay so this script manages rsync daemon. yes that's it, that's the whole description, she's a woman of few words and honestly? respect πŸ’œ


πŸ’– SUPPORTED PARAMETERS πŸ’–

these are the knobs you get to twiddle, and every single one matters, so pay attention bestie 🫢

  • binpath β€” the path to your rsync binary. like, where does rsync actually live. example given in the docs: "/usr/bin/rsync". this one's optional, it's a string, and the default is "rsync" (she'll just find it on your PATH, slay ✨).
  • conffile β€” the rsync daemon configuration file name, and yes, with the full path, don't be shy. the example they give is "/etc/rsyncd.conf". optional, string, default "/etc/rsyncd.conf" πŸŽ€.
  • bwlimit β€” okay this one's the fun one πŸ’… it lets you set a maximum transfer rate in kilobytes per second. it's most effective when you're rsyncing large files (we're talking several megabytes and up, big girl files 🌈). here's the tea on why: due to the nature of rsync transfers, blocks of data are sent, and then if rsync determines the transfer was too fast, it will wait before sending the next data block. so the result is an average transfer rate equaling the limit you specified β€” she's not capping every packet, she's averaging the whole vibe 😌. a value of zero means no limit at all, go wild. this one is optional, a string, and has no default πŸ™ˆ.

πŸ”₯ SUPPORTED ACTIONS πŸ”₯

this resource agent supports the following actions (operations), and each one comes with a suggested minimum timeout because we don't do infinite waits in this house ⭐

  • 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: 60s.
  • validate-all β€” performs a validation of the resource configuration. suggested minimum timeout: 20s.
  • meta-data β€” retrieves resource agent metadata (internal use only, so hands off bestie πŸ™ˆ). suggested minimum timeout: 5s.

🧚 EXAMPLE CRM SHELL 🧚

the following is an example configuration for a rsyncd resource using the crm(8) shell:

primitive p_rsyncd ocf:heartbeat:rsyncd \
  op monitor depth="0" timeout="20s" interval="60s"

copy it exactly, character for character, she's perfect as she is πŸ’«


πŸ“ EXAMPLE PCS πŸ“

and here's the same glow-up, but for pcs(8):

pcs resource create p_rsyncd ocf:heartbeat:rsyncd \
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s"

note the OCF_CHECK_LEVEL="0" there instead of depth="0" β€” that's not a typo, that's just how pcs does it, iykyk 😌


🌈 SEE ALSO 🌈


πŸ‘‘ AUTHOR πŸ‘‘

ClusterLabs contributors β€” see the resource agent source for information about individual authors. we love a collaborative credited moment, periodt πŸ’œ


and that's the whole page diva ✨ this was resource-agents version UNKNOWN, dated 10/01/2026, page OCF_HEARTBEAT_RSYNCD(7) β€” go forth and rsync responsibly, mwah πŸ’‹πŸŽ€

πŸ“¦ where this page comes from