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       monapi
59           Enable enhanced monitoring using AWS API calls to check route table
60           entry
61
62           (optional, boolean, default false)
63
64       lookup_type
65           Name of resource type to lookup in route table. "InstanceId" : EC2
66           instance ID. (default) "NetworkInterfaceId" : ENI ID. (useful in
67           shared VPC setups).
68
69           (optional, string, default "InstanceId")
70

SUPPORTED ACTIONS

72       This resource agent supports the following actions (operations):
73
74       start
75           Starts the resource. Suggested minimum timeout: 180s.
76
77       stop
78           Stops the resource. Suggested minimum timeout: 180s.
79
80       monitor
81           Performs a detailed status check. Suggested minimum timeout: 30s.
82           Suggested interval: 60s.
83
84       validate-all
85           Performs a validation of the resource configuration. Suggested
86           minimum timeout: 5s.
87
88       meta-data
89           Retrieves resource agent metadata (internal use only). Suggested
90           minimum timeout: 5s.
91

EXAMPLE CRM SHELL

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

EXAMPLE PCS

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

AUTHOR

117       ClusterLabs contributors (see the resource agent source for information
118       about individual authors)
119
120
121
122resource-agents UNKNOWN           04/06/2022            OCF_HEARTBEAT_AWS-V(7)