'\" t
.\"     Title: ocf_heartbeat_azure-events
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_AZURE" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_azure-events \- Microsoft Azure Scheduled Events monitoring agent
.SH "SYNOPSIS"
.HP \w'\fBazure\-events\fR\ 'u
\fBazure\-events\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This resource agent implements a monitor for scheduled (maintenance) events for a Microsoft Azure VM\&.
.PP
If any relevant events are found, it moves all Pacemaker resources away from the affected node to allow for a graceful shutdown\&.
.PP
Usage: [OCF_RESKEY_eventTypes=VAL] [OCF_RESKEY_verbose=VAL] azure\-events ACTION
.PP
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
.PP
Deployment: crm configure primitive rsc_azure\-events ocf:heartbeat:azure\-events op monitor interval=10s crm configure clone cln_azure\-events rsc_azure\-events
.PP
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
.PP
.SH "SUPPORTED PARAMETERS"
.PP
\fBeventTypes\fR
.RS 4
A comma\-separated list of event types that will be handled by this resource agent\&. (Possible values: Freeze,Reboot,Redeploy)
.sp
(optional, string, default "Reboot,Redeploy")
.RE
.PP
\fBverbose\fR
.RS 4
Set to true to enable verbose logging
.sp
(optional, boolean, default
false)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 10s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 10s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 240s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 10s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a azure\-events resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_azure\-events ocf:heartbeat:azure\-events \e
  op monitor timeout="240s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a azure\-events resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_azure\-events ocf:heartbeat:azure\-events \e
  op monitor timeout="240s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR