Release Notes
Release Galaxy 2.3.8
Release Targets
FortiOS Galaxy 2.3.8 is based on 2.3.7
Bug Fixes
Return invalid json content instead of error while adding redundant comma at the end of the last variable in fortios_json_generic.
Github #332
Github #337
Mantis #1062185
Mantis #1069348
Mantis #1055387
Github #342 improve the generated playbook with customized data instead of hardcoded data
Mantis #1070530
Mantis #1072112
Mantis #1067831 improve the logic to configure the access_token in hosts file
Mantis #1040147
Improvements
Support new FOS versions 7.6.0.
Mantis #1067831 improve the logic to configure the access_token in hosts file
Improve the logic for SET function to send GET request first then PUT or POST
Release Galaxy 2.3.7
Release Targets
FortiOS Galaxy 2.3.7 is based on 2.3.6
Bug Fixes
Github issue #322.
Github issue #317.
Github issue #316.
Github issue #315.
Github issue #314.
Github issue #312
Github issue #311.
Github issue #309.
mantis issue #1017429.
mantis issue #1017038.
mantis issue #1034238.
Fix some issues in sanity test.
Improvements
Support new FOS versions 7.4.4.
Support Ansible-core 2.17.
Add a sanity_test.yaml file to trigger CI tests in GitHub.
Release Galaxy 2.3.6
Release Targets
FortiOS Galaxy 2.3.6 is based on 2.3.5
Bug Fixes
Github issue #273.
Github issue #280.
Github issue #283.
Github issue #290.
Github issue #301.
Github issue #305.
mantis issue #1003948.
Fix the issue that ssl-certificate cannot be set in fortios_firewall_vip and fortios_firewall_vip6.
Improvements
Supported new FOS versions 7.4.2 and 7.4.3, and support data type mac_address in the collection.
Add notes for backup modules in the documentation in both monitor and monitor_fact modules.
Update the required ansible version to 2.15.
Update the documentation for the supported versions from latest to a fix version number.
Release Galaxy 2.3.5
Release Targets
FortiOS Galaxy 2.3.5 is based on 2.3.4
Bug Fixes
Github issue #278.
Github issue #236.
Github issue #270.
Improvements
Update the document of log_fact.
Update all the boolean values to true/false in the documents and examples.
Update the supported version ranges instead of concrete version numbers to reduce the collection size.
Update the mismatched version message with version ranges.
Update the required ansible version to 2.14.
Release Galaxy 2.3.4
Release Targets
FortiOS Galaxy 2.3.4 is based on 2.3.3
Improvements
update the required Ansible version to 2.14.0 in the runtime.yml file.
Format the contents in the changelog.yml file.
Release Galaxy 2.3.3
Release Targets
FortiOS Galaxy 2.3.3 is based on 2.3.2
Bug Fixes
Fix the issue of one session remaining open after the task is finished.
To optimize the json_generic module and reduce the time spent while sending GET requests.
Improvements
Add new fortios version 7.4.1.
Update Q&A with a resolution for Ansible Always Sending GET/PUT Requests as POST Requests.
Update Ansible version from 2.9 to 2.14.
Update the requirement.txt file to specify the sphinx_rtd_theme==1.3.0
Release Galaxy 2.3.2
Release Targets
FortiOS Galaxy 2.3.2 is based on 2.3.1
Bug Fixes
Fix the hyperlink issue for the supported FOS versions in USER’s GUIDE.
Improvements
Improve the document for adding notes and examples in Q&A for modules using Integer number as the mkey.
Release Galaxy 2.3.1
Release Targets
FortiOS Galaxy 2.3.1 is based on 2.3.0
Bug Fixes
Fix the wrong credential error when using username/password in fos verion 6;
Fix the request error when updating global object;
Fix the sanity test error;
Fix the issue while comparing the changes in before and after data in check_mode;
Fix the issues that some parameters are not in a specific fos vm versions.
Improvements
Update Q&A regarding setting up FortiToken multi-factor authentication;
Add readthedocs.yaml file.
Release Galaxy 2.3.0
Release Targets
FortiOS Galaxy 2.3.0 is based on 2.2.3
Bug Fixes
Fix the error of pure number password.
Improvements
Improve the no_log feature in some modules;
Improve the documentation for member_path in all the modules;
Improve the documentation and example for seq_num in fortios_router_static;
Support new FOS versions.
Release Galaxy 2.2.3
Release Targets
FortiOS Galaxy 2.2.3 is based on 2.2.2
Bug Fixes
Fix the login issue (#232);
Fix the issue that all the params with underscore cannot be set under member operation;
Fix the output path issue (#227);
Improvements
Update
fortios.py
for higher performance;supports temporary session key and pre/post login banner;
update the examples on how to use member operation in Q&A.
Add annotations of member operation for every module.
Release Galaxy 2.2.2
Release Targets
FortiOS Galaxy 2.2.2 is based on 2.2.1
Bug Fixes
Fix runtime issue (#214);
Add required field for module log_fact;
Fix sanity test errors in validate-modules test;
Release Galaxy 2.2.1
Release Targets
FortiOS Galaxy 2.2.1 is based on 2.2.0
Bug Fixes
Fix invalid arguments in version_schemas;
Fix list type arguments inconsistency;
Fix validate-modules error: type not match and name not validate;
Fix supports_check_mode issue for _info and _facts modules;
Improvements
Remove ignore-x.txt files;
Update required ansible to >=2.9.10;
Release Galaxy 2.2.0
Release Targets
FortiOS Galaxy 2.2.0 is based on 2.1.7
Features
Support FortiOS v7.0.6, v7.0.7, v7.0.8, v7.2.1, v7.2.2.
Bug Fixes
Fix issue of missing some options for monitor modules (#196);
Fix issue of filter content could not contain spaces (#208);
Fix list type not match issue;
New modules
fortios_extension_controller_dataplan
- FortiExtender dataplan configuration in Fortinet’s FortiOS and FortiGate;fortios_extension_controller_extender_profile
- FortiExtender extender profile configuration in Fortinet’s FortiOS and FortiGate;fortios_extension_controller_extender
- Extender controller configuration in Fortinet’s FortiOS and FortiGate.fortios_extension_controller_fortigate_profile
- FortiGate connector profile configuration in Fortinet’s FortiOS and FortiGate.fortios_extension_controller_fortigate
- FortiGate controller configuration in Fortinet’s FortiOS and FortiGate.fortios_firewall_global
- Global firewall settings in Fortinet’s FortiOS and FortiGate.fortios_firewall_network_service_dynamic
- Configure Dynamic Network Services in Fortinet’s FortiOS and FortiGate.
Improvements
Update arguments’ value in example;
Update document to reflect accurate version map;
Release Galaxy 2.1.7
Release Targets
FortiOS Galaxy 2.1.7 is based on 2.1.6
Features
Support Fortios 7.2.0.
Support Diff feature in check_mode.
Bug Fixes
Fix typo in the documentation of
Install FortiOS Galaxy Collection
.Fix the error message in the debugging log when using
access_token
.Fix the Github Issue #187.
Fix the Github Issue #188 and #189.
Fix the Github Issue #190.
Fix the Github Issue #191.
Fix the issue when filtering out parameter with space in the module
fortios_configuration_fact
.
Release Galaxy 2.1.6
Release Targets
FortiOS Galaxy 2.1.6 is based on 2.1.5
Bug Fixes
Fix import issues in sanity-test and improve unit tests.
Fix parameter-list-no-elements error in sanity-test.
Add defaut value for enable_log param.
Relicense the FortiOS Collection under GPLv3+.
Fix syntax issue in python2.7.
Use collection version number in the doc.
Update the logic in check_legacy_fortiosapi.
Fix the syntax error in the three wireless_controller_hotspot20 modules.
Release Galaxy 2.1.5
Release Targets
FortiOS Galaxy 2.1.5 is based on 2.1.4
Features
Support FortiOS 7.0.2, 7.0.3, 7.0.4, 7.0.5.
Bug Fixes
Fix status issue in fortios_json_generic().
Fix issues in version mismatch logic.
Fix the issue of inconsistent data types in different schemas.
Release Galaxy 2.1.4
Release Targets
FortiOS Galaxy 2.1.4 is based on 2.1.3
Bug Fixes
Fix bugs in the function of compare_ip_address on check_mode.
Fix bugs when adding new members in some modules.
Release Galaxy 2.1.3
Release Targets
FortiOS Galaxy 2.1.3 is based on 2.1.2
Features
Collect the current configurations of the modules and convert them into playbooks.
Support member operation (delete/add extra members) on an object that has a list of members in it.
Add real-world use cases in the example section for some configuration modules.
Support selectors feature in
fortios_monitor_fact
andfortios_log_fact
.Support FortiOS 7.0.1.
Bug Fixes
Fix the filters error when fetching multiple facts with selectors for a configuration module (Github issue #138 ).
Fix the corner cases that response does not have status in it.
Fix Github issue #134
Release Galaxy 2.1.2
Release Targets
FortiOS Galaxy 2.1.2 is based on 2.1.1
Bug Fixes
Fix a regression bug caused by non-required attributes.
Fix an intentional exception for listed options.
Release Galaxy 2.1.1
Release Targets
FortiOS Galaxy 2.1.1 is based on 2.1.0
Bug Fixes
Fix the KeyError caused by non-required multi-value attributes in an object.
Release Galaxy 2.1.0
Release Targets
FortiOS Galaxy 2.1.0 is based on 2.0.2
Features
Support Fortios 7.0.
Support Log APIs.
New module fortios_monitor_fact.
Bug Fixes
Fix the unexpected warning caused by optinal params in
fortios_monitor_fact
andfortios_monitor
.Disable check_mode feature from all global objects of configuration modules due to ‘state’ issue.
Fix a bug in IP_PREFIX.match().
Fix the issue that the
server_type
is not updated infortios_system_central_management
.
Release Galaxy 2.0.2
Release Targets
FortiOS Galaxy 2.0.2 is based on 2.0.1
Features
Support
check_mode
in all cofigurationAPI-based modules.Improve
fortios_configuration_fact
to use multiple selectors concurrently.Support moving policy in
firewall_central_snat_map
.Support filtering for fact gathering modules
fortios_configuration_fact
andfortios_monitor_fact
.Unify schemas for monitor API.
Bug Fixes
Fix the authorization fails at log in with username and password in FOS7.0.
Github Issue #103
Github Issue #105
Release Galaxy 2.0.1
Release Targets
FortiOS Galaxy is based on 2.0.0
.
Features
fixed
pylint
minor errors.
Release Galaxy 2.0.0
Release Targets
FortiOS Galaxy 2.0.0 is a major ansible release for all v6.x.x FOS virtual and hardware platforms.
Features
Full support for gathering facts of both configuration(
fortios_configuration_fact
) and monitor(fortios_monitor_fact
) objects or runtime data.Support for requesting Monitor API via module
fortios_monitor
.Ported FortiOS generic module:
fortios_json_generic
.Unified collections for all 6.x FOS releases, Ansible detects versioning mismatch at runtime.
Explicit logging option:
enable_log
.Deprecated second-layer
state
module parameter.
Compatibility Notes
As a major release, it semantically breaks backward compability, some modules are removed as new full-fledged replacements come into being.
For deprecated modules, please find the alternatives in Deprecated Modules section.
Other existing modules remain compatible.
Deprecated Modules
fortios_facts
: find full selectors in modulesfortios_configuration_fact
andfortios_monitor_fact
.fortios_registration_forticare
: replaced by modulefortios_monitor
, see selectoradd-license.registration.forticare
.fortios_registration_vdom
: replaced by modulefortios_monitor
, see selectoradd-license.registration.vdom
.fortios_system_vmlicense
: replaced by modulefortios_monitor
, see selectorupload.system.vmlicense
.fortios_system_config_backup_restore
: it was a complexed module.To backup the FOS system, use module
fortios_monitor_fact
and its selectorsystem_config_backup
.To restore the configuration, use module
fortios_monitor
and its selectorrestore.system.config
.
Legacy Multiversions Note(Prior to 2.0.0)
The FortiOS Galaxy namespace: fortinet.fortios
hosts Ansible modules
for multiple FortiOS major releases.
A mismatched Ansible collection version for a FortiOS device can cause a warning:
[WARNING]: Ansible has detected version mismatch between FortOS system and galaxy, see more details by specifying option -vvv
you can find more details with -vvv
option when running a
playbook:
...
"version_check_warning": {
"ansible_collection_version": "v6.0.0 (galaxy: 1.0.13)",
"matched": false,
"message": "Please follow steps in FortiOS versioning notes: https://ansible-galaxy-fortios-docs.readthedocs.io/en/latest/version.html",
"system_version": "v6.2.0"
}
...
Simply installing a matched FortiOS collection can prevent potential compatibility issues.
Release Galaxy 1.1.9
Release Targets
fos_v6.0.0/galaxy_1.1.9
Bug Fixes
Fix legacy module
fortios_system_config_backup_restore
Release Galaxy 1.1.6 … 1.1.8
Release Targets
There are multiple Galaxy releases dedicated to different FortiOS major releases.
fos_v6.2.0/galaxy_1.1.6
fos_v6.4.0/galaxy_1.1.7
fos_v6.0.0/galaxy_1.1.8
Bug Fixes
Fixed module construction for legacy module
fortios_facts
.Sorted selector list of module
fortios_configuration_fact
.
Release Galaxy 1.1.3 … 1.1.5
Release Targets
There are multiple Galaxy releases dedicated to different FortiOS major releases.
fos_v6.2.0/galaxy_1.1.3
fos_v6.4.0/galaxy_1.1.4
fos_v6.0.0/galaxy_1.1.5
Bug Fixes
Fixed a fatal error:
mkey
not recognized in plugin due to wrong naming convention.
Release Galaxy 1.1.0 … 1.1.2
Release Targets
There are multiple Galaxy releases dedicated to different FortiOS major releases.
fos_v6.2.0/galaxy_1.1.0
fos_v6.4.0/galaxy_1.1.1
fos_v6.0.0/galaxy_1.1.2
Features
Support check mode for modules.
Deprecate
fortiosapi
legacy connection mode.Support access token based authentication.
Fully support fact gathering for all configuration API (
fortios_configuration_fact
).Suport Ansible 2.10 base framework.
Support moving objects to different orders (
fortios_firewall_policy
).
Bug Fixes
Github Issue #65
Release Galaxy 1.0.10 … 10.0.13
Release Targets
There are multiple Galaxy releases dedicated to different FortiOS major releases.
fos_v6.0.0/galaxy_1.0.13
fos_v6.0.5/galaxy_1.0.12
fos_v6.4.0/galaxy_1.0.11
fos_v6.2.0/galaxy_1.0.10
New Modules
# |
Module Name |
New in 6.2 |
New in 6.4 |
---|---|---|---|
1 |
|
yes |
yes |
2 |
|
yes |
yes |
3 |
|
yes |
yes |
4 |
|
yes |
yes |
5 |
|
yes |
yes |
6 |
|
yes |
yes |
7 |
|
yes |
yes |
8 |
|
yes |
yes |
9 |
|
yes |
yes |
10 |
|
yes |
yes |
11 |
|
yes |
yes |
12 |
|
yes |
yes |
13 |
|
yes |
yes |
14 |
|
yes |
yes |
15 |
|
yes |
no |
16 |
|
yes |
yes |
17 |
|
yes |
yes |
18 |
|
yes |
yes |
19 |
|
yes |
yes |
20 |
|
yes |
yes |
21 |
|
yes |
yes |
22 |
|
yes |
yes |
23 |
|
yes |
yes |
24 |
|
yes |
yes |
25 |
|
yes |
yes |
26 |
|
yes |
yes |
27 |
|
yes |
yes |
28 |
|
yes |
yes |
29 |
|
yes |
yes |
30 |
|
yes |
yes |
31 |
|
yes |
yes |
32 |
|
yes |
yes |
33 |
|
yes |
yes |
34 |
|
yes |
yes |
35 |
|
yes |
yes |
36 |
|
yes |
yes |
37 |
|
yes |
yes |
38 |
|
yes |
yes |
39 |
|
yes |
yes |
40 |
|
yes |
yes |
41 |
|
yes |
yes |
42 |
|
yes |
yes |
43 |
|
yes |
yes |
44 |
|
yes |
yes |
45 |
|
yes |
yes |
46 |
|
yes |
yes |
47 |
|
yes |
yes |
48 |
|
yes |
yes |
49 |
|
yes |
yes |
50 |
|
yes |
yes |
51 |
|
yes |
yes |
52 |
|
yes |
yes |
53 |
|
yes |
yes |
54 |
|
yes |
yes |
55 |
|
yes |
yes |
56 |
|
no |
yes |
57 |
|
no |
yes |
58 |
|
no |
yes |
59 |
|
no |
yes |
60 |
|
no |
yes |
61 |
|
no |
yes |
62 |
|
no |
yes |
63 |
|
no |
yes |
64 |
|
no |
yes |
65 |
|
no |
yes |
66 |
|
no |
yes |
67 |
|
no |
yes |
68 |
|
no |
yes |
69 |
|
no |
yes |
70 |
|
no |
yes |
71 |
|
no |
yes |
72 |
|
no |
yes |
73 |
|
no |
yes |
74 |
|
no |
yes |
75 |
|
no |
yes |
76 |
|
no |
yes |
77 |
|
no |
yes |
78 |
|
no |
yes |
79 |
|
no |
yes |
80 |
|
no |
yes |
81 |
|
no |
yes |
82 |
|
no |
yes |
83 |
|
no |
yes |
84 |
|
no |
yes |
85 |
|
no |
yes |
86 |
|
no |
yes |
87 |
|
no |
yes |
88 |
|
no |
yes |
89 |
|
no |
yes |
90 |
|
no |
yes |
91 |
|
no |
yes |
92 |
|
no |
yes |
93 |
|
no |
yes |
94 |
|
no |
yes |
95 |
|
no |
yes |
96 |
|
no |
yes |
97 |
|
no |
yes |
98 |
|
no |
yes |
99 |
|
no |
yes |
100 |
|
no |
yes |
101 |
|
no |
yes |
102 |
|
no |
yes |
103 |
|
no |
yes |
104 |
|
no |
yes |
105 |
|
no |
yes |
106 |
|
no |
yes |
107 |
|
no |
yes |
108 |
|
no |
yes |
109 |
|
no |
yes |
110 |
|
no |
yes |
111 |
|
no |
yes |
112 |
|
no |
yes |
113 |
|
no |
yes |
114 |
|
no |
yes |
115 |
|
no |
yes |
116 |
|
no |
yes |
117 |
|
no |
yes |
118 |
|
no |
yes |
119 |
|
no |
yes |
120 |
|
no |
yes |
121 |
|
no |
yes |
122 |
|
no |
yes |
123 |
|
no |
yes |
124 |
|
no |
yes |
125 |
|
no |
yes |
126 |
|
no |
yes |
127 |
|
no |
yes |
128 |
|
no |
yes |
129 |
|
no |
yes |
130 |
|
no |
yes |
131 |
|
no |
yes |
132 |
|
no |
yes |
133 |
|
no |
yes |
134 |
|
no |
yes |
135 |
|
no |
yes |
136 |
|
no |
yes |
137 |
|
no |
yes |
138 |
|
no |
yes |
139 |
|
no |
yes |
140 |
|
no |
yes |
141 |
|
no |
yes |
142 |
|
no |
yes |
143 |
|
no |
yes |
144 |
|
no |
yes |
145 |
|
no |
yes |
146 |
|
no |
yes |
147 |
|
no |
yes |
148 |
|
no |
yes |
149 |
|
no |
yes |
150 |
|
no |
yes |
151 |
|
no |
yes |
152 |
|
no |
yes |
153 |
|
no |
yes |
154 |
|
no |
yes |
155 |
|
no |
yes |
156 |
|
no |
yes |
157 |
|
no |
yes |
158 |
|
no |
yes |
159 |
|
no |
yes |
160 |
|
no |
yes |
161 |
|
no |
yes |
162 |
|
no |
yes |
163 |
|
no |
yes |
164 |
|
no |
yes |
165 |
|
no |
yes |
166 |
|
no |
yes |
167 |
|
no |
yes |
168 |
|
no |
yes |
169 |
|
no |
yes |
170 |
|
no |
yes |
171 |
|
no |
yes |
172 |
|
no |
yes |
173 |
|
no |
yes |
174 |
|
no |
yes |
175 |
|
no |
yes |
176 |
|
no |
yes |
177 |
|
no |
yes |
Features
Support special identifier validation and restoration in Ansible modules.
Support more valid identifiers:
3gpp_plmn
,802_1X_settings
,802.1_tlvs
and802.3_tlvs
.Support
revision_change
in response since fortigate 6.2.3.Support Underscore to hypen conversion.
Support licence modules:
fortios_system_vmlicense
,fortios_registration_forticare
andfortios_registration_vdom
.Support raw json encoding for generic module.
Bug Fixes
Fix
fgd_alert_subscription
multiple choices problem for modulefortios_system_global
.Fix
proposal
exceptional multilist for modulefortios_vpn_ipsec_phase2_interface
.Fix issue #26 of ansible_fgt_modules.
Fix issue #24 of ansible_fgt_modules.
Fix
events
exceptional multilist for modulefortios_system_snmp_community
.Fix py2/py3 compability issue for httpapi plugin fortios.
Fix the mkey encoding in fortios api URL.
Fix
banned_cipher
exceptional multilist for modulefortios_vpn_ssl_settings
.