fortinet.fortios.fortios_firewall_profile_group module – Configure profile groups in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.2.1).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_profile_group.
New in fortinet.fortios 2.0.0
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
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure profile groups. |
|
Name of an existing Application list. Source application.list.name. |
|
Name of an existing Antivirus profile. Source antivirus.profile.name. |
|
Name of an existing CIFS profile. Source cifs.profile.name. |
|
Name of an existing DLP profile. Source dlp.profile.name. |
|
Name of an existing DLP sensor. Source dlp.sensor.name. |
|
Name of an existing DNS filter profile. Source dnsfilter.profile.name. |
|
Name of an existing email filter profile. Source emailfilter.profile.name. |
|
Name of an existing file-filter profile. Source file-filter.profile.name. |
|
Name of an existing ICAP profile. Source icap.profile.name. |
|
Name of an existing IPS sensor. Source ips.sensor.name. |
|
Name of an existing MMS profile. Source firewall.mms-profile.name. |
|
Profile group name. |
|
Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. |
|
Name of an existing SCTP filter profile. Source sctp-filter.profile.name. |
|
Name of an existing Spam filter profile. Source spamfilter.profile.name. |
|
Name of an existing SSH filter profile. Source ssh-filter.profile.name. |
|
Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. |
|
Name of an existing VideoFilter profile. Source videofilter.profile.name. |
|
Name of an existing VoIP profile. Source voip.profile.name. |
|
Name of an existing Web application firewall profile. Source waf.profile.name. |
|
Name of an existing Web filter profile. Source webfilter.profile.name. |
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
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_profile: "<your_own_value> (source dlp.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_14"
profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
sctp_filter_profile: "<your_own_value> (source sctp-filter.profile.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 |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |