From a6c5b918849a92c02f7b135a4d674b8640812f7d Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Sun, 12 Feb 2023 17:59:45 -0500
Subject: freebsd_loader: add docs

---
 roles/freebsd_loader/README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 roles/freebsd_loader/README.md

(limited to 'roles/freebsd_loader')

diff --git a/roles/freebsd_loader/README.md b/roles/freebsd_loader/README.md
new file mode 100644
index 0000000..5c487fb
--- /dev/null
+++ b/roles/freebsd_loader/README.md
@@ -0,0 +1,39 @@
+FreeBSD Bootloader
+==================
+
+Description
+-----------
+
+The `freebsd_loader` role is used to set options in FreeBSD's
+[loader.conf](https://man.freebsd.org/cgi/man.cgi?loader.conf(5)).
+
+It is only used for configuring `loader.conf` options for OPNsense
+firewalls.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable                         | Default   | Description
+---------------------------------|-----------|------------
+`freebsd_loader_config`          | {}        | Mapping of bootloader options
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: opnsense_firewalls
+  roles:
+    - role: freebsd_loader
+      vars:
+        freebsd_loader_config:
+          'mrsas_load': 'YES'
+          'hw.mfi.mrsas_enable': 1
+          'kern.ipc.nmbclusters': 1000000
+          'kern.ipc.nmbjumbop': 524288
+````
-- 
cgit