From 4cc1acf1f365ee4cf61d17094c7fe387afcbb5aa Mon Sep 17 00:00:00 2001
From: Jonathan Gazeley <jonathan.gazeley@bristol.ac.uk>
Date: Fri, 15 Jul 2016 11:09:27 +0100
Subject: [PATCH] Improve documentation
---
README.md | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index d4e99e3..38b8673 100644
--- a/README.md
+++ b/README.md
@@ -764,23 +764,24 @@ Provide content of template item. Specify only one of `source` or `content`.
Define a virtual module which consists of one or more other modules, for failover or
load-balancing purposes.
-##### `name`
##### `submodules`
+
+Provide an array of submodules which will be loaded into this virtual module. Required.
+
##### `type`
+Select the type of virtual module from `redundant`, `load-balance`, `redundant-load-balance`
+or `group`. See [virtual modules](http://wiki.freeradius.org/config/Fail-over#virtual-modules)
+and [load-balancing](http://wiki.freeradius.org/config/load-balancing) for more details.
+
+
```puppet
+# Load virtual module myldap
freeradius::virtual_module { 'myldap':
submodules => ['ldap1', 'ldap2'],
type => 'redundant-load-balance',
}
```
-yields
-```
-redundant-load-balance myldap {
- ldap1
- ldap2
-}
-```
## Limitations
--
GitLab