Class: Ansible::Ruby::Modules::Icinga2_host

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

Overview

Add or remove a host to Icinga2 through the API. See U(www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/)

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_command ⇒ String?

Returns The command used to check if the host is alive.

Returns:

  • (String, nil) —

    The command used to check if the host is alive.



57
 
# File 'lib/ansible/ruby/modules/generated/monitoring/icinga2_host.rb', line 57

attribute :check_command

#client_cert ⇒ Object?

Returns PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, C(client_key) is not required.

Returns:

  • (Object, nil) —

    PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, C(client_key) is not required.



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

attribute :client_cert

#client_key ⇒ Object?

Returns PEM formatted file that contains your private key to be used for SSL client authentication. If C(client_cert) contains both the certificate and key, this option is not required.

Returns:

  • (Object, nil) —

    PEM formatted file that contains your private key to be used for SSL client authentication. If C(client_cert) contains both the certificate and key, this option is not required.



40
 
# File 'lib/ansible/ruby/modules/generated/monitoring/icinga2_host.rb', line 40

attribute :client_key

#display_name ⇒ String?

Returns The name used to display the host.

Returns:

  • (String, nil) —

    The name used to display the host.



61
 
# File 'lib/ansible/ruby/modules/generated/monitoring/icinga2_host.rb', line 61

attribute :display_name

#force_basic_auth ⇒ :yes, ...

Returns httplib2, the library used by the uri module only sends authentication information when a webservice responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the sending of the Basic authentication header upon initial request.

Returns:

  • (:yes, :no, nil) —

    httplib2, the library used by the uri module only sends authentication information when a webservice responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the sending of the Basic authentication header upon initial request.



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

attribute :force_basic_auth

#ip ⇒ String

Returns The IP address of the host.

Returns:

  • (String) —

    The IP address of the host.



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

attribute :ip

#name ⇒ String

Returns Name used to create / delete the host. This does not need to be the FQDN, but does needs to be unique.

Returns:

  • (String) —

    Name used to create / delete the host. This does not need to be the FQDN, but does needs to be unique.



47
 
# File 'lib/ansible/ruby/modules/generated/monitoring/icinga2_host.rb', line 47

attribute :name

#state ⇒ :present, ...

Returns Apply feature state.

Returns:

  • (:present, :absent, nil) —

    Apply feature state.



43
 
# File 'lib/ansible/ruby/modules/generated/monitoring/icinga2_host.rb', line 43

attribute :state

#template ⇒ Object?

Returns The template used to define the host.,Template cannot be modified after object creation.

Returns:

  • (Object, nil) —

    The template used to define the host.,Template cannot be modified after object creation.



54
 
# File 'lib/ansible/ruby/modules/generated/monitoring/icinga2_host.rb', line 54

attribute :template

#url ⇒ String

Returns HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user]@host.domain/path.

Returns:



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

attribute :url

#url_password ⇒ String?

Returns The password for use in HTTP basic authentication.,If the C(url_username) parameter is not specified, the C(url_password) parameter will not be used.

Returns:

  • (String, nil) —

    The password for use in HTTP basic authentication.,If the C(url_username) parameter is not specified, the C(url_password) parameter will not be used.



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

attribute :url_password

#url_username ⇒ String?

Returns The username for use in HTTP basic authentication.,This parameter can be used without C(url_password) for sites that allow empty passwords.

Returns:

  • (String, nil) —

    The username for use in HTTP basic authentication.,This parameter can be used without C(url_password) for sites that allow empty passwords.



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

attribute :url_username

#use_proxy ⇒ :yes, ...

Returns If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Returns:

  • (:yes, :no, nil) —

    If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.



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

attribute :use_proxy

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

  • (:yes, :no, nil) —

    If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.



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

attribute :validate_certs

#variables ⇒ Object?

Returns List of variables.

Returns:

  • (Object, nil) —

    List of variables.



69
 
# File 'lib/ansible/ruby/modules/generated/monitoring/icinga2_host.rb', line 69

attribute :variables

#zone ⇒ Object?

Returns The zone from where this host should be polled.

Returns:

  • (Object, nil) —

    The zone from where this host should be polled.



51
 
# File 'lib/ansible/ruby/modules/generated/monitoring/icinga2_host.rb', line 51

attribute :zone