Class: Ansible::Ruby::Modules::Bigip_monitor_dns

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Bigip_monitor_dns

Defined in:

lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb

Overview

Manages DNS monitors on a BIG-IP.

Instance Method Summary

• #accept_rcode ⇒ :"no-error", ...

  Specifies the RCODE required in the response for an up status.,When creating a new monitor, if this parameter is not specified, the default value is C(no-error).,When C(no-error), specifies that the status of the node will be marked up if the received DNS message has no error.,When C(anything), specifies that the status of the node will be marked up irrespective of the RCODE in the DNS message received.,If this parameter is set to C(anything), it will disregard the C(receive) string, and nullify it if the monitor is being updated.

• #adaptive ⇒ Symbol^?

  Specifies whether adaptive response time monitoring is enabled for this monitor.,When C(yes), the monitor determines the state of a service based on how divergent from the mean latency a monitor probe for that service is allowed to be.

• #adaptive_limit ⇒ Object^?

  Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of C(allowed_divergence) setting, for a probe to be considered successful.,This value applies regardless of the value of the C(allowed_divergence) setting.,While this value can be configured when C(adaptive) is C(no), it will not take effect on the system until C(adaptive) is C(yes).

• #allowed_divergence_type ⇒ :relative, ...

  When specifying a new monitor, if C(adaptive) is C(yes), the default is C(relative),When C(absolute), the number of milliseconds the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed.

• #allowed_divergence_value ⇒ Object^?

  When specifying a new monitor, if C(adaptive) is C(yes), and C(type) is C(relative), the default is C(25) percent.

• #answer_section_contains ⇒ :"any-type", ...

  Specifies the type of DNS query that the monitor sends.,When creating a new monitor, if this value is not specified, the default value is C(query-type).,When C(query-type), specifies that the response should contain at least one answer of which the resource record type matches the query type.,When C(any-type), specifies that the DNS message should contain at least one answer.,When C(anything), specifies that an empty answer is enough to mark the status of the node up.

• #description ⇒ Object^?

  The description of the monitor.

• #interval ⇒ Integer^?

  The interval specifying how frequently the monitor instance of this template will run.,This value B(must) be less than the C(timeout) value.,When creating a new monitor, if this parameter is not provided, the default C(5) will be used.

• #ip ⇒ Object^?

  IP address part of the IP/port definition.,If this parameter is not provided when creating a new monitor, then the default value will be C(*).

• #manual_resume ⇒ Symbol^?

  Specifies whether the system automatically changes the status of a resource to B(enabled) at the next successful monitor check.,If you set this option to C(yes), you must manually re-enable the resource before the system can use it for load balancing connections.,When creating a new monitor, if this parameter is not specified, the default value is C(no).,When C(yes), specifies that you must manually re-enable the resource after an unsuccessful monitor check.,When C(no), specifies that the system automatically changes the status of a resource to B(enabled) at the next successful monitor check.

• #name ⇒ String

  Specifies the name of the monitor.

• #parent ⇒ String^?

  The parent template of this monitor template.

• #partition ⇒ String^?

  Device partition to manage resources on.

• #port ⇒ Object^?

  Port address part of the IP/port definition.,If this parameter is not provided when creating a new monitor, then the default value will be C(*).,Note that if specifying an IP address, a value between 1 and 65535 must be specified.

• #query_name ⇒ String^?

  Specifies a query name for the monitor to use in a DNS query.

• #query_type ⇒ :a, ...

  Specifies the type of DNS query that the monitor sends.,When creating a new monitor, if this parameter is not specified, the default value is C(a).,When C(a), specifies that the monitor will send a DNS query of type A.,When C(aaaa), specifies that the monitor will send a DNS query of type AAAA.

• #receive ⇒ Object^?

  Specifies the IP address that the monitor uses from the resource record sections of the DNS response.,The IP address should be specified in the dotted-decimal notation or IPv6 notation.

• #reverse ⇒ Symbol^?

  Specifies whether the monitor operates in reverse mode.,When the monitor is in reverse mode, a successful receive string match marks the monitored object down instead of up.

• #sampling_timespan ⇒ Object^?

  Specifies the length, in seconds, of the probe history window that the system uses to calculate the mean latency and standard deviation of a monitor probe.,While this value can be configured when C(adaptive) is C(no), it will not take effect on the system until C(adaptive) is C(yes).

• #state ⇒ :present, ...

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

• #time_until_up ⇒ Object^?

  Specifies the amount of time in seconds after the first successful response before a node will be marked up.,A value of 0 will cause a node to be marked up immediately after a valid response is received from the node.,If this parameter is not provided when creating a new monitor, then the default value will be C(0).

• #timeout ⇒ Object^?

  The number of seconds in which the node or service must respond to the monitor request.,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.,You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second.,If this parameter is not provided when creating a new monitor, then the default value will be C(16).

• #transparent ⇒ Symbol^?

  Specifies whether the monitor operates in transparent mode.,Monitors in transparent mode can monitor pool members through firewalls.,When creating a new monitor, if this parameter is not provided, then the default value will be C(no).

• #up_interval ⇒ Integer^?

  Specifies the interval for the system to use to perform the health check when a resource is up.,When C(0), specifies that the system uses the interval specified in C(interval) to check the health of the resource.,When any other number, enables specification of a different interval to use when checking the health of a resource that is up.,When creating a new monitor, if this parameter is not provided, the default C(0) will be used.

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

#accept_rcode ⇒ :"no-error", ...

Returns Specifies the RCODE required in the response for an up status.,When creating a new monitor, if this parameter is not specified, the default value is C(no-error).,When C(no-error), specifies that the status of the node will be marked up if the received DNS message has no error.,When C(anything), specifies that the status of the node will be marked up irrespective of the RCODE in the DNS message received.,If this parameter is set to C(anything), it will disregard the C(receive) string, and nullify it if the monitor is being updated.

Returns:

• (:"no-error", :anything, nil) —

  Specifies the RCODE required in the response for an up status.,When creating a new monitor, if this parameter is not specified, the default value is C(no-error).,When C(no-error), specifies that the status of the node will be marked up if the received DNS message has no error.,When C(anything), specifies that the status of the node will be marked up irrespective of the RCODE in the DNS message received.,If this parameter is set to C(anything), it will disregard the C(receive) string, and nullify it if the monitor is being updated.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 70

attribute :accept_rcode

#adaptive ⇒ Symbol^?

Returns Specifies whether adaptive response time monitoring is enabled for this monitor.,When C(yes), the monitor determines the state of a service based on how divergent from the mean latency a monitor probe for that service is allowed to be. Also, values for the C(allowed_divergence), C(adaptive_limit), and and C(sampling_timespan) will be enforced.,When C(disabled), the monitor determines the state of a service based on the C(interval), C(up_interval), C(time_until_up), and C(timeout) monitor settings.

Returns:

• (Symbol, nil) —

  Specifies whether adaptive response time monitoring is enabled for this monitor.,When C(yes), the monitor determines the state of a service based on how divergent from the mean latency a monitor probe for that service is allowed to be. Also, values for the C(allowed_divergence), C(adaptive_limit), and and C(sampling_timespan) will be enforced.,When C(disabled), the monitor determines the state of a service based on the C(interval), C(up_interval), C(time_until_up), and C(timeout) monitor settings.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 74

attribute :adaptive

#adaptive_limit ⇒ Object^?

Returns Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of C(allowed_divergence) setting, for a probe to be considered successful.,This value applies regardless of the value of the C(allowed_divergence) setting.,While this value can be configured when C(adaptive) is C(no), it will not take effect on the system until C(adaptive) is C(yes).

Returns:

• (Object, nil) —

  Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of C(allowed_divergence) setting, for a probe to be considered successful.,This value applies regardless of the value of the C(allowed_divergence) setting.,While this value can be configured when C(adaptive) is C(no), it will not take effect on the system until C(adaptive) is C(yes).

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 85

attribute :adaptive_limit

#allowed_divergence_type ⇒ :relative, ...

Returns When specifying a new monitor, if C(adaptive) is C(yes), the default is C(relative),When C(absolute), the number of milliseconds the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed. In typical cases, if the monitor detects three probes in a row that miss the latency value you set, the pool member or node is marked down.,When C(relative), the percentage of deviation the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed.

Returns:

• (:relative, :absolute, nil) —

  When specifying a new monitor, if C(adaptive) is C(yes), the default is C(relative),When C(absolute), the number of milliseconds the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed. In typical cases, if the monitor detects three probes in a row that miss the latency value you set, the pool member or node is marked down.,When C(relative), the percentage of deviation the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 78

attribute :allowed_divergence_type

#allowed_divergence_value ⇒ Object^?

Returns When specifying a new monitor, if C(adaptive) is C(yes), and C(type) is C(relative), the default is C(25) percent.

Returns:

• (Object, nil) —

  When specifying a new monitor, if C(adaptive) is C(yes), and C(type) is C(relative), the default is C(25) percent.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 82

attribute :allowed_divergence_value

#answer_section_contains ⇒ :"any-type", ...

Returns Specifies the type of DNS query that the monitor sends.,When creating a new monitor, if this value is not specified, the default value is C(query-type).,When C(query-type), specifies that the response should contain at least one answer of which the resource record type matches the query type.,When C(any-type), specifies that the DNS message should contain at least one answer.,When C(anything), specifies that an empty answer is enough to mark the status of the node up.

Returns:

• (:"any-type", :anything, :"query-type", nil) —

  Specifies the type of DNS query that the monitor sends.,When creating a new monitor, if this value is not specified, the default value is C(query-type).,When C(query-type), specifies that the response should contain at least one answer of which the resource record type matches the query type.,When C(any-type), specifies that the DNS message should contain at least one answer.,When C(anything), specifies that an empty answer is enough to mark the status of the node up.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 66

attribute :answer_section_contains

#description ⇒ Object^?

Returns The description of the monitor.

Returns:

• (Object, nil) —

  The description of the monitor.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 20

attribute :description

#interval ⇒ Integer^?

Returns The interval specifying how frequently the monitor instance of this template will run.,This value B(must) be less than the C(timeout) value.,When creating a new monitor, if this parameter is not provided, the default C(5) will be used.

Returns:

• (Integer, nil) —

  The interval specifying how frequently the monitor instance of this template will run.,This value B(must) be less than the C(timeout) value.,When creating a new monitor, if this parameter is not provided, the default C(5) will be used.

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

attribute :interval

#ip ⇒ Object^?

Returns IP address part of the IP/port definition.,If this parameter is not provided when creating a new monitor, then the default value will be C(*).

Returns:

• (Object, nil) —

  IP address part of the IP/port definition.,If this parameter is not provided when creating a new monitor, then the default value will be C(*).

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

attribute :ip

#manual_resume ⇒ Symbol^?

Returns Specifies whether the system automatically changes the status of a resource to B(enabled) at the next successful monitor check.,If you set this option to C(yes), you must manually re-enable the resource before the system can use it for load balancing connections.,When creating a new monitor, if this parameter is not specified, the default value is C(no).,When C(yes), specifies that you must manually re-enable the resource after an unsuccessful monitor check.,When C(no), specifies that the system automatically changes the status of a resource to B(enabled) at the next successful monitor check.

Returns:

• (Symbol, nil) —

  Specifies whether the system automatically changes the status of a resource to B(enabled) at the next successful monitor check.,If you set this option to C(yes), you must manually re-enable the resource before the system can use it for load balancing connections.,When creating a new monitor, if this parameter is not specified, the default value is C(no).,When C(yes), specifies that you must manually re-enable the resource after an unsuccessful monitor check.,When C(no), specifies that the system automatically changes the status of a resource to B(enabled) at the next successful monitor check.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 48

attribute :manual_resume

#name ⇒ String

Returns Specifies the name of the monitor.

Returns:

• (String) —

  Specifies the name of the monitor.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.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(dns) 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(dns) parent on the C(Common) partition.

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

attribute :parent

#partition ⇒ String^?

Returns Device partition to manage resources on.

Returns:

• (String, nil) —

  Device partition to manage resources on.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 91

attribute :partition

#port ⇒ Object^?

Returns Port address part of the IP/port definition.,If this parameter is not provided when creating a new monitor, then the default value will be C(*).,Note that if specifying an IP address, a value between 1 and 65535 must be specified.

Returns:

• (Object, nil) —

  Port address part of the IP/port definition.,If this parameter is not provided when creating a new monitor, then the default value will be C(*).,Note that if specifying an IP address, a value between 1 and 65535 must be specified.

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

attribute :port

#query_name ⇒ String^?

Returns Specifies a query name for the monitor to use in a DNS query.

Returns:

• (String, nil) —

  Specifies a query name for the monitor to use in a DNS query.

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

attribute :query_name

#query_type ⇒ :a, ...

Returns Specifies the type of DNS query that the monitor sends.,When creating a new monitor, if this parameter is not specified, the default value is C(a).,When C(a), specifies that the monitor will send a DNS query of type A.,When C(aaaa), specifies that the monitor will send a DNS query of type AAAA.

Returns:

• (:a, :aaaa, nil) —

  Specifies the type of DNS query that the monitor sends.,When creating a new monitor, if this parameter is not specified, the default value is C(a).,When C(a), specifies that the monitor will send a DNS query of type A.,When C(aaaa), specifies that the monitor will send a DNS query of type AAAA.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 62

attribute :query_type

#receive ⇒ Object^?

Returns Specifies the IP address that the monitor uses from the resource record sections of the DNS response.,The IP address should be specified in the dotted-decimal notation or IPv6 notation.

Returns:

• (Object, nil) —

  Specifies the IP address that the monitor uses from the resource record sections of the DNS response.,The IP address should be specified in the dotted-decimal notation or IPv6 notation.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 42

attribute :receive

#reverse ⇒ Symbol^?

Returns Specifies whether the monitor operates in reverse mode.,When the monitor is in reverse mode, a successful receive string match marks the monitored object down instead of up. You can use the this mode only if you configure the C(receive) option.,This parameter is not compatible with the C(time_until_up) parameter. If C(time_until_up) is specified, it must be C(0). Or, if it already exists, it must be C(0).

Returns:

• (Symbol, nil) —

  Specifies whether the monitor operates in reverse mode.,When the monitor is in reverse mode, a successful receive string match marks the monitored object down instead of up. You can use the this mode only if you configure the C(receive) option.,This parameter is not compatible with the C(time_until_up) parameter. If C(time_until_up) is specified, it must be C(0). Or, if it already exists, it must be C(0).

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 38

attribute :reverse

#sampling_timespan ⇒ Object^?

Returns Specifies the length, in seconds, of the probe history window that the system uses to calculate the mean latency and standard deviation of a monitor probe.,While this value can be configured when C(adaptive) is C(no), it will not take effect on the system until C(adaptive) is C(yes).

Returns:

• (Object, nil) —

  Specifies the length, in seconds, of the probe history window that the system uses to calculate the mean latency and standard deviation of a monitor probe.,While this value can be configured when C(adaptive) is C(no), it will not take effect on the system until C(adaptive) is C(yes).

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 88

attribute :sampling_timespan

#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.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 95

attribute :state

#time_until_up ⇒ Object^?

Returns Specifies the amount of time in seconds after the first successful response before a node will be marked up.,A value of 0 will cause a node to be marked up immediately after a valid response is received from the node.,If this parameter is not provided when creating a new monitor, then the default value will be C(0).

Returns:

• (Object, nil) —

  Specifies the amount of time in seconds after the first successful response before a node will be marked up.,A value of 0 will cause a node to be marked up immediately after a valid response is received from the node.,If this parameter is not provided when creating a new monitor, then the default value will be C(0).

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 45

attribute :time_until_up

#timeout ⇒ Object^?

Returns The number of seconds in which the node or service must respond to the monitor request.,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.,You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second.,If this parameter is not provided when creating a new monitor, then the default value will be C(16).

Returns:

• (Object, nil) —

  The number of seconds in which the node or service must respond to the monitor request.,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.,You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second.,If this parameter is not provided when creating a new monitor, then the default value will be C(16).

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 31

attribute :timeout

#transparent ⇒ Symbol^?

Returns Specifies whether the monitor operates in transparent mode.,Monitors in transparent mode can monitor pool members through firewalls.,When creating a new monitor, if this parameter is not provided, then the default value will be C(no).

Returns:

• (Symbol, nil) —

  Specifies whether the monitor operates in transparent mode.,Monitors in transparent mode can monitor pool members through firewalls.,When creating a new monitor, if this parameter is not provided, then the default value will be C(no).

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 34

attribute :transparent

#up_interval ⇒ Integer^?

Returns Specifies the interval for the system to use to perform the health check when a resource is up.,When C(0), specifies that the system uses the interval specified in C(interval) to check the health of the resource.,When any other number, enables specification of a different interval to use when checking the health of a resource that is up.,When creating a new monitor, if this parameter is not provided, the default C(0) will be used.

Returns:

• (Integer, nil) —

  Specifies the interval for the system to use to perform the health check when a resource is up.,When C(0), specifies that the system uses the interval specified in C(interval) to check the health of the resource.,When any other number, enables specification of a different interval to use when checking the health of a resource that is up.,When creating a new monitor, if this parameter is not provided, the default C(0) will be used.

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_dns.rb', line 27

attribute :up_interval