ocf_heartbeat_aws-vpc-move-ip(7)

1OCF_HEARTBEAT_AWS-V(7)        OCF resource agents       OCF_HEARTBEAT_AWS-V(7)
2
3
4

NAME

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

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

16       awscli
17           Path to command line tools for AWS
18
19           (optional, string, default "/usr/bin/aws")
20
21       profile
22           Valid AWS CLI profile name (see ~/.aws/config and 'aws configure')
23
24           (optional, string, default "default")
25
26       ip
27           VPC private IP address
28
29           (required, string, no default)
30
31       address
32           Deprecated IP address param. Use the ip param instead.
33
34           (optional, string, no default)
35
36       routing_table
37           Name of the routing table(s), where the route for the IP address
38           should be changed. If declaring multiple routing tables they should
39           be separated by comma. Example: rtb-XXXXXXXX,rtb-YYYYYYYYY
40
41           (required, string, no default)
42
43       routing_table_role
44           Role to use to query/update the route table
45
46           (optional, string, no default)
47
48       interface
49           Name of the network interface, i.e. eth0
50
51           (required, string, default "eth0")
52
53       monapi
54           Enable enhanced monitoring using AWS API calls to check route table
55           entry
56
57           (optional, boolean, default false)
58

SUPPORTED ACTIONS

60       This resource agent supports the following actions (operations):
61
62       start
63           Starts the resource. Suggested minimum timeout: 180s.
64
65       stop
66           Stops the resource. Suggested minimum timeout: 180s.
67
68       monitor
69           Performs a detailed status check. Suggested minimum timeout: 30s.
70           Suggested interval: 60s.
71
72       validate-all
73           Performs a validation of the resource configuration. Suggested
74           minimum timeout: 5s.
75
76       meta-data
77           Retrieves resource agent metadata (internal use only). Suggested
78           minimum timeout: 5s.
79

EXAMPLE CRM SHELL

81       The following is an example configuration for a aws-vpc-move-ip
82       resource using the crm(8) shell:
83
84           primitive p_aws-vpc-move-ip ocf:heartbeat:aws-vpc-move-ip \
85             params \
86               ip=string \
87               routing_table=string \
88               interface="eth0" \
89             op monitor depth="0" timeout="30s" interval="60s"
90

EXAMPLE PCS

92       The following is an example configuration for a aws-vpc-move-ip
93       resource using pcs(8)
94
95           pcs resource create p_aws-vpc-move-ip ocf:heartbeat:aws-vpc-move-ip \
96             ip=string \
97             routing_table=string \
98             interface="eth0" \
99             op monitor depth="0" timeout="30s" interval="60s"
100

AUTHOR

105       ClusterLabs contributors (see the resource agent source for information
106       about individual authors)
107
108
109
110resource-agents UNKNOWN           03/09/2020            OCF_HEARTBEAT_AWS-V(7)