fortinet.fortimanager.fmgr_pkg_footer_policy module – Configure IPv4/IPv6 policies.
Note
This module is part of the fortinet.fortimanager collection (version 2.5.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_footer_policy
.
New in fortinet.fortimanager 2.0.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. |
|
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. |
|
(list) Deprecated, please rename it to access_proxy. |
|
No description. Choices:
|
|
Deprecated, please rename it to active_auth_method. Choices:
|
|
Deprecated, please rename it to anti_replay. Choices:
|
|
(list or str) Deprecated, please rename it to app_category. |
|
(list or str) Deprecated, please rename it to app_group. |
|
(list) No description. |
|
Deprecated, please rename it to application_charts. Choices:
|
|
Deprecated, please rename it to application_list. |
|
Deprecated, please rename it to auth_cert. |
|
Deprecated, please rename it to auth_method. Choices:
|
|
Deprecated, please rename it to auth_path. Choices:
|
|
Deprecated, please rename it to auth_portal. Choices:
|
|
Deprecated, please rename it to auth_redirect_addr. |
|
Deprecated, please rename it to auto_asic_offload. Choices:
|
|
Deprecated, please rename it to av_profile. |
|
No description. Choices:
|
|
Deprecated, please rename it to best_route. Choices:
|
|
Deprecated, please rename it to block_notification. Choices:
|
|
Deprecated, please rename it to captive_portal_exempt. Choices:
|
|
Deprecated, please rename it to capture_packet. Choices:
|
|
Deprecated, please rename it to casb_profile. Name of an existing CASB profile. |
|
(list or str) Deprecated, please rename it to casi_profile. |
|
Deprecated, please rename it to central_nat. Choices:
|
|
Deprecated, please rename it to cgn_eif. Enable/Disable CGN endpoint independent filtering. Choices:
|
|
Deprecated, please rename it to cgn_eim. Enable/Disable CGN endpoint independent mapping Choices:
|
|
(list or str) Deprecated, please rename it to cgn_log_server_grp. NP log server group name |
|
Deprecated, please rename it to cgn_resource_quota. Resource quota |
|
Deprecated, please rename it to cgn_session_quota. Session quota |
|
Deprecated, please rename it to cifs_profile. |
|
Deprecated, please rename it to client_reputation. Choices:
|
|
Deprecated, please rename it to client_reputation_mode. Choices:
|
|
(dict or str) No description. |
|
(list or str) Deprecated, please rename it to custom_log_fields. |
|
Deprecated, please rename it to decrypted_traffic_mirror. |
|
(list or str) Deprecated, please rename it to deep_inspection_options. |
|
Deprecated, please rename it to delay_tcp_npu_session. Choices:
|
|
Deprecated, please rename it to delay_tcp_npu_sessoin. Choices:
|
|
Deprecated, please rename it to detect_https_in_http_request. Choices:
|
|
Deprecated, please rename it to device_detection_portal. Choices:
|
|
Deprecated, please rename it to device_ownership. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to diameter_filter_profile. Name of an existing Diameter filter profile. |
|
Deprecated, please rename it to diffserv_copy. Enable to copy packets DiffServ values from sessions original direction to … Choices:
|
|
Deprecated, please rename it to diffserv_forward. Choices:
|
|
Deprecated, please rename it to diffserv_reverse. Choices:
|
|
Deprecated, please rename it to diffservcode_forward. |
|
Deprecated, please rename it to diffservcode_rev. |
|
No description. Choices:
|
|
Deprecated, please rename it to dlp_profile. Name of an existing DLP profile. |
|
(list or str) Deprecated, please rename it to dlp_sensor. |
|
Deprecated, please rename it to dnsfilter_profile. |
|
No description. Choices:
|
|
Deprecated, please rename it to dscp_match. Choices:
|
|
Deprecated, please rename it to dscp_negate. Choices:
|
|
Deprecated, please rename it to dscp_value. |
|
No description. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to dstaddr_negate. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to dstaddr6_negate. When enabled dstaddr6 specifies what the destination address must NOT be. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to dynamic_bypass. Choices:
|
|
Deprecated, please rename it to dynamic_profile. Choices:
|
|
Deprecated, please rename it to dynamic_profile_access. Choices:
|
|
Deprecated, please rename it to dynamic_profile_fallthrough. Choices:
|
|
(list or str) Deprecated, please rename it to dynamic_profile_group. |
|
Deprecated, please rename it to dynamic_shaping. Enable/disable dynamic RADIUS defined traffic shaping. Choices:
|
|
Deprecated, please rename it to email_collect. Choices:
|
|
Deprecated, please rename it to email_collection_portal. Choices:
|
|
Deprecated, please rename it to emailfilter_profile. |
|
Deprecated, please rename it to endpoint_check. Choices:
|
|
Deprecated, please rename it to endpoint_compliance. Choices:
|
|
(list or str) Deprecated, please rename it to endpoint_keepalive_interface. |
|
(list or str) Deprecated, please rename it to endpoint_profile. |
|
Deprecated, please rename it to extended_log. Choices:
|
|
Deprecated, please rename it to failed_connection. Choices:
|
|
Deprecated, please rename it to fall_through_unauthenticated. Choices:
|
|
Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. Choices:
|
|
Deprecated, please rename it to file_filter_profile. |
|
Deprecated, please rename it to firewall_session_dirty. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to force_proxy. Choices:
|
|
Deprecated, please rename it to forticlient_compliance_devices. Choices:
|
|
Deprecated, please rename it to forticlient_compliance_enforcement_portal. Choices:
|
|
No description. Choices:
|
|
(list or str) Deprecated, please rename it to fsae_server_for_ntlm. |
|
No description. Choices:
|
|
Deprecated, please rename it to fsso_agent_for_ntlm. |
|
(list or str) Deprecated, please rename it to fsso_groups. |
|
Deprecated, please rename it to geo_location. Choices:
|
|
Deprecated, please rename it to geoip_anycast. Choices:
|
|
Deprecated, please rename it to geoip_match. Choices:
|
|
Deprecated, please rename it to global_label. |
|
(list or str) No description. |
|
Deprecated, please rename it to gtp_profile. |
|
Deprecated, please rename it to http_policy_redirect. Choices:
|
|
Deprecated, please rename it to http_tunnel_auth. Choices:
|
|
(list) Deprecated, please rename it to ia_profile. |
|
Deprecated, please rename it to icap_profile. |
|
Deprecated, please rename it to identity_based. Choices:
|
|
Deprecated, please rename it to identity_based_policy. |
|
No description. Choices:
|
|
Deprecated, please rename it to application_charts. Choices:
|
|
Deprecated, please rename it to application_list. |
|
Deprecated, please rename it to av_profile. |
|
Deprecated, please rename it to capture_packet. Choices:
|
|
Deprecated, please rename it to deep_inspection_options. |
|
No description. |
|
Deprecated, please rename it to dlp_sensor. |
|
No description. |
|
Deprecated, please rename it to dstaddr_negate. Choices:
|
|
Deprecated, please rename it to endpoint_compliance. Choices:
|
|
No description. |
|
Deprecated, please rename it to icap_profile. |
|
No description. |
|
Deprecated, please rename it to ips_sensor. |
|
No description. Choices:
|
|
Deprecated, please rename it to logtraffic_app. Choices:
|
|
Deprecated, please rename it to logtraffic_start. Choices:
|
|
Deprecated, please rename it to mms_profile. |
|
Deprecated, please rename it to per_ip_shaper. |
|
Deprecated, please rename it to profile_group. |
|
Deprecated, please rename it to profile_protocol_options. |
|
Deprecated, please rename it to profile_type. Choices:
|
|
Deprecated, please rename it to replacemsg_group. |
|
No description. |
|
Deprecated, please rename it to send_deny_packet. Choices:
|
|
No description. |
|
Deprecated, please rename it to service_negate. Choices:
|
|
Deprecated, please rename it to spamfilter_profile. |
|
Deprecated, please rename it to sslvpn_portal. |
|
Deprecated, please rename it to sslvpn_realm. |
|
Deprecated, please rename it to traffic_shaper. |
|
Deprecated, please rename it to traffic_shaper_reverse. |
|
No description. |
|
Deprecated, please rename it to utm_status. Choices:
|
|
Deprecated, please rename it to voip_profile. |
|
Deprecated, please rename it to webfilter_profile. |
|
Deprecated, please rename it to identity_based_route. |
|
Deprecated, please rename it to identity_from. Choices:
|
|
Deprecated, please rename it to implicit_proxy_detection. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to inspection_mode. Choices:
|
|
Deprecated, please rename it to internet_service. Choices:
|
|
(list or str) Deprecated, please rename it to internet_service_custom. |
|
(list or str) Deprecated, please rename it to internet_service_custom_group. |
|
(list or str) Deprecated, please rename it to internet_service_group. |
|
(list or str) Deprecated, please rename it to internet_service_id. |
|
(list or str) Deprecated, please rename it to internet_service_name. |
|
Deprecated, please rename it to internet_service_negate. Choices:
|
|
Deprecated, please rename it to internet_service_src. Choices:
|
|
(list or str) Deprecated, please rename it to internet_service_src_custom. |
|
(list or str) Deprecated, please rename it to internet_service_src_custom_group. |
|
(list or str) Deprecated, please rename it to internet_service_src_group. |
|
(list or str) Deprecated, please rename it to internet_service_src_id. |
|
(list or str) Deprecated, please rename it to internet_service_src_name. |
|
Deprecated, please rename it to internet_service_src_negate. Choices:
|
|
Deprecated, please rename it to internet_service6. Enable/disable use of IPv6 Internet Services for this policy. Choices:
|
|
(list) Deprecated, please rename it to internet_service6_custom. |
|
(list) Deprecated, please rename it to internet_service6_custom_group. |
|
(list) Deprecated, please rename it to internet_service6_group. |
|
(list) Deprecated, please rename it to internet_service6_name. |
|
Deprecated, please rename it to internet_service6_negate. When enabled internet-service6 specifies what the service must N… Choices:
|
|
Deprecated, please rename it to internet_service6_src. Enable/disable use of IPv6 Internet Services in source for this policy. Choices:
|
|
(list) Deprecated, please rename it to internet_service6_src_custom. |
|
(list) Deprecated, please rename it to internet_service6_src_custom_group. |
|
(list) Deprecated, please rename it to internet_service6_src_group. |
|
(list) Deprecated, please rename it to internet_service6_src_name. |
|
Deprecated, please rename it to internet_service6_src_negate. When enabled internet-service6-src specifies what the servic… Choices:
|
|
Deprecated, please rename it to ip_based. Choices:
|
|
Deprecated, please rename it to ip_version_type. IP version of the policy. |
|
No description. Choices:
|
|
Deprecated, please rename it to ips_sensor. |
|
Deprecated, please rename it to ips_voip_filter. Name of an existing VoIP |
|
(list) Deprecated, please rename it to isolator_profile. |
|
(list) Deprecated, please rename it to isolator_server. |
|
No description. |
|
Deprecated, please rename it to learning_mode. Choices:
|
|
Deprecated, please rename it to log_http_transaction. Choices:
|
|
Deprecated, please rename it to log_unmatched_traffic. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to logtraffic_app. Choices:
|
|
Deprecated, please rename it to logtraffic_start. Choices:
|
|
Deprecated, please rename it to match_vip. Choices:
|
|
Deprecated, please rename it to match_vip_only. Choices:
|
|
Deprecated, please rename it to max_session_per_user. |
|
(list or str) Deprecated, please rename it to mms_profile. |
|
No description. |
|
No description. Choices:
|
|
Enable/disable NAT46. Choices:
|
|
Enable/disable NAT64. Choices:
|
|
No description. Choices:
|
|
No description. |
|
No description. Choices:
|
|
(list) Deprecated, please rename it to network_service_dynamic. |
|
(list) Deprecated, please rename it to network_service_src_dynamic. |
|
Deprecated, please rename it to np_accelation. Choices:
|
|
Deprecated, please rename it to np_acceleration. Choices:
|
|
No description. Choices:
|
|
(list) Deprecated, please rename it to ntlm_enabled_browsers. |
|
Deprecated, please rename it to ntlm_guest. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to pass_through. Choices:
|
|
Deprecated, please rename it to passive_wan_health_measurement. Enable/disable passive WAN health measurement. Choices:
|
|
Deprecated, please rename it to pcp_inbound. Enable/disable PCP inbound DNAT. Choices:
|
|
Deprecated, please rename it to pcp_outbound. Enable/disable PCP outbound SNAT. Choices:
|
|
(list) Deprecated, please rename it to pcp_poolname. |
|
Deprecated, please rename it to per_ip_shaper. |
|
Deprecated, please rename it to permit_any_host. Choices:
|
|
Deprecated, please rename it to permit_stun_host. Choices:
|
|
Deprecated, please rename it to pfcp_profile. PFCP profile. |
|
Deprecated, please rename it to policy_behaviour_type. Behaviour of the policy. |
|
Deprecated, please rename it to policy_expiry. Enable/disable policy expiry. Choices:
|
|
Deprecated, please rename it to policy_expiry_date. Policy expiry date |
|
Deprecated, please rename it to policy_expiry_date_utc. Policy expiry date and time, in epoch format. |
|
Deprecated, please rename it to policy_offload. Enable/Disable hardware session setup for CGNAT. Choices:
|
|
No description. |
|
(list or str) No description. |
|
(list or str) No description. |
|
Deprecated, please rename it to profile_group. |
|
Deprecated, please rename it to profile_protocol_options. |
|
Deprecated, please rename it to profile_type. Choices:
|
|
Deprecated, please rename it to radius_mac_auth_bypass. Choices:
|
|
(list) Deprecated, please rename it to redirect_profile. |
|
Deprecated, please rename it to redirect_url. |
|
(list or str) Deprecated, please rename it to replacemsg_group. |
|
Deprecated, please rename it to replacemsg_override_group. |
|
Deprecated, please rename it to reputation_direction. Choices:
|
|
Deprecated, please rename it to reputation_direction6. Direction of the initial traffic for IPv6 reputation to take effect. Choices:
|
|
Deprecated, please rename it to reputation_minimum. |
|
Deprecated, please rename it to reputation_minimum6. IPv6 Minimum Reputation to take action. |
|
Deprecated, please rename it to require_tfa. Choices:
|
|
Deprecated, please rename it to reverse_cache. Choices:
|
|
No description. Choices:
|
|
(list or str) Deprecated, please rename it to rtp_addr. |
|
Deprecated, please rename it to rtp_nat. Choices:
|
|
Deprecated, please rename it to scan_botnet_connections. Choices:
|
|
No description. |
|
Deprecated, please rename it to schedule_timeout. Choices:
|
|
Deprecated, please rename it to sctp_filter_profile. Name of an existing SCTP filter profile. |
|
Deprecated, please rename it to send_deny_packet. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to service_negate. Choices:
|
|
(int or str) Deprecated, please rename it to session_ttl. |
|
No description. Choices:
|
|
(list) No description. |
|
Deprecated, please rename it to sgt_check. Enable/disable security group tags Choices:
|
|
(list or str) Deprecated, please rename it to spamfilter_profile. |
|
(list or str) Deprecated, please rename it to src_vendor_mac. |
|
(list or str) No description. |
|
Deprecated, please rename it to srcaddr_negate. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to srcaddr6_negate. When enabled srcaddr6 specifies what the source address must NOT be. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to ssh_filter_profile. |
|
Deprecated, please rename it to ssh_policy_check. Choices:
|
|
Deprecated, please rename it to ssh_policy_redirect. Choices:
|
|
Deprecated, please rename it to ssl_mirror. Choices:
|
|
(list or str) Deprecated, please rename it to ssl_mirror_intf. |
|
Deprecated, please rename it to ssl_ssh_profile. |
|
Deprecated, please rename it to sslvpn_auth. Choices:
|
|
Deprecated, please rename it to sslvpn_ccert. Choices:
|
|
Deprecated, please rename it to sslvpn_cipher. Choices:
|
|
Deprecated, please rename it to sso_auth_method. Choices:
|
|
No description. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to tcp_mss_receiver. |
|
Deprecated, please rename it to tcp_mss_sender. |
|
Deprecated, please rename it to tcp_reset. Choices:
|
|
Deprecated, please rename it to tcp_session_without_syn. Choices:
|
|
(list) Deprecated, please rename it to tcp_timeout_pid. |
|
Deprecated, please rename it to timeout_send_rst. Choices:
|
|
No description. |
|
Deprecated, please rename it to tos_mask. |
|
Deprecated, please rename it to tos_negate. Choices:
|
|
Deprecated, please rename it to traffic_shaper. |
|
Deprecated, please rename it to traffic_shaper_reverse. |
|
Deprecated, please rename it to transaction_based. Choices:
|
|
No description. Choices:
|
|
No description. Choices:
|
|
(list) Deprecated, please rename it to udp_timeout_pid. |
|
(list or str) Deprecated, please rename it to url_category. |
|
(list or str) No description. |
|
Deprecated, please rename it to utm_inspection_mode. Choices:
|
|
Deprecated, please rename it to utm_status. Choices:
|
|
No description. |
|
Deprecated, please rename it to uuid_idx. |
|
(list or str) Deprecated, please rename it to vendor_mac. |
|
Deprecated, please rename it to videofilter_profile. Name of an existing VideoFilter profile. |
|
Deprecated, please rename it to virtual_patch_profile. Name of an existing virtual-patch profile. |
|
Deprecated, please rename it to vlan_cos_fwd. |
|
Deprecated, please rename it to vlan_cos_rev. |
|
Deprecated, please rename it to vlan_filter. |
|
Deprecated, please rename it to voip_profile. |
|
No description. |
|
Deprecated, please rename it to waf_profile. |
|
No description. Choices:
|
|
Deprecated, please rename it to wanopt_detection. Choices:
|
|
Deprecated, please rename it to wanopt_passive_opt. Choices:
|
|
Deprecated, please rename it to wanopt_peer. |
|
Deprecated, please rename it to wanopt_profile. |
|
No description. Choices:
|
|
Deprecated, please rename it to web_auth_cookie. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to webcache_https. Choices:
|
|
Deprecated, please rename it to webfilter_profile. |
|
Deprecated, please rename it to webproxy_forward_server. |
|
Deprecated, please rename it to webproxy_profile. |
|
No description. Choices:
|
|
Deprecated, please rename it to ztna_device_ownership. Enable/disable zero trust device ownership. Choices:
|
|
(list or str) Deprecated, please rename it to ztna_ems_tag. Source ztna-ems-tag names. |
|
(list) Deprecated, please rename it to ztna_ems_tag_secondary. |
|
(list or str) Deprecated, please rename it to ztna_geo_tag. Source ztna-geo-tag names. |
|
Deprecated, please rename it to ztna_policy_redirect. Redirect ZTNA traffic to matching Access-Proxy proxy-policy. Choices:
|
|
Deprecated, please rename it to ztna_status. Enable/disable zero trust access. Choices:
|
|
Deprecated, please rename it to ztna_tags_match_logic. Choices:
|
|
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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 footer policies.
fortinet.fortimanager.fmgr_pkg_footer_policy:
bypass_validation: false
pkg: ansible
state: present
pkg_footer_policy:
action: accept # <value in [deny, accept, ipsec, ...]>
dstaddr: gall
dstintf: any
name: ansible-test-footer
policyid: 1074741836 # must larger than 2^30(1074741824), since header/footer policy is a special policy
schedule: galways
service: gALL
srcaddr: gall
srcintf: any
status: enable
- 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 footer policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_footer_policy"
params:
pkg: "ansible"
policy: "your_value"
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 |
Authors
Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)