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

Note

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

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

aliases: ext-tag

string

Tcam data extension tag.

Choices:

  • "disable"

  • "enable"

frag_off

aliases: frag-off

integer

Tcam data ip flag fragment offset.

gen_buf_cnt

aliases: gen-buf-cnt

integer

Tcam data gen info buffer count.

gen_iv

aliases: gen-iv

string

Tcam data gen info iv.

Choices:

  • "invalid"

  • "valid"

gen_l3_flags

aliases: gen-l3-flags

integer

Tcam data gen info L3 flags.

gen_l4_flags

aliases: gen-l4-flags

integer

Tcam data gen info L4 flags.

gen_pkt_ctrl

aliases: gen-pkt-ctrl

integer

Tcam data gen info packet control.

gen_pri

aliases: gen-pri

integer

Tcam data gen info priority.

gen_pri_v

aliases: gen-pri-v

string

Tcam data gen info priority valid.

Choices:

  • "invalid"

  • "valid"

gen_tv

aliases: gen-tv

string

Tcam data gen info tv.

Choices:

  • "invalid"

  • "valid"

ihl

integer

Tcam data ipv4 IHL.

ip4_id

aliases: ip4-id

integer

Tcam data ipv4 id.

ip6_fl

aliases: ip6-fl

integer

Tcam data ipv6 flow label.

ipver

integer

Tcam data ip header version.

l4_wd10

aliases: l4-wd10

integer

Tcam data L4 word10.

l4_wd11

aliases: l4-wd11

integer

Tcam data L4 word11.

l4_wd8

aliases: l4-wd8

integer

Tcam data L4 word8.

l4_wd9

aliases: l4-wd9

integer

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

aliases: smac-change

string

Tcam data source MAC change.

Choices:

  • "disable"

  • "enable"

sp

integer

Tcam data source port.

src_cfi

aliases: src-cfi

string

Tcam data source cfi.

Choices:

  • "disable"

  • "enable"

src_prio

aliases: src-prio

integer

Tcam data source priority.

src_updt

aliases: src-updt

string

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

aliases: tcp-ack

string

Tcam data tcp flag ack.

Choices:

  • "disable"

  • "enable"

tcp_cwr

aliases: tcp-cwr

string

Tcam data tcp flag cwr.

Choices:

  • "disable"

  • "enable"

tcp_ece

aliases: tcp-ece

string

Tcam data tcp flag ece.

Choices:

  • "disable"

  • "enable"

tcp_fin

aliases: tcp-fin

string

Tcam data tcp flag fin.

Choices:

  • "disable"

  • "enable"

tcp_push

aliases: tcp-push

string

Tcam data tcp flag push.

Choices:

  • "disable"

  • "enable"

tcp_rst

aliases: tcp-rst

string

Tcam data tcp flag rst.

Choices:

  • "disable"

  • "enable"

tcp_syn

aliases: tcp-syn

string

Tcam data tcp flag syn.

Choices:

  • "disable"

  • "enable"

tcp_urg

aliases: tcp-urg

string

Tcam data tcp flag urg.

Choices:

  • "disable"

  • "enable"

tgt_cfi

aliases: tgt-cfi

string

Tcam data target cfi.

Choices:

  • "disable"

  • "enable"

tgt_prio

aliases: tgt-prio

integer

Tcam data target priority.

tgt_updt

aliases: tgt-updt

string

Tcam data target port update.

Choices:

  • "disable"

  • "enable"

tgt_v

aliases: tgt-v

string

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

aliases: dbg-dump

integer

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

aliases: ext-tag

string

Tcam mask extension tag.

Choices:

  • "disable"

  • "enable"

frag_off

aliases: frag-off

integer

Tcam data ip flag fragment offset.

gen_buf_cnt

aliases: gen-buf-cnt

integer

Tcam mask gen info buffer count.

gen_iv

aliases: gen-iv

string

Tcam mask gen info iv.

Choices:

  • "invalid"

  • "valid"

gen_l3_flags

aliases: gen-l3-flags

integer

Tcam mask gen info L3 flags.

gen_l4_flags

aliases: gen-l4-flags

integer

Tcam mask gen info L4 flags.

gen_pkt_ctrl

aliases: gen-pkt-ctrl

integer

Tcam mask gen info packet control.

gen_pri

aliases: gen-pri

integer

Tcam mask gen info priority.

gen_pri_v

aliases: gen-pri-v

string

Tcam mask gen info priority valid.

Choices:

  • "invalid"

  • "valid"

gen_tv

aliases: gen-tv

string

Tcam mask gen info tv.

Choices:

  • "invalid"

  • "valid"

ihl

integer

Tcam mask ipv4 IHL.

ip4_id

aliases: ip4-id

integer

Tcam mask ipv4 id.

ip6_fl

aliases: ip6-fl

integer

Tcam mask ipv6 flow label.

ipver

integer

Tcam mask ip header version.

l4_wd10

aliases: l4-wd10

integer

Tcam mask L4 word10.

l4_wd11

aliases: l4-wd11

integer

Tcam mask L4 word11.

l4_wd8

aliases: l4-wd8

integer

Tcam mask L4 word8.

l4_wd9

aliases: l4-wd9

integer

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

aliases: smac-change

string

Tcam mask source MAC change.

Choices:

  • "disable"

  • "enable"

sp

integer

Tcam mask source port.

src_cfi

aliases: src-cfi

string

Tcam mask source cfi.

Choices:

  • "disable"

  • "enable"

src_prio

aliases: src-prio

integer

Tcam mask source priority.

src_updt

aliases: src-updt

string

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

aliases: tcp-ack

string

Tcam mask tcp flag ack.

Choices:

  • "disable"

  • "enable"

tcp_cwr

aliases: tcp-cwr

string

Tcam mask tcp flag cwr.

Choices:

  • "disable"

  • "enable"

tcp_ece

aliases: tcp-ece

string

Tcam mask tcp flag ece.

Choices:

  • "disable"

  • "enable"

tcp_fin

aliases: tcp-fin

string

Tcam mask tcp flag fin.

Choices:

  • "disable"

  • "enable"

tcp_push

aliases: tcp-push

string

Tcam mask tcp flag push.

Choices:

  • "disable"

  • "enable"

tcp_rst

aliases: tcp-rst

string

Tcam mask tcp flag rst.

Choices:

  • "disable"

  • "enable"

tcp_syn

aliases: tcp-syn

string

Tcam mask tcp flag syn.

Choices:

  • "disable"

  • "enable"

tcp_urg

aliases: tcp-urg

string

Tcam mask tcp flag urg.

Choices:

  • "disable"

  • "enable"

tgt_cfi

aliases: tgt-cfi

string

Tcam mask target cfi.

Choices:

  • "disable"

  • "enable"

tgt_prio

aliases: tgt-prio

integer

Tcam mask target priority.

tgt_updt

aliases: tgt-updt

string

Tcam mask target port update.

Choices:

  • "disable"

  • "enable"

tgt_v

aliases: tgt-v

string

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

aliases: mir-act

dictionary

Mir act.

vlif

integer

Tcam mirror action vlif.

name

string / required

NPU TCAM policies name.

oid

integer

NPU TCAM OID.

pri_act

aliases: pri-act

dictionary

Pri act.

priority

integer

Tcam priority action priority.

weight

integer

Tcam priority action weight.

sact

dictionary

Sact.

act

integer

Tcam sact act.

act_v

aliases: act-v

string

Enable to set sact act.

Choices:

  • "disable"

  • "enable"

bmproc

integer

Tcam sact bmproc.

bmproc_v

aliases: bmproc-v

string

Enable to set sact bmproc.

Choices:

  • "disable"

  • "enable"

df_lif

aliases: df-lif

integer

Tcam sact df-lif.

df_lif_v

aliases: df-lif-v

string

Enable to set sact df-lif.

Choices:

  • "disable"

  • "enable"

dfr

integer

Tcam sact dfr.

dfr_v

aliases: dfr-v

string

Enable to set sact dfr.

Choices:

  • "disable"

  • "enable"

dmac_skip

aliases: dmac-skip

integer

Tcam sact dmac-skip.

dmac_skip_v

aliases: dmac-skip-v

string

Enable to set sact dmac-skip.

Choices:

  • "disable"

  • "enable"

dosen

integer

Tcam sact dosen.

dosen_v

aliases: dosen-v

string

Enable to set sact dosen.

Choices:

  • "disable"

  • "enable"

espff_proc

aliases: espff-proc

integer

Tcam sact espff-proc.

espff_proc_v

aliases: espff-proc-v

string

Enable to set sact espff-proc.

Choices:

  • "disable"

  • "enable"

etype_pid

aliases: etype-pid

integer

Tcam sact etype-pid.

etype_pid_v

aliases: etype-pid-v

string

Enable to set sact etype-pid.

Choices:

  • "disable"

  • "enable"

frag_proc

aliases: frag-proc

integer

Tcam sact frag-proc.

frag_proc_v

aliases: frag-proc-v

string

Enable to set sact frag-proc.

Choices:

  • "disable"

  • "enable"

fwd

integer

Tcam sact fwd.

fwd_lif

aliases: fwd-lif

integer

Tcam sact fwd-lif.

fwd_lif_v

aliases: fwd-lif-v

string

Enable to set sact fwd-lif.

Choices:

  • "disable"

  • "enable"

fwd_tvid

aliases: fwd-tvid

integer

Tcam sact fwd-tvid.

fwd_tvid_v

aliases: fwd-tvid-v

string

Enable to set sact fwd-vid.

Choices:

  • "disable"

  • "enable"

fwd_v

aliases: fwd-v

string

Enable to set sact fwd.

Choices:

  • "disable"

  • "enable"

icpen

integer

Tcam sact icpen.

icpen_v

aliases: icpen-v

string

Enable to set sact icpen.

Choices:

  • "disable"

  • "enable"

igmp_mld_snp

aliases: igmp-mld-snp

integer

Tcam sact igmp-mld-snp.

igmp_mld_snp_v

aliases: igmp-mld-snp-v

string

Enable to set sact igmp-mld-snp.

Choices:

  • "disable"

  • "enable"

learn

integer

Tcam sact learn.

learn_v

aliases: learn-v

string

Enable to set sact learn.

Choices:

  • "disable"

  • "enable"

m_srh_ctrl

aliases: m-srh-ctrl

integer

Tcam sact m-srh-ctrl.

m_srh_ctrl_v

aliases: m-srh-ctrl-v

string

Enable to set sact m-srh-ctrl.

Choices:

  • "disable"

  • "enable"

mac_id

aliases: mac-id

integer

Tcam sact mac-id.

mac_id_v

aliases: mac-id-v

string

Enable to set sact mac-id.

Choices:

  • "disable"

  • "enable"

mss

integer

Tcam sact mss.

mss_v

aliases: mss-v

string

Enable to set sact mss.

Choices:

  • "disable"

  • "enable"

pleen

integer

Tcam sact pleen.

pleen_v

aliases: pleen-v

string

Enable to set sact pleen.

Choices:

  • "disable"

  • "enable"

prio_pid

aliases: prio-pid

integer

Tcam sact prio-pid.

prio_pid_v

aliases: prio-pid-v

string

Enable to set sact prio-pid.

Choices:

  • "disable"

  • "enable"

promis

integer

Tcam sact promis.

promis_v

aliases: promis-v

string

Enable to set sact promis.

Choices:

  • "disable"

  • "enable"

rfsh

integer

Tcam sact rfsh.

rfsh_v

aliases: rfsh-v

string

Enable to set sact rfsh.

Choices:

  • "disable"

  • "enable"

smac_skip

aliases: smac-skip

integer

Tcam sact smac-skip.

smac_skip_v

aliases: smac-skip-v

string

Enable to set sact smac-skip.

Choices:

  • "disable"

  • "enable"

tp_smchk

integer

Tcam sact tp mode.

tp_smchk_v

aliases: tp-smchk-v

string

Enable to set sact tp mode.

Choices:

  • "disable"

  • "enable"

tpe_id

aliases: tpe-id

integer

Tcam sact tpe-id.

tpe_id_v

aliases: tpe-id-v

string

Enable to set sact tpe-id.

Choices:

  • "disable"

  • "enable"

vdm

integer

Tcam sact vdm.

vdm_v

aliases: vdm-v

string

Enable to set sact vdm.

Choices:

  • "disable"

  • "enable"

vdom_id

aliases: vdom-id

integer

Tcam sact vdom-id.

vdom_id_v

aliases: vdom-id-v

string

Enable to set sact vdom-id.

Choices:

  • "disable"

  • "enable"

x_mode

aliases: x-mode

integer

Tcam sact x-mode.

x_mode_v

aliases: x-mode-v

string

Enable to set sact x-mode.

Choices:

  • "disable"

  • "enable"

tact

dictionary

Tact.

act

integer

Tcam tact act.

act_v

aliases: act-v

string

Enable to set tact act.

Choices:

  • "disable"

  • "enable"

fmtuv4_s

aliases: fmtuv4-s

integer

Tcam tact fmtuv4-s.

fmtuv4_s_v

aliases: fmtuv4-s-v

string

Enable to set tact fmtuv4-s.

Choices:

  • "disable"

  • "enable"

fmtuv6_s

aliases: fmtuv6-s

integer

Tcam tact fmtuv6-s.

fmtuv6_s_v

aliases: fmtuv6-s-v

string

Enable to set tact fmtuv6-s.

Choices:

  • "disable"

  • "enable"

lnkid

integer

Tcam tact lnkid.

lnkid_v

aliases: lnkid-v

string

Enable to set tact lnkid.

Choices:

  • "disable"

  • "enable"

mac_id

aliases: mac-id

integer

Tcam tact mac-id.

mac_id_v

aliases: mac-id-v

string

Enable to set tact mac-id.

Choices:

  • "disable"

  • "enable"

mss_t

aliases: mss-t

integer

Tcam tact mss.

mss_t_v

aliases: mss-t-v

string

Enable to set tact mss.

Choices:

  • "disable"

  • "enable"

mtuv4

integer

Tcam tact mtuv4.

mtuv4_v

aliases: mtuv4-v

string

Enable to set tact mtuv4.

Choices:

  • "disable"

  • "enable"

mtuv6

integer

Tcam tact mtuv6.

mtuv6_v

aliases: mtuv6-v

string

Enable to set tact mtuv6.

Choices:

  • "disable"

  • "enable"

slif_act

aliases: slif-act

integer

Tcam tact slif-act.

slif_act_v

aliases: slif-act-v

string

Enable to set tact slif-act.

Choices:

  • "disable"

  • "enable"

sublnkid

integer

Tcam tact sublnkid.

sublnkid_v

aliases: sublnkid-v

string

Enable to set tact sublnkid.

Choices:

  • "disable"

  • "enable"

tgtv_act

aliases: tgtv-act

integer

Tcam tact tgtv-act.

tgtv_act_v

aliases: tgtv-act-v

string

Enable to set tact tgtv-act.

Choices:

  • "disable"

  • "enable"

tlif_act

aliases: tlif-act

integer

Tcam tact tlif-act.

tlif_act_v

aliases: tlif-act-v

string

Enable to set tact tlif-act.

Choices:

  • "disable"

  • "enable"

tpeid

integer

Tcam tact tpeid.

tpeid_v

aliases: tpeid-v

string

Enable to set tact tpeid.

Choices:

  • "disable"

  • "enable"

v6fe

integer

Tcam tact v6fe.

v6fe_v

aliases: v6fe-v

string

Enable to set tact v6fe.

Choices:

  • "disable"

  • "enable"

vep_en

integer

Tcam tact vep_en.

vep_en_v

aliases: vep-en-v

string

Enable to set tact vep-en.

Choices:

  • "disable"

  • "enable"

vep_slid

aliases: vep-slid

integer

Tcam tact vep_slid.

vep_slid_v

aliases: vep-slid-v

string

Enable to set tact vep-slid.

Choices:

  • "disable"

  • "enable"

xlt_lif

aliases: xlt-lif

integer

Tcam tact xlt-lif.

xlt_lif_v

aliases: xlt-lif-v

string

Enable to set tact xlt-lif.

Choices:

  • "disable"

  • "enable"

xlt_vid

aliases: xlt-vid

integer

Tcam tact xlt-vid.

xlt_vid_v

aliases: xlt-vid-v

string

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)