:source: fmgr_pkg_firewall_policy.py
:orphan:
.. _fmgr_pkg_firewall_policy:
fmgr_pkg_firewall_policy -- Configure IPv4 policies.
++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.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.0.0 -> latest
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_policy - Configure IPv4 policies. type: dict
- action Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec, ssl-vpn, redirect, isolate]
more...
Supported Version Ranges: v6.0.0 -> latest
- app_category (Alias name: app-category) Application category id list. type: list or str
more...
Supported Version Ranges: v6.0.0 -> v7.6.2, v7.6.4 -> latest
- application Application id list. type: list
more...
Supported Version Ranges: v6.0.0 -> v7.6.2, v7.6.4 -> latest
- application_list (Alias name: application-list) Name of an existing application list. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- auth_cert (Alias name: auth-cert) Https server certificate for policy authentication. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- auth_path (Alias name: auth-path) Enable/disable authentication-based routing. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- auth_redirect_addr (Alias name: auth-redirect-addr) Http-to-https redirect address for firewall authentication. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- 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.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- av_profile (Alias name: av-profile) Name of an existing antivirus profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- block_notification (Alias name: block-notification) Enable/disable block notification. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- captive_portal_exempt (Alias name: captive-portal-exempt) Enable to exempt some users from the captive portal. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- capture_packet (Alias name: capture-packet) Enable/disable capture packets. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- comments Comment. type: dict or str
more...
Supported Version Ranges: v6.0.0 -> latest
- custom_log_fields (Alias name: custom-log-fields) Custom fields to append to log messages for this policy. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- delay_tcp_npu_session (Alias name: delay-tcp-npu-session) Enable tcp npu session delay to guarantee packet order of 3-way handshake. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- devices Names of devices or device groups that can be matched by the policy. type: list or str
more...
Supported Version Ranges: v6.0.0 -> v7.2.1
- 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.0.0 -> latest
- 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.0.0 -> latest
- diffservcode_forward (Alias name: diffservcode-forward) Change packets diffserv to this value. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- diffservcode_rev (Alias name: diffservcode-rev) Change packets reverse (reply) diffserv to this value. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- disclaimer Enable/disable user authentication disclaimer. type: str choices: [disable, enable, user, domain, policy]
more...
Supported Version Ranges: v6.0.0 -> latest
- dlp_sensor (Alias name: dlp-sensor) Name of an existing dlp sensor. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- dnsfilter_profile (Alias name: dnsfilter-profile) Name of an existing dns filter profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- dscp_match (Alias name: dscp-match) Enable dscp check. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.2.1
- dscp_negate (Alias name: dscp-negate) Enable negated dscp match. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.2.1
- dscp_value (Alias name: dscp-value) Dscp value. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.2.1
- dsri Enable dsri to ignore http server responses. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- dstaddr Destination address and address group names. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- 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.0.0 -> latest
- dstintf Outgoing (egress) interface. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- firewall_session_dirty (Alias name: firewall-session-dirty) How to handle sessions if the configuration of this firewall policy changes. type: str choices: [check-all, check-new]
more...
Supported Version Ranges: v6.0.0 -> latest
- fixedport Enable to prevent source nat from changing a sessions source port. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- fsso Enable/disable fortinet single sign-on. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.6.2
- fsso_agent_for_ntlm (Alias name: fsso-agent-for-ntlm) Fsso agent to use for ntlm authentication. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- 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.0.0 -> latest
- groups Names of user groups that can authenticate with this policy. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- gtp_profile (Alias name: gtp-profile) Gtp profile. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- icap_profile (Alias name: icap-profile) Name of an existing icap profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- identity_based_route (Alias name: identity-based-route) Name of identity-based routing rule. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- 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.0.0 -> latest
- 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.0.0 -> latest
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- internet_service_id (Alias name: internet-service-id) Internet service id. type: list or str
more...
Supported Version Ranges: v6.0.0 -> 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.0.0 -> latest
- ippool Enable to use ip pools for source nat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ips_sensor (Alias name: ips-sensor) Name of an existing ips sensor. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- label Label for the policy that appears when the gui is in section view mode. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- learning_mode (Alias name: learning-mode) Enable to allow everything, but log all of the meaningful data for security information gathering. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.2.1
- logtraffic Enable or disable logging. type: str choices: [disable, enable, all, utm]
more...
Supported Version Ranges: v6.0.0 -> latest
- logtraffic_start (Alias name: logtraffic-start) Record logs when a session starts and ends. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- match_vip (Alias name: match-vip) Enable to match packets that have had their destination addresses changed by a vip. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- mms_profile (Alias name: mms-profile) Name of an existing mms profile. type: str
more...
Supported Version Ranges: v6.0.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.0.0 -> latest
- nat Enable/disable source nat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- natinbound Policy-based ipsec vpn: apply destination nat to inbound traffic. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- natip Policy-based ipsec vpn: source nat ip address for outgoing traffic. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- natoutbound Policy-based ipsec vpn: apply source nat to outbound traffic. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ntlm Enable/disable ntlm authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ntlm_enabled_browsers (Alias name: ntlm-enabled-browsers) Http-user-agent value of supported browsers. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- ntlm_guest (Alias name: ntlm-guest) Enable/disable ntlm guest user access. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- 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.0.0 -> latest
- per_ip_shaper (Alias name: per-ip-shaper) Per-ip traffic shaper. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- permit_any_host (Alias name: permit-any-host) Accept udp packets from any host. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- permit_stun_host (Alias name: permit-stun-host) Accept udp packets from any session traversal utilities for nat (stun) host. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- policyid Policy id. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- poolname Ip pool names. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- profile_group (Alias name: profile-group) Name of profile group. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- profile_protocol_options (Alias name: profile-protocol-options) Name of an existing protocol options profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- 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.0.0 -> latest
- radius_mac_auth_bypass (Alias name: radius-mac-auth-bypass) Enable mac authentication bypass. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- redirect_url (Alias name: redirect-url) Url users are directed to after seeing and accepting the disclaimer or authenticating. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- replacemsg_override_group (Alias name: replacemsg-override-group) Override the default replacement message group for this policy. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- rsso Enable/disable radius single sign-on (rsso). type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.6.2
- rtp_addr (Alias name: rtp-addr) Address names if this is an rtp nat policy. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- rtp_nat (Alias name: rtp-nat) Enable real time protocol (rtp) nat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- scan_botnet_connections (Alias name: scan-botnet-connections) Block or monitor connections to botnet servers or disable botnet scanning. type: str choices: [disable, block, monitor]
more...
Supported Version Ranges: v6.0.0 -> v7.2.1, v7.4.8 -> v7.4.10
- schedule Schedule name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- schedule_timeout (Alias name: schedule-timeout) Enable to force current sessions to end when the schedule object times out. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- send_deny_packet (Alias name: send-deny-packet) Enable to send a reply when a session is denied or blocked by a firewall policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- service Service and service group names. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- 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.0.0 -> latest
- session_ttl (Alias name: session-ttl) Session ttl in seconds for sessions accepted by this policy. type: int or str
more...
Supported Version Ranges: v6.0.0 -> latest
- spamfilter_profile (Alias name: spamfilter-profile) Name of an existing spam filter profile. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.2.1, v7.4.8 -> v7.4.10
- srcaddr Source address and address group names. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- 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.0.0 -> latest
- srcintf Incoming (ingress) interface. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- ssl_mirror (Alias name: ssl-mirror) Enable to copy decrypted ssl traffic to a fortigate interface (called ssl mirroring). type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.6.2
- ssl_mirror_intf (Alias name: ssl-mirror-intf) Ssl mirror interface name. type: list or str
more...
Supported Version Ranges: v6.0.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.0.0 -> latest
- status Enable or disable this policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- tags Names of object-tags applied to this policy. type: str
more...
Supported Version Ranges: v6.0.0 -> v6.4.15, v7.4.8 -> v7.4.10
- tcp_mss_receiver (Alias name: tcp-mss-receiver) Receiver tcp maximum segment size (mss). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- tcp_mss_sender (Alias name: tcp-mss-sender) Sender tcp maximum segment size (mss). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- tcp_session_without_syn (Alias name: tcp-session-without-syn) Enable/disable creation of tcp session without syn flag. type: str choices: [all, data-only, disable]
more...
Supported Version Ranges: v6.0.0 -> latest
- timeout_send_rst (Alias name: timeout-send-rst) Enable/disable sending rst packets when tcp sessions expire. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- traffic_shaper (Alias name: traffic-shaper) Traffic shaper. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) Reverse traffic shaper. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- url_category (Alias name: url-category) Url category id list. type: list or str
more...
Supported Version Ranges: v6.0.0 -> v7.6.2, v7.6.4 -> latest
- users Names of individual users that can authenticate with this policy. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- 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.0.0 -> latest
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- vlan_cos_fwd (Alias name: vlan-cos-fwd) Vlan forward direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- vlan_cos_rev (Alias name: vlan-cos-rev) Vlan reverse direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- voip_profile (Alias name: voip-profile) Name of an existing voip profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- vpn_dst_node Vpn dst node. type: list
more...
Supported Version Ranges: v6.0.0 -> v7.0.2
- host Host. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.0.2
- seq Seq. type: int
more...
Supported Version Ranges: v6.0.0 -> v7.0.2
- subnet Subnet. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.0.2
- vpn_src_node Vpn src node. type: list
more...
Supported Version Ranges: v6.0.0 -> v7.0.2
- host Host. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.0.2
- seq Seq. type: int
more...
Supported Version Ranges: v6.0.0 -> v7.0.2
- subnet Subnet. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.0.2
- vpntunnel Policy-based ipsec vpn: name of the ipsec vpn phase 1. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- waf_profile (Alias name: waf-profile) Name of an existing web application firewall profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- wanopt Enable/disable wan optimization. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wanopt_detection (Alias name: wanopt-detection) Wan optimization auto-detection mode. type: str choices: [active, passive, off]
more...
Supported Version Ranges: v6.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wanopt_peer (Alias name: wanopt-peer) Wan optimization peer. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wanopt_profile (Alias name: wanopt-profile) Wan optimization profile. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wccp Enable/disable forwarding traffic matching this policy to a configured wccp server. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- webcache Enable/disable web cache. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- webcache_https (Alias name: webcache-https) Enable/disable web cache for https. type: str choices: [disable, ssl-server, any, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- webfilter_profile (Alias name: webfilter-profile) Name of an existing web filter profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- wsso Enable/disable wifi single sign on (wsso). type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.6.2
- anti_replay (Alias name: anti-replay) Enable/disable anti-replay check. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> latest
- app_group (Alias name: app-group) Application group names. type: list or str
more...
Supported Version Ranges: v6.2.0 -> v7.6.2, v7.6.4 -> latest
- cifs_profile (Alias name: cifs-profile) Name of an existing cifs profile. type: str
more...
Supported Version Ranges: v6.2.0 -> latest
- email_collect (Alias name: email-collect) Enable/disable email collection. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> latest
- emailfilter_profile (Alias name: emailfilter-profile) Name of an existing email filter profile. type: str
more...
Supported Version Ranges: v6.2.0 -> latest
- fsso_groups (Alias name: fsso-groups) Names of fsso groups. type: list or str
more...
Supported Version Ranges: v6.2.1 -> latest
- geoip_anycast (Alias name: geoip-anycast) Enable/disable recognition of anycast ip addresses using the geography ip database. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> latest
- http_policy_redirect (Alias name: http-policy-redirect) Redirect http(s) traffic to matching transparent web proxy policy. type: str choices: [disable, enable, legacy]
more...
Supported Version Ranges: v6.2.0 -> latest
- inspection_mode (Alias name: inspection-mode) Policy inspection mode (flow/proxy). type: str choices: [proxy, flow]
more...
Supported Version Ranges: v6.2.0 -> latest
- 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.0 -> latest
- internet_service_group (Alias name: internet-service-group) Internet service group name. type: list or str
more...
Supported Version Ranges: v6.2.0 -> latest
- 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.0 -> latest
- 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.0 -> latest
- 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.0 -> latest
- 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.0 -> latest
- internet_service_src_id (Alias name: internet-service-src-id) Internet service source id. type: list or str
more...
Supported Version Ranges: v6.2.0 -> 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.0 -> latest
- match_vip_only (Alias name: match-vip-only) Enable/disable matching of only those packets that have had their destination addresses changed by a vip. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.1 -> latest
- np_acceleration (Alias name: np-acceleration) Enable/disable utm network processor acceleration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- reputation_direction (Alias name: reputation-direction) Direction of the initial traffic for reputation to take effect. type: str choices: [source, destination]
more...
Supported Version Ranges: v6.2.0 -> latest
- reputation_minimum (Alias name: reputation-minimum) Minimum reputation to take action. type: int
more...
Supported Version Ranges: v6.2.0 -> latest
- 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.4, v7.2.6 -> latest
- 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 -> latest
- tos Tos (type of service) value used for comparison. type: str
more...
Supported Version Ranges: v6.2.0 -> latest
- tos_mask (Alias name: tos-mask) Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str
more...
Supported Version Ranges: v6.2.0 -> latest
- tos_negate (Alias name: tos-negate) Enable negated tos match. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> latest
- vlan_filter (Alias name: vlan-filter) Set vlan filters. type: str
more...
Supported Version Ranges: v6.2.0 -> latest
- webproxy_forward_server (Alias name: webproxy-forward-server) Webproxy forward server name. type: str
more...
Supported Version Ranges: v6.2.0 -> latest
- webproxy_profile (Alias name: webproxy-profile) Webproxy profile name. type: str
more...
Supported Version Ranges: v6.2.0 -> latest
- np_accelation (Alias name: np-accelation) Enable/disable utm network processor acceleration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.1 -> v6.4.15
- delay_tcp_npu_sessoin (Alias name: delay-tcp-npu-sessoin) Enable/disable tcp npu session delay in order to guarantee packet order of 3-way handshake. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v6.2.13
- casi_profile (Alias name: casi-profile) Casi profile. type: str
more...
Supported Version Ranges: v6.2.0 -> v6.2.13
- best_route (Alias name: best-route) Enable/disable the use of best route. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.3 -> v7.6.2
- decrypted_traffic_mirror (Alias name: decrypted-traffic-mirror) Decrypted traffic mirror. type: str
more...
Supported Version Ranges: v6.4.0 -> latest
- dstaddr6 Destination ipv6 address name and address group names. type: list or str
more...
Supported Version Ranges: v6.4.0 -> latest
- geoip_match (Alias name: geoip-match) Match geography address based either on its physical location or registered location. type: str choices: [physical-location, registered-location]
more...
Supported Version Ranges: v6.4.0 -> latest
- internet_service_name (Alias name: internet-service-name) Internet service name. type: list or str
more...
Supported Version Ranges: v6.4.0 -> latest
- internet_service_src_name (Alias name: internet-service-src-name) Internet service source name. type: list or str
more...
Supported Version Ranges: v6.4.0 -> latest
- poolname6 Ipv6 pool names. type: list or str
more...
Supported Version Ranges: v6.4.0 -> latest
- src_vendor_mac (Alias name: src-vendor-mac) Vendor mac source id. type: list or str
more...
Supported Version Ranges: v6.4.0 -> latest
- srcaddr6 Source ipv6 address name and address group names. type: list or str
more...
Supported Version Ranges: v6.4.0 -> latest
- file_filter_profile (Alias name: file-filter-profile) Name of an existing file-filter profile. type: str
more...
Supported Version Ranges: v6.4.1 -> v7.2.4, v7.2.6 -> latest
- policy_offload (Alias name: policy-offload) Enable/disable hardware session setup for cgnat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.3 -> latest
- cgn_session_quota (Alias name: cgn-session-quota) Session quota type: int
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.3 -> latest
- cgn_eif (Alias name: cgn-eif) Enable/disable cgn endpoint independent filtering. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.3 -> latest
- cgn_log_server_grp (Alias name: cgn-log-server-grp) Np log server group name type: str
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.3 -> latest
- cgn_eim (Alias name: cgn-eim) Enable/disable cgn endpoint independent mapping type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.3 -> latest
- cgn_resource_quota (Alias name: cgn-resource-quota) Resource quota type: int
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.3 -> latest
- dynamic_shaping (Alias name: dynamic-shaping) Enable/disable dynamic radius defined traffic shaping. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.6 -> latest
- passive_wan_health_measurement (Alias name: passive-wan-health-measurement) Enable/disable passive wan health measurement. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.0 -> latest
- videofilter_profile (Alias name: videofilter-profile) Name of an existing videofilter profile. type: str
more...
Supported Version Ranges: v7.0.0 -> v7.2.4, v7.2.6 -> latest
- ztna_ems_tag (Alias name: ztna-ems-tag) Source ztna-ems-tag names. type: list or str
more...
Supported Version Ranges: v7.0.0 -> latest
- ztna_geo_tag (Alias name: ztna-geo-tag) Source ztna-geo-tag names. type: list or str
more...
Supported Version Ranges: v7.0.0 -> latest
- ztna_status (Alias name: ztna-status) Enable/disable zero trust access. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.0 -> latest
- _policy_block Assigned policy block. type: int
more...
Supported Version Ranges: v7.0.3 -> latest
- dlp_profile (Alias name: dlp-profile) Name of an existing dlp profile. type: str
more...
Supported Version Ranges: v7.2.0 -> latest
- fec Enable/disable forward error correction on traffic matching this policy on a fec device. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.2 -> latest
- nat46 Enable/disable nat46. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.1 -> latest
- nat64 Enable/disable nat64. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.1 -> latest
- pfcp_profile (Alias name: pfcp-profile) Pfcp profile. type: str
more...
Supported Version Ranges: v7.0.1 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- policy_expiry (Alias name: policy-expiry) Enable/disable policy expiry. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.0 -> latest
- policy_expiry_date (Alias name: policy-expiry-date) Policy expiry date (yyyy-mm-dd hh:mm:ss). type: str
more...
Supported Version Ranges: v7.2.0 -> latest
- sctp_filter_profile (Alias name: sctp-filter-profile) Name of an existing sctp filter profile. type: str
more...
Supported Version Ranges: v7.0.1 -> v7.2.4, v7.2.6 -> latest
- sgt Security group tags. type: list
more...
Supported Version Ranges: v7.0.1 -> latest
- sgt_check (Alias name: sgt-check) Enable/disable security group tags (sgt) check. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.1 -> latest
- tcp_timeout_pid (Alias name: tcp-timeout-pid) Tcp timeout profile id type: str
more...
Supported Version Ranges: v7.0.3 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- udp_timeout_pid (Alias name: udp-timeout-pid) Udp timeout profile id type: str
more...
Supported Version Ranges: v7.0.3 -> v7.2.0, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- diffserv_copy (Alias name: diffserv-copy) Enable to copy packets diffserv values from sessions original direction to its reply direction. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- dstaddr6_negate (Alias name: dstaddr6-negate) When enabled dstaddr6 specifies what the destination address must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6 (Alias name: internet-service6) Enable/disable use of ipv6 internet services for this policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_custom (Alias name: internet-service6-custom) Custom ipv6 internet service name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_custom_group (Alias name: internet-service6-custom-group) Custom internet service6 group name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_group (Alias name: internet-service6-group) Internet service group name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_name (Alias name: internet-service6-name) Ipv6 internet service name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_negate (Alias name: internet-service6-negate) When enabled internet-service6 specifies what the service must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_src (Alias name: internet-service6-src) Enable/disable use of ipv6 internet services in source for this policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_src_custom (Alias name: internet-service6-src-custom) Custom ipv6 internet service source name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_src_custom_group (Alias name: internet-service6-src-custom-group) Custom internet service6 source group name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_src_group (Alias name: internet-service6-src-group) Internet service6 source group name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_src_name (Alias name: internet-service6-src-name) Ipv6 internet service source name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- internet_service6_src_negate (Alias name: internet-service6-src-negate) When enabled internet-service6-src specifies what the service must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- network_service_dynamic (Alias name: network-service-dynamic) Dynamic network service name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- network_service_src_dynamic (Alias name: network-service-src-dynamic) Dynamic network service source name. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- reputation_direction6 (Alias name: reputation-direction6) Direction of the initial traffic for ipv6 reputation to take effect. type: str choices: [source, destination]
more...
Supported Version Ranges: v7.2.1 -> latest
- reputation_minimum6 (Alias name: reputation-minimum6) Ipv6 minimum reputation to take action. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- srcaddr6_negate (Alias name: srcaddr6-negate) When enabled srcaddr6 specifies what the source address must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- ip_version_type (Alias name: ip-version-type) Ip version of the policy. type: str
more...
Supported Version Ranges: v7.2.6 -> latest
- ips_voip_filter (Alias name: ips-voip-filter) Name of an existing voip (ips) profile. type: str
more...
Supported Version Ranges: v7.2.6 -> latest
- pcp_inbound (Alias name: pcp-inbound) Enable/disable pcp inbound dnat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.0 -> latest
- pcp_outbound (Alias name: pcp-outbound) Enable/disable pcp outbound snat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.0 -> latest
- pcp_poolname (Alias name: pcp-poolname) Pcp pool names. type: list
more...
Supported Version Ranges: v7.4.0 -> latest
- policy_behaviour_type (Alias name: policy-behaviour-type) Behaviour of the policy. type: str
more...
Supported Version Ranges: v7.2.6 -> latest
- policy_expiry_date_utc (Alias name: policy-expiry-date-utc) Policy expiry date and time, in epoch format. type: str
more...
Supported Version Ranges: v7.2.6 -> latest
- ztna_device_ownership (Alias name: ztna-device-ownership) Enable/disable zero trust device ownership. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> latest
- ztna_ems_tag_secondary (Alias name: ztna-ems-tag-secondary) Source ztna-ems-tag-secondary names. type: list
more...
Supported Version Ranges: v7.4.0 -> latest
- ztna_policy_redirect (Alias name: ztna-policy-redirect) Redirect ztna traffic to matching access-proxy proxy-policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> latest
- ztna_tags_match_logic (Alias name: ztna-tags-match-logic) Ztna tag matching logic. type: str choices: [or, and]
more...
Supported Version Ranges: v7.2.6 -> latest
- casb_profile (Alias name: casb-profile) Name of an existing casb profile. type: str
more...
Supported Version Ranges: v7.4.1 -> latest
- virtual_patch_profile (Alias name: virtual-patch-profile) Name of an existing virtual-patch profile. type: str
more...
Supported Version Ranges: v7.4.1 -> latest
- diameter_filter_profile (Alias name: diameter-filter-profile) Name of an existing diameter filter profile. type: str
more...
Supported Version Ranges: v7.4.2 -> latest
- port_preserve (Alias name: port-preserve) Enable/disable preservation of the original source port from source nat if it has not been used. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- cgn_sw_eif_ctrl (Alias name: cgn-sw-eif-ctrl) Enable/disable software endpoint independent filtering control. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- eif_check (Alias name: eif-check) Enable/disable check endpoint-independent-filtering pinhole. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- eif_learn (Alias name: eif-learn) Enable/disable learning of end-point-independent filtering pinhole. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- log_http_transaction (Alias name: log-http-transaction) Enable/disable http transaction log. type: str choices: [disable, enable, all, utm]
more...
Supported Version Ranges: v7.4.8 -> latest
- radius_ip_auth_bypass (Alias name: radius-ip-auth-bypass) Enable ip authentication bypass. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- app_monitor (Alias name: app-monitor) Enable/disable application tcp metrics in session logs. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- port_random (Alias name: port-random) Enable/disable random source port selection for source nat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- ztna_ems_tag_negate (Alias name: ztna-ems-tag-negate) When enabled ztna-ems-tag specifies what the tags must not be. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- telemetry_profile (Alias name: telemetry-profile) Name of an existing telemetry profile. type: list
more...
Supported Version Ranges: v7.6.3 -> latest
- access_proxy (Alias name: access-proxy) Access proxy. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- detect_https_in_http_request (Alias name: detect-https-in-http-request) Detect https in http request. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- device_ownership (Alias name: device-ownership) Device ownership. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dynamic_bypass (Alias name: dynamic-bypass) Dynamic bypass. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- explicit_web_proxy (Alias name: explicit-web-proxy) Explicit web proxy. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- extended_log (Alias name: extended-log) Extended log. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- force_proxy (Alias name: force-proxy) Force proxy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- http_tunnel_auth (Alias name: http-tunnel-auth) Enable/disable http tunnel authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- https_sub_category (Alias name: https-sub-category) Https sub category. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ia_profile (Alias name: ia-profile) Image analyzer profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- implicit_proxy_detection (Alias name: implicit-proxy-detection) Implicit proxy detection. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- isolator_profile (Alias name: isolator-profile) Isolator profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- isolator_server (Alias name: isolator-server) Isolator server name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- max_session_per_user (Alias name: max-session-per-user) Max utm sessions per user. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- pass_through (Alias name: pass-through) Pass through. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- redirect_profile (Alias name: redirect-profile) Redirect profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- reverse_cache (Alias name: reverse-cache) Enable/disable reverse cache servers. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssh_policy_check (Alias name: ssh-policy-check) Ssh policy check. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- transparent Set webproxy to use original client address. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- type Type of policy. type: str choices: [explicit-web, transparent, explicit-ftp, ssh-tunnel, ssh, wanopt, access-proxy, ztna-proxy, explicit-web-connect, transparent-connect, llm-proxy]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- url_risk (Alias name: url-risk) Url risk. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- service_connector (Alias name: service-connector) Service connector. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- ztna_proxy (Alias name: ztna-proxy) Ztna proxy. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- internet_service6_fortiguard (Alias name: internet-service6-fortiguard) Fortiguard ipv6 internet service name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- scim_groups (Alias name: scim-groups) Names of scim groups. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- internet_service_fortiguard (Alias name: internet-service-fortiguard) Fortiguard internet service name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- internet_service_src_fortiguard (Alias name: internet-service-src-fortiguard) Fortiguard internet service source name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- scim_users (Alias name: scim-users) Names of scim users. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- scim Enable/disable scim (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> latest
- internet_service6_src_fortiguard (Alias name: internet-service6-src-fortiguard) Fortiguard ipv6 internet service source name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- saml_server (Alias name: saml-server) Saml server name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- llm_profile (Alias name: llm-profile) Llm profile. type: list
more...
Supported Version Ranges: v7.6.5 -> latest
- object_position (Alias name: object position) Object position. type: list
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
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 policies.
fortinet.fortimanager.fmgr_pkg_firewall_policy:
bypass_validation: false
adom: ansible
pkg: ansible # package name
state: present
pkg_firewall_policy:
action: accept #
comments: ansible-comment
dstaddr: all
dstintf: any
# name: ansible-test-policy
nat: disable
policyid: 1
schedule: always
service: ALL
srcaddr: all
srcintf: any
status: disable
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the IPv4 policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_firewall_policy"
params:
adom: "ansible"
pkg: "ansible" # package name
policy: "your_value"
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)