fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy – Configure IPv4 interface policies.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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_interfacepolicy.
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 | Choices/Defaults | Comments | |
|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | ||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
| enable_log boolean |
| Enable/Disable logging for task | |
| pkg string / required | the parameter (pkg) in requested url | ||
| pkg_firewall_interfacepolicy dictionary | the top level parameters set | ||
| address-type string |
| no description | |
| application-list string | Application list name. | ||
| application-list-status string |
| Enable/disable application control. | |
| av-profile string | Antivirus profile. | ||
| av-profile-status string |
| Enable/disable antivirus. | |
| comments string | Comments. | ||
| dlp-sensor string | DLP sensor name. | ||
| dlp-sensor-status string |
| Enable/disable DLP. | |
| dsri string |
| Enable/disable DSRI. | |
| dstaddr string | Address object to limit traffic monitoring to network traffic sent to the specified address or range. | ||
| emailfilter-profile string | Email filter profile. | ||
| emailfilter-profile-status string |
| Enable/disable email filter. | |
| interface string | Monitored interface name from available interfaces. | ||
| ips-sensor string | IPS sensor name. | ||
| ips-sensor-status string |
| Enable/disable IPS. | |
| label string | Label. | ||
| logtraffic string |
| Logging type to be used in this policy (Options: all | utm | disable, Default: utm). | |
| policyid integer | Policy ID. | ||
| scan-botnet-connections string |
| Enable/disable scanning for connections to Botnet servers. | |
| service string | Service object from available options. | ||
| spamfilter-profile string | Antispam profile. | ||
| spamfilter-profile-status string |
| Enable/disable antispam. | |
| srcaddr string | Address object to limit traffic monitoring to network traffic sent from the specified address or range. | ||
| status string |
| Enable/disable this policy. | |
| webfilter-profile string | Web filter profile. | ||
| webfilter-profile-status string |
| Enable/disable web filtering. | |
| proposed_method string |
| The overridden method for the underlying Json RPC request | |
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | ||
| rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | ||
| state string / required |
| the directive to create, update or delete an object | |
| workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | ||
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | |
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 IPv4 interface policies.
fmgr_pkg_firewall_interfacepolicy:
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_interfacepolicy:
address-type: <value in [ipv4, ipv6]>
application-list: <value of string>
application-list-status: <value in [disable, enable]>
av-profile: <value of string>
av-profile-status: <value in [disable, enable]>
comments: <value of string>
dlp-sensor: <value of string>
dlp-sensor-status: <value in [disable, enable]>
dsri: <value in [disable, enable]>
dstaddr: <value of string>
interface: <value of string>
ips-sensor: <value of string>
ips-sensor-status: <value in [disable, enable]>
label: <value of string>
logtraffic: <value in [disable, all, utm]>
policyid: <value of integer>
scan-botnet-connections: <value in [disable, block, monitor]>
service: <value of string>
spamfilter-profile: <value of string>
spamfilter-profile-status: <value in [disable, enable]>
srcaddr: <value of string>
status: <value in [disable, enable]>
webfilter-profile: <value of string>
webfilter-profile-status: <value in [disable, enable]>
emailfilter-profile: <value of string>
emailfilter-profile-status: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 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/fortimanager/fmgr_pkg_firewall_interfacepolicy_module.html