fortinet.fortimanager.fmgr_system_npu_nputcam (2.4.0) — module

Configure NPU TCAM policies.

| "added in version" 2.4.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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure NPU TCAM policies.
      fortinet.fortimanager.fmgr_system_npu_nputcam:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        system_npu_nputcam:
          data:
            df: <value in [disable, enable]>
            dstip: <string>
            dstipv6: <string>
            dstmac: <string>
            dstport: <integer>
            ethertype: <string>
            ext_tag: <value in [disable, enable]>
            frag_off: <integer>
            gen_buf_cnt: <integer>
            gen_iv: <value in [invalid, valid]>
            gen_l3_flags: <integer>
            gen_l4_flags: <integer>
            gen_pkt_ctrl: <integer>
            gen_pri: <integer>
            gen_pri_v: <value in [invalid, valid]>
            gen_tv: <value in [invalid, valid]>
            ihl: <integer>
            ip4_id: <integer>
            ip6_fl: <integer>
            ipver: <integer>
            l4_wd10: <integer>
            l4_wd11: <integer>
            l4_wd8: <integer>
            l4_wd9: <integer>
            mf: <value in [disable, enable]>
            protocol: <integer>
            slink: <integer>
            smac_change: <value in [disable, enable]>
            sp: <integer>
            src_cfi: <value in [disable, enable]>
            src_prio: <integer>
            src_updt: <value in [disable, enable]>
            srcip: <string>
            srcipv6: <string>
            srcmac: <string>
            srcport: <integer>
            svid: <integer>
            tcp_ack: <value in [disable, enable]>
            tcp_cwr: <value in [disable, enable]>
            tcp_ece: <value in [disable, enable]>
            tcp_fin: <value in [disable, enable]>
            tcp_push: <value in [disable, enable]>
            tcp_rst: <value in [disable, enable]>
            tcp_syn: <value in [disable, enable]>
            tcp_urg: <value in [disable, enable]>
            tgt_cfi: <value in [disable, enable]>
            tgt_prio: <integer>
            tgt_updt: <value in [disable, enable]>
            tgt_v: <value in [invalid, valid]>
            tos: <integer>
            tp: <integer>
            ttl: <integer>
            tvid: <integer>
            vdid: <integer>
          dbg_dump: <integer>
          mask:
            df: <value in [disable, enable]>
            dstip: <string>
            dstipv6: <string>
            dstmac: <string>
            dstport: <integer>
            ethertype: <string>
            ext_tag: <value in [disable, enable]>
            frag_off: <integer>
            gen_buf_cnt: <integer>
            gen_iv: <value in [invalid, valid]>
            gen_l3_flags: <integer>
            gen_l4_flags: <integer>
            gen_pkt_ctrl: <integer>
            gen_pri: <integer>
            gen_pri_v: <value in [invalid, valid]>
            gen_tv: <value in [invalid, valid]>
            ihl: <integer>
            ip4_id: <integer>
            ip6_fl: <integer>
            ipver: <integer>
            l4_wd10: <integer>
            l4_wd11: <integer>
            l4_wd8: <integer>
            l4_wd9: <integer>
            mf: <value in [disable, enable]>
            protocol: <integer>
            slink: <integer>
            smac_change: <value in [disable, enable]>
            sp: <integer>
            src_cfi: <value in [disable, enable]>
            src_prio: <integer>
            src_updt: <value in [disable, enable]>
            srcip: <string>
            srcipv6: <string>
            srcmac: <string>
            srcport: <integer>
            svid: <integer>
            tcp_ack: <value in [disable, enable]>
            tcp_cwr: <value in [disable, enable]>
            tcp_ece: <value in [disable, enable]>
            tcp_fin: <value in [disable, enable]>
            tcp_push: <value in [disable, enable]>
            tcp_rst: <value in [disable, enable]>
            tcp_syn: <value in [disable, enable]>
            tcp_urg: <value in [disable, enable]>
            tgt_cfi: <value in [disable, enable]>
            tgt_prio: <integer>
            tgt_updt: <value in [disable, enable]>
            tgt_v: <value in [invalid, valid]>
            tos: <integer>
            tp: <integer>
            ttl: <integer>
            tvid: <integer>
            vdid: <integer>
          mir_act:
            vlif: <integer>
          name: <string>
          oid: <integer>
          pri_act:
            priority: <integer>
            weight: <integer>
          sact:
            act: <integer>
            act_v: <value in [disable, enable]>
            bmproc: <integer>
            bmproc_v: <value in [disable, enable]>
            df_lif: <integer>
            df_lif_v: <value in [disable, enable]>
            dfr: <integer>
            dfr_v: <value in [disable, enable]>
            dmac_skip: <integer>
            dmac_skip_v: <value in [disable, enable]>
            dosen: <integer>
            dosen_v: <value in [disable, enable]>
            espff_proc: <integer>
            espff_proc_v: <value in [disable, enable]>
            etype_pid: <integer>
            etype_pid_v: <value in [disable, enable]>
            frag_proc: <integer>
            frag_proc_v: <value in [disable, enable]>
            fwd: <integer>
            fwd_lif: <integer>
            fwd_lif_v: <value in [disable, enable]>
            fwd_tvid: <integer>
            fwd_tvid_v: <value in [disable, enable]>
            fwd_v: <value in [disable, enable]>
            icpen: <integer>
            icpen_v: <value in [disable, enable]>
            igmp_mld_snp: <integer>
            igmp_mld_snp_v: <value in [disable, enable]>
            learn: <integer>
            learn_v: <value in [disable, enable]>
            m_srh_ctrl: <integer>
            m_srh_ctrl_v: <value in [disable, enable]>
            mac_id: <integer>
            mac_id_v: <value in [disable, enable]>
            mss: <integer>
            mss_v: <value in [disable, enable]>
            pleen: <integer>
            pleen_v: <value in [disable, enable]>
            prio_pid: <integer>
            prio_pid_v: <value in [disable, enable]>
            promis: <integer>
            promis_v: <value in [disable, enable]>
            rfsh: <integer>
            rfsh_v: <value in [disable, enable]>
            smac_skip: <integer>
            smac_skip_v: <value in [disable, enable]>
            tp_smchk_v: <value in [disable, enable]>
            tp_smchk: <integer>
            tpe_id: <integer>
            tpe_id_v: <value in [disable, enable]>
            vdm: <integer>
            vdm_v: <value in [disable, enable]>
            vdom_id: <integer>
            vdom_id_v: <value in [disable, enable]>
            x_mode: <integer>
            x_mode_v: <value in [disable, enable]>
          tact:
            act: <integer>
            act_v: <value in [disable, enable]>
            fmtuv4_s: <integer>
            fmtuv4_s_v: <value in [disable, enable]>
            fmtuv6_s: <integer>
            fmtuv6_s_v: <value in [disable, enable]>
            lnkid: <integer>
            lnkid_v: <value in [disable, enable]>
            mac_id: <integer>
            mac_id_v: <value in [disable, enable]>
            mss_t: <integer>
            mss_t_v: <value in [disable, enable]>
            mtuv4: <integer>
            mtuv4_v: <value in [disable, enable]>
            mtuv6: <integer>
            mtuv6_v: <value in [disable, enable]>
            slif_act: <integer>
            slif_act_v: <value in [disable, enable]>
            sublnkid: <integer>
            sublnkid_v: <value in [disable, enable]>
            tgtv_act: <integer>
            tgtv_act_v: <value in [disable, enable]>
            tlif_act: <integer>
            tlif_act_v: <value in [disable, enable]>
            tpeid: <integer>
            tpeid_v: <value in [disable, enable]>
            v6fe: <integer>
            v6fe_v: <value in [disable, enable]>
            vep_en_v: <value in [disable, enable]>
            vep_slid: <integer>
            vep_slid_v: <value in [disable, enable]>
            vep_en: <integer>
            xlt_lif: <integer>
            xlt_lif_v: <value in [disable, enable]>
            xlt_vid: <integer>
            xlt_vid_v: <value in [disable, enable]>
          type: <value in [L2_src_tc, L2_tgt_tc, L2_src_mir, ...]>
          vid: <integer>

Inputs

    
adom:
    description: The parameter (adom) 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

system_npu_nputcam:
    description: The top level parameters set.
    required: false
    suboptions:
      data:
        description: No description.
        suboptions:
          df:
            choices:
            - disable
            - enable
            description: Tcam data ip flag df.
            type: str
          dstip:
            description: Tcam data dst ipv4 address.
            type: str
          dstipv6:
            description: Tcam data dst ipv6 address.
            type: str
          dstmac:
            description: Tcam data dst macaddr.
            type: str
          dstport:
            description: Tcam data L4 dst port.
            type: int
          ethertype:
            description: Tcam data ethertype.
            type: str
          ext-tag:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to ext_tag. Tcam data extension
              tag.
            type: str
          frag-off:
            description: Deprecated, please rename it to frag_off. Tcam data ip flag fragment
              offset.
            type: int
          gen-buf-cnt:
            description: Deprecated, please rename it to gen_buf_cnt. Tcam data gen info
              buffer count.
            type: int
          gen-iv:
            choices:
            - invalid
            - valid
            description: Deprecated, please rename it to gen_iv. Tcam data gen info iv.
            type: str
          gen-l3-flags:
            description: Deprecated, please rename it to gen_l3_flags. Tcam data gen info
              L3 flags.
            type: int
          gen-l4-flags:
            description: Deprecated, please rename it to gen_l4_flags. Tcam data gen info
              L4 flags.
            type: int
          gen-pkt-ctrl:
            description: Deprecated, please rename it to gen_pkt_ctrl. Tcam data gen info
              packet control.
            type: int
          gen-pri:
            description: Deprecated, please rename it to gen_pri. Tcam data gen info priority.
            type: int
          gen-pri-v:
            choices:
            - invalid
            - valid
            description: Deprecated, please rename it to gen_pri_v. Tcam data gen info
              priority valid.
            type: str
          gen-tv:
            choices:
            - invalid
            - valid
            description: Deprecated, please rename it to gen_tv. Tcam data gen info tv.
            type: str
          ihl:
            description: Tcam data ipv4 IHL.
            type: int
          ip4-id:
            description: Deprecated, please rename it to ip4_id. Tcam data ipv4 id.
            type: int
          ip6-fl:
            description: Deprecated, please rename it to ip6_fl. Tcam data ipv6 flow label.
            type: int
          ipver:
            description: Tcam data ip header version.
            type: int
          l4-wd10:
            description: Deprecated, please rename it to l4_wd10. Tcam data L4 word10.
            type: int
          l4-wd11:
            description: Deprecated, please rename it to l4_wd11. Tcam data L4 word11.
            type: int
          l4-wd8:
            description: Deprecated, please rename it to l4_wd8. Tcam data L4 word8.
            type: int
          l4-wd9:
            description: Deprecated, please rename it to l4_wd9. Tcam data L4 word9.
            type: int
          mf:
            choices:
            - disable
            - enable
            description: Tcam data ip flag mf.
            type: str
          protocol:
            description: Tcam data ip protocol.
            type: int
          slink:
            description: Tcam data sublink.
            type: int
          smac-change:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to smac_change. Tcam data source
              MAC change.
            type: str
          sp:
            description: Tcam data source port.
            type: int
          src-cfi:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to src_cfi. Tcam data source cfi.
            type: str
          src-prio:
            description: Deprecated, please rename it to src_prio. Tcam data source priority.
            type: int
          src-updt:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to src_updt. Tcam data source update.
            type: str
          srcip:
            description: Tcam data src ipv4 address.
            type: str
          srcipv6:
            description: Tcam data src ipv6 address.
            type: str
          srcmac:
            description: Tcam data src macaddr.
            type: str
          srcport:
            description: Tcam data L4 src port.
            type: int
          svid:
            description: Tcam data source vid.
            type: int
          tcp-ack:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_ack. Tcam data tcp flag ack.
            type: str
          tcp-cwr:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_cwr. Tcam data tcp flag cwr.
            type: str
          tcp-ece:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_ece. Tcam data tcp flag ece.
            type: str
          tcp-fin:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_fin. Tcam data tcp flag fin.
            type: str
          tcp-push:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_push. Tcam data tcp flag
              push.
            type: str
          tcp-rst:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_rst. Tcam data tcp flag rst.
            type: str
          tcp-syn:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_syn. Tcam data tcp flag syn.
            type: str
          tcp-urg:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_urg. Tcam data tcp flag urg.
            type: str
          tgt-cfi:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tgt_cfi. Tcam data target cfi.
            type: str
          tgt-prio:
            description: Deprecated, please rename it to tgt_prio. Tcam data target priority.
            type: int
          tgt-updt:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tgt_updt. Tcam data target port
              update.
            type: str
          tgt-v:
            choices:
            - invalid
            - valid
            description: Deprecated, please rename it to tgt_v. Tcam data target valid.
            type: str
          tos:
            description: Tcam data ip tos.
            type: int
          tp:
            description: Tcam data target port.
            type: int
          ttl:
            description: Tcam data ip ttl.
            type: int
          tvid:
            description: Tcam data target vid.
            type: int
          vdid:
            description: Tcam data vdom id.
            type: int
        type: dict
      dbg-dump:
        description: Deprecated, please rename it to dbg_dump. Debug driver dump data/mask
          pdq.
        type: int
      mask:
        description: No description.
        suboptions:
          df:
            choices:
            - disable
            - enable
            description: Tcam mask ip flag df.
            type: str
          dstip:
            description: Tcam mask dst ipv4 address.
            type: str
          dstipv6:
            description: Tcam mask dst ipv6 address.
            type: str
          dstmac:
            description: Tcam mask dst macaddr.
            type: str
          dstport:
            description: Tcam mask L4 dst port.
            type: int
          ethertype:
            description: Tcam mask ethertype.
            type: str
          ext-tag:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to ext_tag. Tcam mask extension
              tag.
            type: str
          frag-off:
            description: Deprecated, please rename it to frag_off. Tcam data ip flag fragment
              offset.
            type: int
          gen-buf-cnt:
            description: Deprecated, please rename it to gen_buf_cnt. Tcam mask gen info
              buffer count.
            type: int
          gen-iv:
            choices:
            - invalid
            - valid
            description: Deprecated, please rename it to gen_iv. Tcam mask gen info iv.
            type: str
          gen-l3-flags:
            description: Deprecated, please rename it to gen_l3_flags. Tcam mask gen info
              L3 flags.
            type: int
          gen-l4-flags:
            description: Deprecated, please rename it to gen_l4_flags. Tcam mask gen info
              L4 flags.
            type: int
          gen-pkt-ctrl:
            description: Deprecated, please rename it to gen_pkt_ctrl. Tcam mask gen info
              packet control.
            type: int
          gen-pri:
            description: Deprecated, please rename it to gen_pri. Tcam mask gen info priority.
            type: int
          gen-pri-v:
            choices:
            - invalid
            - valid
            description: Deprecated, please rename it to gen_pri_v. Tcam mask gen info
              priority valid.
            type: str
          gen-tv:
            choices:
            - invalid
            - valid
            description: Deprecated, please rename it to gen_tv. Tcam mask gen info tv.
            type: str
          ihl:
            description: Tcam mask ipv4 IHL.
            type: int
          ip4-id:
            description: Deprecated, please rename it to ip4_id. Tcam mask ipv4 id.
            type: int
          ip6-fl:
            description: Deprecated, please rename it to ip6_fl. Tcam mask ipv6 flow label.
            type: int
          ipver:
            description: Tcam mask ip header version.
            type: int
          l4-wd10:
            description: Deprecated, please rename it to l4_wd10. Tcam mask L4 word10.
            type: int
          l4-wd11:
            description: Deprecated, please rename it to l4_wd11. Tcam mask L4 word11.
            type: int
          l4-wd8:
            description: Deprecated, please rename it to l4_wd8. Tcam mask L4 word8.
            type: int
          l4-wd9:
            description: Deprecated, please rename it to l4_wd9. Tcam mask L4 word9.
            type: int
          mf:
            choices:
            - disable
            - enable
            description: Tcam mask ip flag mf.
            type: str
          protocol:
            description: Tcam mask ip protocol.
            type: int
          slink:
            description: Tcam mask sublink.
            type: int
          smac-change:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to smac_change. Tcam mask source
              MAC change.
            type: str
          sp:
            description: Tcam mask source port.
            type: int
          src-cfi:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to src_cfi. Tcam mask source cfi.
            type: str
          src-prio:
            description: Deprecated, please rename it to src_prio. Tcam mask source priority.
            type: int
          src-updt:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to src_updt. Tcam mask source update.
            type: str
          srcip:
            description: Tcam mask src ipv4 address.
            type: str
          srcipv6:
            description: Tcam mask src ipv6 address.
            type: str
          srcmac:
            description: Tcam mask src macaddr.
            type: str
          srcport:
            description: Tcam mask L4 src port.
            type: int
          svid:
            description: Tcam mask source vid.
            type: int
          tcp-ack:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_ack. Tcam mask tcp flag ack.
            type: str
          tcp-cwr:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_cwr. Tcam mask tcp flag cwr.
            type: str
          tcp-ece:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_ece. Tcam mask tcp flag ece.
            type: str
          tcp-fin:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_fin. Tcam mask tcp flag fin.
            type: str
          tcp-push:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_push. Tcam mask tcp flag
              push.
            type: str
          tcp-rst:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_rst. Tcam mask tcp flag rst.
            type: str
          tcp-syn:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_syn. Tcam mask tcp flag syn.
            type: str
          tcp-urg:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tcp_urg. Tcam mask tcp flag urg.
            type: str
          tgt-cfi:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tgt_cfi. Tcam mask target cfi.
            type: str
          tgt-prio:
            description: Deprecated, please rename it to tgt_prio. Tcam mask target priority.
            type: int
          tgt-updt:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tgt_updt. Tcam mask target port
              update.
            type: str
          tgt-v:
            choices:
            - invalid
            - valid
            description: Deprecated, please rename it to tgt_v. Tcam mask target valid.
            type: str
          tos:
            description: Tcam mask ip tos.
            type: int
          tp:
            description: Tcam mask target port.
            type: int
          ttl:
            description: Tcam mask ip ttl.
            type: int
          tvid:
            description: Tcam mask target vid.
            type: int
          vdid:
            description: Tcam mask vdom id.
            type: int
        type: dict
      mir-act:
        description: Deprecated, please rename it to mir_act.
        suboptions:
          vlif:
            description: Tcam mirror action vlif.
            type: int
        type: dict
      name:
        description: NPU TCAM policies name.
        required: true
        type: str
      oid:
        description: NPU TCAM OID.
        type: int
      pri-act:
        description: Deprecated, please rename it to pri_act.
        suboptions:
          priority:
            description: Tcam priority action priority.
            type: int
          weight:
            description: Tcam priority action weight.
            type: int
        type: dict
      sact:
        description: No description.
        suboptions:
          act:
            description: Tcam sact act.
            type: int
          act-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to act_v. Enable to set sact act.
            type: str
          bmproc:
            description: Tcam sact bmproc.
            type: int
          bmproc-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to bmproc_v. Enable to set sact
              bmproc.
            type: str
          df-lif:
            description: Deprecated, please rename it to df_lif. Tcam sact df-lif.
            type: int
          df-lif-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to df_lif_v. Enable to set sact
              df-lif.
            type: str
          dfr:
            description: Tcam sact dfr.
            type: int
          dfr-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to dfr_v. Enable to set sact dfr.
            type: str
          dmac-skip:
            description: Deprecated, please rename it to dmac_skip. Tcam sact dmac-skip.
            type: int
          dmac-skip-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to dmac_skip_v. Enable to set sact
              dmac-skip.
            type: str
          dosen:
            description: Tcam sact dosen.
            type: int
          dosen-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to dosen_v. Enable to set sact dosen.
            type: str
          espff-proc:
            description: Deprecated, please rename it to espff_proc. Tcam sact espff-proc.
            type: int
          espff-proc-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to espff_proc_v. Enable to set sact
              espff-proc.
            type: str
          etype-pid:
            description: Deprecated, please rename it to etype_pid. Tcam sact etype-pid.
            type: int
          etype-pid-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to etype_pid_v. Enable to set sact
              etype-pid.
            type: str
          frag-proc:
            description: Deprecated, please rename it to frag_proc. Tcam sact frag-proc.
            type: int
          frag-proc-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to frag_proc_v. Enable to set sact
              frag-proc.
            type: str
          fwd:
            description: Tcam sact fwd.
            type: int
          fwd-lif:
            description: Deprecated, please rename it to fwd_lif. Tcam sact fwd-lif.
            type: int
          fwd-lif-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to fwd_lif_v. Enable to set sact
              fwd-lif.
            type: str
          fwd-tvid:
            description: Deprecated, please rename it to fwd_tvid. Tcam sact fwd-tvid.
            type: int
          fwd-tvid-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to fwd_tvid_v. Enable to set sact
              fwd-vid.
            type: str
          fwd-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to fwd_v. Enable to set sact fwd.
            type: str
          icpen:
            description: Tcam sact icpen.
            type: int
          icpen-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to icpen_v. Enable to set sact icpen.
            type: str
          igmp-mld-snp:
            description: Deprecated, please rename it to igmp_mld_snp. Tcam sact igmp-mld-snp.
            type: int
          igmp-mld-snp-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to igmp_mld_snp_v. Enable to set
              sact igmp-mld-snp.
            type: str
          learn:
            description: Tcam sact learn.
            type: int
          learn-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to learn_v. Enable to set sact learn.
            type: str
          m-srh-ctrl:
            description: Deprecated, please rename it to m_srh_ctrl. Tcam sact m-srh-ctrl.
            type: int
          m-srh-ctrl-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to m_srh_ctrl_v. Enable to set sact
              m-srh-ctrl.
            type: str
          mac-id:
            description: Deprecated, please rename it to mac_id. Tcam sact mac-id.
            type: int
          mac-id-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to mac_id_v. Enable to set sact
              mac-id.
            type: str
          mss:
            description: Tcam sact mss.
            type: int
          mss-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to mss_v. Enable to set sact mss.
            type: str
          pleen:
            description: Tcam sact pleen.
            type: int
          pleen-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to pleen_v. Enable to set sact pleen.
            type: str
          prio-pid:
            description: Deprecated, please rename it to prio_pid. Tcam sact prio-pid.
            type: int
          prio-pid-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to prio_pid_v. Enable to set sact
              prio-pid.
            type: str
          promis:
            description: Tcam sact promis.
            type: int
          promis-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to promis_v. Enable to set sact
              promis.
            type: str
          rfsh:
            description: Tcam sact rfsh.
            type: int
          rfsh-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to rfsh_v. Enable to set sact rfsh.
            type: str
          smac-skip:
            description: Deprecated, please rename it to smac_skip. Tcam sact smac-skip.
            type: int
          smac-skip-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to smac_skip_v. Enable to set sact
              smac-skip.
            type: str
          tp-smchk-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tp_smchk_v. Enable to set sact
              tp mode.
            type: str
          tp_smchk:
            description: Tcam sact tp mode.
            type: int
          tpe-id:
            description: Deprecated, please rename it to tpe_id. Tcam sact tpe-id.
            type: int
          tpe-id-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tpe_id_v. Enable to set sact
              tpe-id.
            type: str
          vdm:
            description: Tcam sact vdm.
            type: int
          vdm-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to vdm_v. Enable to set sact vdm.
            type: str
          vdom-id:
            description: Deprecated, please rename it to vdom_id. Tcam sact vdom-id.
            type: int
          vdom-id-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to vdom_id_v. Enable to set sact
              vdom-id.
            type: str
          x-mode:
            description: Deprecated, please rename it to x_mode. Tcam sact x-mode.
            type: int
          x-mode-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to x_mode_v. Enable to set sact
              x-mode.
            type: str
        type: dict
      tact:
        description: No description.
        suboptions:
          act:
            description: Tcam tact act.
            type: int
          act-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to act_v. Enable to set tact act.
            type: str
          fmtuv4-s:
            description: Deprecated, please rename it to fmtuv4_s. Tcam tact fmtuv4-s.
            type: int
          fmtuv4-s-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to fmtuv4_s_v. Enable to set tact
              fmtuv4-s.
            type: str
          fmtuv6-s:
            description: Deprecated, please rename it to fmtuv6_s. Tcam tact fmtuv6-s.
            type: int
          fmtuv6-s-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to fmtuv6_s_v. Enable to set tact
              fmtuv6-s.
            type: str
          lnkid:
            description: Tcam tact lnkid.
            type: int
          lnkid-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to lnkid_v. Enable to set tact lnkid.
            type: str
          mac-id:
            description: Deprecated, please rename it to mac_id. Tcam tact mac-id.
            type: int
          mac-id-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to mac_id_v. Enable to set tact
              mac-id.
            type: str
          mss-t:
            description: Deprecated, please rename it to mss_t. Tcam tact mss.
            type: int
          mss-t-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to mss_t_v. Enable to set tact mss.
            type: str
          mtuv4:
            description: Tcam tact mtuv4.
            type: int
          mtuv4-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to mtuv4_v. Enable to set tact mtuv4.
            type: str
          mtuv6:
            description: Tcam tact mtuv6.
            type: int
          mtuv6-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to mtuv6_v. Enable to set tact mtuv6.
            type: str
          slif-act:
            description: Deprecated, please rename it to slif_act. Tcam tact slif-act.
            type: int
          slif-act-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to slif_act_v. Enable to set tact
              slif-act.
            type: str
          sublnkid:
            description: Tcam tact sublnkid.
            type: int
          sublnkid-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to sublnkid_v. Enable to set tact
              sublnkid.
            type: str
          tgtv-act:
            description: Deprecated, please rename it to tgtv_act. Tcam tact tgtv-act.
            type: int
          tgtv-act-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tgtv_act_v. Enable to set tact
              tgtv-act.
            type: str
          tlif-act:
            description: Deprecated, please rename it to tlif_act. Tcam tact tlif-act.
            type: int
          tlif-act-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tlif_act_v. Enable to set tact
              tlif-act.
            type: str
          tpeid:
            description: Tcam tact tpeid.
            type: int
          tpeid-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tpeid_v. Enable to set tact tpeid.
            type: str
          v6fe:
            description: Tcam tact v6fe.
            type: int
          v6fe-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to v6fe_v. Enable to set tact v6fe.
            type: str
          vep-en-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to vep_en_v. Enable to set tact
              vep-en.
            type: str
          vep-slid:
            description: Deprecated, please rename it to vep_slid. Tcam tact vep_slid.
            type: int
          vep-slid-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to vep_slid_v. Enable to set tact
              vep-slid.
            type: str
          vep_en:
            description: Tcam tact vep_en.
            type: int
          xlt-lif:
            description: Deprecated, please rename it to xlt_lif. Tcam tact xlt-lif.
            type: int
          xlt-lif-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to xlt_lif_v. Enable to set tact
              xlt-lif.
            type: str
          xlt-vid:
            description: Deprecated, please rename it to xlt_vid. Tcam tact xlt-vid.
            type: int
          xlt-vid-v:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to xlt_vid_v. Enable to set tact
              xlt-vid.
            type: str
        type: dict
      type:
        choices:
        - L2_src_tc
        - L2_tgt_tc
        - L2_src_mir
        - L2_tgt_mir
        - L2_src_act
        - L2_tgt_act
        - IPv4_src_tc
        - IPv4_tgt_tc
        - IPv4_src_mir
        - IPv4_tgt_mir
        - IPv4_src_act
        - IPv4_tgt_act
        - IPv6_src_tc
        - IPv6_tgt_tc
        - IPv6_src_mir
        - IPv6_tgt_mir
        - IPv6_src_act
        - IPv6_tgt_act
        description: TCAM policy type.
        type: str
      vid:
        description: NPU TCAM VID.
        type: int
    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