Class: Ansible::Ruby::Modules::Sensu_client

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

Overview

Manages Sensu client configuration. For more information, refer to the Sensu documentation: U(sensuapp.org/docs/latest/reference/clients.html)

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

#address ⇒ String?

Returns An address to help identify and reach the client. This is only informational, usually an IP address or hostname.

Returns:

  • (String, nil) —

    An address to help identify and reach the client. This is only informational, usually an IP address or hostname.



21
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 21

attribute :address

#chef ⇒ Object?

Returns The chef definition scope, used to configure the Sensu Enterprise Chef integration (Sensu Enterprise users only).

Returns:

  • (Object, nil) —

    The chef definition scope, used to configure the Sensu Enterprise Chef integration (Sensu Enterprise users only).



62
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 62

attribute :chef

#deregister ⇒ :yes, ...

Returns If a deregistration event should be created upon Sensu client process stop.

Returns:

  • (:yes, :no, nil) —

    If a deregistration event should be created upon Sensu client process stop.



52
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 52

attribute :deregister

#deregistration ⇒ Object?

Returns The deregistration definition scope, used to configure automated Sensu client de-registration.

Returns:

  • (Object, nil) —

    The deregistration definition scope, used to configure automated Sensu client de-registration.



56
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 56

attribute :deregistration

#ec2 ⇒ Object?

Returns The ec2 definition scope, used to configure the Sensu Enterprise AWS EC2 integration (Sensu Enterprise users only).

Returns:

  • (Object, nil) —

    The ec2 definition scope, used to configure the Sensu Enterprise AWS EC2 integration (Sensu Enterprise users only).



59
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 59

attribute :ec2

#keepalive ⇒ Hash?

Returns The keepalive definition scope, used to configure Sensu client keepalives behavior (e.g. keepalive thresholds, etc).

Returns:

  • (Hash, nil) —

    The keepalive definition scope, used to configure Sensu client keepalives behavior (e.g. keepalive thresholds, etc).



45
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 45

attribute :keepalive

#keepalives ⇒ :yes, ...

Returns If Sensu should monitor keepalives for this client.

Returns:

  • (:yes, :no, nil) —

    If Sensu should monitor keepalives for this client.



41
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 41

attribute :keepalives

#name ⇒ String?

Returns A unique name for the client. The name cannot contain special characters or spaces.

Returns:

  • (String, nil) —

    A unique name for the client. The name cannot contain special characters or spaces.



17
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 17

attribute :name

#puppet ⇒ Object?

Returns The puppet definition scope, used to configure the Sensu Enterprise Puppet integration (Sensu Enterprise users only).

Returns:

  • (Object, nil) —

    The puppet definition scope, used to configure the Sensu Enterprise Puppet integration (Sensu Enterprise users only).



65
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 65

attribute :puppet

#redact ⇒ Array<String>, ...

Returns Client definition attributes to redact (values) when logging and sending client keepalives.

Returns:

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

    Client definition attributes to redact (values) when logging and sending client keepalives.



33
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 33

attribute :redact

#registration ⇒ Object?

Returns The registration definition scope, used to configure Sensu registration event handlers.

Returns:

  • (Object, nil) —

    The registration definition scope, used to configure Sensu registration event handlers.



49
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 49

attribute :registration

#safe_mode ⇒ :yes, ...

Returns If safe mode is enabled for the client. Safe mode requires local check definitions in order to accept a check request and execute the check.

Returns:

  • (:yes, :no, nil) —

    If safe mode is enabled for the client. Safe mode requires local check definitions in order to accept a check request and execute the check.



29
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 29

attribute :safe_mode

#servicenow ⇒ Object?

Returns The servicenow definition scope, used to configure the Sensu Enterprise ServiceNow integration (Sensu Enterprise users only).

Returns:

  • (Object, nil) —

    The servicenow definition scope, used to configure the Sensu Enterprise ServiceNow integration (Sensu Enterprise users only).



68
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 68

attribute :servicenow

#socket ⇒ Hash?

Returns The socket definition scope, used to configure the Sensu client socket.

Returns:

  • (Hash, nil) —

    The socket definition scope, used to configure the Sensu client socket.



37
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 37

attribute :socket

#state ⇒ :present, ...

Returns Whether the client should be present or not.

Returns:

  • (:present, :absent, nil) —

    Whether the client should be present or not



13
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 13

attribute :state

#subscriptions ⇒ Array<String>, String

Returns An array of client subscriptions, a list of roles and/or responsibilities assigned to the system (e.g. webserver).,These subscriptions determine which monitoring checks are executed by the client, as check requests are sent to subscriptions.,The subscriptions array items must be strings.

Returns:

  • (Array<String>, String) —

    An array of client subscriptions, a list of roles and/or responsibilities assigned to the system (e.g. webserver).,These subscriptions determine which monitoring checks are executed by the client, as check requests are sent to subscriptions.,The subscriptions array items must be strings.



25
 
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_client.rb', line 25

attribute :subscriptions