OCF_HEARTBEAT_AWSEIP(7)

💖 NAME 💖

okay bestie, this is OCF_HEARTBEAT_AWSEIP(7) from the OCF resource agents crew — it's the manual for ocf_heartbeat_awseip, the Amazon AWS Elastic IP Address Resource Agent ✨

---

🌸 SYNOPSIS 🌸

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

---

💅 DESCRIPTION 💅

Resource Agent for Amazon AWS Elastic IP Addresses. It manages AWS Elastic IP Addresses with awscli.

Credentials need to be set up by running aws configure, or by using AWS Policies.

See https://aws.amazon.com/cli/ for more information about awscli.

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 🎀

• awscli — command line tools for aws services (optional, string, default "/usr/bin/aws")
• auth_type — Authentication type "key" for AccessKey and SecretAccessKey set via aws configure, or "role" to use AWS Policies (optional, string, default "key")
• profile — Valid AWS CLI profile name (see ~/.aws/config and aws configure) (optional, string, default "default")
• elastic_ip — reserved elastic ip for ec2 instance (unique, required, string, no default)
• allocation_id — reserved allocation id for ec2 instance (unique, required, string, no default)
• private_ip_address — predefined private ip address for ec2 instance (unique, optional, string, no default)
• region — Region for AWS resource (required for role-based authentication) (optional, string, no default)
• api_delay — a short delay between API calls, to avoid sending API too quick (optional, integer, default 3)
• curl_retries — curl retries before failing (optional, integer, default 4)
• curl_sleep — curl sleep between tries (optional, integer, default 3)

---

🦋 SUPPORTED ACTIONS 🦋

This resource agent supports the following actions (operations):

• 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 🍓

The following is an example configuration for an awseip resource using the crm(8) shell:

           primitive p_awseip ocf:heartbeat:awseip \
             params \
               elastic_ip=string \
               allocation_id=string \
             meta allow-migrate="true" \
             op monitor timeout="30s" interval="20s" depth="0"

---

🌈 EXAMPLE PCS 🌈

The following is an example configuration for an awseip resource using pcs(8):

           pcs resource create p_awseip ocf:heartbeat:awseip \
             elastic_ip=string \
             allocation_id=string \
             op monitor timeout="30s" interval="20s" OCF_CHECK_LEVEL="0"

---

👑 SEE ALSO 👑

http://clusterlabs.org/ — that's the see-also, bestie 💖

---

💜 AUTHOR 💜

ClusterLabs contributors (see the resource agent source for information about individual authors)

---

xoxo, your resource-agents bestie — source/version resource-agents UNKNOWN, dated 10/01/2026 💅🫶