NAME

       ocf_heartbeat_azure-events - Microsoft Azure Scheduled Events monitoring agent

SYNOPSIS

       azure-events [start | stop | monitor | meta-data | validate-all]

DESCRIPTION

       This resource agent implements a monitor for scheduled (maintenance) events for a Microsoft Azure VM.

       If any relevant events are found, it moves all Pacemaker resources away from the affected node to allow
       for a graceful shutdown.

       Usage: [OCF_RESKEY_eventTypes=VAL] [OCF_RESKEY_verbose=VAL] azure-events ACTION

       action (required): Supported values: monitor, help, meta-data eventTypes (optional): List of event types
       to be considered relevant by the resource agent (comma-separated). Supported values:
       Freeze,Reboot,Redeploy Default = Reboot,Redeploy / verbose (optional): If set to true, displays debug
       info. Default = false

       Deployment: crm configure primitive rsc_azure-events ocf:heartbeat:azure-events op monitor interval=10s
       crm configure clone cln_azure-events rsc_azure-events

       For further information on Microsoft Azure Scheduled Events, please refer to the following documentation:
       https://docs.microsoft.com/en-us/azure/virtual-machines/linux/scheduled-events

SUPPORTED PARAMETERS

       eventTypes
           A comma-separated list of event types that will be handled by this resource agent. (Possible values:
           Freeze,Reboot,Redeploy)

           (optional, string, default "Reboot,Redeploy")

       verbose
           Set to true to enable verbose logging

           (optional, boolean, default false)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

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

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

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

       monitor
           Performs a detailed status check. Suggested minimum timeout: 240s. Suggested interval: 10s.

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

EXAMPLE CRM SHELL

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

           primitive p_azure-events ocf:heartbeat:azure-events \
             op monitor timeout="240s" interval="10s"

EXAMPLE PCS

       The following is an example configuration for a azure-events resource using pcs(8)

           pcs resource create p_azure-events ocf:heartbeat:azure-events \
             op monitor timeout="240s" interval="10s"

SEE ALSO

       http://clusterlabs.org/

AUTHOR

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

resource-agents 4.13.0-1ubuntu                     04/01/2024                             OCF_HEARTBEAT_AZURE(7)