fmgr_pkg_header_policy – Configure IPv4/IPv6 policies.
Added in version 2.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.nameNew 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.
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>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- 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
- pkg - The parameter in requested url type: str required: true
- pkg_header_policy - Configure IPv4/IPv6 policies. type: dict
- action Action. type: str choices: [deny, accept, ipsec, ssl-vpn, redirect, isolate] more...
- active_auth_method (Alias name: active-auth-method) Active auth method. type: str choices: [ntlm, basic, digest, form] more...
- anti_replay (Alias name: anti-replay) Anti replay. type: str choices: [disable, enable] more...
- app_category (Alias name: app-category) App category. type: list or str more...
- app_group (Alias name: app-group) App group. type: list or str more...
- application Application. type: list more...
- application_charts (Alias name: application-charts) Application charts. type: list choices: [top10-app, top10-p2p-user, top10-media-user] more...
- application_list (Alias name: application-list) Application list. type: str more...
- auth_cert (Alias name: auth-cert) Auth cert. type: str more...
- auth_method (Alias name: auth-method) Auth method. type: str choices: [basic, digest, ntlm, fsae, form, fsso, rsso] more...
- auth_path (Alias name: auth-path) Auth path. type: str choices: [disable, enable] more...
- auth_portal (Alias name: auth-portal) Auth portal. type: str choices: [disable, enable] more...
- auth_redirect_addr (Alias name: auth-redirect-addr) Auth redirect addr. type: str more...
- auto_asic_offload (Alias name: auto-asic-offload) Auto asic offload. type: str choices: [disable, enable] more...
- av_profile (Alias name: av-profile) Av profile. type: str more...
- bandwidth Bandwidth. type: str choices: [disable, enable] more...
- block_notification (Alias name: block-notification) Block notification. type: str choices: [disable, enable] more...
- captive_portal_exempt (Alias name: captive-portal-exempt) Captive portal exempt. type: str choices: [disable, enable] more...
- capture_packet (Alias name: capture-packet) Capture packet. type: str choices: [disable, enable] more...
- casi_profile (Alias name: casi-profile) Casi profile. type: list or str more...
- central_nat (Alias name: central-nat) Central nat. type: str choices: [disable, enable] more...
- cifs_profile (Alias name: cifs-profile) Cifs profile. type: str more...
- client_reputation (Alias name: client-reputation) Client reputation. type: str choices: [disable, enable] more...
- client_reputation_mode (Alias name: client-reputation-mode) Client reputation mode. type: str choices: [learning, monitoring] more...
- comments Comments. type: dict or str
- custom_log_fields (Alias name: custom-log-fields) Custom log fields. type: list or str more...
- deep_inspection_options (Alias name: deep-inspection-options) Deep inspection options. type: list or str more...
- delay_tcp_npu_session (Alias name: delay-tcp-npu-session) Delay tcp npu session. type: str choices: [disable, enable] more...
- delay_tcp_npu_sessoin (Alias name: delay-tcp-npu-sessoin) Delay tcp npu sessoin. type: str choices: [disable, enable] more...
- device_detection_portal (Alias name: device-detection-portal) Device detection portal. type: str choices: [disable, enable] more...
- devices Devices. type: list or str more...
- diffserv_forward (Alias name: diffserv-forward) Diffserv forward. type: str choices: [disable, enable] more...
- diffserv_reverse (Alias name: diffserv-reverse) Diffserv reverse. type: str choices: [disable, enable] more...
- diffservcode_forward (Alias name: diffservcode-forward) Diffservcode forward. type: str more...
- diffservcode_rev (Alias name: diffservcode-rev) Diffservcode rev. type: str more...
- disclaimer Disclaimer. type: str choices: [disable, enable, user, domain, policy] more...
- dlp_sensor (Alias name: dlp-sensor) Dlp sensor. type: list or str more...
- dnsfilter_profile (Alias name: dnsfilter-profile) Dnsfilter profile. type: str more...
- dponly Dponly. type: str choices: [disable, enable] more...
- dscp_match (Alias name: dscp-match) Dscp match. type: str choices: [disable, enable] more...
- dscp_negate (Alias name: dscp-negate) Dscp negate. type: str choices: [disable, enable] more...
- dscp_value (Alias name: dscp-value) Dscp value. type: str more...
- dsri Dsri. type: str choices: [disable, enable] more...
- dstaddr Dstaddr. type: list or str more...
- dstaddr_negate (Alias name: dstaddr-negate) Dstaddr negate. type: str choices: [disable, enable] more...
- dstaddr6 Dstaddr6. type: list or str more...
- dstintf Dstintf. type: list or str more...
- dynamic_profile (Alias name: dynamic-profile) Dynamic profile. type: str choices: [disable, enable] more...
- dynamic_profile_access (Alias name: dynamic-profile-access) Dynamic profile access. type: list choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, ftps, ssh] more...
- dynamic_profile_fallthrough (Alias name: dynamic-profile-fallthrough) Dynamic profile fallthrough. type: str choices: [disable, enable] more...
- dynamic_profile_group (Alias name: dynamic-profile-group) Dynamic profile group. type: list or str more...
- email_collect (Alias name: email-collect) Email collect. type: str choices: [disable, enable] more...
- email_collection_portal (Alias name: email-collection-portal) Email collection portal. type: str choices: [disable, enable] more...
- emailfilter_profile (Alias name: emailfilter-profile) Emailfilter profile. type: str more...
- endpoint_check (Alias name: endpoint-check) Endpoint check. type: str choices: [disable, enable] more...
- endpoint_compliance (Alias name: endpoint-compliance) Endpoint compliance. type: str choices: [disable, enable] more...
- endpoint_keepalive_interface (Alias name: endpoint-keepalive-interface) Endpoint keepalive interface. type: list or str more...
- endpoint_profile (Alias name: endpoint-profile) Endpoint profile. type: list or str more...
- failed_connection (Alias name: failed-connection) Failed connection. type: str choices: [disable, enable] more...
- fall_through_unauthenticated (Alias name: fall-through-unauthenticated) Fall through unauthenticated. type: str choices: [disable, enable] more...
- firewall_session_dirty (Alias name: firewall-session-dirty) Firewall session dirty. type: str choices: [check-all, check-new] more...
- fixedport Fixedport. type: str choices: [disable, enable] more...
- forticlient_compliance_devices (Alias name: forticlient-compliance-devices) Forticlient compliance devices. type: list choices: [windows-pc, mac, iphone-ipad, android] more...
- forticlient_compliance_enforcement_portal (Alias name: forticlient-compliance-enforcement-portal) Forticlient compliance enforcement portal. type: str choices: [disable, enable] more...
- fsae Fsae. type: str choices: [disable, enable] more...
- fsae_server_for_ntlm (Alias name: fsae-server-for-ntlm) Fsae server for ntlm. type: list or str more...
- fsso Fsso. type: str choices: [disable, enable] more...
- fsso_agent_for_ntlm (Alias name: fsso-agent-for-ntlm) Fsso agent for ntlm. type: str more...
- geo_location (Alias name: geo-location) Geo location. type: str choices: [disable, enable] more...
- geoip_anycast (Alias name: geoip-anycast) Geoip anycast. type: str choices: [disable, enable] more...
- global_label (Alias name: global-label) Global label. type: str more...
- groups Groups. type: list or str more...
- gtp_profile (Alias name: gtp-profile) Gtp profile. type: str more...
- http_policy_redirect (Alias name: http-policy-redirect) Http policy redirect. type: str choices: [disable, enable] more...
- icap_profile (Alias name: icap-profile) Icap profile. type: str more...
- identity_based (Alias name: identity-based) Identity based. type: str choices: [disable, enable] more...
- identity_based_policy (Alias name: identity-based-policy) Identity based policy. type: list
more...
- action Action. type: str choices: [deny, accept] more...
- application_charts (Alias name: application-charts) Application charts. type: list choices: [top10-app, top10-p2p-user, top10-media-user] more...
- application_list (Alias name: application-list) Application list. type: str more...
- av_profile (Alias name: av-profile) Av profile. type: str more...
- capture_packet (Alias name: capture-packet) Capture packet. type: str choices: [disable, enable] more...
- deep_inspection_options (Alias name: deep-inspection-options) Deep inspection options. type: str more...
- devices Devices. type: str more...
- dlp_sensor (Alias name: dlp-sensor) Dlp sensor. type: str more...
- dstaddr Dstaddr. type: str more...
- dstaddr_negate (Alias name: dstaddr-negate) Dstaddr negate. type: str choices: [disable, enable] more...
- endpoint_compliance (Alias name: endpoint-compliance) Endpoint compliance. type: str choices: [disable, enable] more...
- groups Groups. type: str more...
- icap_profile (Alias name: icap-profile) Icap profile. type: str more...
- id Id. type: int more...
- ips_sensor (Alias name: ips-sensor) Ips sensor. type: str more...
- logtraffic Logtraffic. type: str choices: [disable, enable, all, utm] more...
- logtraffic_app (Alias name: logtraffic-app) Logtraffic app. type: str choices: [disable, enable] more...
- logtraffic_start (Alias name: logtraffic-start) Logtraffic start. type: str choices: [disable, enable] more...
- mms_profile (Alias name: mms-profile) Mms profile. type: str more...
- per_ip_shaper (Alias name: per-ip-shaper) Per ip shaper. type: str more...
- profile_group (Alias name: profile-group) Profile group. type: str more...
- profile_protocol_options (Alias name: profile-protocol-options) Profile protocol options. type: str more...
- profile_type (Alias name: profile-type) Profile type. type: str choices: [single, group] more...
- replacemsg_group (Alias name: replacemsg-group) Replacemsg group. type: str more...
- schedule Schedule. type: str more...
- send_deny_packet (Alias name: send-deny-packet) Send deny packet. type: str choices: [disable, enable] more...
- service Service. type: str more...
- service_negate (Alias name: service-negate) Service negate. type: str choices: [disable, enable] more...
- spamfilter_profile (Alias name: spamfilter-profile) Spamfilter profile. type: str more...
- sslvpn_portal (Alias name: sslvpn-portal) Sslvpn portal. type: str more...
- sslvpn_realm (Alias name: sslvpn-realm) Sslvpn realm. type: str more...
- traffic_shaper (Alias name: traffic-shaper) Traffic shaper. type: str more...
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) Traffic shaper reverse. type: str more...
- users Users. type: str more...
- utm_status (Alias name: utm-status) Utm status. type: str choices: [disable, enable] more...
- voip_profile (Alias name: voip-profile) Voip profile. type: str more...
- webfilter_profile (Alias name: webfilter-profile) Webfilter profile. type: str more...
- identity_based_route (Alias name: identity-based-route) Identity based route. type: str more...
- identity_from (Alias name: identity-from) Identity from. type: str choices: [auth, device] more...
- inbound Inbound. type: str choices: [disable, enable] more...
- inspection_mode (Alias name: inspection-mode) Inspection mode. type: str choices: [proxy, flow] more...
- internet_service (Alias name: internet-service) Internet service. type: str choices: [disable, enable] more...
- internet_service_custom (Alias name: internet-service-custom) Internet service custom. type: list or str more...
- internet_service_custom_group (Alias name: internet-service-custom-group) Internet service custom group. type: list or str more...
- internet_service_group (Alias name: internet-service-group) Internet service group. type: list or str more...
- internet_service_id (Alias name: internet-service-id) Internet service id. type: list or str more...
- internet_service_negate (Alias name: internet-service-negate) Internet service negate. type: str choices: [disable, enable] more...
- internet_service_src (Alias name: internet-service-src) Internet service src. type: str choices: [disable, enable] more...
- internet_service_src_custom (Alias name: internet-service-src-custom) Internet service src custom. type: list or str more...
- internet_service_src_custom_group (Alias name: internet-service-src-custom-group) Internet service src custom group. type: list or str more...
- internet_service_src_group (Alias name: internet-service-src-group) Internet service src group. type: list or str more...
- internet_service_src_id (Alias name: internet-service-src-id) Internet service src id. type: list or str more...
- internet_service_src_negate (Alias name: internet-service-src-negate) Internet service src negate. type: str choices: [disable, enable] more...
- ip_based (Alias name: ip-based) Ip based. type: str choices: [disable, enable] more...
- ippool Ippool. type: str choices: [disable, enable] more...
- ips_sensor (Alias name: ips-sensor) Ips sensor. type: str more...
- label Label. type: str more...
- learning_mode (Alias name: learning-mode) Learning mode. type: str choices: [disable, enable] more...
- log_unmatched_traffic (Alias name: log-unmatched-traffic) Log unmatched traffic. type: str choices: [disable, enable] more...
- logtraffic Logtraffic. type: str choices: [disable, enable, all, utm] more...
- logtraffic_app (Alias name: logtraffic-app) Logtraffic app. type: str choices: [disable, enable] more...
- logtraffic_start (Alias name: logtraffic-start) Logtraffic start. type: str choices: [disable, enable] more...
- match_vip (Alias name: match-vip) Match vip. type: str choices: [disable, enable] more...
- mms_profile (Alias name: mms-profile) Mms profile. type: list or str more...
- name Name. type: str more...
- nat Nat. type: str choices: [disable, enable] more...
- natinbound Natinbound. type: str choices: [disable, enable] more...
- natip Natip. type: str more...
- natoutbound Natoutbound. type: str choices: [disable, enable] more...
- np_acceleration (Alias name: np-acceleration) Np acceleration. type: str choices: [disable, enable] more...
- ntlm Ntlm. type: str choices: [disable, enable] more...
- ntlm_enabled_browsers (Alias name: ntlm-enabled-browsers) Ntlm enabled browsers. type: list more...
- ntlm_guest (Alias name: ntlm-guest) Ntlm guest. type: str choices: [disable, enable] more...
- outbound Outbound. type: str choices: [disable, enable] more...
- per_ip_shaper (Alias name: per-ip-shaper) Per ip shaper. type: str more...
- permit_any_host (Alias name: permit-any-host) Permit any host. type: str choices: [disable, enable] more...
- permit_stun_host (Alias name: permit-stun-host) Permit stun host. type: str choices: [disable, enable] more...
- policyid Policyid. type: int more...
- poolname Poolname. type: list or str more...
- profile_group (Alias name: profile-group) Profile group. type: str more...
- profile_protocol_options (Alias name: profile-protocol-options) Profile protocol options. type: str more...
- profile_type (Alias name: profile-type) Profile type. type: str choices: [single, group] more...
- radius_mac_auth_bypass (Alias name: radius-mac-auth-bypass) Radius mac auth bypass. type: str choices: [disable, enable] more...
- redirect_url (Alias name: redirect-url) Redirect url. type: str more...
- replacemsg_group (Alias name: replacemsg-group) Replacemsg group. type: list or str more...
- replacemsg_override_group (Alias name: replacemsg-override-group) Replacemsg override group. type: str more...
- reputation_direction (Alias name: reputation-direction) Reputation direction. type: str choices: [source, destination] more...
- reputation_minimum (Alias name: reputation-minimum) Reputation minimum. type: int more...
- require_tfa (Alias name: require-tfa) Require tfa. type: str choices: [disable, enable] more...
- rsso Rsso. type: str choices: [disable, enable] more...
- rtp_addr (Alias name: rtp-addr) Rtp addr. type: list or str more...
- rtp_nat (Alias name: rtp-nat) Rtp nat. type: str choices: [disable, enable] more...
- scan_botnet_connections (Alias name: scan-botnet-connections) Scan botnet connections. type: str choices: [disable, block, monitor] more...
- schedule Schedule. type: str more...
- schedule_timeout (Alias name: schedule-timeout) Schedule timeout. type: str choices: [disable, enable] more...
- send_deny_packet (Alias name: send-deny-packet) Send deny packet. type: str choices: [disable, enable] more...
- service Service. type: list or str more...
- service_negate (Alias name: service-negate) Service negate. type: str choices: [disable, enable] more...
- session_ttl (Alias name: session-ttl) Session ttl. type: int or str more...
- sessions Sessions. type: str choices: [disable, enable] more...
- spamfilter_profile (Alias name: spamfilter-profile) Spamfilter profile. type: list or str more...
- srcaddr Srcaddr. type: list or str more...
- srcaddr_negate (Alias name: srcaddr-negate) Srcaddr negate. type: str choices: [disable, enable] more...
- srcaddr6 Srcaddr6. type: list or str more...
- srcintf Srcintf. type: list or str more...
- ssh_filter_profile (Alias name: ssh-filter-profile) Ssh filter profile. type: str more...
- ssh_policy_redirect (Alias name: ssh-policy-redirect) Ssh policy redirect. type: str choices: [disable, enable] more...
- ssl_mirror (Alias name: ssl-mirror) Ssl mirror. type: str choices: [disable, enable] more...
- ssl_mirror_intf (Alias name: ssl-mirror-intf) Ssl mirror intf. type: list or str more...
- ssl_ssh_profile (Alias name: ssl-ssh-profile) Ssl ssh profile. type: str more...
- sslvpn_auth (Alias name: sslvpn-auth) Sslvpn auth. type: str choices: [any, local, radius, ldap, tacacs+] more...
- sslvpn_ccert (Alias name: sslvpn-ccert) Sslvpn ccert. type: str choices: [disable, enable] more...
- sslvpn_cipher (Alias name: sslvpn-cipher) Sslvpn cipher. type: str choices: [any, high, medium] more...
- sso_auth_method (Alias name: sso-auth-method) Sso auth method. type: str choices: [fsso, rsso] more...
- status Status. type: str choices: [disable, enable] more...
- tags Tags. type: list or str more...
- tcp_mss_receiver (Alias name: tcp-mss-receiver) Tcp mss receiver. type: int more...
- tcp_mss_sender (Alias name: tcp-mss-sender) Tcp mss sender. type: int more...
- tcp_reset (Alias name: tcp-reset) Tcp reset. type: str choices: [disable, enable] more...
- tcp_session_without_syn (Alias name: tcp-session-without-syn) Tcp session without syn. type: str choices: [all, data-only, disable] more...
- timeout_send_rst (Alias name: timeout-send-rst) Timeout send rst. type: str choices: [disable, enable] more...
- tos Tos. type: str more...
- tos_mask (Alias name: tos-mask) Tos mask. type: str more...
- tos_negate (Alias name: tos-negate) Tos negate. type: str choices: [disable, enable] more...
- traffic_shaper (Alias name: traffic-shaper) Traffic shaper. type: str more...
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) Traffic shaper reverse. type: str more...
- transaction_based (Alias name: transaction-based) Transaction based. type: str choices: [disable, enable] more...
- url_category (Alias name: url-category) Url category. type: list or str more...
- users Users. type: list or str more...
- utm_inspection_mode (Alias name: utm-inspection-mode) Utm inspection mode. type: str choices: [proxy, flow] more...
- utm_status (Alias name: utm-status) Utm status. type: str choices: [disable, enable] more...
- uuid Uuid. type: str more...
- vlan_cos_fwd (Alias name: vlan-cos-fwd) Vlan cos fwd. type: int more...
- vlan_cos_rev (Alias name: vlan-cos-rev) Vlan cos rev. type: int more...
- vlan_filter (Alias name: vlan-filter) Vlan filter. type: str more...
- voip_profile (Alias name: voip-profile) Voip profile. type: str more...
- vpntunnel Vpntunnel. type: str more...
- waf_profile (Alias name: waf-profile) Waf profile. type: str more...
- wanopt Wanopt. type: str choices: [disable, enable] more...
- wanopt_detection (Alias name: wanopt-detection) Wanopt detection. type: str choices: [active, passive, off] more...
- wanopt_passive_opt (Alias name: wanopt-passive-opt) Wanopt passive opt. type: str choices: [default, transparent, non-transparent] more...
- wanopt_peer (Alias name: wanopt-peer) Wanopt peer. type: str more...
- wanopt_profile (Alias name: wanopt-profile) Wanopt profile. type: str more...
- wccp Wccp. type: str choices: [disable, enable] more...
- web_auth_cookie (Alias name: web-auth-cookie) Web auth cookie. type: str choices: [disable, enable] more...
- webcache Webcache. type: str choices: [disable, enable] more...
- webcache_https (Alias name: webcache-https) Webcache https. type: str choices: [disable, ssl-server, any, enable] more...
- webfilter_profile (Alias name: webfilter-profile) Webfilter profile. type: str more...
- webproxy_forward_server (Alias name: webproxy-forward-server) Webproxy forward server. type: str more...
- webproxy_profile (Alias name: webproxy-profile) Webproxy profile. type: str more...
- wsso Wsso. type: str choices: [disable, enable] more...
- fsso_groups (Alias name: fsso-groups) Fsso groups. type: list or str more...
- match_vip_only (Alias name: match-vip-only) Match vip only. type: str choices: [disable, enable] more...
- np_accelation (Alias name: np-accelation) Np accelation. type: str choices: [disable, enable] more...
- best_route (Alias name: best-route) Best route. type: str choices: [disable, enable] more...
- decrypted_traffic_mirror (Alias name: decrypted-traffic-mirror) Decrypted traffic mirror. type: str more...
- geoip_match (Alias name: geoip-match) Geoip match. type: str choices: [physical-location, registered-location] more...
- internet_service_name (Alias name: internet-service-name) Internet service name. type: list or str more...
- internet_service_src_name (Alias name: internet-service-src-name) Internet service src name. type: list or str more...
- poolname6 Poolname6. type: list or str more...
- src_vendor_mac (Alias name: src-vendor-mac) Src vendor mac. type: list or str more...
- vendor_mac (Alias name: vendor-mac) Vendor mac. type: list or str more...
- file_filter_profile (Alias name: file-filter-profile) File filter profile. type: str more...
- cgn_eif (Alias name: cgn-eif) Enable/disable cgn endpoint independent filtering. type: str choices: [disable, enable] more...
- cgn_eim (Alias name: cgn-eim) Enable/disable cgn endpoint independent mapping type: str choices: [disable, enable] more...
- cgn_log_server_grp (Alias name: cgn-log-server-grp) Np log server group name type: list or str more...
- cgn_resource_quota (Alias name: cgn-resource-quota) Resource quota type: int more...
- cgn_session_quota (Alias name: cgn-session-quota) Session quota type: int more...
- policy_offload (Alias name: policy-offload) Enable/disable hardware session setup for cgnat. type: str choices: [disable, enable] more...
- dynamic_shaping (Alias name: dynamic-shaping) Enable/disable dynamic radius defined traffic shaping. type: str choices: [disable, enable] more...
- passive_wan_health_measurement (Alias name: passive-wan-health-measurement) Enable/disable passive wan health measurement. type: str choices: [disable, enable] more...
- videofilter_profile (Alias name: videofilter-profile) Name of an existing videofilter profile. type: str more...
- ztna_ems_tag (Alias name: ztna-ems-tag) Source ztna-ems-tag names. type: list or str more...
- ztna_geo_tag (Alias name: ztna-geo-tag) Source ztna-geo-tag names. type: list or str more...
- ztna_status (Alias name: ztna-status) Enable/disable zero trust access. type: str choices: [disable, enable] more...
- access_proxy (Alias name: access-proxy) Access proxy. type: list more...
- dlp_profile (Alias name: dlp-profile) Name of an existing dlp profile. type: str more...
- dynamic_bypass (Alias name: dynamic-bypass) Dynamic bypass. type: str choices: [disable, enable] more...
- fec Enable/disable forward error correction on traffic matching this policy on a fec device. type: str choices: [disable, enable] more...
- force_proxy (Alias name: force-proxy) Force proxy. type: str choices: [disable, enable] more...
- http_tunnel_auth (Alias name: http-tunnel-auth) Http tunnel auth. type: str choices: [disable, enable] more...
- ia_profile (Alias name: ia-profile) Ia profile. type: list more...
- isolator_server (Alias name: isolator-server) Isolator server. type: list more...
- log_http_transaction (Alias name: log-http-transaction) Log http transaction. type: str choices: [disable, enable, all, utm] more...
- max_session_per_user (Alias name: max-session-per-user) Max session per user. type: int more...
- nat46 Enable/disable nat46. type: str choices: [disable, enable] more...
- nat64 Enable/disable nat64. type: str choices: [disable, enable] more...
- pass_through (Alias name: pass-through) Pass through. type: str choices: [disable, enable] more...
- pfcp_profile (Alias name: pfcp-profile) Pfcp profile. type: str more...
- policy_expiry (Alias name: policy-expiry) Enable/disable policy expiry. type: str choices: [disable, enable] more...
- policy_expiry_date (Alias name: policy-expiry-date) Policy expiry date (yyyy-mm-dd hh:mm:ss). type: str more...
- reverse_cache (Alias name: reverse-cache) Reverse cache. type: str choices: [disable, enable] more...
- sctp_filter_profile (Alias name: sctp-filter-profile) Name of an existing sctp filter profile. type: str more...
- sgt Security group tags. type: list more...
- sgt_check (Alias name: sgt-check) Enable/disable security group tags (sgt) check. type: str choices: [disable, enable] more...
- tcp_timeout_pid (Alias name: tcp-timeout-pid) Tcp timeout profile id type: list more...
- transparent Transparent. type: str choices: [disable, enable] more...
- type Type. type: str choices: [explicit-web, transparent, explicit-ftp, ssh-tunnel, ssh, wanopt, access-proxy] more...
- udp_timeout_pid (Alias name: udp-timeout-pid) Udp timeout profile id type: list more...
- ztna_tags_match_logic (Alias name: ztna-tags-match-logic) Ztna tags match logic. type: str choices: [or, and] more...
- uuid_idx (Alias name: uuid-idx) Uuid idx. type: int more...
- device_ownership (Alias name: device-ownership) Device ownership. type: str choices: [disable, enable] more...
- ssh_policy_check (Alias name: ssh-policy-check) Ssh policy check. type: str choices: [disable, enable] more...
- extended_log (Alias name: extended-log) Extended log. type: str choices: [disable, enable] more...
- 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...
- dstaddr6_negate (Alias name: dstaddr6-negate) When enabled dstaddr6 specifies what the destination address must not be. type: str choices: [disable, enable] more...
- internet_service6 (Alias name: internet-service6) Enable/disable use of ipv6 internet services for this policy. type: str choices: [disable, enable] more...
- internet_service6_custom (Alias name: internet-service6-custom) Custom ipv6 internet service name. type: list more...
- internet_service6_custom_group (Alias name: internet-service6-custom-group) Custom internet service6 group name. type: list more...
- internet_service6_group (Alias name: internet-service6-group) Internet service group name. type: list more...
- internet_service6_name (Alias name: internet-service6-name) Ipv6 internet service name. type: list more...
- 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...
- 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...
- internet_service6_src_custom (Alias name: internet-service6-src-custom) Custom ipv6 internet service source name. type: list more...
- internet_service6_src_custom_group (Alias name: internet-service6-src-custom-group) Custom internet service6 source group name. type: list more...
- internet_service6_src_group (Alias name: internet-service6-src-group) Internet service6 source group name. type: list more...
- internet_service6_src_name (Alias name: internet-service6-src-name) Ipv6 internet service source name. type: list more...
- 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...
- network_service_dynamic (Alias name: network-service-dynamic) Dynamic network service name. type: list more...
- network_service_src_dynamic (Alias name: network-service-src-dynamic) Dynamic network service source name. type: list more...
- reputation_direction6 (Alias name: reputation-direction6) Direction of the initial traffic for ipv6 reputation to take effect. type: str choices: [source, destination] more...
- reputation_minimum6 (Alias name: reputation-minimum6) Ipv6 minimum reputation to take action. type: int more...
- srcaddr6_negate (Alias name: srcaddr6-negate) When enabled srcaddr6 specifies what the source address must not be. type: str choices: [disable, enable] more...
- _policy_block Assigned policy block. type: int more...
- isolator_profile (Alias name: isolator-profile) Isolator profile. type: list more...
- policy_expiry_date_utc (Alias name: policy-expiry-date-utc) Policy expiry date and time, in epoch format. type: str more...
- ztna_device_ownership (Alias name: ztna-device-ownership) Enable/disable zero trust device ownership. type: str choices: [disable, enable] more...
- ztna_policy_redirect (Alias name: ztna-policy-redirect) Redirect ztna traffic to matching access-proxy proxy-policy. type: str choices: [disable, enable] more...
- ip_version_type (Alias name: ip-version-type) Ip version of the policy. type: str more...
- ips_voip_filter (Alias name: ips-voip-filter) Name of an existing voip (ips) profile. type: str more...
- policy_behaviour_type (Alias name: policy-behaviour-type) Behaviour of the policy. type: str more...
- pcp_inbound (Alias name: pcp-inbound) Enable/disable pcp inbound dnat. type: str choices: [disable, enable] more...
- pcp_outbound (Alias name: pcp-outbound) Enable/disable pcp outbound snat. type: str choices: [disable, enable] more...
- pcp_poolname (Alias name: pcp-poolname) Pcp pool names. type: list more...
- ztna_ems_tag_secondary (Alias name: ztna-ems-tag-secondary) Source ztna-ems-tag-secondary names. type: list more...
- casb_profile (Alias name: casb-profile) Name of an existing casb profile. type: str more...
- implicit_proxy_detection (Alias name: implicit-proxy-detection) Implicit proxy detection. type: str choices: [disable, enable] more...
- virtual_patch_profile (Alias name: virtual-patch-profile) Name of an existing virtual-patch profile. type: str more...
- detect_https_in_http_request (Alias name: detect-https-in-http-request) Detect https in http request. type: str choices: [disable, enable] more...
- diameter_filter_profile (Alias name: diameter-filter-profile) Name of an existing diameter filter profile. type: str more...
- redirect_profile (Alias name: redirect-profile) Redirect profile. type: list more...
- 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...
- cgn_sw_eif_ctrl (Alias name: cgn-sw-eif-ctrl) Enable/disable software endpoint independent filtering control. type: str choices: [disable, enable] more...
- eif_check (Alias name: eif-check) Enable/disable check endpoint-independent-filtering pinhole. type: str choices: [disable, enable] more...
- eif_learn (Alias name: eif-learn) Enable/disable learning of end-point-independent filtering pinhole. type: str choices: [disable, enable] more...
- radius_ip_auth_bypass (Alias name: radius-ip-auth-bypass) Enable ip authentication bypass. type: str choices: [disable, enable] more...
- url_risk (Alias name: url-risk) Url risk. type: list more...
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
- 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 header policies.
fortinet.fortimanager.fmgr_pkg_header_policy:
bypass_validation: false
pkg: ansible
state: present
pkg_header_policy:
action: accept # <value in [deny, accept, ipsec, ...]>
comments: "ansible-comment"
dstaddr: gall
dstintf: any
name: ansible-test-header
policyid: 1073741826 # must larger than 2^30(1074741824), since header/footer policy is a special policy
schedule: galways
service: gALL
srcaddr: gall
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 header policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_header_policy"
params:
pkg: "ansible"
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:
- 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.