fortinet.fortimanager.fmgr_system_npu_nputcam module – Configure NPU TCAM policies.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_npu_nputcam.

New in fortinet.fortimanager 2.4.0

Synopsis

  • This module is able to configure a FortiManager device.

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

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

system_npu_nputcam

dictionary

The top level parameters set.

data

dictionary

Data.

df

string

Tcam data ip flag df.

Choices:

  • "disable"

  • "enable"

dstip

string

Tcam data dst ipv4 address.

dstipv6

string

Tcam data dst ipv6 address.

dstmac

string

Tcam data dst macaddr.

dstport

integer

Tcam data L4 dst port.

ethertype

string

Tcam data ethertype.

ext-tag

string

Deprecated, please rename it to ext_tag. Tcam data extension tag.

Choices:

  • "disable"

  • "enable"

frag-off

integer

Deprecated, please rename it to frag_off. Tcam data ip flag fragment offset.

gen-buf-cnt

integer

Deprecated, please rename it to gen_buf_cnt. Tcam data gen info buffer count.

gen-iv

string

Deprecated, please rename it to gen_iv. Tcam data gen info iv.

Choices:

  • "invalid"

  • "valid"

gen-l3-flags

integer

Deprecated, please rename it to gen_l3_flags. Tcam data gen info L3 flags.

gen-l4-flags

integer

Deprecated, please rename it to gen_l4_flags. Tcam data gen info L4 flags.

gen-pkt-ctrl

integer

Deprecated, please rename it to gen_pkt_ctrl. Tcam data gen info packet control.

gen-pri

integer

Deprecated, please rename it to gen_pri. Tcam data gen info priority.

gen-pri-v

string

Deprecated, please rename it to gen_pri_v. Tcam data gen info priority valid.

Choices:

  • "invalid"

  • "valid"

gen-tv

string

Deprecated, please rename it to gen_tv. Tcam data gen info tv.

Choices:

  • "invalid"

  • "valid"

ihl

integer

Tcam data ipv4 IHL.

ip4-id

integer

Deprecated, please rename it to ip4_id. Tcam data ipv4 id.

ip6-fl

integer

Deprecated, please rename it to ip6_fl. Tcam data ipv6 flow label.

ipver

integer

Tcam data ip header version.

l4-wd10

integer

Deprecated, please rename it to l4_wd10. Tcam data L4 word10.

l4-wd11

integer

Deprecated, please rename it to l4_wd11. Tcam data L4 word11.

l4-wd8

integer

Deprecated, please rename it to l4_wd8. Tcam data L4 word8.

l4-wd9

integer

Deprecated, please rename it to l4_wd9. Tcam data L4 word9.

mf

string

Tcam data ip flag mf.

Choices:

  • "disable"

  • "enable"

protocol

integer

Tcam data ip protocol.

integer

Tcam data sublink.

smac-change

string

Deprecated, please rename it to smac_change. Tcam data source MAC change.

Choices:

  • "disable"

  • "enable"

sp

integer

Tcam data source port.

src-cfi

string

Deprecated, please rename it to src_cfi. Tcam data source cfi.

Choices:

  • "disable"

  • "enable"

src-prio

integer

Deprecated, please rename it to src_prio. Tcam data source priority.

src-updt

string

Deprecated, please rename it to src_updt. Tcam data source update.

Choices:

  • "disable"

  • "enable"

srcip

string

Tcam data src ipv4 address.

srcipv6

string

Tcam data src ipv6 address.

srcmac

string

Tcam data src macaddr.

srcport

integer

Tcam data L4 src port.

svid

integer

Tcam data source vid.

tcp-ack

string

Deprecated, please rename it to tcp_ack. Tcam data tcp flag ack.

Choices:

  • "disable"

  • "enable"

tcp-cwr

string

Deprecated, please rename it to tcp_cwr. Tcam data tcp flag cwr.

Choices:

  • "disable"

  • "enable"

tcp-ece

string

Deprecated, please rename it to tcp_ece. Tcam data tcp flag ece.

Choices:

  • "disable"

  • "enable"

tcp-fin

string

Deprecated, please rename it to tcp_fin. Tcam data tcp flag fin.

Choices:

  • "disable"

  • "enable"

tcp-push

string

Deprecated, please rename it to tcp_push. Tcam data tcp flag push.

Choices:

  • "disable"

  • "enable"

tcp-rst

string

Deprecated, please rename it to tcp_rst. Tcam data tcp flag rst.

Choices:

  • "disable"

  • "enable"

tcp-syn

string

Deprecated, please rename it to tcp_syn. Tcam data tcp flag syn.

Choices:

  • "disable"

  • "enable"

tcp-urg

string

Deprecated, please rename it to tcp_urg. Tcam data tcp flag urg.

Choices:

  • "disable"

  • "enable"

tgt-cfi

string

Deprecated, please rename it to tgt_cfi. Tcam data target cfi.

Choices:

  • "disable"

  • "enable"

tgt-prio

integer

Deprecated, please rename it to tgt_prio. Tcam data target priority.

tgt-updt

string

Deprecated, please rename it to tgt_updt. Tcam data target port update.

Choices:

  • "disable"

  • "enable"

tgt-v

string

Deprecated, please rename it to tgt_v. Tcam data target valid.

Choices:

  • "invalid"

  • "valid"

tos

integer

Tcam data ip tos.

tp

integer

Tcam data target port.

ttl

integer

Tcam data ip ttl.

tvid

integer

Tcam data target vid.

vdid

integer

Tcam data vdom id.

dbg-dump

integer

Deprecated, please rename it to dbg_dump. Debug driver dump data/mask pdq.

mask

dictionary

Mask.

df

string

Tcam mask ip flag df.

Choices:

  • "disable"

  • "enable"

dstip

string

Tcam mask dst ipv4 address.

dstipv6

string

Tcam mask dst ipv6 address.

dstmac

string

Tcam mask dst macaddr.

dstport

integer

Tcam mask L4 dst port.

ethertype

string

Tcam mask ethertype.

ext-tag

string

Deprecated, please rename it to ext_tag. Tcam mask extension tag.

Choices:

  • "disable"

  • "enable"

frag-off

integer

Deprecated, please rename it to frag_off. Tcam data ip flag fragment offset.

gen-buf-cnt

integer

Deprecated, please rename it to gen_buf_cnt. Tcam mask gen info buffer count.

gen-iv

string

Deprecated, please rename it to gen_iv. Tcam mask gen info iv.

Choices:

  • "invalid"

  • "valid"

gen-l3-flags

integer

Deprecated, please rename it to gen_l3_flags. Tcam mask gen info L3 flags.

gen-l4-flags

integer

Deprecated, please rename it to gen_l4_flags. Tcam mask gen info L4 flags.

gen-pkt-ctrl

integer

Deprecated, please rename it to gen_pkt_ctrl. Tcam mask gen info packet control.

gen-pri

integer

Deprecated, please rename it to gen_pri. Tcam mask gen info priority.

gen-pri-v

string

Deprecated, please rename it to gen_pri_v. Tcam mask gen info priority valid.

Choices:

  • "invalid"

  • "valid"

gen-tv

string

Deprecated, please rename it to gen_tv. Tcam mask gen info tv.

Choices:

  • "invalid"

  • "valid"

ihl

integer

Tcam mask ipv4 IHL.

ip4-id

integer

Deprecated, please rename it to ip4_id. Tcam mask ipv4 id.

ip6-fl

integer

Deprecated, please rename it to ip6_fl. Tcam mask ipv6 flow label.

ipver

integer

Tcam mask ip header version.

l4-wd10

integer

Deprecated, please rename it to l4_wd10. Tcam mask L4 word10.

l4-wd11

integer

Deprecated, please rename it to l4_wd11. Tcam mask L4 word11.

l4-wd8

integer

Deprecated, please rename it to l4_wd8. Tcam mask L4 word8.

l4-wd9

integer

Deprecated, please rename it to l4_wd9. Tcam mask L4 word9.

mf

string

Tcam mask ip flag mf.

Choices:

  • "disable"

  • "enable"

protocol

integer

Tcam mask ip protocol.

integer

Tcam mask sublink.

smac-change

string

Deprecated, please rename it to smac_change. Tcam mask source MAC change.

Choices:

  • "disable"

  • "enable"

sp

integer

Tcam mask source port.

src-cfi

string

Deprecated, please rename it to src_cfi. Tcam mask source cfi.

Choices:

  • "disable"

  • "enable"

src-prio

integer

Deprecated, please rename it to src_prio. Tcam mask source priority.

src-updt

string

Deprecated, please rename it to src_updt. Tcam mask source update.

Choices:

  • "disable"

  • "enable"

srcip

string

Tcam mask src ipv4 address.

srcipv6

string

Tcam mask src ipv6 address.

srcmac

string

Tcam mask src macaddr.

srcport

integer

Tcam mask L4 src port.

svid

integer

Tcam mask source vid.

tcp-ack

string

Deprecated, please rename it to tcp_ack. Tcam mask tcp flag ack.

Choices:

  • "disable"

  • "enable"

tcp-cwr

string

Deprecated, please rename it to tcp_cwr. Tcam mask tcp flag cwr.

Choices:

  • "disable"

  • "enable"

tcp-ece

string

Deprecated, please rename it to tcp_ece. Tcam mask tcp flag ece.

Choices:

  • "disable"

  • "enable"

tcp-fin

string

Deprecated, please rename it to tcp_fin. Tcam mask tcp flag fin.

Choices:

  • "disable"

  • "enable"

tcp-push

string

Deprecated, please rename it to tcp_push. Tcam mask tcp flag push.

Choices:

  • "disable"

  • "enable"

tcp-rst

string

Deprecated, please rename it to tcp_rst. Tcam mask tcp flag rst.

Choices:

  • "disable"

  • "enable"

tcp-syn

string

Deprecated, please rename it to tcp_syn. Tcam mask tcp flag syn.

Choices:

  • "disable"

  • "enable"

tcp-urg

string

Deprecated, please rename it to tcp_urg. Tcam mask tcp flag urg.

Choices:

  • "disable"

  • "enable"

tgt-cfi

string

Deprecated, please rename it to tgt_cfi. Tcam mask target cfi.

Choices:

  • "disable"

  • "enable"

tgt-prio

integer

Deprecated, please rename it to tgt_prio. Tcam mask target priority.

tgt-updt

string

Deprecated, please rename it to tgt_updt. Tcam mask target port update.

Choices:

  • "disable"

  • "enable"

tgt-v

string

Deprecated, please rename it to tgt_v. Tcam mask target valid.

Choices:

  • "invalid"

  • "valid"

tos

integer

Tcam mask ip tos.

tp

integer

Tcam mask target port.

ttl

integer

Tcam mask ip ttl.

tvid

integer

Tcam mask target vid.

vdid

integer

Tcam mask vdom id.

mir-act

dictionary

Deprecated, please rename it to mir_act. Mir act.

vlif

integer

Tcam mirror action vlif.

name

string / required

NPU TCAM policies name.

oid

integer

NPU TCAM OID.

pri-act

dictionary

Deprecated, please rename it to pri_act. Pri act.

priority

integer

Tcam priority action priority.

weight

integer

Tcam priority action weight.

sact

dictionary

Sact.

act

integer

Tcam sact act.

act-v

string

Deprecated, please rename it to act_v. Enable to set sact act.

Choices:

  • "disable"

  • "enable"

bmproc

integer

Tcam sact bmproc.

bmproc-v

string

Deprecated, please rename it to bmproc_v. Enable to set sact bmproc.

Choices:

  • "disable"

  • "enable"

df-lif

integer

Deprecated, please rename it to df_lif. Tcam sact df-lif.

df-lif-v

string

Deprecated, please rename it to df_lif_v. Enable to set sact df-lif.

Choices:

  • "disable"

  • "enable"

dfr

integer

Tcam sact dfr.

dfr-v

string

Deprecated, please rename it to dfr_v. Enable to set sact dfr.

Choices:

  • "disable"

  • "enable"

dmac-skip

integer

Deprecated, please rename it to dmac_skip. Tcam sact dmac-skip.

dmac-skip-v

string

Deprecated, please rename it to dmac_skip_v. Enable to set sact dmac-skip.

Choices:

  • "disable"

  • "enable"

dosen

integer

Tcam sact dosen.

dosen-v

string

Deprecated, please rename it to dosen_v. Enable to set sact dosen.

Choices:

  • "disable"

  • "enable"

espff-proc

integer

Deprecated, please rename it to espff_proc. Tcam sact espff-proc.

espff-proc-v

string

Deprecated, please rename it to espff_proc_v. Enable to set sact espff-proc.

Choices:

  • "disable"

  • "enable"

etype-pid

integer

Deprecated, please rename it to etype_pid. Tcam sact etype-pid.

etype-pid-v

string

Deprecated, please rename it to etype_pid_v. Enable to set sact etype-pid.

Choices:

  • "disable"

  • "enable"

frag-proc

integer

Deprecated, please rename it to frag_proc. Tcam sact frag-proc.

frag-proc-v

string

Deprecated, please rename it to frag_proc_v. Enable to set sact frag-proc.

Choices:

  • "disable"

  • "enable"

fwd

integer

Tcam sact fwd.

fwd-lif

integer

Deprecated, please rename it to fwd_lif. Tcam sact fwd-lif.

fwd-lif-v

string

Deprecated, please rename it to fwd_lif_v. Enable to set sact fwd-lif.

Choices:

  • "disable"

  • "enable"

fwd-tvid

integer

Deprecated, please rename it to fwd_tvid. Tcam sact fwd-tvid.

fwd-tvid-v

string

Deprecated, please rename it to fwd_tvid_v. Enable to set sact fwd-vid.

Choices:

  • "disable"

  • "enable"

fwd-v

string

Deprecated, please rename it to fwd_v. Enable to set sact fwd.

Choices:

  • "disable"

  • "enable"

icpen

integer

Tcam sact icpen.

icpen-v

string

Deprecated, please rename it to icpen_v. Enable to set sact icpen.

Choices:

  • "disable"

  • "enable"

igmp-mld-snp

integer

Deprecated, please rename it to igmp_mld_snp. Tcam sact igmp-mld-snp.

igmp-mld-snp-v

string

Deprecated, please rename it to igmp_mld_snp_v. Enable to set sact igmp-mld-snp.

Choices:

  • "disable"

  • "enable"

learn

integer

Tcam sact learn.

learn-v

string

Deprecated, please rename it to learn_v. Enable to set sact learn.

Choices:

  • "disable"

  • "enable"

m-srh-ctrl

integer

Deprecated, please rename it to m_srh_ctrl. Tcam sact m-srh-ctrl.

m-srh-ctrl-v

string

Deprecated, please rename it to m_srh_ctrl_v. Enable to set sact m-srh-ctrl.

Choices:

  • "disable"

  • "enable"

mac-id

integer

Deprecated, please rename it to mac_id. Tcam sact mac-id.

mac-id-v

string

Deprecated, please rename it to mac_id_v. Enable to set sact mac-id.

Choices:

  • "disable"

  • "enable"

mss

integer

Tcam sact mss.

mss-v

string

Deprecated, please rename it to mss_v. Enable to set sact mss.

Choices:

  • "disable"

  • "enable"

pleen

integer

Tcam sact pleen.

pleen-v

string

Deprecated, please rename it to pleen_v. Enable to set sact pleen.

Choices:

  • "disable"

  • "enable"

prio-pid

integer

Deprecated, please rename it to prio_pid. Tcam sact prio-pid.

prio-pid-v

string

Deprecated, please rename it to prio_pid_v. Enable to set sact prio-pid.

Choices:

  • "disable"

  • "enable"

promis

integer

Tcam sact promis.

promis-v

string

Deprecated, please rename it to promis_v. Enable to set sact promis.

Choices:

  • "disable"

  • "enable"

rfsh

integer

Tcam sact rfsh.

rfsh-v

string

Deprecated, please rename it to rfsh_v. Enable to set sact rfsh.

Choices:

  • "disable"

  • "enable"

smac-skip

integer

Deprecated, please rename it to smac_skip. Tcam sact smac-skip.

smac-skip-v

string

Deprecated, please rename it to smac_skip_v. Enable to set sact smac-skip.

Choices:

  • "disable"

  • "enable"

tp-smchk-v

string

Deprecated, please rename it to tp_smchk_v. Enable to set sact tp mode.

Choices:

  • "disable"

  • "enable"

tp_smchk

integer

Tcam sact tp mode.

tpe-id

integer

Deprecated, please rename it to tpe_id. Tcam sact tpe-id.

tpe-id-v

string

Deprecated, please rename it to tpe_id_v. Enable to set sact tpe-id.

Choices:

  • "disable"

  • "enable"

vdm

integer

Tcam sact vdm.

vdm-v

string

Deprecated, please rename it to vdm_v. Enable to set sact vdm.

Choices:

  • "disable"

  • "enable"

vdom-id

integer

Deprecated, please rename it to vdom_id. Tcam sact vdom-id.

vdom-id-v

string

Deprecated, please rename it to vdom_id_v. Enable to set sact vdom-id.

Choices:

  • "disable"

  • "enable"

x-mode

integer

Deprecated, please rename it to x_mode. Tcam sact x-mode.

x-mode-v

string

Deprecated, please rename it to x_mode_v. Enable to set sact x-mode.

Choices:

  • "disable"

  • "enable"

tact

dictionary

Tact.

act

integer

Tcam tact act.

act-v

string

Deprecated, please rename it to act_v. Enable to set tact act.

Choices:

  • "disable"

  • "enable"

fmtuv4-s

integer

Deprecated, please rename it to fmtuv4_s. Tcam tact fmtuv4-s.

fmtuv4-s-v

string

Deprecated, please rename it to fmtuv4_s_v. Enable to set tact fmtuv4-s.

Choices:

  • "disable"

  • "enable"

fmtuv6-s

integer

Deprecated, please rename it to fmtuv6_s. Tcam tact fmtuv6-s.

fmtuv6-s-v

string

Deprecated, please rename it to fmtuv6_s_v. Enable to set tact fmtuv6-s.

Choices:

  • "disable"

  • "enable"

lnkid

integer

Tcam tact lnkid.

lnkid-v

string

Deprecated, please rename it to lnkid_v. Enable to set tact lnkid.

Choices:

  • "disable"

  • "enable"

mac-id

integer

Deprecated, please rename it to mac_id. Tcam tact mac-id.

mac-id-v

string

Deprecated, please rename it to mac_id_v. Enable to set tact mac-id.

Choices:

  • "disable"

  • "enable"

mss-t

integer

Deprecated, please rename it to mss_t. Tcam tact mss.

mss-t-v

string

Deprecated, please rename it to mss_t_v. Enable to set tact mss.

Choices:

  • "disable"

  • "enable"

mtuv4

integer

Tcam tact mtuv4.

mtuv4-v

string

Deprecated, please rename it to mtuv4_v. Enable to set tact mtuv4.

Choices:

  • "disable"

  • "enable"

mtuv6

integer

Tcam tact mtuv6.

mtuv6-v

string

Deprecated, please rename it to mtuv6_v. Enable to set tact mtuv6.

Choices:

  • "disable"

  • "enable"

slif-act

integer

Deprecated, please rename it to slif_act. Tcam tact slif-act.

slif-act-v

string

Deprecated, please rename it to slif_act_v. Enable to set tact slif-act.

Choices:

  • "disable"

  • "enable"

sublnkid

integer

Tcam tact sublnkid.

sublnkid-v

string

Deprecated, please rename it to sublnkid_v. Enable to set tact sublnkid.

Choices:

  • "disable"

  • "enable"

tgtv-act

integer

Deprecated, please rename it to tgtv_act. Tcam tact tgtv-act.

tgtv-act-v

string

Deprecated, please rename it to tgtv_act_v. Enable to set tact tgtv-act.

Choices:

  • "disable"

  • "enable"

tlif-act

integer

Deprecated, please rename it to tlif_act. Tcam tact tlif-act.

tlif-act-v

string

Deprecated, please rename it to tlif_act_v. Enable to set tact tlif-act.

Choices:

  • "disable"

  • "enable"

tpeid

integer

Tcam tact tpeid.

tpeid-v

string

Deprecated, please rename it to tpeid_v. Enable to set tact tpeid.

Choices:

  • "disable"

  • "enable"

v6fe

integer

Tcam tact v6fe.

v6fe-v

string

Deprecated, please rename it to v6fe_v. Enable to set tact v6fe.

Choices:

  • "disable"

  • "enable"

vep-en-v

string

Deprecated, please rename it to vep_en_v. Enable to set tact vep-en.

Choices:

  • "disable"

  • "enable"

vep-slid

integer

Deprecated, please rename it to vep_slid. Tcam tact vep_slid.

vep-slid-v

string

Deprecated, please rename it to vep_slid_v. Enable to set tact vep-slid.

Choices:

  • "disable"

  • "enable"

vep_en

integer

Tcam tact vep_en.

xlt-lif

integer

Deprecated, please rename it to xlt_lif. Tcam tact xlt-lif.

xlt-lif-v

string

Deprecated, please rename it to xlt_lif_v. Enable to set tact xlt-lif.

Choices:

  • "disable"

  • "enable"

xlt-vid

integer

Deprecated, please rename it to xlt_vid. Tcam tact xlt-vid.

xlt-vid-v

string

Deprecated, please rename it to xlt_vid_v. Enable to set tact xlt-vid.

Choices:

  • "disable"

  • "enable"

type

string

TCAM policy 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"

vid

integer

NPU TCAM VID.

workspace_locking_adom

string

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

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

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

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

  • To delete an object, use state absent directive.

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

Examples

- name: Example playbook (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 here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)