NAME

       ocf_heartbeat_osceip - Outscale Elastic IP Address Resource Agent

SYNOPSIS

       osceip [start | stop | monitor | migrate_to | migrate_from | meta-data | validate-all]

DESCRIPTION

       Resource Agent for Outscale Elastic IP Addresses.

       It manages Outscale Elastic IP Addresses with osc-cli.

       Credentials needs to be setup.

       See https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html for more information
       about osccli.

       This resource agent may be configured for native migration if available in the cluster manager. For
       Pacemaker, the allow-migrate="true" meta attribute enables native migration.

SUPPORTED PARAMETERS

       osccli
           command line tools for outscale services

           (optional, string, default "/usr/local/bin/osc-cli")

       profile
           Valid OSC-CLI profile name (see ~/.osc/config and 'osc configure')

           (optional, string, default "default")

       elastic_ip
           reserved elastic ip for vm instance

           (unique, required, string, no default)

       region
           Region for osc resource (required for role-based authentication)

           (optional, string, no default)

       curl_retries
           curl retries before failing

           (optional, integer, default 3)

       curl_sleep
           curl sleep between tries

           (optional, integer, default 1)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

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

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

       monitor
           Performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 20s.

       migrate_to
           Executes steps necessary for migrating the resource to the node. Suggested minimum timeout: 30s.

       migrate_from
           Executes steps necessary for migrating the resource away from the node. Suggested minimum timeout:
           30s.

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

       validate
           Suggested minimum timeout: 10s.

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

EXAMPLE CRM SHELL

       The following is an example configuration for a osceip resource using the crm(8) shell:

           primitive p_osceip ocf:heartbeat:osceip \
             params \
               elastic_ip=string \
             meta allow-migrate="true" \
             op monitor timeout="30s" interval="20s" depth="0"

EXAMPLE PCS

       The following is an example configuration for a osceip resource using pcs(8)

           pcs resource create p_osceip ocf:heartbeat:osceip \
             elastic_ip=string \
             op monitor timeout="30s" interval="20s" OCF_CHECK_LEVEL="0"

SEE ALSO

       http://clusterlabs.org/

AUTHOR

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

resource-agents 4.16.0-3ubuntu                     06/25/2025                            OCF_HEARTBEAT_OSCEIP(7)