ocf_heartbeat_openstack-virtual-ip(7)

1OCF_HEARTBEAT_OPENST(7)       OCF resource agents      OCF_HEARTBEAT_OPENST(7)
2
3
4

NAME

6       ocf_heartbeat_openstack-virtual-ip - Move a virtual IP
7

SYNOPSIS

9       openstack-virtual-ip [start | stop | monitor | meta-data |
10                            validate-all]
11

DESCRIPTION

13       Resource Agent to move a virtual IP address from an instance to another
14       one by adding an allowed-address pair associated with an instance port.
15       It relies on attributes given by openstack-info resource agent
16       (openstack_ports, openstack_id attributes). The attribute called
17       "openstack_virtual_ip" is updated.
18

SUPPORTED PARAMETERS

20       cloud
21           Openstack cloud (from ~/.config/openstack/clouds.yaml or
22           /etc/openstack/clouds.yaml).
23
24           (optional, string, no default)
25
26       openrc
27           Openstack credentials as openrc file from api_access/openrc.
28
29           (optional, string, no default)
30
31       auth_url
32           Keystone Auth URL
33
34           (optional, string, no default)
35
36       username
37           Username.
38
39           (optional, string, no default)
40
41       password
42           Password.
43
44           (optional, string, no default)
45
46       project_name
47           Keystone Project.
48
49           (optional, string, no default)
50
51       user_domain_name
52           Keystone User Domain Name.
53
54           (optional, string, default "Default")
55
56       project_domain_name
57           Keystone Project Domain Name.
58
59           (optional, string, default "Default")
60
61       openstackcli
62           Path to command line tools for openstack.
63
64           (optional, string, default "/usr/bin/openstack")
65
66       insecure
67           Allow insecure connections
68
69           (optional, boolean, default false)
70
71       ip
72           Virtual IP Address.
73
74           (required, string, no default)
75
76       subnet_id
77           Subnet Identifier to use to attach the address.
78
79           (required, string, no default)
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: 180s.
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 openstack-virtual-ip
104       resource using the crm(8) shell:
105
106           primitive p_openstack-virtual-ip ocf:heartbeat:openstack-virtual-ip \
107             params \
108               ip=string \
109               subnet_id=string \
110             op monitor depth="0" timeout="180s" interval="60s"
111

EXAMPLE PCS

113       The following is an example configuration for a openstack-virtual-ip
114       resource using pcs(8)
115
116           pcs resource create p_openstack-virtual-ip ocf:heartbeat:openstack-virtual-ip \
117             ip=string \
118             subnet_id=string \
119             op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="60s"
120

AUTHOR

125       ClusterLabs contributors (see the resource agent source for information
126       about individual authors)
127
128
129
130resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_OPENST(7)