OCF_HEARTBEAT_AWSVIP(7)

πŸ¦‹ OCF_HEARTBEAT_AWSVIP(7) πŸ¦‹

okay so this is a page from the OCF resource agents manual set, and it's literally all about ocf_heartbeat_awsvip β€” bestie, we're doing cloud networking today πŸ’…


✨ NAME ✨

ocf_heartbeat_awsvip β€” the Amazon AWS Secondary Private IP Address Resource Agent. yes. that's the whole name. it's giving "long title, big job" energy πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

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

that's the vibe check: you hand it one of those actions and it does the thing ✨


🌸 DESCRIPTION 🌸

okay so real talk β€” this is a Resource Agent for Amazon AWS Secondary Private IP Addresses. it handles all that with awscli, no cap.

your credentials gotta be set up first, bestie: either run "aws configure", or use AWS Policies. pick your fighter 🫢

if you wanna know more about awscli (and honestly why wouldn't you), it's at https://aws.amazon.com/cli/ β€” go read, i'll wait πŸ’–

also!! this resource agent can be configured for native migration if your cluster manager supports it. for Pacemaker specifically, the allow-migrate="true" meta attribute is what turns native migration on. iykyk 😌


πŸ’œ SUPPORTED PARAMETERS πŸ’œ

the full lineup, no skips, no skips, we're going through all of them:

  • awscli β€” the command line tools for aws services. (optional, string, default "/usr/bin/aws")
  • auth_type β€” the authentication type. set it to "key" for AccessKey and SecretAccessKey set via "aws configure", or "role" to use AWS Policies. (optional, string, default "key")
  • profile β€” a valid AWS CLI profile name, see ~/.aws/config and 'aws configure'. (optional, string, default "default")
  • secondary_private_ip β€” the reserved secondary private ip for your ec2 instance. this one's the main character, it's the only required one πŸ‘‘ (unique, required, string, no default)
  • region β€” the Region for the AWS resource. heads up, it's required for role-based authentication. (optional, string, no default)
  • api_delay β€” a short delay between API calls, so you don't send those APIs off too quick, bestie, they need a second 🫠 (optional, integer, default 3)
  • interface β€” the Name of the network interface, i.e. eth0. (optional, string, no default)
  • curl_retries β€” how many curl retries happen before failing. (optional, integer, default 4)
  • curl_sleep β€” the curl sleep between tries. (optional, integer, default 3)

πŸ”₯ SUPPORTED ACTIONS πŸ”₯

this resource agent supports the following actions (operations), and here is every single one with its timeout tea β˜•

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

🌈 EXAMPLE CRM SHELL 🌈

here's what it looks like when you set up an awsvip resource with the crm(8) shell β€” copy-paste queen behavior, honestly:

primitive p_awsvip ocf:heartbeat:awsvip \
  params \
    secondary_private_ip=string \
  meta allow-migrate="true" \
  op monitor timeout="30s" interval="20s" depth="0"

⭐ EXAMPLE PCS ⭐

and here's the same energy but with pcs(8) β€” pick whichever one your cluster's into πŸ’–

pcs resource create p_awsvip ocf:heartbeat:awsvip \
  secondary_private_ip=string \
  op monitor timeout="30s" interval="20s" OCF_CHECK_LEVEL="0"

🧚 SEE ALSO 🧚

http://clusterlabs.org/ β€” go say hi to the clusterlabs fam, they're icons πŸ’…


πŸ“ AUTHOR πŸ“

ClusterLabs contributors β€” and yeah, if you're nosy about which individual authors, the resource agent source has all that tea in it πŸ™ˆ


lowkey reminder bestie: secondary_private_ip is the one with no default and it's required & unique, so if things are being weird, start there 😭 also region is required for role-based auth β€” don't forget it, i'm begging 🫢

and that's the whole page!! mwah πŸ’‹

this little gem came from resource-agents UNKNOWN, dated 10/01/2026, and it lives under the name OCF_HEARTBEAT_AWSVIP(7) β€” slay, go configure your secondary private IPs, you're gonna do amazing βœ¨πŸ’–βœ¨

πŸ“¦ where this page comes from