Class: Ansible::Ruby::Modules::Clc_alert_policy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/centurylink/clc_alert_policy.rb

Overview

An Ansible module to Create or Delete Alert Policies at CenturyLink Cloud.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#alert_recipients ⇒ Object?

Returns A list of recipient email ids to notify the alert. This is required for state ‘present’.

Returns:

  • (Object, nil) —

    A list of recipient email ids to notify the alert. This is required for state ‘present’



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/centurylink/clc_alert_policy.rb', line 23

attribute :alert_recipients

#alias ⇒ Object

Returns The alias of your CLC Account.

Returns:

  • (Object) —

    The alias of your CLC Account



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/centurylink/clc_alert_policy.rb', line 12

attribute :alias

#duration ⇒ Object?

Returns The length of time in minutes that the condition must exceed the threshold. This is required for state ‘present’.

Returns:

  • (Object, nil) —

    The length of time in minutes that the condition must exceed the threshold. This is required for state ‘present’



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/centurylink/clc_alert_policy.rb', line 30

attribute :duration

#id ⇒ Object?

Returns The alert policy id. This is mutually exclusive with name.

Returns:

  • (Object, nil) —

    The alert policy id. This is mutually exclusive with name



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/centurylink/clc_alert_policy.rb', line 20

attribute :id

#metric ⇒ :cpu, ...

Returns The metric on which to measure the condition that will trigger the alert. This is required for state ‘present’.

Returns:

  • (:cpu, :memory, :disk, nil) —

    The metric on which to measure the condition that will trigger the alert. This is required for state ‘present’



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/centurylink/clc_alert_policy.rb', line 26

attribute :metric

#name ⇒ String?

Returns The name of the alert policy. This is mutually exclusive with id.

Returns:

  • (String, nil) —

    The name of the alert policy. This is mutually exclusive with id



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/centurylink/clc_alert_policy.rb', line 16

attribute :name

#state ⇒ :present, ...

Returns Whether to create or delete the policy.

Returns:

  • (:present, :absent, nil) —

    Whether to create or delete the policy.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/centurylink/clc_alert_policy.rb', line 36

attribute :state

#threshold ⇒ Object?

Returns The threshold that will trigger the alert when the metric equals or exceeds it. This is required for state ‘present’ This number represents a percentage and must be a value between 5.0 - 95.0 that is a multiple of 5.0.

Returns:

  • (Object, nil) —

    The threshold that will trigger the alert when the metric equals or exceeds it. This is required for state ‘present’ This number represents a percentage and must be a value between 5.0 - 95.0 that is a multiple of 5.0



33
 
# File 'lib/ansible/ruby/modules/generated/cloud/centurylink/clc_alert_policy.rb', line 33

attribute :threshold