Class: Ansible::Ruby::Modules::Sensu_silence

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/monitoring/sensu_silence.rb

Overview

Create and clear (delete) a silence entries via the Sensu API for subscriptions and checks.

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

#check ⇒ String?

Returns Specifies the check which the silence entry applies to.

Returns:

  • (String, nil) —

    Specifies the check which the silence entry applies to.



12
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_silence.rb', line 12

attribute :check

#creator ⇒ String?

Returns Specifies the entity responsible for this entry.

Returns:

  • (String, nil) —

    Specifies the entity responsible for this entry.



16
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_silence.rb', line 16

attribute :creator

#expire ⇒ Object?

Returns If specified, the silence entry will be automatically cleared after this number of seconds.

Returns:

  • (Object, nil) —

    If specified, the silence entry will be automatically cleared after this number of seconds.



20
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_silence.rb', line 20

attribute :expire

#expire_on_resolve ⇒ Symbol?

Returns If specified as true, the silence entry will be automatically cleared once the condition it is silencing is resolved.

Returns:

  • (Symbol, nil) —

    If specified as true, the silence entry will be automatically cleared once the condition it is silencing is resolved.



23
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_silence.rb', line 23

attribute :expire_on_resolve

#reason ⇒ String?

Returns If specified, this free-form string is used to provide context or rationale for the reason this silence entry was created.

Returns:

  • (String, nil) —

    If specified, this free-form string is used to provide context or rationale for the reason this silence entry was created.



27
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_silence.rb', line 27

attribute :reason

#state ⇒ :present, :absent

Returns Specifies to create or clear (delete) a silence entry via the Sensu API.

Returns:

  • (:present, :absent) —

    Specifies to create or clear (delete) a silence entry via the Sensu API



31
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_silence.rb', line 31

attribute :state

#subscription ⇒ Object

Returns Specifies the subscription which the silence entry applies to.,To create a silence entry for a client prepend C(client:) to client name. Example - C(client:server1.example.dev).

Returns:

  • (Object) —

    Specifies the subscription which the silence entry applies to.,To create a silence entry for a client prepend C(client:) to client name. Example - C(client:server1.example.dev)



35
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_silence.rb', line 35

attribute :subscription

#url ⇒ String?

Returns Specifies the URL of the Sensu monitoring host server.

Returns:

  • (String, nil) —

    Specifies the URL of the Sensu monitoring host server.



39
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_silence.rb', line 39

attribute :url