fortinet.fortimanager.fmgr_system_npu_nputcam_data module – Data fields of TCAM.

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

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_data

dictionary

The top level parameters set.

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.

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: Data fields of TCAM.
      fortinet.fortimanager.fmgr_system_npu_nputcam_data:
        # 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_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>

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)