fortinet.fortios.fortios_firewall_profile_group – Configure profile groups in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_profile_group
.
New in version 2.10: of fortinet.fortios
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.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||
enable_log boolean |
| Enable/Disable logging for task. | |
firewall_profile_group dictionary | 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. | ||
cifs_profile string | Name of an existing CIFS profile. Source cifs.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. | ||
emailfilter_profile string | Name of an existing email filter profile. Source emailfilter.profile.name. | ||
file_filter_profile string | Name of an existing file-filter profile. Source file-filter.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. | ||
mms_profile string | Name of an existing MMS profile. Source firewall.mms-profile.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. | ||
videofilter_profile string | Name of an existing VideoFilter profile. Source videofilter.profile.name. | ||
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. | ||
state string / required |
| Indicates whether to create or remove the object. | |
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
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure profile groups. fortios_firewall_profile_group: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" firewall_profile_group: application_list: "<your_own_value> (source application.list.name)" av_profile: "<your_own_value> (source antivirus.profile.name)" cifs_profile: "<your_own_value> (source cifs.profile.name)" dlp_sensor: "<your_own_value> (source dlp.sensor.name)" dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)" emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)" file_filter_profile: "<your_own_value> (source file-filter.profile.name)" icap_profile: "<your_own_value> (source icap.profile.name)" ips_sensor: "<your_own_value> (source ips.sensor.name)" mms_profile: "<your_own_value> (source firewall.mms-profile.name)" name: "default_name_13" 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)" videofilter_profile: "<your_own_value> (source videofilter.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 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_profile_group_module.html