fortinet.fortimanager.fmgr_system_npu_nputcam_mask module – Mask fields of TCAM.

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_mask.

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.

npu-tcam

string

Deprecated, please use “npu_tcam”

npu_tcam

string

The parameter (npu-tcam) in requested url.

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.

system_npu_nputcam_mask

dictionary

The top level parameters set.

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.

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.

  • 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: Mask fields of TCAM.
      fortinet.fortimanager.fmgr_system_npu_nputcam_mask:
        # 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>
        npu_tcam: <your own value>
        system_npu_nputcam_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>

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)