NAME

       ocf_heartbeat_aws-vpc-move-ip - Move IP within a VPC of the AWS EC2

SYNOPSIS

       aws-vpc-move-ip [start | stop | monitor | meta-data | validate-all]

DESCRIPTION

       Resource Agent to move IP addresses within a VPC of the Amazon Webservices EC2 by changing
       an entry in an specific routing table

       Credentials needs to be setup by running "aws configure", or by using AWS Policies.

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

SUPPORTED PARAMETERS

       awscli
           Path to command line tools for AWS

           (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")

       region
           Valid AWS region name (e.g., 'us-west-2')

           (optional, string, no default)

       ip
           VPC private IP address

           (required, string, no default)

       address
           Deprecated IP address param. Use the ip param instead.

           (optional, string, no default)

       routing_table
           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

           (required, string, no default)

       routing_table_role
           Role to use to query/update the route table

           (optional, string, no default)

       interface
           Name of the network interface, i.e. eth0

           (required, string, default "eth0")

       iflabel
           You can specify an additional label for your IP address here. This label is appended
           to your interface name.

           The kernel allows alphanumeric labels up to a maximum length of 15 characters
           including the interface name and colon (e.g. eth0:foobar1234)

           (optional, string, no default)

       monapi
           Enable enhanced monitoring using AWS API calls to check route table entry

           (optional, boolean, default false)

       lookup_type
           Name of resource type to lookup in route table. "InstanceId" : EC2 instance ID.
           (default) "NetworkInterfaceId" : ENI ID. (useful in shared VPC setups).

           (optional, string, default "InstanceId")

       curl_retries
           curl retries before failing

           (optional, integer, default 3)

       curl_sleep
           curl sleep between tries

           (optional, integer, default 1)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
           Starts the resource. Suggested minimum timeout: 180s.

       stop
           Stops the resource. Suggested minimum timeout: 180s.

       monitor
           Performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval:
           60s.

       validate-all
           Performs a validation of the resource configuration. Suggested minimum timeout: 5s.

       meta-data
           Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

EXAMPLE CRM SHELL

       The following is an example configuration for a aws-vpc-move-ip resource using the crm(8)
       shell:

           primitive p_aws-vpc-move-ip ocf:heartbeat:aws-vpc-move-ip \
             params \
               ip=string \
               routing_table=string \
               interface="eth0" \
             op monitor depth="0" timeout="30s" interval="60s"

EXAMPLE PCS

       The following is an example configuration for a aws-vpc-move-ip resource using pcs(8)

           pcs resource create p_aws-vpc-move-ip ocf:heartbeat:aws-vpc-move-ip \
             ip=string \
             routing_table=string \
             interface="eth0" \
             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="60s"

SEE ALSO

       http://clusterlabs.org/

AUTHOR

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