fortinet.fortimanager.fmgr_pkg_firewall_securitypolicy – Configure NGFW IPv4/IPv6 application policies.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.4).
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.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_securitypolicy
.
New in version 2.10: of fortinet.fortimanager
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
the parameter (adom) in requested url |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
Enable/Disable logging for task Choices:
|
|
the parameter (pkg) in requested url |
|
the top level parameters set |
|
Policy action (accept/deny). Choices:
|
|
Application category ID list. |
|
Application group names. |
|
Application ID list. |
|
Name of an existing Application list. |
|
Name of an existing Antivirus profile. |
|
Name of an existing CIFS profile. |
|
Comment. |
|
Name of an existing DLP sensor. |
|
Name of an existing DNS filter profile. |
|
Destination IPv4 address name and address group names. |
|
When enabled dstaddr/dstaddr6 specifies what the destination address must NOT be. Choices:
|
|
Destination IPv4 address name and address group names. |
|
Destination IPv6 address name and address group names. |
|
Outgoing (egress) interface. |
|
Name of an existing email filter profile. |
|
Enable/disable default application port enforcement for allowed applications. Choices:
|
|
Name of an existing file-filter profile. |
|
Names of FSSO groups. |
|
Label for the policy that appears when the GUI is in Global View mode. |
|
Names of user groups that can authenticate with this policy. |
|
Name of an existing ICAP profile. |
|
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Choices:
|
|
Custom Internet Service name. |
|
Custom Internet Service group name. |
|
Internet Service group name. |
|
Internet Service ID. |
|
Internet Service name. |
|
When enabled internet-service specifies what the service must NOT be. Choices:
|
|
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Choices:
|
|
Custom Internet Service source name. |
|
Custom Internet Service source group name. |
|
Internet Service source group name. |
|
Internet Service source ID. |
|
Internet Service source name. |
|
When enabled internet-service-src specifies what the service must NOT be. Choices:
|
|
Name of an existing IPS sensor. |
|
Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be g… Choices:
|
|
Enable or disable logging. Log all sessions or security profile sessions. Choices:
|
|
Record logs when a session starts. Choices:
|
|
Name of an existing MMS profile. |
|
Policy name. |
|
Policy ID. |
|
Name of profile group. |
|
Name of an existing Protocol options profile. |
|
Determine whether the firewall policy allows security profile groups or single profiles only. Choices:
|
|
Schedule name. |
|
Enable to send a reply when a session is denied or blocked by a firewall policy. Choices:
|
|
Service and service group names. |
|
When enabled service specifies what the service must NOT be. Choices:
|
|
Source IPv4 address name and address group names. |
|
When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. Choices:
|
|
Source IPv4 address name and address group names. |
|
Source IPv6 address name and address group names. |
|
Incoming (ingress) interface. |
|
Name of an existing SSH filter profile. |
|
Name of an existing SSL SSH profile. |
|
Enable or disable this policy. Choices:
|
|
URL category ID list. |
|
Names of individual users that can authenticate with this policy. |
|
Enable security profiles. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Name of an existing VideoFilter profile. |
|
Name of an existing VoIP profile. |
|
Name of an existing Web filter profile. |
|
The overridden method for the underlying Json RPC request Choices:
|
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the directive to create, update or delete an object Choices:
|
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
the maximum time in seconds to wait for other user to release the workspace lock Default: 300 |
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure NGFW IPv4/IPv6 application policies.
fmgr_pkg_firewall_securitypolicy:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
pkg: <your own value>
state: <value in [present, absent]>
pkg_firewall_securitypolicy:
action: <value in [deny, accept]>
app-category: <value of string>
app-group: <value of string>
application: <value of integer>
application-list: <value of string>
av-profile: <value of string>
cifs-profile: <value of string>
comments: <value of string>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
dstaddr4: <value of string>
dstaddr6: <value of string>
dstintf: <value of string>
emailfilter-profile: <value of string>
enforce-default-app-port: <value in [disable, enable]>
groups: <value of string>
icap-profile: <value of string>
internet-service: <value in [disable, enable]>
internet-service-custom: <value of string>
internet-service-custom-group: <value of string>
internet-service-group: <value of string>
internet-service-id: <value of string>
internet-service-negate: <value in [disable, enable]>
internet-service-src: <value in [disable, enable]>
internet-service-src-custom: <value of string>
internet-service-src-custom-group: <value of string>
internet-service-src-group: <value of string>
internet-service-src-id: <value of string>
internet-service-src-negate: <value in [disable, enable]>
ips-sensor: <value of string>
logtraffic: <value in [disable, all, utm]>
logtraffic-start: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
policyid: <value of integer>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
schedule: <value of string>
service: <value of string>
service-negate: <value in [disable, enable]>
srcaddr4: <value of string>
srcaddr6: <value of string>
srcintf: <value of string>
ssh-filter-profile: <value of string>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
url-category: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
voip-profile: <value of string>
webfilter-profile: <value of string>
fsso-groups: <value of string>
global-label: <value of string>
send-deny-packet: <value in [disable, enable]>
dstaddr: <value of string>
internet-service-name: <value of string>
internet-service-src-name: <value of string>
srcaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
file-filter-profile: <value of string>
srcaddr-negate: <value in [disable, enable]>
learning-mode: <value in [disable, enable]>
videofilter-profile: <value of string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)