Class: Ansible::Ruby::Modules::Bigip_monitor_snmp_dca

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb

Overview

The BIG-IP has an SNMP data collecting agent (DCA) that can query remote SNMP agents of various types, including the UC Davis agent (UCD) and the Windows 2000 Server agent (WIN2000).

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

#agent_type ⇒ :UCD, ...

Returns Specifies the SNMP agent running on the monitored server. When creating a new monitor, the default is C(UCD) (UC-Davis).

Returns:

  • (:UCD, :WIN2000, :GENERIC, nil) —

    Specifies the SNMP agent running on the monitored server. When creating a new monitor, the default is C(UCD) (UC-Davis).



39
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 39

attribute :agent_type

#community ⇒ Object?

Returns Specifies the community name that the system must use to authenticate with the host server through SNMP. When creating a new monitor, the default value is C(public). Note that this value is case sensitive.

Returns:

  • (Object, nil) —

    Specifies the community name that the system must use to authenticate with the host server through SNMP. When creating a new monitor, the default value is C(public). Note that this value is case sensitive.



32
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 32

attribute :community

#cpu_coefficient ⇒ Object?

Returns Specifies the coefficient that the system uses to calculate the weight of the CPU threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is C(1.5).

Returns:

  • (Object, nil) —

    Specifies the coefficient that the system uses to calculate the weight of the CPU threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is C(1.5).



43
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 43

attribute :cpu_coefficient

#cpu_threshold ⇒ Object?

Returns Specifies the maximum acceptable CPU usage on the target server. When creating a new monitor, the default is C(80) percent.

Returns:

  • (Object, nil) —

    Specifies the maximum acceptable CPU usage on the target server. When creating a new monitor, the default is C(80) percent.



46
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 46

attribute :cpu_threshold

#description ⇒ Object?

Returns Specifies descriptive text that identifies the monitor.

Returns:

  • (Object, nil) —

    Specifies descriptive text that identifies the monitor.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 16

attribute :description

#disk_coefficient ⇒ Object?

Returns Specifies the coefficient that the system uses to calculate the weight of the disk threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is C(2.0).

Returns:

  • (Object, nil) —

    Specifies the coefficient that the system uses to calculate the weight of the disk threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is C(2.0).



55
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 55

attribute :disk_coefficient

#disk_threshold ⇒ Object?

Returns Specifies the maximum acceptable disk usage on the target server. When creating a new monitor, the default is C(90) percent.

Returns:

  • (Object, nil) —

    Specifies the maximum acceptable disk usage on the target server. When creating a new monitor, the default is C(90) percent.



58
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 58

attribute :disk_threshold

#interval ⇒ Object?

Returns Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. When creating a new monitor, the default is C(10).

Returns:

  • (Object, nil) —

    Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. When creating a new monitor, the default is C(10).



23
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 23

attribute :interval

#memory_coefficient ⇒ Object?

Returns Specifies the coefficient that the system uses to calculate the weight of the memory threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is C(1.0).

Returns:

  • (Object, nil) —

    Specifies the coefficient that the system uses to calculate the weight of the memory threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is C(1.0).



49
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 49

attribute :memory_coefficient

#memory_threshold ⇒ Object?

Returns Specifies the maximum acceptable memory usage on the target server. When creating a new monitor, the default is C(70) percent.

Returns:

  • (Object, nil) —

    Specifies the maximum acceptable memory usage on the target server. When creating a new monitor, the default is C(70) percent.



52
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 52

attribute :memory_threshold

#name ⇒ String

Returns Monitor name.

Returns:

  • (String) —

    Monitor name.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 12

attribute :name

#parent ⇒ String?

Returns The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(snmp_dca) parent on the C(Common) partition.

Returns:

  • (String, nil) —

    The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(snmp_dca) parent on the C(Common) partition.



19
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 19

attribute :parent

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



61
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 61

attribute :partition

#state ⇒ :present, ...

Returns When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed.



65
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 65

attribute :state

#time_until_up ⇒ Object?

Returns Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to ‘up’. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked ‘up’. A value of 0, means that the resource is marked up immediately upon receipt of the first correct response. When creating a new monitor, the default is C(0).

Returns:

  • (Object, nil) —

    Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to ‘up’. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked ‘up’. A value of 0, means that the resource is marked up immediately upon receipt of the first correct response. When creating a new monitor, the default is C(0).



29
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 29

attribute :time_until_up

#timeout ⇒ Object?

Returns Specifies the number of seconds the target has in which to respond to the monitor request. When creating a new monitor, the default is C(30) seconds. If the target responds within the set time period, it is considered ‘up’. If the target does not respond within the set time period, it is considered ‘down’. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that C(timeout) and C(time_until_up) combine to control when a resource is set to up.

Returns:

  • (Object, nil) —

    Specifies the number of seconds the target has in which to respond to the monitor request. When creating a new monitor, the default is C(30) seconds. If the target responds within the set time period, it is considered ‘up’. If the target does not respond within the set time period, it is considered ‘down’. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that C(timeout) and C(time_until_up) combine to control when a resource is set to up.



26
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 26

attribute :timeout

#version ⇒ :v1, ...

Returns Specifies the version of SNMP that the host server uses. When creating a new monitor, the default is C(v1). When C(v1), specifies that the host server uses SNMP version 1. When C(v2c), specifies that the host server uses SNMP version 2c.

Returns:

  • (:v1, :v2c, nil) —

    Specifies the version of SNMP that the host server uses. When creating a new monitor, the default is C(v1). When C(v1), specifies that the host server uses SNMP version 1. When C(v2c), specifies that the host server uses SNMP version 2c.



35
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_snmp_dca.rb', line 35

attribute :version