NAME

       ocf_heartbeat_openstack-virtual-ip - Move a virtual IP

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

       cloud
           Openstack cloud (from ~/.config/openstack/clouds.yaml or /etc/openstack/clouds.yaml).

           (optional, string, no default)

       openrc
           Openstack credentials as openrc file from api_access/openrc.

           (optional, string, no default)

       auth_url
           Keystone Auth URL

           (optional, string, no default)

       username
           Username.

           (optional, string, no default)

       password
           Password.

           (optional, string, no default)

       project_name
           Keystone Project.

           (optional, string, no default)

       user_domain_name
           Keystone User Domain Name.

           (optional, string, default "Default")

       project_domain_name
           Keystone Project Domain Name.

           (optional, string, default "Default")

       openstackcli
           Path to command line tools for openstack.

           (optional, string, default "/usr/bin/openstack")

       insecure
           Allow insecure connections

           (optional, boolean, default false)

       ip
           Virtual IP Address.

           (required, string, no default)

       subnet_id
           Subnet Identifier to use to attach the address.

           (required, string, no default)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
           Starts the resource. Suggested minimum timeout: 180s.

       stop
           Stops the resource. Suggested minimum timeout: 180s.

       monitor
           Performs a detailed status check. Suggested minimum timeout: 180s. Suggested interval: 60s.

       validate-all
           Performs a validation of the resource configuration. Suggested minimum timeout: 5s.

       meta-data
           Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

EXAMPLE CRM SHELL

       The following is an example configuration for a openstack-virtual-ip resource using the crm(8) shell:

           primitive p_openstack-virtual-ip ocf:heartbeat:openstack-virtual-ip \
             params \
               ip=string \
               subnet_id=string \
             op monitor depth="0" timeout="180s" interval="60s"

EXAMPLE PCS

       The following is an example configuration for a openstack-virtual-ip resource using pcs(8)

           pcs resource create p_openstack-virtual-ip ocf:heartbeat:openstack-virtual-ip \
             ip=string \
             subnet_id=string \
             op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="60s"

SEE ALSO

       http://clusterlabs.org/

AUTHOR

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

resource-agents 4.16.0-2ubuntu                     02/19/2025                            OCF_HEARTBEAT_OPENST(7)