Module: Veeam::Client::Alarms

Included in:
Veeam::Client
Defined in:
lib/veeam/client/alarms.rb

Overview

Defines methods related to alarm resources

See Also:

Instance Method Summary collapse

Instance Method Details

#active_alarm(alarm_id) ⇒ Object Also known as: triggered_alarm

Returns a resource representation of a triggered alarm with the specified UID.



14
15
16
 
# File 'lib/veeam/client/alarms.rb', line 14

def active_alarm(alarm_id)
  get("/api/v3/alarms/active/#{alarm_id}")
end

#active_alarms ⇒ Object Also known as: all_triggered_alarms

Returns collection resource representation of all Veeam Service Provider Console triggered alarms.



8
9
10
 
# File 'lib/veeam/client/alarms.rb', line 8

def active_alarms
  get_paged('/api/v3/alarms/active')
end

#alarm_history(alarm_id) ⇒ Object Also known as: triggered_alarm_history

Returns a collection resource representation of all status changes of a triggered alarm with the specified UID in chronological order.



21
22
23
 
# File 'lib/veeam/client/alarms.rb', line 21

def alarm_history(alarm_id)
  get_paged("/api/v3/alarms/active#{alarm_id}/history")
end

#alarm_template(template_id) ⇒ Object

Returns a resource representation of a triggered alarm with the specified UID.



33
34
35
 
# File 'lib/veeam/client/alarms.rb', line 33

def alarm_template(template_id)
  get("/api/v3/alarms/templates/#{template_id}")
end

#alarm_template_events(template_id) ⇒ Object Also known as: alarm_status_changes

Returns all status changes of a triggered alarm with the specified template UID.



38
39
40
 
# File 'lib/veeam/client/alarms.rb', line 38

def alarm_template_events(template_id)
  get_paged("/api/v3/alarms/templates/#{template_id}/events")
end

#alarm_templates ⇒ Object Also known as: all_alarm_templates

Returns a collection resource representation of all Veeam Service Provider Console alarm templates.



27
28
29
 
# File 'lib/veeam/client/alarms.rb', line 27

def alarm_templates
  get_paged('/api/v3/alarms/templates')
end