fortios_firewall_profile_group – Configure profile groups in Fortinet’s FortiOS and FortiGate
New in version 2.8.
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and profile_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
firewall_profile_group dictionary | Default: null | Configure profile groups. | |
application_list string | Name of an existing Application list. Source application.list.name. | ||
av_profile string | Name of an existing Antivirus profile. Source antivirus.profile.name. | ||
dlp_sensor string | Name of an existing DLP sensor. Source dlp.sensor.name. | ||
dnsfilter_profile string | Name of an existing DNS filter profile. Source dnsfilter.profile.name. | ||
icap_profile string | Name of an existing ICAP profile. Source icap.profile.name. | ||
ips_sensor string | Name of an existing IPS sensor. Source ips.sensor.name. | ||
name string / required | Profile group name. | ||
profile_protocol_options string | Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. | ||
spamfilter_profile string | Name of an existing Spam filter profile. Source spamfilter.profile.name. | ||
ssh_filter_profile string | Name of an existing SSH filter profile. Source ssh-filter.profile.name. | ||
ssl_ssh_profile string | Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. | ||
state string |
| Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object. | |
voip_profile string | Name of an existing VoIP profile. Source voip.profile.name. | ||
waf_profile string | Name of an existing Web application firewall profile. Source waf.profile.name. | ||
webfilter_profile string | Name of an existing Web filter profile. Source webfilter.profile.name. | ||
host string | FortiOS or FortiGate IP address. | ||
https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |
password string | Default: "" | FortiOS or FortiGate password. | |
ssl_verify boolean added in 2.9 |
| Ensures FortiGate certificate must be verified by a proper CA. | |
state string added in 2.9 |
| Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. | |
username string | FortiOS or FortiGate username. | ||
vdom string | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. |
Notes
Note
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure profile groups. fortios_firewall_profile_group: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" firewall_profile_group: application_list: "<your_own_value> (source application.list.name)" av_profile: "<your_own_value> (source antivirus.profile.name)" dlp_sensor: "<your_own_value> (source dlp.sensor.name)" dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)" icap_profile: "<your_own_value> (source icap.profile.name)" ips_sensor: "<your_own_value> (source ips.sensor.name)" name: "default_name_9" profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)" spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)" ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)" ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)" voip_profile: "<your_own_value> (source voip.profile.name)" waf_profile: "<your_own_value> (source waf.profile.name)" webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_firewall_profile_group_module.html