pfsensible.haproxy.pfsense_haproxy_backend (0.1.0) — module

Install collection

Install with ansible-galaxy collection install pfsensible.haproxy:==0.1.0

Add to requirements.yml

  collections:
    - name: pfsensible.haproxy
      version: 0.1.0

Description

Manage pfSense HAProxy backends

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add backend
  pfsense_haproxy_backend:
    name: exchange
    balance: leastconn
    httpcheck_method: HTTP
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove backend
  pfsense_haproxy_backend:
    name: exchange
    state: absent

Inputs

    
name:
    description: The backend name.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: State in which to leave the backend
    type: str

balance:
    choices:
    - none
    - roundrobin
    - static-rr
    - leastconn
    - source
    - uri
    default: none
    description: The load balancing option.
    required: false
    type: str

retries:
    description: After a connection failure to a server, it is possible to retry, potentially
      on another server.
    required: false
    type: int

check_type:
    choices:
    - none
    - Basic
    - HTTP
    - Agent
    - LDAP
    - MySQL
    - PostgreSQL
    - Redis
    - SMTP
    - ESMTP
    - SSL
    default: none
    description: Health check method.
    type: str

log_checks:
    description: When this option is enabled, any change of the health check status or
      to the server's health will be logged.
    required: false
    type: bool

monitor_uri:
    description: Url used by http check requests.
    required: false
    type: str

balance_urilen:
    description: Indicates that the algorithm should only consider that many characters
      at the beginning of the URI to compute the hash.
    required: false
    type: int

monitor_domain:
    description: Domain used in checks (SMTP and ESMTP)
    required: false
    type: str

server_timeout:
    description: The time (in milliseconds) we accept to wait for data from the server,
      or for the server to accept data (default 30000).
    required: false
    type: int

check_frequency:
    description: The check interval (in milliseconds). For HTTP/HTTPS defaults to 1000
      if left blank. For TCP no check will be performed if left empty.
    required: false
    type: int

balance_uridepth:
    description: Indicates the maximum directory depth to be used to compute the hash.
      One level is counted for each slash in the request.
    required: false
    type: int

balance_uriwhole:
    description: Allow using whole URI including url parameters behind a question mark.
    required: false
    type: bool

httpcheck_method:
    choices:
    - OPTIONS
    - HEAD
    - GET
    - POST
    - PUT
    - DELETE
    - TRACE
    description: HTTP check method.
    required: false
    type: str

monitor_username:
    description: Username used in checks (MySQL and PostgreSQL)
    required: false
    type: str

connection_timeout:
    description: The time (in milliseconds) we give up if the connection does not complete
      within (default 30000).
    required: false
    type: int

monitor_httpversion:
    description: Defaults to "HTTP/1.0" if left blank.
    required: false
    type: str

Outputs

commands:
  description: the set of commands that would be pushed to the remote device (if pfSense
    had a CLI)
  returned: always
  sample:
  - create haproxy_backend 'exchange', balance='leastconn', httpcheck_method='HTTP'
  - delete haproxy_backend 'exchange'
  type: list