:source: fmgr_pkg_firewall_consolidated_policy.py
:orphan:
.. _fmgr_pkg_firewall_consolidated_policy:
fmgr_pkg_firewall_consolidated_policy -- Configure consolidated IPv4/IPv6 policies.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.1.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v6.2.0 -> v7.6.2
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_firewall_consolidated_policy - Configure consolidated IPv4/IPv6 policies. type: dict
- action Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- app_category (Alias name: app-category) Application category id list. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.2.5, v7.4.0 -> v7.4.2
- app_group (Alias name: app-group) Application group names. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.2.5, v7.4.0 -> v7.4.2
- application Application id list. type: list
more...
Supported Version Ranges: v6.2.0 -> v7.2.5, v7.4.0 -> v7.4.2
- application_list (Alias name: application-list) Name of an existing application list. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- auto_asic_offload (Alias name: auto-asic-offload) Enable/disable offloading security profile processing to cp processors. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- av_profile (Alias name: av-profile) Name of an existing antivirus profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- cifs_profile (Alias name: cifs-profile) Name of an existing cifs profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- comments Comment. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- diffserv_forward (Alias name: diffserv-forward) Enable to change packets diffserv values to the specified diffservcode-forward value. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- diffserv_reverse (Alias name: diffserv-reverse) Enable to change packets reverse (reply) diffserv values to the specified diffservcode-rev value. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- diffservcode_forward (Alias name: diffservcode-forward) Change packets diffserv to this value. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- diffservcode_rev (Alias name: diffservcode-rev) Change packets reverse (reply) diffserv to this value. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- dlp_sensor (Alias name: dlp-sensor) Name of an existing dlp sensor. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- dnsfilter_profile (Alias name: dnsfilter-profile) Name of an existing dns filter profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- dstaddr4 Destination ipv4 address name and address group names. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- dstaddr6 Destination ipv6 address name and address group names. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- dstintf Outgoing (egress) interface. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- emailfilter_profile (Alias name: emailfilter-profile) Name of an existing email filter profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- fixedport Enable to prevent source nat from changing a sessions source port. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- groups Names of user groups that can authenticate with this policy. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- http_policy_redirect (Alias name: http-policy-redirect) Redirect http(s) traffic to matching transparent web proxy policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- icap_profile (Alias name: icap-profile) Name of an existing icap profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- inbound Policy-based ipsec vpn: only traffic from the remote network can initiate a vpn. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- inspection_mode (Alias name: inspection-mode) Policy inspection mode (flow/proxy). type: str choices: [proxy, flow]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- internet_service (Alias name: internet-service) Enable/disable use of internet services for this policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name. type: list or str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group name. type: list or str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- internet_service_group (Alias name: internet-service-group) Internet service group name. type: list or str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- internet_service_id (Alias name: internet-service-id) Internet service id. type: list or str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- internet_service_src (Alias name: internet-service-src) Enable/disable use of internet services in source for this policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- internet_service_src_custom (Alias name: internet-service-src-custom) Custom internet service source name. type: list or str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- internet_service_src_custom_group (Alias name: internet-service-src-custom-group) Custom internet service source group name. type: list or str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- internet_service_src_group (Alias name: internet-service-src-group) Internet service source group name. type: list or str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- internet_service_src_id (Alias name: internet-service-src-id) Internet service source id. type: list or str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- ippool Enable to use ip pools for source nat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- ips_sensor (Alias name: ips-sensor) Name of an existing ips sensor. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- logtraffic Enable or disable logging. type: str choices: [disable, all, utm]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- logtraffic_start (Alias name: logtraffic-start) Record logs when a session starts. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- mms_profile (Alias name: mms-profile) Name of an existing mms profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- name Policy name. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- nat Enable/disable source nat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- outbound Policy-based ipsec vpn: only traffic from the internal network can initiate a vpn. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- per_ip_shaper (Alias name: per-ip-shaper) Per-ip traffic shaper. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- policyid Policy id (0 - 4294967294). type: int
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- poolname4 Ipv4 pool names. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- poolname6 Ipv6 pool names. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- profile_group (Alias name: profile-group) Name of profile group. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- profile_protocol_options (Alias name: profile-protocol-options) Name of an existing protocol options profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- profile_type (Alias name: profile-type) Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: [single, group]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- schedule Schedule name. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- service Service and service group names. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- session_ttl (Alias name: session-ttl) Ttl in seconds for sessions accepted by this policy (0 means use the system default session ttl). type: int
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- srcaddr4 Source ipv4 address name and address group names. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- srcaddr6 Source ipv6 address name and address group names. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- srcintf Incoming (ingress) interface. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- ssh_filter_profile (Alias name: ssh-filter-profile) Name of an existing ssh filter profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- ssh_policy_redirect (Alias name: ssh-policy-redirect) Redirect ssh traffic to matching transparent proxy policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- ssl_ssh_profile (Alias name: ssl-ssh-profile) Name of an existing ssl ssh profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- status Enable or disable this policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- tcp_mss_receiver (Alias name: tcp-mss-receiver) Receiver tcp maximum segment size (mss). type: int
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- tcp_mss_sender (Alias name: tcp-mss-sender) Sender tcp maximum segment size (mss). type: int
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- traffic_shaper (Alias name: traffic-shaper) Traffic shaper. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) Reverse traffic shaper. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- url_category (Alias name: url-category) Url category id list. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.2.5, v7.4.0 -> v7.4.2
- users Names of individual users that can authenticate with this policy. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- utm_status (Alias name: utm-status) Enable to add one or more security profiles (av, ips, etc. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- voip_profile (Alias name: voip-profile) Name of an existing voip profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- vpntunnel Policy-based ipsec vpn: name of the ipsec vpn phase 1. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- waf_profile (Alias name: waf-profile) Name of an existing web application firewall profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- wanopt Enable/disable wan optimization. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.1 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- wanopt_detection (Alias name: wanopt-detection) Wan optimization auto-detection mode. type: str choices: [active, passive, off]
more...
Supported Version Ranges: v6.2.1 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- wanopt_passive_opt (Alias name: wanopt-passive-opt) Wan optimization passive mode options. type: str choices: [default, transparent, non-transparent]
more...
Supported Version Ranges: v6.2.1 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- wanopt_peer (Alias name: wanopt-peer) Wan optimization peer. type: str
more...
Supported Version Ranges: v6.2.1 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- wanopt_profile (Alias name: wanopt-profile) Wan optimization profile. type: str
more...
Supported Version Ranges: v6.2.1 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- webcache Enable/disable web cache. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.1 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- webcache_https (Alias name: webcache-https) Enable/disable web cache for https. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.1 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- webfilter_profile (Alias name: webfilter-profile) Name of an existing web filter profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2
- webproxy_forward_server (Alias name: webproxy-forward-server) Webproxy forward server name. type: str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- webproxy_profile (Alias name: webproxy-profile) Webproxy profile name. type: str
more...
Supported Version Ranges: v6.2.1 -> v7.6.2
- captive_portal_exempt (Alias name: captive-portal-exempt) Enable exemption of some users from the captive portal. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.2 -> v7.6.2
- dstaddr_negate (Alias name: dstaddr-negate) When enabled dstaddr specifies what the destination address must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.2 -> v7.6.2
- fsso_groups (Alias name: fsso-groups) Names of fsso groups. type: list or str
more...
Supported Version Ranges: v6.2.3 -> v7.6.2
- global_label (Alias name: global-label) Label for the policy that appears when the gui is in global view mode. type: str
more...
Supported Version Ranges: v6.2.3 -> v7.6.2
- internet_service_negate (Alias name: internet-service-negate) When enabled internet-service specifies what the service must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.2 -> v7.6.2
- internet_service_src_negate (Alias name: internet-service-src-negate) When enabled internet-service-src specifies what the service must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.2 -> v7.6.2
- service_negate (Alias name: service-negate) When enabled service specifies what the service must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.2 -> v7.6.2
- srcaddr_negate (Alias name: srcaddr-negate) When enabled srcaddr specifies what the source address must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.2 -> v7.6.2
- _policy_block Assigned policy block. type: int
more...
Supported Version Ranges: v7.0.3 -> v7.6.2
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure consolidated IPv4/IPv6 policies.
fortinet.fortimanager.fmgr_pkg_firewall_consolidated_policy:
# workspace_locking_adom:
adom:
pkg:
state: present #
pkg_firewall_consolidated_policy:
policyid: 0 # Required variable, integer
# action:
# app_category:
# app_group:
# application:
# application_list:
# auto_asic_offload:
# av_profile:
# cifs_profile:
# comments:
# diffserv_forward:
# diffserv_reverse:
# diffservcode_forward:
# diffservcode_rev:
# dlp_sensor:
# dnsfilter_profile:
# dstaddr4:
# dstaddr6:
# dstintf:
# emailfilter_profile:
# fixedport:
# groups:
# http_policy_redirect:
# icap_profile:
# inbound:
# inspection_mode:
# internet_service:
# internet_service_custom:
# internet_service_custom_group:
# internet_service_group:
# internet_service_id:
# internet_service_src:
# internet_service_src_custom:
# internet_service_src_custom_group:
# internet_service_src_group:
# internet_service_src_id:
# ippool:
# ips_sensor:
# logtraffic:
# logtraffic_start:
# mms_profile:
# name:
# nat:
# outbound:
# per_ip_shaper:
# poolname4:
# poolname6:
# profile_group:
# profile_protocol_options:
# profile_type:
# schedule:
# service:
# session_ttl:
# srcaddr4:
# srcaddr6:
# srcintf:
# ssh_filter_profile:
# ssh_policy_redirect:
# ssl_ssh_profile:
# status:
# tcp_mss_receiver:
# tcp_mss_sender:
# traffic_shaper:
# traffic_shaper_reverse:
# url_category:
# users:
# utm_status:
# uuid:
# voip_profile:
# vpntunnel:
# waf_profile:
# wanopt:
# wanopt_detection:
# wanopt_passive_opt:
# wanopt_peer:
# wanopt_profile:
# webcache:
# webcache_https:
# webfilter_profile:
# webproxy_forward_server:
# webproxy_profile:
# captive_portal_exempt:
# dstaddr_negate:
# fsso_groups:
# global_label:
# internet_service_negate:
# internet_service_src_negate:
# service_negate:
# srcaddr_negate:
# _policy_block:
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)