'\" t
.\"     Title: ocf_heartbeat_aws-vpc-move-ip
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/13/2023
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.12.0-2
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_AWS\-V" "7" "04/13/2023" "resource-agents 4.12.0-2" "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_aws-vpc-move-ip \- Move IP within a VPC of the AWS EC2
.SH "SYNOPSIS"
.HP \w'\fBaws\-vpc\-move\-ip\fR\ 'u
\fBaws\-vpc\-move\-ip\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource Agent to move IP addresses within a VPC of the Amazon Webservices EC2 by changing an entry in an specific routing table
.SH "SUPPORTED PARAMETERS"
.PP
\fBawscli\fR
.RS 4
Path to command line tools for AWS
.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
\fBregion\fR
.RS 4
Valid AWS region name (e\&.g\&., \*(Aqus\-west\-2\*(Aq)
.sp
(optional, string, no default)
.RE
.PP
\fBip\fR
.RS 4
VPC private IP address
.sp
(required, string, no default)
.RE
.PP
\fBaddress\fR
.RS 4
Deprecated IP address param\&. Use the ip param instead\&.
.sp
(optional, string, no default)
.RE
.PP
\fBrouting_table\fR
.RS 4
Name of the routing table(s), where the route for the IP address should be changed\&. If declaring multiple routing tables they should be separated by comma\&. Example: rtb\-XXXXXXXX,rtb\-YYYYYYYYY
.sp
(required, string, no default)
.RE
.PP
\fBrouting_table_role\fR
.RS 4
Role to use to query/update the route table
.sp
(optional, string, no default)
.RE
.PP
\fBinterface\fR
.RS 4
Name of the network interface, i\&.e\&. eth0
.sp
(required, string, default "eth0")
.RE
.PP
\fBiflabel\fR
.RS 4
You can specify an additional label for your IP address here\&. This label is appended to your interface name\&.
.sp
The kernel allows alphanumeric labels up to a maximum length of 15 characters including the interface name and colon (e\&.g\&. eth0:foobar1234)
.sp
(optional, string, no default)
.RE
.PP
\fBmonapi\fR
.RS 4
Enable enhanced monitoring using AWS API calls to check route table entry
.sp
(optional, boolean, default
false)
.RE
.PP
\fBlookup_type\fR
.RS 4
Name of resource type to lookup in route table\&. "InstanceId" : EC2 instance ID\&. (default) "NetworkInterfaceId" : ENI ID\&. (useful in shared VPC setups)\&.
.sp
(optional, string, default "InstanceId")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 180s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 180s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 60s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a aws\-vpc\-move\-ip resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_aws\-vpc\-move\-ip ocf:heartbeat:aws\-vpc\-move\-ip \e
  params \e
    ip=\fIstring\fR \e
    routing_table=\fIstring\fR \e
    interface="eth0" \e
  op monitor depth="0" timeout="30s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a aws\-vpc\-move\-ip resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_aws\-vpc\-move\-ip ocf:heartbeat:aws\-vpc\-move\-ip \e
  ip=\fIstring\fR \e
  routing_table=\fIstring\fR \e
  interface="eth0" \e
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="60s" 
.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