'\" t
.\"     Title: ocf_heartbeat_awseip
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 03/20/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_AWSEIP" "7" "03/20/2024" "resource-agents UNKNOWN" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_awseip \- Amazon AWS Elastic IP Address Resource Agent
.SH "SYNOPSIS"
.HP \w'\fBawseip\fR\ 'u
\fBawseip\fR [start | stop | monitor | migrate_to | migrate_from | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource Agent for Amazon AWS Elastic IP Addresses\&.
.PP
It manages AWS Elastic IP Addresses with awscli\&.
.PP
Credentials needs to be setup by running "aws configure"\&.
.PP
See https://aws\&.amazon\&.com/cli/ for more information about awscli\&.
.PP
This resource agent may be configured for
\fInative migration\fR
if available in the cluster manager\&. For Pacemaker, the
\fIallow\-migrate="true"\fR
meta attribute enables native migration\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBawscli\fR
.RS 4
command line tools for aws services
.sp
(optional, string, default "/usr/bin/aws")
.RE
.PP
\fBprofile\fR
.RS 4
Valid AWS CLI profile name (see ~/\&.aws/config and \*(Aqaws configure\*(Aq)
.sp
(optional, string, default "default")
.RE
.PP
\fBelastic_ip\fR
.RS 4
reserved elastic ip for ec2 instance
.sp
(unique, required, string, no default)
.RE
.PP
\fBallocation_id\fR
.RS 4
reserved allocation id for ec2 instance
.sp
(unique, required, string, no default)
.RE
.PP
\fBprivate_ip_address\fR
.RS 4
predefined private ip address for ec2 instance
.sp
(unique, optional, string, no default)
.RE
.PP
\fBapi_delay\fR
.RS 4
a short delay between API calls, to avoid sending API too quick
.sp
(optional, integer, default
3)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 20s\&.
.RE
.PP
\fBmigrate_to\fR
.RS 4
Executes steps necessary for migrating the resource
\fIto\fR
the node\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmigrate_from\fR
.RS 4
Executes steps necessary for migrating the resource
\fIaway from\fR
the node\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\fR
.RS 4
Suggested minimum timeout: 10s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 10s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a awseip resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_awseip ocf:heartbeat:awseip \e
  params \e
    elastic_ip=\fIstring\fR \e
    allocation_id=\fIstring\fR \e
  meta allow\-migrate="true" \e
  op monitor timeout="30s" interval="20s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a awseip resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_awseip ocf:heartbeat:awseip \e
  elastic_ip=\fIstring\fR \e
  allocation_id=\fIstring\fR \e
  op monitor timeout="30s" interval="20s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR
