fmgr_system_npu_nputcam – Configure NPU TCAM policies.

Added in version 2.4.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.2 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • system_npu_nputcam - Configure NPU TCAM policies. type: dict
    • data type: dict
      • df Tcam data ip flag df. type: str choices: [disable, enable] more...
      • dstip Tcam data dst ipv4 address. type: str more...
      • dstipv6 Tcam data dst ipv6 address. type: str more...
      • dstmac Tcam data dst macaddr. type: str more...
      • dstport Tcam data l4 dst port. type: int more...
      • ethertype Tcam data ethertype. type: str more...
      • ext_tag (Alias name: ext-tag) Tcam data extension tag. type: str choices: [disable, enable] more...
      • frag_off (Alias name: frag-off) Tcam data ip flag fragment offset. type: int more...
      • gen_buf_cnt (Alias name: gen-buf-cnt) Tcam data gen info buffer count. type: int more...
      • gen_iv (Alias name: gen-iv) Tcam data gen info iv. type: str choices: [invalid, valid] more...
      • gen_l3_flags (Alias name: gen-l3-flags) Tcam data gen info l3 flags. type: int more...
      • gen_l4_flags (Alias name: gen-l4-flags) Tcam data gen info l4 flags. type: int more...
      • gen_pkt_ctrl (Alias name: gen-pkt-ctrl) Tcam data gen info packet control. type: int more...
      • gen_pri (Alias name: gen-pri) Tcam data gen info priority. type: int more...
      • gen_pri_v (Alias name: gen-pri-v) Tcam data gen info priority valid. type: str choices: [invalid, valid] more...
      • gen_tv (Alias name: gen-tv) Tcam data gen info tv. type: str choices: [invalid, valid] more...
      • ihl Tcam data ipv4 ihl. type: int more...
      • ip4_id (Alias name: ip4-id) Tcam data ipv4 id. type: int more...
      • ip6_fl (Alias name: ip6-fl) Tcam data ipv6 flow label. type: int more...
      • ipver Tcam data ip header version. type: int more...
      • l4_wd10 (Alias name: l4-wd10) Tcam data l4 word10. type: int more...
      • l4_wd11 (Alias name: l4-wd11) Tcam data l4 word11. type: int more...
      • l4_wd8 (Alias name: l4-wd8) Tcam data l4 word8. type: int more...
      • l4_wd9 (Alias name: l4-wd9) Tcam data l4 word9. type: int more...
      • mf Tcam data ip flag mf. type: str choices: [disable, enable] more...
      • protocol Tcam data ip protocol. type: int more...
      • slink Tcam data sublink. type: int more...
      • smac_change (Alias name: smac-change) Tcam data source mac change. type: str choices: [disable, enable] more...
      • sp Tcam data source port. type: int more...
      • src_cfi (Alias name: src-cfi) Tcam data source cfi. type: str choices: [disable, enable] more...
      • src_prio (Alias name: src-prio) Tcam data source priority. type: int more...
      • src_updt (Alias name: src-updt) Tcam data source update. type: str choices: [disable, enable] more...
      • srcip Tcam data src ipv4 address. type: str more...
      • srcipv6 Tcam data src ipv6 address. type: str more...
      • srcmac Tcam data src macaddr. type: str more...
      • srcport Tcam data l4 src port. type: int more...
      • svid Tcam data source vid. type: int more...
      • tcp_ack (Alias name: tcp-ack) Tcam data tcp flag ack. type: str choices: [disable, enable] more...
      • tcp_cwr (Alias name: tcp-cwr) Tcam data tcp flag cwr. type: str choices: [disable, enable] more...
      • tcp_ece (Alias name: tcp-ece) Tcam data tcp flag ece. type: str choices: [disable, enable] more...
      • tcp_fin (Alias name: tcp-fin) Tcam data tcp flag fin. type: str choices: [disable, enable] more...
      • tcp_push (Alias name: tcp-push) Tcam data tcp flag push. type: str choices: [disable, enable] more...
      • tcp_rst (Alias name: tcp-rst) Tcam data tcp flag rst. type: str choices: [disable, enable] more...
      • tcp_syn (Alias name: tcp-syn) Tcam data tcp flag syn. type: str choices: [disable, enable] more...
      • tcp_urg (Alias name: tcp-urg) Tcam data tcp flag urg. type: str choices: [disable, enable] more...
      • tgt_cfi (Alias name: tgt-cfi) Tcam data target cfi. type: str choices: [disable, enable] more...
      • tgt_prio (Alias name: tgt-prio) Tcam data target priority. type: int more...
      • tgt_updt (Alias name: tgt-updt) Tcam data target port update. type: str choices: [disable, enable] more...
      • tgt_v (Alias name: tgt-v) Tcam data target valid. type: str choices: [invalid, valid] more...
      • tos Tcam data ip tos. type: int more...
      • tp Tcam data target port. type: int more...
      • ttl Tcam data ip ttl. type: int more...
      • tvid Tcam data target vid. type: int more...
      • vdid Tcam data vdom id. type: int more...
    • dbg_dump (Alias name: dbg-dump) Debug driver dump data/mask pdq. type: int more...
    • mask type: dict
      • df Tcam mask ip flag df. type: str choices: [disable, enable] more...
      • dstip Tcam mask dst ipv4 address. type: str more...
      • dstipv6 Tcam mask dst ipv6 address. type: str more...
      • dstmac Tcam mask dst macaddr. type: str more...
      • dstport Tcam mask l4 dst port. type: int more...
      • ethertype Tcam mask ethertype. type: str more...
      • ext_tag (Alias name: ext-tag) Tcam mask extension tag. type: str choices: [disable, enable] more...
      • frag_off (Alias name: frag-off) Tcam data ip flag fragment offset. type: int more...
      • gen_buf_cnt (Alias name: gen-buf-cnt) Tcam mask gen info buffer count. type: int more...
      • gen_iv (Alias name: gen-iv) Tcam mask gen info iv. type: str choices: [invalid, valid] more...
      • gen_l3_flags (Alias name: gen-l3-flags) Tcam mask gen info l3 flags. type: int more...
      • gen_l4_flags (Alias name: gen-l4-flags) Tcam mask gen info l4 flags. type: int more...
      • gen_pkt_ctrl (Alias name: gen-pkt-ctrl) Tcam mask gen info packet control. type: int more...
      • gen_pri (Alias name: gen-pri) Tcam mask gen info priority. type: int more...
      • gen_pri_v (Alias name: gen-pri-v) Tcam mask gen info priority valid. type: str choices: [invalid, valid] more...
      • gen_tv (Alias name: gen-tv) Tcam mask gen info tv. type: str choices: [invalid, valid] more...
      • ihl Tcam mask ipv4 ihl. type: int more...
      • ip4_id (Alias name: ip4-id) Tcam mask ipv4 id. type: int more...
      • ip6_fl (Alias name: ip6-fl) Tcam mask ipv6 flow label. type: int more...
      • ipver Tcam mask ip header version. type: int more...
      • l4_wd10 (Alias name: l4-wd10) Tcam mask l4 word10. type: int more...
      • l4_wd11 (Alias name: l4-wd11) Tcam mask l4 word11. type: int more...
      • l4_wd8 (Alias name: l4-wd8) Tcam mask l4 word8. type: int more...
      • l4_wd9 (Alias name: l4-wd9) Tcam mask l4 word9. type: int more...
      • mf Tcam mask ip flag mf. type: str choices: [disable, enable] more...
      • protocol Tcam mask ip protocol. type: int more...
      • slink Tcam mask sublink. type: int more...
      • smac_change (Alias name: smac-change) Tcam mask source mac change. type: str choices: [disable, enable] more...
      • sp Tcam mask source port. type: int more...
      • src_cfi (Alias name: src-cfi) Tcam mask source cfi. type: str choices: [disable, enable] more...
      • src_prio (Alias name: src-prio) Tcam mask source priority. type: int more...
      • src_updt (Alias name: src-updt) Tcam mask source update. type: str choices: [disable, enable] more...
      • srcip Tcam mask src ipv4 address. type: str more...
      • srcipv6 Tcam mask src ipv6 address. type: str more...
      • srcmac Tcam mask src macaddr. type: str more...
      • srcport Tcam mask l4 src port. type: int more...
      • svid Tcam mask source vid. type: int more...
      • tcp_ack (Alias name: tcp-ack) Tcam mask tcp flag ack. type: str choices: [disable, enable] more...
      • tcp_cwr (Alias name: tcp-cwr) Tcam mask tcp flag cwr. type: str choices: [disable, enable] more...
      • tcp_ece (Alias name: tcp-ece) Tcam mask tcp flag ece. type: str choices: [disable, enable] more...
      • tcp_fin (Alias name: tcp-fin) Tcam mask tcp flag fin. type: str choices: [disable, enable] more...
      • tcp_push (Alias name: tcp-push) Tcam mask tcp flag push. type: str choices: [disable, enable] more...
      • tcp_rst (Alias name: tcp-rst) Tcam mask tcp flag rst. type: str choices: [disable, enable] more...
      • tcp_syn (Alias name: tcp-syn) Tcam mask tcp flag syn. type: str choices: [disable, enable] more...
      • tcp_urg (Alias name: tcp-urg) Tcam mask tcp flag urg. type: str choices: [disable, enable] more...
      • tgt_cfi (Alias name: tgt-cfi) Tcam mask target cfi. type: str choices: [disable, enable] more...
      • tgt_prio (Alias name: tgt-prio) Tcam mask target priority. type: int more...
      • tgt_updt (Alias name: tgt-updt) Tcam mask target port update. type: str choices: [disable, enable] more...
      • tgt_v (Alias name: tgt-v) Tcam mask target valid. type: str choices: [invalid, valid] more...
      • tos Tcam mask ip tos. type: int more...
      • tp Tcam mask target port. type: int more...
      • ttl Tcam mask ip ttl. type: int more...
      • tvid Tcam mask target vid. type: int more...
      • vdid Tcam mask vdom id. type: int more...
    • mir_act (Alias name: mir-act) type: dict
      • vlif Tcam mirror action vlif. type: int more...
    • name Npu tcam policies name. type: str more...
    • oid Npu tcam oid. type: int more...
    • pri_act (Alias name: pri-act) type: dict
      • priority Tcam priority action priority. type: int more...
      • weight Tcam priority action weight. type: int more...
    • sact type: dict
      • act Tcam sact act. type: int more...
      • act_v (Alias name: act-v) Enable to set sact act. type: str choices: [disable, enable] more...
      • bmproc Tcam sact bmproc. type: int more...
      • bmproc_v (Alias name: bmproc-v) Enable to set sact bmproc. type: str choices: [disable, enable] more...
      • df_lif (Alias name: df-lif) Tcam sact df-lif. type: int more...
      • df_lif_v (Alias name: df-lif-v) Enable to set sact df-lif. type: str choices: [disable, enable] more...
      • dfr Tcam sact dfr. type: int more...
      • dfr_v (Alias name: dfr-v) Enable to set sact dfr. type: str choices: [disable, enable] more...
      • dmac_skip (Alias name: dmac-skip) Tcam sact dmac-skip. type: int more...
      • dmac_skip_v (Alias name: dmac-skip-v) Enable to set sact dmac-skip. type: str choices: [disable, enable] more...
      • dosen Tcam sact dosen. type: int more...
      • dosen_v (Alias name: dosen-v) Enable to set sact dosen. type: str choices: [disable, enable] more...
      • espff_proc (Alias name: espff-proc) Tcam sact espff-proc. type: int more...
      • espff_proc_v (Alias name: espff-proc-v) Enable to set sact espff-proc. type: str choices: [disable, enable] more...
      • etype_pid (Alias name: etype-pid) Tcam sact etype-pid. type: int more...
      • etype_pid_v (Alias name: etype-pid-v) Enable to set sact etype-pid. type: str choices: [disable, enable] more...
      • frag_proc (Alias name: frag-proc) Tcam sact frag-proc. type: int more...
      • frag_proc_v (Alias name: frag-proc-v) Enable to set sact frag-proc. type: str choices: [disable, enable] more...
      • fwd Tcam sact fwd. type: int more...
      • fwd_lif (Alias name: fwd-lif) Tcam sact fwd-lif. type: int more...
      • fwd_lif_v (Alias name: fwd-lif-v) Enable to set sact fwd-lif. type: str choices: [disable, enable] more...
      • fwd_tvid (Alias name: fwd-tvid) Tcam sact fwd-tvid. type: int more...
      • fwd_tvid_v (Alias name: fwd-tvid-v) Enable to set sact fwd-vid. type: str choices: [disable, enable] more...
      • fwd_v (Alias name: fwd-v) Enable to set sact fwd. type: str choices: [disable, enable] more...
      • icpen Tcam sact icpen. type: int more...
      • icpen_v (Alias name: icpen-v) Enable to set sact icpen. type: str choices: [disable, enable] more...
      • igmp_mld_snp (Alias name: igmp-mld-snp) Tcam sact igmp-mld-snp. type: int more...
      • igmp_mld_snp_v (Alias name: igmp-mld-snp-v) Enable to set sact igmp-mld-snp. type: str choices: [disable, enable] more...
      • learn Tcam sact learn. type: int more...
      • learn_v (Alias name: learn-v) Enable to set sact learn. type: str choices: [disable, enable] more...
      • m_srh_ctrl (Alias name: m-srh-ctrl) Tcam sact m-srh-ctrl. type: int more...
      • m_srh_ctrl_v (Alias name: m-srh-ctrl-v) Enable to set sact m-srh-ctrl. type: str choices: [disable, enable] more...
      • mac_id (Alias name: mac-id) Tcam sact mac-id. type: int more...
      • mac_id_v (Alias name: mac-id-v) Enable to set sact mac-id. type: str choices: [disable, enable] more...
      • mss Tcam sact mss. type: int more...
      • mss_v (Alias name: mss-v) Enable to set sact mss. type: str choices: [disable, enable] more...
      • pleen Tcam sact pleen. type: int more...
      • pleen_v (Alias name: pleen-v) Enable to set sact pleen. type: str choices: [disable, enable] more...
      • prio_pid (Alias name: prio-pid) Tcam sact prio-pid. type: int more...
      • prio_pid_v (Alias name: prio-pid-v) Enable to set sact prio-pid. type: str choices: [disable, enable] more...
      • promis Tcam sact promis. type: int more...
      • promis_v (Alias name: promis-v) Enable to set sact promis. type: str choices: [disable, enable] more...
      • rfsh Tcam sact rfsh. type: int more...
      • rfsh_v (Alias name: rfsh-v) Enable to set sact rfsh. type: str choices: [disable, enable] more...
      • smac_skip (Alias name: smac-skip) Tcam sact smac-skip. type: int more...
      • smac_skip_v (Alias name: smac-skip-v) Enable to set sact smac-skip. type: str choices: [disable, enable] more...
      • tp_smchk_v (Alias name: tp-smchk-v) Enable to set sact tp mode. type: str choices: [disable, enable] more...
      • tp_smchk Tcam sact tp mode. type: int more...
      • tpe_id (Alias name: tpe-id) Tcam sact tpe-id. type: int more...
      • tpe_id_v (Alias name: tpe-id-v) Enable to set sact tpe-id. type: str choices: [disable, enable] more...
      • vdm Tcam sact vdm. type: int more...
      • vdm_v (Alias name: vdm-v) Enable to set sact vdm. type: str choices: [disable, enable] more...
      • vdom_id (Alias name: vdom-id) Tcam sact vdom-id. type: int more...
      • vdom_id_v (Alias name: vdom-id-v) Enable to set sact vdom-id. type: str choices: [disable, enable] more...
      • x_mode (Alias name: x-mode) Tcam sact x-mode. type: int more...
      • x_mode_v (Alias name: x-mode-v) Enable to set sact x-mode. type: str choices: [disable, enable] more...
    • tact type: dict
      • act Tcam tact act. type: int more...
      • act_v (Alias name: act-v) Enable to set tact act. type: str choices: [disable, enable] more...
      • fmtuv4_s (Alias name: fmtuv4-s) Tcam tact fmtuv4-s. type: int more...
      • fmtuv4_s_v (Alias name: fmtuv4-s-v) Enable to set tact fmtuv4-s. type: str choices: [disable, enable] more...
      • fmtuv6_s (Alias name: fmtuv6-s) Tcam tact fmtuv6-s. type: int more...
      • fmtuv6_s_v (Alias name: fmtuv6-s-v) Enable to set tact fmtuv6-s. type: str choices: [disable, enable] more...
      • lnkid Tcam tact lnkid. type: int more...
      • lnkid_v (Alias name: lnkid-v) Enable to set tact lnkid. type: str choices: [disable, enable] more...
      • mac_id (Alias name: mac-id) Tcam tact mac-id. type: int more...
      • mac_id_v (Alias name: mac-id-v) Enable to set tact mac-id. type: str choices: [disable, enable] more...
      • mss_t (Alias name: mss-t) Tcam tact mss. type: int more...
      • mss_t_v (Alias name: mss-t-v) Enable to set tact mss. type: str choices: [disable, enable] more...
      • mtuv4 Tcam tact mtuv4. type: int more...
      • mtuv4_v (Alias name: mtuv4-v) Enable to set tact mtuv4. type: str choices: [disable, enable] more...
      • mtuv6 Tcam tact mtuv6. type: int more...
      • mtuv6_v (Alias name: mtuv6-v) Enable to set tact mtuv6. type: str choices: [disable, enable] more...
      • slif_act (Alias name: slif-act) Tcam tact slif-act. type: int more...
      • slif_act_v (Alias name: slif-act-v) Enable to set tact slif-act. type: str choices: [disable, enable] more...
      • sublnkid Tcam tact sublnkid. type: int more...
      • sublnkid_v (Alias name: sublnkid-v) Enable to set tact sublnkid. type: str choices: [disable, enable] more...
      • tgtv_act (Alias name: tgtv-act) Tcam tact tgtv-act. type: int more...
      • tgtv_act_v (Alias name: tgtv-act-v) Enable to set tact tgtv-act. type: str choices: [disable, enable] more...
      • tlif_act (Alias name: tlif-act) Tcam tact tlif-act. type: int more...
      • tlif_act_v (Alias name: tlif-act-v) Enable to set tact tlif-act. type: str choices: [disable, enable] more...
      • tpeid Tcam tact tpeid. type: int more...
      • tpeid_v (Alias name: tpeid-v) Enable to set tact tpeid. type: str choices: [disable, enable] more...
      • v6fe Tcam tact v6fe. type: int more...
      • v6fe_v (Alias name: v6fe-v) Enable to set tact v6fe. type: str choices: [disable, enable] more...
      • vep_en_v (Alias name: vep-en-v) Enable to set tact vep-en. type: str choices: [disable, enable] more...
      • vep_slid (Alias name: vep-slid) Tcam tact vep_slid. type: int more...
      • vep_slid_v (Alias name: vep-slid-v) Enable to set tact vep-slid. type: str choices: [disable, enable] more...
      • vep_en Tcam tact vep_en. type: int more...
      • xlt_lif (Alias name: xlt-lif) Tcam tact xlt-lif. type: int more...
      • xlt_lif_v (Alias name: xlt-lif-v) Enable to set tact xlt-lif. type: str choices: [disable, enable] more...
      • xlt_vid (Alias name: xlt-vid) Tcam tact xlt-vid. type: int more...
      • xlt_vid_v (Alias name: xlt-vid-v) Enable to set tact xlt-vid. type: str choices: [disable, enable] more...
    • type Tcam policy type. type: str 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] more...
    • vid Npu tcam vid. type: int more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (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>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)