Class: Ansible::Ruby::Modules::Manageiq_alerts

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_alerts.rb

Overview

The manageiq_alerts module supports adding, updating and deleting alerts in ManageIQ.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#description ⇒ String?

Returns The unique alert description in ManageIQ.,Required when state is “absent” or “present”.

Returns:

  • (String, nil) —

    The unique alert description in ManageIQ.,Required when state is “absent” or “present”.



16
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_alerts.rb', line 16

attribute :description

#enabled ⇒ Symbol?

Returns Enable or disable the alert. Required if state is “present”.

Returns:

  • (Symbol, nil) —

    Enable or disable the alert. Required if state is “present”.



32
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_alerts.rb', line 32

attribute :enabled

#expression ⇒ Hash?

Returns The alert expression for ManageIQ.,Can either be in the “Miq Expression” format or the “Hash Expression format”.,Required if state is “present”.

Returns:

  • (Hash, nil) —

    The alert expression for ManageIQ.,Can either be in the “Miq Expression” format or the “Hash Expression format”.,Required if state is “present”.



28
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_alerts.rb', line 28

attribute :expression

#expression_type ⇒ :hash, ...

Returns Expression type.

Returns:

  • (:hash, :miq, nil) —

    Expression type.



24
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_alerts.rb', line 24

attribute :expression_type

#options ⇒ Hash?

Returns Additional alert options, such as notification type and frequency.

Returns:

  • (Hash, nil) —

    Additional alert options, such as notification type and frequency



36
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_alerts.rb', line 36

attribute :options

#resource_type ⇒ :Vm, ...

Returns The entity type for the alert in ManageIQ. Required when state is “present”.

Returns:

  • (:Vm, :ContainerNode, :MiqServer, :Host, :Storage, :EmsCluster, :ExtManagementSystem, :MiddlewareServer, nil) —

    The entity type for the alert in ManageIQ. Required when state is “present”.



20
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_alerts.rb', line 20

attribute :resource_type

#state ⇒ :absent, ...

Returns absent - alert should not exist,,present - alert should exist,.

Returns:

  • (:absent, :present, nil) —

    absent - alert should not exist,,present - alert should exist,



12
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_alerts.rb', line 12

attribute :state