fortinet.fortimanager.fmgr_system_npu_nputcam_mask module – Mask fields of TCAM.
Note
This module is part of the fortinet.fortimanager collection (version 2.5.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_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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
Deprecated, please use “npu_tcam” |
|
The parameter (npu-tcam) in requested url. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Tcam mask ip flag df. Choices:
|
|
Tcam mask dst ipv4 address. |
|
Tcam mask dst ipv6 address. |
|
Tcam mask dst macaddr. |
|
Tcam mask L4 dst port. |
|
Tcam mask ethertype. |
|
Deprecated, please rename it to ext_tag. Tcam mask extension tag. Choices:
|
|
Deprecated, please rename it to frag_off. Tcam data ip flag fragment offset. |
|
Deprecated, please rename it to gen_buf_cnt. Tcam mask gen info buffer count. |
|
Deprecated, please rename it to gen_iv. Tcam mask gen info iv. Choices:
|
|
Deprecated, please rename it to gen_l3_flags. Tcam mask gen info L3 flags. |
|
Deprecated, please rename it to gen_l4_flags. Tcam mask gen info L4 flags. |
|
Deprecated, please rename it to gen_pkt_ctrl. Tcam mask gen info packet control. |
|
Deprecated, please rename it to gen_pri. Tcam mask gen info priority. |
|
Deprecated, please rename it to gen_pri_v. Tcam mask gen info priority valid. Choices:
|
|
Deprecated, please rename it to gen_tv. Tcam mask gen info tv. Choices:
|
|
Tcam mask ipv4 IHL. |
|
Deprecated, please rename it to ip4_id. Tcam mask ipv4 id. |
|
Deprecated, please rename it to ip6_fl. Tcam mask ipv6 flow label. |
|
Tcam mask ip header version. |
|
Deprecated, please rename it to l4_wd10. Tcam mask L4 word10. |
|
Deprecated, please rename it to l4_wd11. Tcam mask L4 word11. |
|
Deprecated, please rename it to l4_wd8. Tcam mask L4 word8. |
|
Deprecated, please rename it to l4_wd9. Tcam mask L4 word9. |
|
Tcam mask ip flag mf. Choices:
|
|
Tcam mask ip protocol. |
|
Tcam mask sublink. |
|
Deprecated, please rename it to smac_change. Tcam mask source MAC change. Choices:
|
|
Tcam mask source port. |
|
Deprecated, please rename it to src_cfi. Tcam mask source cfi. Choices:
|
|
Deprecated, please rename it to src_prio. Tcam mask source priority. |
|
Deprecated, please rename it to src_updt. Tcam mask source update. Choices:
|
|
Tcam mask src ipv4 address. |
|
Tcam mask src ipv6 address. |
|
Tcam mask src macaddr. |
|
Tcam mask L4 src port. |
|
Tcam mask source vid. |
|
Deprecated, please rename it to tcp_ack. Tcam mask tcp flag ack. Choices:
|
|
Deprecated, please rename it to tcp_cwr. Tcam mask tcp flag cwr. Choices:
|
|
Deprecated, please rename it to tcp_ece. Tcam mask tcp flag ece. Choices:
|
|
Deprecated, please rename it to tcp_fin. Tcam mask tcp flag fin. Choices:
|
|
Deprecated, please rename it to tcp_push. Tcam mask tcp flag push. Choices:
|
|
Deprecated, please rename it to tcp_rst. Tcam mask tcp flag rst. Choices:
|
|
Deprecated, please rename it to tcp_syn. Tcam mask tcp flag syn. Choices:
|
|
Deprecated, please rename it to tcp_urg. Tcam mask tcp flag urg. Choices:
|
|
Deprecated, please rename it to tgt_cfi. Tcam mask target cfi. Choices:
|
|
Deprecated, please rename it to tgt_prio. Tcam mask target priority. |
|
Deprecated, please rename it to tgt_updt. Tcam mask target port update. Choices:
|
|
Deprecated, please rename it to tgt_v. Tcam mask target valid. Choices:
|
|
Tcam mask ip tos. |
|
Tcam mask target port. |
|
Tcam mask ip ttl. |
|
Tcam mask target vid. |
|
Tcam mask vdom id. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |