Resource Type: f5_monitor

Defined in:
lib/puppet/type/f5_monitor.rb
Providers:
sip
tcp
udp
http
icmp
ldap
dummy
https
external
tcp_half
gateway_icmp

Overview

Manage monitor objects. Docs at support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/ltm_configuration_guide_10_0_0/ltm_appendixa_monitor_types.html#1172375

Properties

  • additional_accepted_status_codes

    SIP accepted status codes. Valid options:

  • additional_rejected_status_codes

    SIP rejected status codes. Valid options:

  • alias_address

    Specifies the destination IP address that the monitor checks. Valid options:

  • alias_service_port

    Specifies the destination port that the monitor checks.

  • arguments

    Command arguments for external monitor.

  • base

    LDAP base for LDAP monitor

  • chase_referrals
  • cipher_list

    A list of ciphers in the Cipher List field that match those of the client sending a request, or of the server sending a response.

  • client_certificate

    Specifies a client certificate that the monitor sends to the target SSL server.

  • client_key

    Specifies a key for a client certificate that the monitor sends to the target SSL server.

  • compatibility
  • debug
  • description
  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • external_program

    Command to run for external monitor.

  • filter

    LDAP filter for LDAP monitor

  • header_list

    Headers for SIP monitor. Accepts an array of values.

  • interval

    How often in seconds to send a request Valid options:

  • ip_dscp

    ToS or DSCP bits for traffic that you are optimizing. Set the IP DSCP setting for appropriate TCP profiles to pass. The default value is 0, which clears the ToS bits for all traffic using that profile.

  • mandatory_attributes
  • manual_resume
  • mode

    SIP mode for SIP monitor. Valid options: tcp, udp, tls, sips

    Supported values:
    • tcp
    • udp
    • tls
    • sips
  • parent_monitor

    Specifies the parent predefined or user-defined monitor.

  • password

    A password for the monitor’s authentication when checking a resource.

  • receive_disable_string

    A regular expression that represents the text string that the monitor looks for in the returned resource. Use a Receive String value together with a Receive Disable String value to match the value of a response from the origin web server and create one of three states for a pool member or node: Up (Enabled), when only Receive String matches the response; Up (Disabled), when only Receive Disable String matches the response; or Down, when neither Receive String nor Receive Disable String matches the response.

  • receive_string

    A regular expression that represents the text string that the monitor looks for in the returned resource

  • reverse
  • security

    LDAP security for LDAP monitor. Valid options: none, ssl, tls

    Supported values:
    • none
    • ssl
    • tls
  • send_string

    The text string that the monitor sends to the target resource. Eg: GET / HTTP/1.0\n\n

  • sip_request

    The request to be sent by the SIP monitor.

  • time_until_up

    Allows the system to delay the marking of a pool member or node as up for some number of seconds after receipt of the first correct response.

  • timeout

    If a pool member or node being checked does not respond within a specified timeout period, or the status of a node indicates that performance is degraded.

  • transparent
  • up_interval

    How often to check the health of a resource Valid options:

  • username

    A user name for the monitor’s authentication when checking a resource.

  • variables

Parameters

  • name (namevar)
  • provider

    The specific backend to use for this ‘f5_monitor` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

Features

  • external —

    External command functionality

  • strings —

    Send/receive string functionality

  • ssl —

    SSL functionality

  • reverse —

    Reverse test functionality

  • dscp —

    DSCP functionality

  • auth —

    Authentication functionality

  • ldap —

    LDAP functionality

  • debug —

    Debug functionality

  • sip —

    SIP functionality

  • transparent —

    Pass-through functionality