fmgr_system_npu_nputcam_mask – Mask fields of TCAM.
Added in version 2.4.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v6.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v7.4.2 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- npu-tcam - The parameter in requested url type: str required: true
- system_npu_nputcam_mask - Mask fields of TCAM. type: dict
- df Tcam mask ip flag df. type: str choices: [disable, enable] more...
- dstip Tcam mask dst ipv4 address. type: str more...
- dstipv6 Tcam mask dst ipv6 address. type: str more...
- dstmac Tcam mask dst macaddr. type: str more...
- dstport Tcam mask l4 dst port. type: int more...
- ethertype Tcam mask ethertype. type: str more...
- ext_tag (Alias name: ext-tag) Tcam mask extension tag. type: str choices: [disable, enable] more...
- frag_off (Alias name: frag-off) Tcam data ip flag fragment offset. type: int more...
- gen_buf_cnt (Alias name: gen-buf-cnt) Tcam mask gen info buffer count. type: int more...
- gen_iv (Alias name: gen-iv) Tcam mask gen info iv. type: str choices: [invalid, valid] more...
- gen_l3_flags (Alias name: gen-l3-flags) Tcam mask gen info l3 flags. type: int more...
- gen_l4_flags (Alias name: gen-l4-flags) Tcam mask gen info l4 flags. type: int more...
- gen_pkt_ctrl (Alias name: gen-pkt-ctrl) Tcam mask gen info packet control. type: int more...
- gen_pri (Alias name: gen-pri) Tcam mask gen info priority. type: int more...
- gen_pri_v (Alias name: gen-pri-v) Tcam mask gen info priority valid. type: str choices: [invalid, valid] more...
- gen_tv (Alias name: gen-tv) Tcam mask gen info tv. type: str choices: [invalid, valid] more...
- ihl Tcam mask ipv4 ihl. type: int more...
- ip4_id (Alias name: ip4-id) Tcam mask ipv4 id. type: int more...
- ip6_fl (Alias name: ip6-fl) Tcam mask ipv6 flow label. type: int more...
- ipver Tcam mask ip header version. type: int more...
- l4_wd10 (Alias name: l4-wd10) Tcam mask l4 word10. type: int more...
- l4_wd11 (Alias name: l4-wd11) Tcam mask l4 word11. type: int more...
- l4_wd8 (Alias name: l4-wd8) Tcam mask l4 word8. type: int more...
- l4_wd9 (Alias name: l4-wd9) Tcam mask l4 word9. type: int more...
- mf Tcam mask ip flag mf. type: str choices: [disable, enable] more...
- protocol Tcam mask ip protocol. type: int more...
- slink Tcam mask sublink. type: int more...
- smac_change (Alias name: smac-change) Tcam mask source mac change. type: str choices: [disable, enable] more...
- sp Tcam mask source port. type: int more...
- src_cfi (Alias name: src-cfi) Tcam mask source cfi. type: str choices: [disable, enable] more...
- src_prio (Alias name: src-prio) Tcam mask source priority. type: int more...
- src_updt (Alias name: src-updt) Tcam mask source update. type: str choices: [disable, enable] more...
- srcip Tcam mask src ipv4 address. type: str more...
- srcipv6 Tcam mask src ipv6 address. type: str more...
- srcmac Tcam mask src macaddr. type: str more...
- srcport Tcam mask l4 src port. type: int more...
- svid Tcam mask source vid. type: int more...
- tcp_ack (Alias name: tcp-ack) Tcam mask tcp flag ack. type: str choices: [disable, enable] more...
- tcp_cwr (Alias name: tcp-cwr) Tcam mask tcp flag cwr. type: str choices: [disable, enable] more...
- tcp_ece (Alias name: tcp-ece) Tcam mask tcp flag ece. type: str choices: [disable, enable] more...
- tcp_fin (Alias name: tcp-fin) Tcam mask tcp flag fin. type: str choices: [disable, enable] more...
- tcp_push (Alias name: tcp-push) Tcam mask tcp flag push. type: str choices: [disable, enable] more...
- tcp_rst (Alias name: tcp-rst) Tcam mask tcp flag rst. type: str choices: [disable, enable] more...
- tcp_syn (Alias name: tcp-syn) Tcam mask tcp flag syn. type: str choices: [disable, enable] more...
- tcp_urg (Alias name: tcp-urg) Tcam mask tcp flag urg. type: str choices: [disable, enable] more...
- tgt_cfi (Alias name: tgt-cfi) Tcam mask target cfi. type: str choices: [disable, enable] more...
- tgt_prio (Alias name: tgt-prio) Tcam mask target priority. type: int more...
- tgt_updt (Alias name: tgt-updt) Tcam mask target port update. type: str choices: [disable, enable] more...
- tgt_v (Alias name: tgt-v) Tcam mask target valid. type: str choices: [invalid, valid] more...
- tos Tcam mask ip tos. type: int more...
- tp Tcam mask target port. type: int more...
- ttl Tcam mask ip ttl. type: int more...
- tvid Tcam mask target vid. type: int more...
- vdid Tcam mask vdom id. type: int more...
Notes
Note
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: 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.