fortinet.fortimanager.fmgr_pkg_footer_policy (2.4.0) — module

Configure IPv4/IPv6 policies.

| "added in version" 2.0.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
pkg:
    description: The parameter (pkg) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

pkg_footer_policy:
    description: The top level parameters set.
    required: false
    suboptions:
      _policy_block:
        description: Assigned policy block.
        type: int
      access-proxy:
        description: (list) Deprecated, please rename it to access_proxy.
        type: raw
      action:
        choices:
        - deny
        - accept
        - ipsec
        - ssl-vpn
        - redirect
        - isolate
        description: No description.
        type: str
      active-auth-method:
        choices:
        - ntlm
        - basic
        - digest
        - form
        description: Deprecated, please rename it to active_auth_method.
        type: str
      anti-replay:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to anti_replay.
        type: str
      app-category:
        description: (list or str) Deprecated, please rename it to app_category.
        type: raw
      app-group:
        description: (list or str) Deprecated, please rename it to app_group.
        type: raw
      application:
        description: (list) No description.
        type: raw
      application-charts:
        choices:
        - top10-app
        - top10-p2p-user
        - top10-media-user
        description: Deprecated, please rename it to application_charts.
        elements: str
        type: list
      application-list:
        description: Deprecated, please rename it to application_list.
        type: str
      auth-cert:
        description: Deprecated, please rename it to auth_cert.
        type: str
      auth-method:
        choices:
        - basic
        - digest
        - ntlm
        - fsae
        - form
        - fsso
        - rsso
        description: Deprecated, please rename it to auth_method.
        type: str
      auth-path:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auth_path.
        type: str
      auth-portal:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auth_portal.
        type: str
      auth-redirect-addr:
        description: Deprecated, please rename it to auth_redirect_addr.
        type: str
      auto-asic-offload:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auto_asic_offload.
        type: str
      av-profile:
        description: Deprecated, please rename it to av_profile.
        type: str
      bandwidth:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      best-route:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to best_route.
        type: str
      block-notification:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to block_notification.
        type: str
      captive-portal-exempt:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to captive_portal_exempt.
        type: str
      capture-packet:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to capture_packet.
        type: str
      casb-profile:
        description: Deprecated, please rename it to casb_profile. Name of an existing
          CASB profile.
        type: str
      casi-profile:
        description: (list or str) Deprecated, please rename it to casi_profile.
        type: raw
      central-nat:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to central_nat.
        type: str
      cgn-eif:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to cgn_eif. Enable/Disable CGN endpoint
          independent filtering.
        type: str
      cgn-eim:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to cgn_eim. Enable/Disable CGN endpoint
          independent mapping
        type: str
      cgn-log-server-grp:
        description: (list or str) Deprecated, please rename it to cgn_log_server_grp.
          NP log server group name
        type: raw
      cgn-resource-quota:
        description: Deprecated, please rename it to cgn_resource_quota. Resource quota
        type: int
      cgn-session-quota:
        description: Deprecated, please rename it to cgn_session_quota. Session quota
        type: int
      cifs-profile:
        description: Deprecated, please rename it to cifs_profile.
        type: str
      client-reputation:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to client_reputation.
        type: str
      client-reputation-mode:
        choices:
        - learning
        - monitoring
        description: Deprecated, please rename it to client_reputation_mode.
        type: str
      comments:
        description: (dict or str) No description.
        type: raw
      custom-log-fields:
        description: (list or str) Deprecated, please rename it to custom_log_fields.
        type: raw
      decrypted-traffic-mirror:
        description: Deprecated, please rename it to decrypted_traffic_mirror.
        type: str
      deep-inspection-options:
        description: (list or str) Deprecated, please rename it to deep_inspection_options.
        type: raw
      delay-tcp-npu-session:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to delay_tcp_npu_session.
        type: str
      delay-tcp-npu-sessoin:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to delay_tcp_npu_sessoin.
        type: str
      detect-https-in-http-request:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to detect_https_in_http_request.
        type: str
      device-detection-portal:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to device_detection_portal.
        type: str
      device-ownership:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to device_ownership.
        type: str
      devices:
        description: (list or str) No description.
        type: raw
      diameter-filter-profile:
        description: Deprecated, please rename it to diameter_filter_profile. Name of
          an existing Diameter filter profile.
        type: str
      diffserv-copy:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to diffserv_copy. Enable to copy packets
          DiffServ values from sessions original direction to ...
        type: str
      diffserv-forward:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to diffserv_forward.
        type: str
      diffserv-reverse:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to diffserv_reverse.
        type: str
      diffservcode-forward:
        description: Deprecated, please rename it to diffservcode_forward.
        type: str
      diffservcode-rev:
        description: Deprecated, please rename it to diffservcode_rev.
        type: str
      disclaimer:
        choices:
        - disable
        - enable
        - user
        - domain
        - policy
        description: No description.
        type: str
      dlp-profile:
        description: Deprecated, please rename it to dlp_profile. Name of an existing
          DLP profile.
        type: str
      dlp-sensor:
        description: (list or str) Deprecated, please rename it to dlp_sensor.
        type: raw
      dnsfilter-profile:
        description: Deprecated, please rename it to dnsfilter_profile.
        type: str
      dponly:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      dscp-match:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dscp_match.
        type: str
      dscp-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dscp_negate.
        type: str
      dscp-value:
        description: Deprecated, please rename it to dscp_value.
        type: str
      dsri:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      dstaddr:
        description: (list or str) No description.
        type: raw
      dstaddr-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dstaddr_negate.
        type: str
      dstaddr6:
        description: (list or str) No description.
        type: raw
      dstaddr6-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dstaddr6_negate. When enabled dstaddr6
          specifies what the destination address must NOT be.
        type: str
      dstintf:
        description: (list or str) No description.
        type: raw
      dynamic-bypass:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dynamic_bypass.
        type: str
      dynamic-profile:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dynamic_profile.
        type: str
      dynamic-profile-access:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - im
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - ssh
        description: Deprecated, please rename it to dynamic_profile_access.
        elements: str
        type: list
      dynamic-profile-fallthrough:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dynamic_profile_fallthrough.
        type: str
      dynamic-profile-group:
        description: (list or str) Deprecated, please rename it to dynamic_profile_group.
        type: raw
      dynamic-shaping:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dynamic_shaping. Enable/disable dynamic
          RADIUS defined traffic shaping.
        type: str
      email-collect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to email_collect.
        type: str
      email-collection-portal:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to email_collection_portal.
        type: str
      emailfilter-profile:
        description: Deprecated, please rename it to emailfilter_profile.
        type: str
      endpoint-check:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to endpoint_check.
        type: str
      endpoint-compliance:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to endpoint_compliance.
        type: str
      endpoint-keepalive-interface:
        description: (list or str) Deprecated, please rename it to endpoint_keepalive_interface.
        type: raw
      endpoint-profile:
        description: (list or str) Deprecated, please rename it to endpoint_profile.
        type: raw
      extended-log:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to extended_log.
        type: str
      failed-connection:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to failed_connection.
        type: str
      fall-through-unauthenticated:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to fall_through_unauthenticated.
        type: str
      fec:
        choices:
        - disable
        - enable
        description: Enable/disable Forward Error Correction on traffic matching this
          policy on a FEC device.
        type: str
      file-filter-profile:
        description: Deprecated, please rename it to file_filter_profile.
        type: str
      firewall-session-dirty:
        choices:
        - check-all
        - check-new
        description: Deprecated, please rename it to firewall_session_dirty.
        type: str
      fixedport:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      force-proxy:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to force_proxy.
        type: str
      forticlient-compliance-devices:
        choices:
        - windows-pc
        - mac
        - iphone-ipad
        - android
        description: Deprecated, please rename it to forticlient_compliance_devices.
        elements: str
        type: list
      forticlient-compliance-enforcement-portal:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to forticlient_compliance_enforcement_portal.
        type: str
      fsae:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      fsae-server-for-ntlm:
        description: (list or str) Deprecated, please rename it to fsae_server_for_ntlm.
        type: raw
      fsso:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      fsso-agent-for-ntlm:
        description: Deprecated, please rename it to fsso_agent_for_ntlm.
        type: str
      fsso-groups:
        description: (list or str) Deprecated, please rename it to fsso_groups.
        type: raw
      geo-location:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to geo_location.
        type: str
      geoip-anycast:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to geoip_anycast.
        type: str
      geoip-match:
        choices:
        - physical-location
        - registered-location
        description: Deprecated, please rename it to geoip_match.
        type: str
      global-label:
        description: Deprecated, please rename it to global_label.
        type: str
      groups:
        description: (list or str) No description.
        type: raw
      gtp-profile:
        description: Deprecated, please rename it to gtp_profile.
        type: str
      http-policy-redirect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to http_policy_redirect.
        type: str
      http-tunnel-auth:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to http_tunnel_auth.
        type: str
      ia-profile:
        description: (list) Deprecated, please rename it to ia_profile.
        type: raw
      icap-profile:
        description: Deprecated, please rename it to icap_profile.
        type: str
      identity-based:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to identity_based.
        type: str
      identity-based-policy:
        description: Deprecated, please rename it to identity_based_policy.
        elements: dict
        suboptions:
          action:
            choices:
            - deny
            - accept
            description: No description.
            type: str
          application-charts:
            choices:
            - top10-app
            - top10-p2p-user
            - top10-media-user
            description: Deprecated, please rename it to application_charts.
            elements: str
            type: list
          application-list:
            description: Deprecated, please rename it to application_list.
            type: str
          av-profile:
            description: Deprecated, please rename it to av_profile.
            type: str
          capture-packet:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to capture_packet.
            type: str
          deep-inspection-options:
            description: Deprecated, please rename it to deep_inspection_options.
            type: str
          devices:
            description: No description.
            type: str
          dlp-sensor:
            description: Deprecated, please rename it to dlp_sensor.
            type: str
          dstaddr:
            description: No description.
            type: str
          dstaddr-negate:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to dstaddr_negate.
            type: str
          endpoint-compliance:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to endpoint_compliance.
            type: str
          groups:
            description: No description.
            type: str
          icap-profile:
            description: Deprecated, please rename it to icap_profile.
            type: str
          id:
            description: No description.
            type: int
          ips-sensor:
            description: Deprecated, please rename it to ips_sensor.
            type: str
          logtraffic:
            choices:
            - disable
            - enable
            - all
            - utm
            description: No description.
            type: str
          logtraffic-app:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to logtraffic_app.
            type: str
          logtraffic-start:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to logtraffic_start.
            type: str
          mms-profile:
            description: Deprecated, please rename it to mms_profile.
            type: str
          per-ip-shaper:
            description: Deprecated, please rename it to per_ip_shaper.
            type: str
          profile-group:
            description: Deprecated, please rename it to profile_group.
            type: str
          profile-protocol-options:
            description: Deprecated, please rename it to profile_protocol_options.
            type: str
          profile-type:
            choices:
            - single
            - group
            description: Deprecated, please rename it to profile_type.
            type: str
          replacemsg-group:
            description: Deprecated, please rename it to replacemsg_group.
            type: str
          schedule:
            description: No description.
            type: str
          send-deny-packet:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to send_deny_packet.
            type: str
          service:
            description: No description.
            type: str
          service-negate:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to service_negate.
            type: str
          spamfilter-profile:
            description: Deprecated, please rename it to spamfilter_profile.
            type: str
          sslvpn-portal:
            description: Deprecated, please rename it to sslvpn_portal.
            type: str
          sslvpn-realm:
            description: Deprecated, please rename it to sslvpn_realm.
            type: str
          traffic-shaper:
            description: Deprecated, please rename it to traffic_shaper.
            type: str
          traffic-shaper-reverse:
            description: Deprecated, please rename it to traffic_shaper_reverse.
            type: str
          users:
            description: No description.
            type: str
          utm-status:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to utm_status.
            type: str
          voip-profile:
            description: Deprecated, please rename it to voip_profile.
            type: str
          webfilter-profile:
            description: Deprecated, please rename it to webfilter_profile.
            type: str
        type: list
      identity-based-route:
        description: Deprecated, please rename it to identity_based_route.
        type: str
      identity-from:
        choices:
        - auth
        - device
        description: Deprecated, please rename it to identity_from.
        type: str
      implicit-proxy-detection:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to implicit_proxy_detection.
        type: str
      inbound:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      inspection-mode:
        choices:
        - proxy
        - flow
        description: Deprecated, please rename it to inspection_mode.
        type: str
      internet-service:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service.
        type: str
      internet-service-custom:
        description: (list or str) Deprecated, please rename it to internet_service_custom.
        type: raw
      internet-service-custom-group:
        description: (list or str) Deprecated, please rename it to internet_service_custom_group.
        type: raw
      internet-service-group:
        description: (list or str) Deprecated, please rename it to internet_service_group.
        type: raw
      internet-service-id:
        description: (list or str) Deprecated, please rename it to internet_service_id.
        type: raw
      internet-service-name:
        description: (list or str) Deprecated, please rename it to internet_service_name.
        type: raw
      internet-service-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service_negate.
        type: str
      internet-service-src:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service_src.
        type: str
      internet-service-src-custom:
        description: (list or str) Deprecated, please rename it to internet_service_src_custom.
        type: raw
      internet-service-src-custom-group:
        description: (list or str) Deprecated, please rename it to internet_service_src_custom_group.
        type: raw
      internet-service-src-group:
        description: (list or str) Deprecated, please rename it to internet_service_src_group.
        type: raw
      internet-service-src-id:
        description: (list or str) Deprecated, please rename it to internet_service_src_id.
        type: raw
      internet-service-src-name:
        description: (list or str) Deprecated, please rename it to internet_service_src_name.
        type: raw
      internet-service-src-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service_src_negate.
        type: str
      internet-service6:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service6. Enable/disable
          use of IPv6 Internet Services for this policy.
        type: str
      internet-service6-custom:
        description: (list) Deprecated, please rename it to internet_service6_custom.
        type: raw
      internet-service6-custom-group:
        description: (list) Deprecated, please rename it to internet_service6_custom_group.
        type: raw
      internet-service6-group:
        description: (list) Deprecated, please rename it to internet_service6_group.
        type: raw
      internet-service6-name:
        description: (list) Deprecated, please rename it to internet_service6_name.
        type: raw
      internet-service6-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service6_negate. When enabled
          internet-service6 specifies what the service must N...
        type: str
      internet-service6-src:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service6_src. Enable/disable
          use of IPv6 Internet Services in source for this policy.
        type: str
      internet-service6-src-custom:
        description: (list) Deprecated, please rename it to internet_service6_src_custom.
        type: raw
      internet-service6-src-custom-group:
        description: (list) Deprecated, please rename it to internet_service6_src_custom_group.
        type: raw
      internet-service6-src-group:
        description: (list) Deprecated, please rename it to internet_service6_src_group.
        type: raw
      internet-service6-src-name:
        description: (list) Deprecated, please rename it to internet_service6_src_name.
        type: raw
      internet-service6-src-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to internet_service6_src_negate. When
          enabled internet-service6-src specifies what the servic...
        type: str
      ip-based:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ip_based.
        type: str
      ip-version-type:
        description: Deprecated, please rename it to ip_version_type. IP version of the
          policy.
        type: str
      ippool:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      ips-sensor:
        description: Deprecated, please rename it to ips_sensor.
        type: str
      ips-voip-filter:
        description: Deprecated, please rename it to ips_voip_filter. Name of an existing
          VoIP
        type: str
      isolator-profile:
        description: (list) Deprecated, please rename it to isolator_profile.
        type: raw
      isolator-server:
        description: (list) Deprecated, please rename it to isolator_server.
        type: raw
      label:
        description: No description.
        type: str
      learning-mode:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to learning_mode.
        type: str
      log-http-transaction:
        choices:
        - disable
        - enable
        - all
        - utm
        description: Deprecated, please rename it to log_http_transaction.
        type: str
      log-unmatched-traffic:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to log_unmatched_traffic.
        type: str
      logtraffic:
        choices:
        - disable
        - enable
        - all
        - utm
        description: No description.
        type: str
      logtraffic-app:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to logtraffic_app.
        type: str
      logtraffic-start:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to logtraffic_start.
        type: str
      match-vip:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to match_vip.
        type: str
      match-vip-only:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to match_vip_only.
        type: str
      max-session-per-user:
        description: Deprecated, please rename it to max_session_per_user.
        type: int
      mms-profile:
        description: (list or str) Deprecated, please rename it to mms_profile.
        type: raw
      name:
        description: No description.
        type: str
      nat:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      nat46:
        choices:
        - disable
        - enable
        description: Enable/disable NAT46.
        type: str
      nat64:
        choices:
        - disable
        - enable
        description: Enable/disable NAT64.
        type: str
      natinbound:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      natip:
        description: No description.
        type: str
      natoutbound:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      network-service-dynamic:
        description: (list) Deprecated, please rename it to network_service_dynamic.
        type: raw
      network-service-src-dynamic:
        description: (list) Deprecated, please rename it to network_service_src_dynamic.
        type: raw
      np-accelation:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to np_accelation.
        type: str
      np-acceleration:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to np_acceleration.
        type: str
      ntlm:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      ntlm-enabled-browsers:
        description: (list) Deprecated, please rename it to ntlm_enabled_browsers.
        type: raw
      ntlm-guest:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ntlm_guest.
        type: str
      outbound:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      pass-through:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pass_through.
        type: str
      passive-wan-health-measurement:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to passive_wan_health_measurement. Enable/disable
          passive WAN health measurement.
        type: str
      pcp-inbound:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pcp_inbound. Enable/disable PCP inbound
          DNAT.
        type: str
      pcp-outbound:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pcp_outbound. Enable/disable PCP
          outbound SNAT.
        type: str
      pcp-poolname:
        description: (list) Deprecated, please rename it to pcp_poolname.
        type: raw
      per-ip-shaper:
        description: Deprecated, please rename it to per_ip_shaper.
        type: str
      permit-any-host:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to permit_any_host.
        type: str
      permit-stun-host:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to permit_stun_host.
        type: str
      pfcp-profile:
        description: Deprecated, please rename it to pfcp_profile. PFCP profile.
        type: str
      policy-behaviour-type:
        description: Deprecated, please rename it to policy_behaviour_type. Behaviour
          of the policy.
        type: str
      policy-expiry:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to policy_expiry. Enable/disable policy
          expiry.
        type: str
      policy-expiry-date:
        description: Deprecated, please rename it to policy_expiry_date. Policy expiry
          date
        type: str
      policy-expiry-date-utc:
        description: Deprecated, please rename it to policy_expiry_date_utc. Policy expiry
          date and time, in epoch format.
        type: str
      policy-offload:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to policy_offload. Enable/Disable hardware
          session setup for CGNAT.
        type: str
      policyid:
        description: No description.
        required: true
        type: int
      poolname:
        description: (list or str) No description.
        type: raw
      poolname6:
        description: (list or str) No description.
        type: raw
      profile-group:
        description: Deprecated, please rename it to profile_group.
        type: str
      profile-protocol-options:
        description: Deprecated, please rename it to profile_protocol_options.
        type: str
      profile-type:
        choices:
        - single
        - group
        description: Deprecated, please rename it to profile_type.
        type: str
      radius-mac-auth-bypass:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to radius_mac_auth_bypass.
        type: str
      redirect-profile:
        description: (list) Deprecated, please rename it to redirect_profile.
        type: raw
      redirect-url:
        description: Deprecated, please rename it to redirect_url.
        type: str
      replacemsg-group:
        description: (list or str) Deprecated, please rename it to replacemsg_group.
        type: raw
      replacemsg-override-group:
        description: Deprecated, please rename it to replacemsg_override_group.
        type: str
      reputation-direction:
        choices:
        - source
        - destination
        description: Deprecated, please rename it to reputation_direction.
        type: str
      reputation-direction6:
        choices:
        - source
        - destination
        description: Deprecated, please rename it to reputation_direction6. Direction
          of the initial traffic for IPv6 reputation to take effect.
        type: str
      reputation-minimum:
        description: Deprecated, please rename it to reputation_minimum.
        type: int
      reputation-minimum6:
        description: Deprecated, please rename it to reputation_minimum6. IPv6 Minimum
          Reputation to take action.
        type: int
      require-tfa:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to require_tfa.
        type: str
      reverse-cache:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to reverse_cache.
        type: str
      rsso:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      rtp-addr:
        description: (list or str) Deprecated, please rename it to rtp_addr.
        type: raw
      rtp-nat:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to rtp_nat.
        type: str
      scan-botnet-connections:
        choices:
        - disable
        - block
        - monitor
        description: Deprecated, please rename it to scan_botnet_connections.
        type: str
      schedule:
        description: No description.
        type: str
      schedule-timeout:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to schedule_timeout.
        type: str
      sctp-filter-profile:
        description: Deprecated, please rename it to sctp_filter_profile. Name of an existing
          SCTP filter profile.
        type: str
      send-deny-packet:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to send_deny_packet.
        type: str
      service:
        description: (list or str) No description.
        type: raw
      service-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to service_negate.
        type: str
      session-ttl:
        description: (int or str) Deprecated, please rename it to session_ttl.
        type: raw
      sessions:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      sgt:
        description: (list) No description.
        type: raw
      sgt-check:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to sgt_check. Enable/disable security
          group tags
        type: str
      spamfilter-profile:
        description: (list or str) Deprecated, please rename it to spamfilter_profile.
        type: raw
      src-vendor-mac:
        description: (list or str) Deprecated, please rename it to src_vendor_mac.
        type: raw
      srcaddr:
        description: (list or str) No description.
        type: raw
      srcaddr-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to srcaddr_negate.
        type: str
      srcaddr6:
        description: (list or str) No description.
        type: raw
      srcaddr6-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to srcaddr6_negate. When enabled srcaddr6
          specifies what the source address must NOT be.
        type: str
      srcintf:
        description: (list or str) No description.
        type: raw
      ssh-filter-profile:
        description: Deprecated, please rename it to ssh_filter_profile.
        type: str
      ssh-policy-check:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ssh_policy_check.
        type: str
      ssh-policy-redirect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ssh_policy_redirect.
        type: str
      ssl-mirror:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ssl_mirror.
        type: str
      ssl-mirror-intf:
        description: (list or str) Deprecated, please rename it to ssl_mirror_intf.
        type: raw
      ssl-ssh-profile:
        description: Deprecated, please rename it to ssl_ssh_profile.
        type: str
      sslvpn-auth:
        choices:
        - any
        - local
        - radius
        - ldap
        - tacacs+
        description: Deprecated, please rename it to sslvpn_auth.
        type: str
      sslvpn-ccert:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to sslvpn_ccert.
        type: str
      sslvpn-cipher:
        choices:
        - any
        - high
        - medium
        description: Deprecated, please rename it to sslvpn_cipher.
        type: str
      sso-auth-method:
        choices:
        - fsso
        - rsso
        description: Deprecated, please rename it to sso_auth_method.
        type: str
      status:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      tags:
        description: (list or str) No description.
        type: raw
      tcp-mss-receiver:
        description: Deprecated, please rename it to tcp_mss_receiver.
        type: int
      tcp-mss-sender:
        description: Deprecated, please rename it to tcp_mss_sender.
        type: int
      tcp-reset:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tcp_reset.
        type: str
      tcp-session-without-syn:
        choices:
        - all
        - data-only
        - disable
        description: Deprecated, please rename it to tcp_session_without_syn.
        type: str
      tcp-timeout-pid:
        description: (list) Deprecated, please rename it to tcp_timeout_pid.
        type: raw
      timeout-send-rst:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to timeout_send_rst.
        type: str
      tos:
        description: No description.
        type: str
      tos-mask:
        description: Deprecated, please rename it to tos_mask.
        type: str
      tos-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tos_negate.
        type: str
      traffic-shaper:
        description: Deprecated, please rename it to traffic_shaper.
        type: str
      traffic-shaper-reverse:
        description: Deprecated, please rename it to traffic_shaper_reverse.
        type: str
      transaction-based:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to transaction_based.
        type: str
      transparent:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      type:
        choices:
        - explicit-web
        - transparent
        - explicit-ftp
        - ssh-tunnel
        - ssh
        - wanopt
        - access-proxy
        description: No description.
        type: str
      udp-timeout-pid:
        description: (list) Deprecated, please rename it to udp_timeout_pid.
        type: raw
      url-category:
        description: (list or str) Deprecated, please rename it to url_category.
        type: raw
      users:
        description: (list or str) No description.
        type: raw
      utm-inspection-mode:
        choices:
        - proxy
        - flow
        description: Deprecated, please rename it to utm_inspection_mode.
        type: str
      utm-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to utm_status.
        type: str
      uuid:
        description: No description.
        type: str
      uuid-idx:
        description: Deprecated, please rename it to uuid_idx.
        type: int
      vendor-mac:
        description: (list or str) Deprecated, please rename it to vendor_mac.
        type: raw
      videofilter-profile:
        description: Deprecated, please rename it to videofilter_profile. Name of an existing
          VideoFilter profile.
        type: str
      virtual-patch-profile:
        description: Deprecated, please rename it to virtual_patch_profile. Name of an
          existing virtual-patch profile.
        type: str
      vlan-cos-fwd:
        description: Deprecated, please rename it to vlan_cos_fwd.
        type: int
      vlan-cos-rev:
        description: Deprecated, please rename it to vlan_cos_rev.
        type: int
      vlan-filter:
        description: Deprecated, please rename it to vlan_filter.
        type: str
      voip-profile:
        description: Deprecated, please rename it to voip_profile.
        type: str
      vpntunnel:
        description: No description.
        type: str
      waf-profile:
        description: Deprecated, please rename it to waf_profile.
        type: str
      wanopt:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      wanopt-detection:
        choices:
        - active
        - passive
        - 'off'
        description: Deprecated, please rename it to wanopt_detection.
        type: str
      wanopt-passive-opt:
        choices:
        - default
        - transparent
        - non-transparent
        description: Deprecated, please rename it to wanopt_passive_opt.
        type: str
      wanopt-peer:
        description: Deprecated, please rename it to wanopt_peer.
        type: str
      wanopt-profile:
        description: Deprecated, please rename it to wanopt_profile.
        type: str
      wccp:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      web-auth-cookie:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to web_auth_cookie.
        type: str
      webcache:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      webcache-https:
        choices:
        - disable
        - ssl-server
        - any
        - enable
        description: Deprecated, please rename it to webcache_https.
        type: str
      webfilter-profile:
        description: Deprecated, please rename it to webfilter_profile.
        type: str
      webproxy-forward-server:
        description: Deprecated, please rename it to webproxy_forward_server.
        type: str
      webproxy-profile:
        description: Deprecated, please rename it to webproxy_profile.
        type: str
      wsso:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      ztna-device-ownership:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ztna_device_ownership. Enable/disable
          zero trust device ownership.
        type: str
      ztna-ems-tag:
        description: (list or str) Deprecated, please rename it to ztna_ems_tag. Source
          ztna-ems-tag names.
        type: raw
      ztna-ems-tag-secondary:
        description: (list) Deprecated, please rename it to ztna_ems_tag_secondary.
        type: raw
      ztna-geo-tag:
        description: (list or str) Deprecated, please rename it to ztna_geo_tag. Source
          ztna-geo-tag names.
        type: raw
      ztna-policy-redirect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ztna_policy_redirect. Redirect ZTNA
          traffic to matching Access-Proxy proxy-policy.
        type: str
      ztna-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ztna_status. Enable/disable zero
          trust access.
        type: str
      ztna-tags-match-logic:
        choices:
        - or
        - and
        description: Deprecated, please rename it to ztna_tags_match_logic.
        type: str
    type: dict

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list