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       region
27           Valid AWS region name (e.g., 'us-west-2')
28
29           (optional, string, no default)
30
31       ip
32           VPC private IP address
33
34           (required, string, no default)
35
36       address
37           Deprecated IP address param. Use the ip param instead.
38
39           (optional, string, no default)
40
41       routing_table
42           Name of the routing table(s), where the route for the IP address
43           should be changed. If declaring multiple routing tables they should
44           be separated by comma. Example: rtb-XXXXXXXX,rtb-YYYYYYYYY
45
46           (required, string, no default)
47
48       routing_table_role
49           Role to use to query/update the route table
50
51           (optional, string, no default)
52
53       interface
54           Name of the network interface, i.e. eth0
55
56           (required, string, default "eth0")
57
58       iflabel
59           You can specify an additional label for your IP address here. This
60           label is appended to your interface name.
61
62           The kernel allows alphanumeric labels up to a maximum length of 15
63           characters including the interface name and colon (e.g.
64           eth0:foobar1234)
65
66           (optional, string, no default)
67
68       monapi
69           Enable enhanced monitoring using AWS API calls to check route table
70           entry
71
72           (optional, boolean, default false)
73
74       lookup_type
75           Name of resource type to lookup in route table. "InstanceId" : EC2
76           instance ID. (default) "NetworkInterfaceId" : ENI ID. (useful in
77           shared VPC setups).
78
79           (optional, string, default "InstanceId")
80

SUPPORTED ACTIONS

82       This resource agent supports the following actions (operations):
83
84       start
85           Starts the resource. Suggested minimum timeout: 180s.
86
87       stop
88           Stops the resource. Suggested minimum timeout: 180s.
89
90       monitor
91           Performs a detailed status check. Suggested minimum timeout: 30s.
92           Suggested interval: 60s.
93
94       validate-all
95           Performs a validation of the resource configuration. Suggested
96           minimum timeout: 5s.
97
98       meta-data
99           Retrieves resource agent metadata (internal use only). Suggested
100           minimum timeout: 5s.
101

EXAMPLE CRM SHELL

103       The following is an example configuration for a aws-vpc-move-ip
104       resource using the crm(8) shell:
105
106           primitive p_aws-vpc-move-ip ocf:heartbeat:aws-vpc-move-ip \
107             params \
108               ip=string \
109               routing_table=string \
110               interface="eth0" \
111             op monitor depth="0" timeout="30s" interval="60s"
112

EXAMPLE PCS

114       The following is an example configuration for a aws-vpc-move-ip
115       resource using pcs(8)
116
117           pcs resource create p_aws-vpc-move-ip ocf:heartbeat:aws-vpc-move-ip \
118             ip=string \
119             routing_table=string \
120             interface="eth0" \
121             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="60s"
122

AUTHOR

127       ClusterLabs contributors (see the resource agent source for information
128       about individual authors)
129
130
131
132resource-agents UNKNOWN           10/11/2023            OCF_HEARTBEAT_AWS-V(7)