fortinet.fortimanager.fmgr_pkg_firewall_consolidated_policy module – Configure consolidated IPv4/IPv6 policies.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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_consolidated_policy.
New in fortinet.fortimanager 2.1.0
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 token to access FortiManager without using username and password. |
|
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:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (pkg) in requested url. |
|
The top level parameters set. |
|
Assigned policy block. |
|
Policy action Choices:
|
|
(list or str) Deprecated, please rename it to app_category. Application category ID list. |
|
(list or str) Deprecated, please rename it to app_group. Application group names. |
|
(list) Application ID list. |
|
Deprecated, please rename it to application_list. Name of an existing Application list. |
|
Deprecated, please rename it to auto_asic_offload. Enable/disable offloading security profile processing to CP processors. Choices:
|
|
Deprecated, please rename it to av_profile. Name of an existing Antivirus profile. |
|
Deprecated, please rename it to captive_portal_exempt. Enable exemption of some users from the captive portal. Choices:
|
|
Deprecated, please rename it to cifs_profile. Name of an existing CIFS profile. |
|
Comment. |
|
Deprecated, please rename it to diffserv_forward. Enable to change packets DiffServ values to the specified diffservcode-f… Choices:
|
|
Deprecated, please rename it to diffserv_reverse. Enable to change packets reverse Choices:
|
|
Deprecated, please rename it to diffservcode_forward. Change packets DiffServ to this value. |
|
Deprecated, please rename it to diffservcode_rev. Change packets reverse |
|
Deprecated, please rename it to dlp_sensor. Name of an existing DLP sensor. |
|
Deprecated, please rename it to dnsfilter_profile. Name of an existing DNS filter profile. |
|
Deprecated, please rename it to dstaddr_negate. When enabled dstaddr specifies what the destination address must NOT be. Choices:
|
|
(list or str) Destination IPv4 address name and address group names. |
|
(list or str) Destination IPv6 address name and address group names. |
|
(list or str) Outgoing |
|
Deprecated, please rename it to emailfilter_profile. Name of an existing email filter profile. |
|
Enable to prevent source NAT from changing a sessions source port. Choices:
|
|
(list or str) Deprecated, please rename it to fsso_groups. Names of FSSO groups. |
|
Deprecated, please rename it to global_label. Label for the policy that appears when the GUI is in Global View mode. |
|
(list or str) Names of user groups that can authenticate with this policy. |
|
Deprecated, please rename it to http_policy_redirect. Redirect HTTP Choices:
|
|
Deprecated, please rename it to icap_profile. Name of an existing ICAP profile. |
|
Policy-based IPsec VPN Choices:
|
|
Deprecated, please rename it to inspection_mode. Policy inspection mode Choices:
|
|
Deprecated, please rename it to internet_service. Enable/disable use of Internet Services for this policy. Choices:
|
|
(list or str) Deprecated, please rename it to internet_service_custom. Custom Internet Service name. |
|
(list or str) Deprecated, please rename it to internet_service_custom_group. Custom Internet Service group name. |
|
(list or str) Deprecated, please rename it to internet_service_group. Internet Service group name. |
|
(list or str) Deprecated, please rename it to internet_service_id. Internet Service ID. |
|
Deprecated, please rename it to internet_service_negate. When enabled internet-service specifies what the service must NOT be. Choices:
|
|
Deprecated, please rename it to internet_service_src. Enable/disable use of Internet Services in source for this policy. Choices:
|
|
(list or str) Deprecated, please rename it to internet_service_src_custom. Custom Internet Service source name. |
|
(list or str) Deprecated, please rename it to internet_service_src_custom_group. Custom Internet Service source group name. |
|
(list or str) Deprecated, please rename it to internet_service_src_group. Internet Service source group name. |
|
(list or str) Deprecated, please rename it to internet_service_src_id. Internet Service source ID. |
|
Deprecated, please rename it to internet_service_src_negate. When enabled internet-service-src specifies what the service … Choices:
|
|
Enable to use IP Pools for source NAT. Choices:
|
|
Deprecated, please rename it to ips_sensor. Name of an existing IPS sensor. |
|
Enable or disable logging. Choices:
|
|
Deprecated, please rename it to logtraffic_start. Record logs when a session starts. Choices:
|
|
Deprecated, please rename it to mms_profile. Name of an existing MMS profile. |
|
Policy name. |
|
Enable/disable source NAT. Choices:
|
|
Policy-based IPsec VPN Choices:
|
|
Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper. |
|
Policy ID |
|
(list or str) IPv4 pool names. |
|
(list or str) IPv6 pool names. |
|
Deprecated, please rename it to profile_group. Name of profile group. |
|
Deprecated, please rename it to profile_protocol_options. Name of an existing Protocol options profile. |
|
Deprecated, please rename it to profile_type. Determine whether the firewall policy allows security profile groups or sing… Choices:
|
|
Schedule name. |
|
(list or str) Service and service group names. |
|
Deprecated, please rename it to service_negate. When enabled service specifies what the service must NOT be. Choices:
|
|
Deprecated, please rename it to session_ttl. TTL in seconds for sessions accepted by this policy |
|
Deprecated, please rename it to srcaddr_negate. When enabled srcaddr specifies what the source address must NOT be. Choices:
|
|
(list or str) Source IPv4 address name and address group names. |
|
(list or str) Source IPv6 address name and address group names. |
|
(list or str) Incoming |
|
Deprecated, please rename it to ssh_filter_profile. Name of an existing SSH filter profile. |
|
Deprecated, please rename it to ssh_policy_redirect. Redirect SSH traffic to matching transparent proxy policy. Choices:
|
|
Deprecated, please rename it to ssl_ssh_profile. Name of an existing SSL SSH profile. |
|
Enable or disable this policy. Choices:
|
|
Deprecated, please rename it to tcp_mss_receiver. Receiver TCP maximum segment size |
|
Deprecated, please rename it to tcp_mss_sender. Sender TCP maximum segment size |
|
Deprecated, please rename it to traffic_shaper. Traffic shaper. |
|
Deprecated, please rename it to traffic_shaper_reverse. Reverse traffic shaper. |
|
(list or str) Deprecated, please rename it to url_category. URL category ID list. |
|
(list or str) Names of individual users that can authenticate with this policy. |
|
Deprecated, please rename it to utm_status. Enable to add one or more security profiles Choices:
|
|
Universally Unique Identifier |
|
Deprecated, please rename it to voip_profile. Name of an existing VoIP profile. |
|
Policy-based IPsec VPN |
|
Deprecated, please rename it to waf_profile. Name of an existing Web application firewall profile. |
|
Enable/disable WAN optimization. Choices:
|
|
Deprecated, please rename it to wanopt_detection. WAN optimization auto-detection mode. Choices:
|
|
Deprecated, please rename it to wanopt_passive_opt. WAN optimization passive mode options. Choices:
|
|
Deprecated, please rename it to wanopt_peer. WAN optimization peer. |
|
Deprecated, please rename it to wanopt_profile. WAN optimization profile. |
|
Enable/disable web cache. Choices:
|
|
Deprecated, please rename it to webcache_https. Enable/disable web cache for HTTPS. Choices:
|
|
Deprecated, please rename it to webfilter_profile. Name of an existing Web filter profile. |
|
Deprecated, please rename it to webproxy_forward_server. Webproxy forward server name. |
|
Deprecated, please rename it to webproxy_profile. Webproxy profile name. |
|
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: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure consolidated IPv4/IPv6 policies.
fortinet.fortimanager.fmgr_pkg_firewall_consolidated_policy:
# 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: present # <value in [present, absent]>
pkg_firewall_consolidated_policy:
action: <value in [deny, accept, ipsec]>
app_category: <list or string>
app_group: <list or string>
application: <list or integer>
application_list: <string>
auto_asic_offload: <value in [disable, enable]>
av_profile: <string>
cifs_profile: <string>
comments: <string>
diffserv_forward: <value in [disable, enable]>
diffserv_reverse: <value in [disable, enable]>
diffservcode_forward: <string>
diffservcode_rev: <string>
dlp_sensor: <string>
dnsfilter_profile: <string>
dstaddr4: <list or string>
dstaddr6: <list or string>
dstintf: <list or string>
emailfilter_profile: <string>
fixedport: <value in [disable, enable]>
groups: <list or string>
http_policy_redirect: <value in [disable, enable]>
icap_profile: <string>
inbound: <value in [disable, enable]>
inspection_mode: <value in [proxy, flow]>
internet_service: <value in [disable, enable]>
internet_service_custom: <list or string>
internet_service_custom_group: <list or string>
internet_service_group: <list or string>
internet_service_id: <list or string>
internet_service_src: <value in [disable, enable]>
internet_service_src_custom: <list or string>
internet_service_src_custom_group: <list or string>
internet_service_src_group: <list or string>
internet_service_src_id: <list or string>
ippool: <value in [disable, enable]>
ips_sensor: <string>
logtraffic: <value in [disable, all, utm]>
logtraffic_start: <value in [disable, enable]>
mms_profile: <string>
name: <string>
nat: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per_ip_shaper: <string>
policyid: <integer>
poolname4: <list or string>
poolname6: <list or string>
profile_group: <string>
profile_protocol_options: <string>
profile_type: <value in [single, group]>
schedule: <string>
service: <list or string>
session_ttl: <integer>
srcaddr4: <list or string>
srcaddr6: <list or string>
srcintf: <list or string>
ssh_filter_profile: <string>
ssh_policy_redirect: <value in [disable, enable]>
ssl_ssh_profile: <string>
status: <value in [disable, enable]>
tcp_mss_receiver: <integer>
tcp_mss_sender: <integer>
traffic_shaper: <string>
traffic_shaper_reverse: <string>
url_category: <list or string>
users: <list or string>
utm_status: <value in [disable, enable]>
uuid: <string>
voip_profile: <string>
vpntunnel: <string>
waf_profile: <string>
wanopt: <value in [disable, enable]>
wanopt_detection: <value in [active, passive, off]>
wanopt_passive_opt: <value in [default, transparent, non-transparent]>
wanopt_peer: <string>
wanopt_profile: <string>
webcache: <value in [disable, enable]>
webcache_https: <value in [disable, enable]>
webfilter_profile: <string>
webproxy_forward_server: <string>
webproxy_profile: <string>
captive_portal_exempt: <value in [disable, enable]>
dstaddr_negate: <value in [disable, enable]>
fsso_groups: <list or string>
global_label: <string>
internet_service_negate: <value in [disable, enable]>
internet_service_src_negate: <value in [disable, enable]>
service_negate: <value in [disable, enable]>
srcaddr_negate: <value in [disable, enable]>
_policy_block: <integer>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |