Class: Ansible::Ruby::Modules::Zabbix_host
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Zabbix_host
- Defined in:
- lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb
Overview
This module allows you to create, modify and delete Zabbix host entries and associated group and template data.
Instance Method Summary collapse
-
#description ⇒ String?
Description of the host in Zabbix.
-
#force ⇒ :yes, ...
Overwrite the host configuration, even if already present.
-
#host_groups ⇒ Array<String>, ...
List of host groups the host is part of.
-
#host_name ⇒ String
Name of the host in Zabbix.,host_name is the unique identifier used and cannot be updated using this module.
-
#interfaces ⇒ Object?
List of interfaces to be created for the host (see example below).,Available keys are: I(dns), I(ip), I(main), I(port), I(type), I(useip), and I(bulk).,Please review the interface documentation for more information on the supported properties,www.zabbix.com/documentation/2.0/manual/appendix/api/hostinterface/definitions#host_interface,If an interface definition is incomplete, this module will attempt to fill in sensible values.,I(type) can also be C(agent), C(snmp), C(ipmi), or C(jmx) instead of its numerical value.
-
#inventory_mode ⇒ :automatic, ...
Configure the inventory mode.
-
#inventory_zabbix ⇒ Hash?
Add Facts for a zabbix inventory (e.g. Tag) (see example below).,Please review the interface documentation for more information on the supported properties,www.zabbix.com/documentation/3.2/manual/api/reference/host/object#host_inventory.
-
#ipmi_authtype ⇒ Integer?
IPMI authentication algorithm.,Please review the Host object documentation for more information on the supported properties,www.zabbix.com/documentation/3.4/manual/api/reference/host/object,Possible values are, C(0) (none), C(1) (MD2), C(2) (MD5), C(4) (straight), C(5) (OEM), C(6) (RMCP+), with -1 being the API default.,Please note that the Zabbix API will treat absent settings as default when updating any of the I(ipmi_)-options; this means that if you attempt to set any of the four options individually, the rest will be reset to default values.
-
#ipmi_password ⇒ String?
IPMI password.,also see the last note in the I(ipmi_authtype) documentation.
-
#ipmi_privilege ⇒ Integer?
IPMI privilege level.,Please review the Host object documentation for more information on the supported properties,www.zabbix.com/documentation/3.4/manual/api/reference/host/object,Possible values are C(1) (callback), C(2) (user), C(3) (operator), C(4) (admin), C(5) (OEM), with C(2) being the API default.,also see the last note in the I(ipmi_authtype) documentation.
-
#ipmi_username ⇒ String?
IPMI username.,also see the last note in the I(ipmi_authtype) documentation.
-
#link_templates ⇒ Array<String>, ...
List of templates linked to the host.
-
#proxy ⇒ String?
The name of the Zabbix proxy to be used.
-
#state ⇒ :present, ...
State of the host.,On C(present), it will create if host does not exist or update the host if the associated data is different.,On C(absent) will remove a host if it exists.
-
#status ⇒ :enabled, ...
Monitoring status of the host.
-
#tls_accept ⇒ Integer?
Specifies what types of connections are allowed for incoming connections.,The tls_accept parameter accepts values of 1 to 7,Possible values, 1 (no encryption), 2 (PSK), 4 (certificate).,Values can be combined.,Works only with >= Zabbix 3.0.
-
#tls_connect ⇒ Integer?
Specifies what encryption to use for outgoing connections.,Possible values, 1 (no encryption), 2 (PSK), 4 (certificate).,Works only with >= Zabbix 3.0.
-
#tls_issuer ⇒ Object?
Required certificate issuer.,Works only with >= Zabbix 3.0.
-
#tls_psk ⇒ String?
PSK value is a hard to guess string of hexadecimal digits.,The preshared key, at least 32 hex digits.
-
#tls_psk_identity ⇒ String?
It is a unique name by which this specific PSK is referred to by Zabbix components,Do not put sensitive information in the PSK identity string, it is transmitted over the network unencrypted.,Works only with >= Zabbix 3.0.
-
#tls_subject ⇒ Object?
Required certificate subject.,Works only with >= Zabbix 3.0.
-
#visible_name ⇒ String?
Visible name of the host in Zabbix.
Methods inherited from Base
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
#description ⇒ String?
Returns Description of the host in Zabbix.
20 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 20 attribute :description |
#force ⇒ :yes, ...
Returns Overwrite the host configuration, even if already present.
93 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 93 attribute :force |
#host_groups ⇒ Array<String>, ...
Returns List of host groups the host is part of.
24 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 24 attribute :host_groups |
#host_name ⇒ String
Returns Name of the host in Zabbix.,host_name is the unique identifier used and cannot be updated using this module.
12 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 12 attribute :host_name |
#interfaces ⇒ Object?
Returns List of interfaces to be created for the host (see example below).,Available keys are: I(dns), I(ip), I(main), I(port), I(type), I(useip), and I(bulk).,Please review the interface documentation for more information on the supported properties,www.zabbix.com/documentation/2.0/manual/appendix/api/hostinterface/definitions#host_interface,If an interface definition is incomplete, this module will attempt to fill in sensible values.,I(type) can also be C(agent), C(snmp), C(ipmi), or C(jmx) instead of its numerical value.
52 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 52 attribute :interfaces |
#inventory_mode ⇒ :automatic, ...
Returns Configure the inventory mode.
32 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 32 attribute :inventory_mode |
#inventory_zabbix ⇒ Hash?
Returns Add Facts for a zabbix inventory (e.g. Tag) (see example below).,Please review the interface documentation for more information on the supported properties,www.zabbix.com/documentation/3.2/manual/api/reference/host/object#host_inventory.
36 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 36 attribute :inventory_zabbix |
#ipmi_authtype ⇒ Integer?
Returns IPMI authentication algorithm.,Please review the Host object documentation for more information on the supported properties,www.zabbix.com/documentation/3.4/manual/api/reference/host/object,Possible values are, C(0) (none), C(1) (MD2), C(2) (MD5), C(4) (straight), C(5) (OEM), C(6) (RMCP+), with -1 being the API default.,Please note that the Zabbix API will treat absent settings as default when updating any of the I(ipmi_)-options; this means that if you attempt to set any of the four options individually, the rest will be reset to default values.
77 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 77 attribute :ipmi_authtype |
#ipmi_password ⇒ String?
Returns IPMI password.,also see the last note in the I(ipmi_authtype) documentation.
89 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 89 attribute :ipmi_password |
#ipmi_privilege ⇒ Integer?
Returns IPMI privilege level.,Please review the Host object documentation for more information on the supported properties,www.zabbix.com/documentation/3.4/manual/api/reference/host/object,Possible values are C(1) (callback), C(2) (user), C(3) (operator), C(4) (admin), C(5) (OEM), with C(2) being the API default.,also see the last note in the I(ipmi_authtype) documentation.
81 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 81 attribute :ipmi_privilege |
#ipmi_username ⇒ String?
Returns IPMI username.,also see the last note in the I(ipmi_authtype) documentation.
85 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 85 attribute :ipmi_username |
#link_templates ⇒ Array<String>, ...
Returns List of templates linked to the host.
28 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 28 attribute :link_templates |
#proxy ⇒ String?
Returns The name of the Zabbix proxy to be used.
48 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 48 attribute :proxy |
#state ⇒ :present, ...
Returns State of the host.,On C(present), it will create if host does not exist or update the host if the associated data is different.,On C(absent) will remove a host if it exists.
44 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 44 attribute :state |
#status ⇒ :enabled, ...
Returns Monitoring status of the host.
40 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 40 attribute :status |
#tls_accept ⇒ Integer?
Returns Specifies what types of connections are allowed for incoming connections.,The tls_accept parameter accepts values of 1 to 7,Possible values, 1 (no encryption), 2 (PSK), 4 (certificate).,Values can be combined.,Works only with >= Zabbix 3.0.
59 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 59 attribute :tls_accept |
#tls_connect ⇒ Integer?
Returns Specifies what encryption to use for outgoing connections.,Possible values, 1 (no encryption), 2 (PSK), 4 (certificate).,Works only with >= Zabbix 3.0.
55 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 55 attribute :tls_connect |
#tls_issuer ⇒ Object?
Returns Required certificate issuer.,Works only with >= Zabbix 3.0.
71 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 71 attribute :tls_issuer |
#tls_psk ⇒ String?
Returns PSK value is a hard to guess string of hexadecimal digits.,The preshared key, at least 32 hex digits. Required if either tls_connect or tls_accept has PSK enabled.,Works only with >= Zabbix 3.0.
67 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 67 attribute :tls_psk |
#tls_psk_identity ⇒ String?
Returns It is a unique name by which this specific PSK is referred to by Zabbix components,Do not put sensitive information in the PSK identity string, it is transmitted over the network unencrypted.,Works only with >= Zabbix 3.0.
63 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 63 attribute :tls_psk_identity |
#tls_subject ⇒ Object?
Returns Required certificate subject.,Works only with >= Zabbix 3.0.
74 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 74 attribute :tls_subject |
#visible_name ⇒ String?
Returns Visible name of the host in Zabbix.
16 |
# File 'lib/ansible/ruby/modules/generated/monitoring/zabbix/zabbix_host.rb', line 16 attribute :visible_name |