ocf_heartbeat_azure-events(7)

1OCF_HEARTBEAT_AZURE()                                    OCF_HEARTBEAT_AZURE()
2
3
4

NAME

6       ocf_heartbeat_azure-events - Microsoft Azure Scheduled Events
7       monitoring agent
8

SYNOPSIS

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

DESCRIPTION

13       This resource agent implements a monitor for scheduled (maintenance)
14       events for a Microsoft Azure VM.
15
16       If any relevant events are found, it moves all Pacemaker resources away
17       from the affected node to allow for a graceful shutdown.
18
19       Usage: [OCF_RESKEY_eventTypes=VAL] [OCF_RESKEY_verbose=VAL]
20       azure-events ACTION
21
22       action (required): Supported values: monitor, help, meta-data
23       eventTypes (optional): List of event types to be considered relevant by
24       the resource agent (comma-separated). Supported values:
25       Freeze,Reboot,Redeploy Default = Reboot,Redeploy / verbose (optional):
26       If set to true, displays debug info. Default = false
27
28       Deployment: crm configure primitive rsc_azure-events
29       ocf:heartbeat:azure-events op monitor interval=10s crm configure clone
30       cln_azure-events rsc_azure-events
31
32       For further information on Microsoft Azure Scheduled Events, please
33       refer to the following documentation:
34       https://docs.microsoft.com/en-us/azure/virtual-machines/linux/scheduled-events
35

SUPPORTED PARAMETERS

37       eventTypes
38           A comma-separated list of event types that will be handled by this
39           resource agent. (Possible values: Freeze,Reboot,Redeploy)
40
41           (optional, string, default "Reboot,Redeploy")
42
43       verbose
44           Set to true to enable verbose logging
45
46           (optional, boolean, default false)
47

SUPPORTED ACTIONS

49       This resource agent supports the following actions (operations):
50
51       start
52           Starts the resource. Suggested minimum timeout: 10s.
53
54       stop
55           Stops the resource. Suggested minimum timeout: 10s.
56
57       validate-all
58           Performs a validation of the resource configuration. Suggested
59           minimum timeout: 20s.
60
61       monitor
62           Performs a detailed status check. Suggested minimum timeout: 240s.
63           Suggested interval: 10s.
64
65       meta-data
66           Retrieves resource agent metadata (internal use only). Suggested
67           minimum timeout: 10s.
68

EXAMPLE CRM SHELL

70       The following is an example configuration for a azure-events resource
71       using the crm(8) shell:
72
73           primitive p_azure-events ocf:heartbeat:azure-events \
74             op monitor timeout="240s" interval="10s"
75

EXAMPLE PCS

77       The following is an example configuration for a azure-events resource
78       using pcs(8)
79
80           pcs resource create p_azure-events ocf:heartbeat:azure-events \
81             op monitor timeout="240s" interval="10s"
82

AUTHOR

87       ClusterLabs contributors (see the resource agent source for information
88       about individual authors)
89
90
91
92                                                         OCF_HEARTBEAT_AZURE()