Skip to content

Commit 3273104

Browse files
committed
Add note to README about using pfsense_write_config to trigger XMLRPC conifguration syncs
1 parent ae3145d commit 3273104

3 files changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,22 @@ These modules allow you to manage installed packages:
9595

9696
## [Change Log](https://github.com/pfsensible/core/blob/master/CHANGELOG.rst)
9797

98+
## High-Availability Configuration Syncing
99+
pfsensible modules do not trigger an XMLRPC configuration sync to a secondary system. But this can be done with the use of a handler as shown:
100+
```
101+
tasks:
102+
- name: Make a chage
103+
pfsensible.core.alias:
104+
name: an_alias
105+
state: absent
106+
become: true
107+
notify: sync config
108+
handlers:
109+
- name: sync config
110+
pfsensible.core.rewrite_config:
111+
become: true
112+
```
113+
98114
## Writing new modules
99115

100116
See [GENERATING_MODULES](https://github.com/pfsensible/core/blob/master/GENERATING_MODULES.md) for instructions on how to use the
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
minor_changes:
2+
- Add note to README about using pfsense_write_config to trigger XMLRPC configuration syncs (https://github.com/pfsensible/core/issues/239).

plugins/modules/pfsense_rewrite_config.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
short_description: Rewrite pfSense config.xml
2121
description:
2222
- Rewrites pfSense's config.xml using native tools to reproduce formatting.
23+
- This also triggers an XMLRPC configuration sync to a high availability secondary system.
2324
notes:
2425
"""
2526

0 commit comments

Comments
 (0)