Class: Ansible::Ruby::Modules::Netapp_e_alerts

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_alerts.rb

Overview

Certain E-Series systems have the capability to send email notifications on potentially critical events. This module will allow the owner of the system to specify email recipients for these messages.

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

#contact ⇒ String?

Returns Allows the owner to specify some free-form contact information to be included in the emails.,This is typically utilized to provide a contact phone number.

Returns:

  • (String, nil) —

    Allows the owner to specify some free-form contact information to be included in the emails.,This is typically utilized to provide a contact phone number.



25
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_alerts.rb', line 25

attribute :contact

#log_path ⇒ Object?

Returns Path to a file on the Ansible control node to be used for debug logging.

Returns:

  • (Object, nil) —

    Path to a file on the Ansible control node to be used for debug logging



37
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_alerts.rb', line 37

attribute :log_path

#recipients ⇒ Array<String>, ...

Returns The email addresses that will receive the email notifications.,Required when I(state=enabled).

Returns:

  • (Array<String>, String, nil) —

    The email addresses that will receive the email notifications.,Required when I(state=enabled).



29
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_alerts.rb', line 29

attribute :recipients

#sender ⇒ String?

Returns This is the sender that the recipient will see. It doesn’t necessarily need to be a valid email account.,Required when I(state=enabled).

Returns:

  • (String, nil) —

    This is the sender that the recipient will see. It doesn’t necessarily need to be a valid email account.,Required when I(state=enabled).



21
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_alerts.rb', line 21

attribute :sender

#server ⇒ String?

Returns A fully qualified domain name, IPv4 address, or IPv6 address of a mail server.,To use a fully qualified domain name, you must configure a DNS server on both controllers using M(netapp_e_mgmt_interface). - Required when I(state=enabled).

Returns:

  • (String, nil) —

    A fully qualified domain name, IPv4 address, or IPv6 address of a mail server.,To use a fully qualified domain name, you must configure a DNS server on both controllers using M(netapp_e_mgmt_interface). - Required when I(state=enabled).



17
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_alerts.rb', line 17

attribute :server

#state ⇒ :enabled, ...

Returns Enable/disable the sending of email-based alerts.

Returns:

  • (:enabled, :disabled, nil) —

    Enable/disable the sending of email-based alerts.



13
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_alerts.rb', line 13

attribute :state

#test ⇒ Symbol?

Returns When a change is detected in the configuration, a test email will be sent.,This may take a few minutes to process.,Only applicable if I(state=enabled).

Returns:

  • (Symbol, nil) —

    When a change is detected in the configuration, a test email will be sent.,This may take a few minutes to process.,Only applicable if I(state=enabled).



33
 
# File 'lib/ansible/ruby/modules/generated/storage/netapp/netapp_e_alerts.rb', line 33

attribute :test