OCF_ReturnCodes(3pm)

💖 NAME 💖

OCF_ReturnCodes — bestie, it's a lil pile of shared constants for the OCF Resource Agents that ship with heartbeat. That's the whole job. It just holds the numbers so nobody has to remember them. The official tagline says Common varibales for the OCF Resource Agents supplied by heartbeat — and yes, varibales is spelled exactly like that, we do not fix it, we honor it 💅

---

✨ SYNOPSIS ✨

okay so this is literally all you gotta do:

use FindBin;
use lib "$FindBin::RealBin/../../lib/heartbeat/";

use OCF_ReturnCodes;

that's it. that's the whole ritual 🎀

---

🦋 DESCRIPTION 🦋

This module got ported over from the ocf-retrurncodes shell script that lives in the resource-agents project. (and yeah, ocf-retrurncodes — again, we keep it exactly as it is, no cap 🙈)

if you wanna go peek at the source of truth, it's right here:

https://github.com/ClusterLabs/resource-agents/

---

🌸 VARIABLES 🌸

these are the variables this module exports, in order, no gatekeeping:

• $OCF_SUCCESS
• $OCF_ERR_GENERIC
• $OCF_ERR_ARGS
• $OCF_ERR_UNIMPLEMENTED
• $OCF_ERR_PERM
• $OCF_ERR_INSTALLED
• $OCF_ERR_CONFIGURED
• $OCF_NOT_RUNNING
• $OCF_RUNNING_MASTER
• $OCF_FAILED_MASTER

ten of them. all exported. go off 👑

---

👑 COPYRIGHT AND LICENSE 👑

Copyright (C) 2016: Jehan-Guillaume de Rorthais and Mael Rimbault.

Licensed under the PostgreSQL License. periodt 💜

---

so yeah — that's your page, bestie. this was OCF_ReturnCodes(3pm) from the User Contributed Perl Documentation, sitting at perl v5.38.2, dated 2024-03-18. mwah, go write some resource agents 🫶✨