Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
OCF_HEARTBEAT_AWSVIP(7)        OCF resource agents	 OCF_HEARTBEAT_AWSVIP(7)

NAME
     ocf_heartbeat_awsvip  -  Amazon  AWS  Secondary Private IP Address Resource
     Agent

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

DESCRIPTION
     Resource Agent for Amazon AWS Secondary Private IP Addresses.

     It manages AWS Secondary Private IP Addresses with awscli.

     Credentials needs to be setup by running "aws configure".

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

     profile
	 Valid AWS CLI profile name (see ~/.aws/config and 'aws configure')

	 (optional, string, default "default")

     secondary_private_ip
	 reserved secondary private ip for ec2 instance

	 (unique, required, string, no default)

     api_delay
	 a short delay between API calls, to avoid sending API too quick

	 (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.  Sug-
	 gested interval: 20s.

     migrate_to
	 Executes  steps  necessary for migrating the resource to the node. Sug-
	 gested 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  mini-
	 mum 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 a awsvip resource  using  the
     crm(8) shell:

	 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
     The  following  is  an  example  configuration  for a awsvip resource using
     pcs(8)

	 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/

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

resource-agents 4.13.0		   08/27/2026		 OCF_HEARTBEAT_AWSVIP(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_awsvip&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>

home | help