Resource Type: opnsense_haproxy_server

Defined in:
lib/puppet/type/opnsense_haproxy_server.rb

Summary

Manage opnsense haproxy servers

Overview

This type provides Puppet with the capabilities to manage opnsense haproxy server

Examples:

opnsense_haproxy_server { 'webserver1':
  device                 => 'opnsense-test.device.com',
  enabled                => true,
  description            => 'primary webserver',
  address                => 'webserver1.example.com',
  port                   => '443',
  checkport              => '80',
  mode                   => 'active',
  type                   => 'static',
  service_name           => '',
  linked_resolver        => '',
  resolver_opts          => ['allow-dup-ip','ignore-weight','prevent-dup-ip'],
  resolve_prefer         => 'ipv4',
  ssl                    => false,
  ssl_verify             => true,
  ssl_ca                 => [],
  ssl_crl                => [],
  ssl_client_certificate => '5eba6f0f352e3',
  weight                 => '10',
  check_interval         => '100',
  check_down_interval    => '200',
  source                 => '10.0.0.1',
  advanced               => 'send-proxy',
  ensure                 => 'present',
}

Properties

  • address

    The FQDN or the IP address of this server.

  • advanced

    list of parameters that will be appended to the server line in every backend where this server will be used.

  • check_down_interval

    Sets the interval (in milliseconds) for running health checks on the server when the server state is DOWN.

  • check_interval

    Sets the interval (in milliseconds) for running health checks on this server.

  • checkport

    Provide the TCP communication port to use during check.

  • description

    The server description.

  • enabled (defaults to: true)

    Enable or disable this server.

  • ensure (defaults to: present)

    Whether this resource should be present or absent on the target system.

  • linked_resolver

    Specify the uuid of the resolver to discover available services via DNS.

  • mode (defaults to: active)

    Sets the operation mode to use for this server.

  • number

    The number of servers this template initializes, i.e. 5 or 1-5.

  • port

    Provide the TCP or UDP communication port for this server.

  • resolve_prefer (defaults to: '')

    When DNS resolution is enabled and multiple IP addresses from different families are returned use this.

  • resolver_opts (defaults to: [])

    Add resolver options.

  • service_name

    FQDN for all the servers this template initializes or a service name to discover via DNS SRV records.

  • source

    Sets the source address which will be used when connecting to the server.

  • ssl

    Enable or disable SSL communication with this server.

  • ssl_ca (defaults to: [])

    These CA Ids will be used to verify server’s certificate.

  • ssl_client_certificate

    This certificate will be sent if the server send a client certificate request.

  • ssl_crl (defaults to: [])

    This certificate revocation list Ids will be used to verify server’s certificate.

  • ssl_verify (defaults to: true)

    Enable or disable server ssl certificate verification.

  • type (defaults to: static)

    Sets the operation mode to use for this server.

  • uuid

    The uuid of the server.

  • weight

    Adjust the server’s weight relative to other servers.

Parameters

  • device (namevar)

    The name of the opnsense_device type you want to manage.

  • name (namevar)

    The name of the resource you want to manage.