nginx.rst

Nginx

STATE: unstable

TESTS: nginx_upstream_server nginx_upstream

API Docs: Plugins - Nginx

Service Docs: Nginx

Contribution

Thanks to @atammy-narmi for developing these modules!

Prerequisites

You need to install the following plugin:

os-nginx

You can also install it using the :ref:`ansibleguy.opnsense.package <modules_package>` module.

Definition

ansibleguy.opnsense.nginx_general

Definition

Parameter	Type	Required	Default	Aliases	Comment
enabled	boolean	false	true	-	Enable configured services.
ban_ttl	integer	false	0	-	Set autoblock lifetime in minutes. Set to 0 for infinite.

ansibleguy.opnsense.nginx_upstream_server

Definition

Parameter	Type	Required	Default	Aliases	Comment
description	string	true	-	name	-
server	string	true	-	-	-
port	integer	true	-	-	-
priority	integer	true	-	-	-
max_conns	integer	false	-	-	-
max_fails	integer	false	-	-	-
fail_timeout	integer	false	-	-	-
no_use	string	false	-	-	Choice of empty, 'down' or 'backup'.
state	string	false	present	-	Choice of 'present' or 'absent'.
reload	boolean	false	true	-

ansibleguy.opnsense.nginx_upstream

Definition

Parameter	Type	Required	Default	Aliases	Comment
description	string	true	-	name	-
serverentries	list	true	-	-	List of upstream servers
load_balancing_algorithm	string	false	-	-	-
keepalive	integer	false	-	-	-
keepalive_requests	integer	false	-	-	-
keepalive_timeout	integer	false	-	-	-
host_port	integer	false	-	-	-
x_forwarded_host_verbatim	boolean	false	-	-	-
proxy_protocol	boolean	false	-	-	-
store	boolean	false	-	-	Store the response on the local storage.
tls_enable	boolean	false	-	-	Use TLS (HTTPS) to connect to the server.
tls_client_certificate	string	false	-	-	A certificate to use for this upstream.
tls_name_override	string	false	-	-	-
tls_protocol_versions	list	false	-	-	List of support TLS versions TLSv1, TLSv1.1, TLSv1.2, TLSv1.3
tls_session_reuse	boolean	true	-	-	-
tls_trusted_certificate	string	false	-	-	A certificate authority to use for this upstream.
tls_verify	boolean	false	-	-	-
tls_verify_depth	integer	false	1	-	-
state	string	false	present	-	Choice of 'present' or 'absent'.
reload	boolean	false	true	-

Usage

Enabling the nginx configured services.

Examples

ansibleguy.opnsense.nginx_upstream_server

- hosts: localhost
  gather_facts: false
  module_defaults:
    group/ansibleguy.opnsense.all:
      firewall: 'opnsense.template.ansibleguy.net'
      api_credential_file: '/home/guy/.secret/opn.key'

    ansibleguy.opnsense.list:
      target: 'nginx_upstream_server'

  tasks:
    - name: Add an upstream server
      ansibleguy.opnsense.nginx_upstream_server:
        name: 'upstream1'
        server: '192.168.1.1'
        port: 80
        priority: 1
        max_conns: 100
        max_fails: 50
        fail_timeout: 10
        no_use: 'down'
        # state: 'present'
        # reload: true

    - name: Changing the server
      ansibleguy.opnsense.nginx_upstream_server:
        name: 'upstream1'
        server: '192.168.1.100'

    - name: Listing upstream servers
      ansibleguy.opnsense.list:
      #  target: 'nginx_upstream_server'
      register: existing_servers

    - name: Printing
      ansible.builtin.debug:
        var: existing_servers.data

ansibleguy.opnsense.nginx_upstream

- hosts: localhost
  gather_facts: false
  module_defaults:
    group/ansibleguy.opnsense.all:
      firewall: 'opnsense.template.ansibleguy.net'
      api_credential_file: '/home/guy/.secret/opn.key'

    ansibleguy.opnsense.list:
      target: 'nginx_upstream'

  tasks:
    - name: Add an upstream server
      ansibleguy.opnsense.nginx_upstream_server:
        name: 'upstreamserver1'
        server: '192.168.1.1'
        port: 80
        priority: 1
        max_conns: 100
        max_fails: 50
        fail_timeout: 10
        no_use: 'down'

    - name: Add an upstream
      ansibleguy.opnsense.nginx_upstream:
        name: 'upstream1'
        serverentries: ['upstreamserver1']
        load_balancing_algorithm: 'ip_hash'
        keepalive: 1
        keepalive_requests: 100
        keepalive_timeout: 10
        host_port: 80
        x_forwarded_host_verbatim: true
        proxy_protocol: false
        store: false
        tls_enable: true
        # tls_client_certificate: "example.com (ACME Client)"
        tls_protocol_versions: ['TLSv1', 'TLSv1.1', 'TLSv1.2', 'TLSv1.3']
        tls_session_reuse: true
        tls_verify: false
        tls_verify_depth: 1
        # state: 'present'
        # reload: true

    - name: Changing the upstream
      ansibleguy.opnsense.nginx_upstream:
        name: 'upstream1'
        serverentries: ['192.168.1.100']

    - name: Listing upstreams
      ansibleguy.opnsense.list:
        target: 'nginx_upstream'
      register: existing_upstreams

    - name: Printing
      ansible.builtin.debug:
        var: existing_upstreams.data