fmgr_system_npu – Configure NPU attributes.¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- system_npu - no description type: dict
- capwap-offload - Enable/disable offloading managed FortiAP and FortiLink CAPWAP sessions. type: str choices: [disable, enable] more...
- dedicated-management-affinity - Affinity setting for management deamons (hexadecimal value up to 256 bits in the format of xxxxxxxxxxxxxxxx). type: str more...
- dedicated-management-cpu - Enable to dedicate one CPU for GUI and CLI connections when NPs are busy. type: str choices: [disable, enable] more...
- fastpath - Enable/disable NP6 offloading (also called fast path). type: str choices: [disable, enable] more...
- fp-anomaly type: dict
- esp-minlen-err - Invalid IPv4 ESP short packet anomalies. type: str choices: [drop, trap-to-host] more...
- icmp-csum-err - Invalid IPv4 ICMP packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
- icmp-minlen-err - Invalid IPv4 ICMP short packet anomalies. type: str choices: [drop, trap-to-host] more...
- ipv4-csum-err - Invalid IPv4 packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
- ipv4-ihl-err - Invalid IPv4 header length anomalies. type: str choices: [drop, trap-to-host] more...
- ipv4-len-err - Invalid IPv4 packet length anomalies. type: str choices: [drop, trap-to-host] more...
- ipv4-opt-err - Invalid IPv4 option parsing anomalies. type: str choices: [drop, trap-to-host] more...
- ipv4-ttlzero-err - Invalid IPv4 TTL field zero anomalies. type: str choices: [drop, trap-to-host] more...
- ipv4-ver-err - Invalid IPv4 header version anomalies. type: str choices: [drop, trap-to-host] more...
- ipv6-exthdr-len-err - Invalid IPv6 packet chain extension header total length anomalies. type: str choices: [drop, trap-to-host] more...
- ipv6-exthdr-order-err - Invalid IPv6 packet extension header ordering anomalies. type: str choices: [drop, trap-to-host] more...
- ipv6-ihl-err - Invalid IPv6 packet length anomalies. type: str choices: [drop, trap-to-host] more...
- ipv6-plen-zero - Invalid IPv6 packet payload length zero anomalies. type: str choices: [drop, trap-to-host] more...
- ipv6-ver-err - Invalid IPv6 packet version anomalies. type: str choices: [drop, trap-to-host] more...
- tcp-csum-err - Invalid IPv4 TCP packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
- tcp-hlen-err - Invalid IPv4 TCP header length anomalies. type: str choices: [drop, trap-to-host] more...
- tcp-plen-err - Invalid IPv4 TCP packet length anomalies. type: str choices: [drop, trap-to-host] more...
- udp-csum-err - Invalid IPv4 UDP packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
- udp-hlen-err - Invalid IPv4 UDP packet header length anomalies. type: str choices: [drop, trap-to-host] more...
- udp-len-err - Invalid IPv4 UDP packet length anomalies. type: str choices: [drop, trap-to-host] more...
- udp-plen-err - Invalid IPv4 UDP packet minimum length anomalies. type: str choices: [drop, trap-to-host] more...
- udplite-cover-err - Invalid IPv4 UDP-Lite packet coverage anomalies. type: str choices: [drop, trap-to-host] more...
- udplite-csum-err - Invalid IPv4 UDP-Lite packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
- unknproto-minlen-err - Invalid IPv4 L4 unknown protocol short packet anomalies. type: str choices: [drop, trap-to-host] more...
- gtp-enhanced-cpu-range - GTP enhanced CPU range option. type: str choices: [0, 1, 2] more...
- gtp-enhanced-mode - Enable/disable GTP enhanced mode. type: str choices: [disable, enable] more...
- host-shortcut-mode - Set np6 host shortcut mode. type: str choices: [bi-directional, host-shortcut] more...
- htx-gtse-quota - Configure HTX GTSE quota. type: str choices: [100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 600Mbps, 700Mbps, 800Mbps, 900Mbps, 1Gbps, 2Gbps, 4Gbps, 8Gbps, 10Gbps] more...
- intf-shaping-offload - Enable/disable NPU offload when doing interface-based traffic shaping according to the egress-shaping-profile. type: str choices: [disable, enable] more...
- iph-rsvd-re-cksum - Enable/disable IP checksum re-calculation for packets with iph. type: str choices: [disable, enable] more...
- ipsec-dec-subengine-mask - IPsec decryption subengine mask (0x1 - 0xff, default 0xff). type: str more...
- ipsec-enc-subengine-mask - IPsec encryption subengine mask (0x1 - 0xff, default 0xff). type: str more...
- ipsec-inbound-cache - Enable/disable IPsec inbound cache for anti-replay. type: str choices: [disable, enable] more...
- ipsec-mtu-override - Enable/disable NP6 IPsec MTU override. type: str choices: [disable, enable] more...
- ipsec-over-vlink - Enable/disable IPSEC over vlink. type: str choices: [disable, enable] more...
- isf-np-queues type: dict
- cos0 - CoS profile name for CoS 0. type: str more...
- cos1 - CoS profile name for CoS 1. type: str more...
- cos2 - CoS profile name for CoS 2. type: str more...
- cos3 - CoS profile name for CoS 3. type: str more...
- cos4 - CoS profile name for CoS 4. type: str more...
- cos5 - CoS profile name for CoS 5. type: str more...
- cos6 - CoS profile name for CoS 6. type: str more...
- cos7 - CoS profile name for CoS 7. type: str more...
- lag-out-port-select - Enable/disable LAG outgoing port selection based on incoming traffic port. type: str choices: [disable, enable] more...
- mcast-session-accounting - Enable/disable traffic accounting for each multicast session through TAE counter. type: str choices: [disable, session-based, tpe-based] more...
- np6-cps-optimization-mode - Enable/disable NP6 connection per second (CPS) optimization mode. type: str choices: [disable, enable] more...
- per-session-accounting - Enable/disable per-session accounting. type: str choices: [enable, disable, enable-by-log, all-enable, traffic-log-only] more...
- port-cpu-map - No description for the parameter type: array more...
- port-npu-map - No description for the parameter type: array more...
- priority-protocol type: dict
- bfd - Enable/disable NPU BFD priority protocol. type: str choices: [disable, enable] more...
- bgp - Enable/disable NPU BGP priority protocol. type: str choices: [disable, enable] more...
- slbc - Enable/disable NPU SLBC priority protocol. type: str choices: [disable, enable] more...
- qos-mode - QoS mode on switch and NP. type: str choices: [disable, priority, round-robin] more...
- rdp-offload - Enable/disable rdp offload. type: str choices: [disable, enable] more...
- recover-np6-link - Enable/disable internal link failure check and recovery after boot up. type: str choices: [disable, enable] more...
- session-denied-offload - Enable/disable offloading of denied sessions. type: str choices: [disable, enable] more...
- sse-backpressure - Enable/disable sse backpressure. type: str choices: [disable, enable] more...
- strip-clear-text-padding - Enable/disable stripping clear text padding. type: str choices: [disable, enable] more...
- strip-esp-padding - Enable/disable stripping ESP padding. type: str choices: [disable, enable] more...
- sw-eh-hash type: dict
- computation - Set hashing computation. type: str choices: [xor16, xor8, xor4, crc16] more...
- destination-ip-lower-16 - Include/exclude destination IP address lower 16 bits. type: str choices: [include, exclude] more...
- destination-ip-upper-16 - Include/exclude destination IP address upper 16 bits. type: str choices: [include, exclude] more...
- destination-port - Include/exclude destination port if TCP/UDP. type: str choices: [include, exclude] more...
- ip-protocol - Include/exclude IP protocol. type: str choices: [include, exclude] more...
- netmask-length - Network mask length. type: int more...
- source-ip-lower-16 - Include/exclude source IP address lower 16 bits. type: str choices: [include, exclude] more...
- source-ip-upper-16 - Include/exclude source IP address upper 16 bits. type: str choices: [include, exclude] more...
- source-port - Include/exclude source port if TCP/UDP. type: str choices: [include, exclude] more...
- sw-np-bandwidth - Bandwidth from switch to NP. type: str choices: [0G, 2G, 4G, 5G, 6G, 7G, 8G, 9G] more...
- switch-np-hash - Switch-NP trunk port selection Criteria. type: str choices: [src-ip, dst-ip, src-dst-ip] more...
- uesp-offload - Enable/disable UDP-encapsulated ESP offload (default = disable). type: str choices: [disable, enable] 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_system_npu:
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>
system_npu:
capwap-offload: <value in [disable, enable]>
dedicated-management-affinity: <value of string>
dedicated-management-cpu: <value in [disable, enable]>
fastpath: <value in [disable, enable]>
fp-anomaly:
esp-minlen-err: <value in [drop, trap-to-host]>
icmp-csum-err: <value in [drop, trap-to-host]>
icmp-minlen-err: <value in [drop, trap-to-host]>
ipv4-csum-err: <value in [drop, trap-to-host]>
ipv4-ihl-err: <value in [drop, trap-to-host]>
ipv4-len-err: <value in [drop, trap-to-host]>
ipv4-opt-err: <value in [drop, trap-to-host]>
ipv4-ttlzero-err: <value in [drop, trap-to-host]>
ipv4-ver-err: <value in [drop, trap-to-host]>
ipv6-exthdr-len-err: <value in [drop, trap-to-host]>
ipv6-exthdr-order-err: <value in [drop, trap-to-host]>
ipv6-ihl-err: <value in [drop, trap-to-host]>
ipv6-plen-zero: <value in [drop, trap-to-host]>
ipv6-ver-err: <value in [drop, trap-to-host]>
tcp-csum-err: <value in [drop, trap-to-host]>
tcp-hlen-err: <value in [drop, trap-to-host]>
tcp-plen-err: <value in [drop, trap-to-host]>
udp-csum-err: <value in [drop, trap-to-host]>
udp-hlen-err: <value in [drop, trap-to-host]>
udp-len-err: <value in [drop, trap-to-host]>
udp-plen-err: <value in [drop, trap-to-host]>
udplite-cover-err: <value in [drop, trap-to-host]>
udplite-csum-err: <value in [drop, trap-to-host]>
unknproto-minlen-err: <value in [drop, trap-to-host]>
gtp-enhanced-cpu-range: <value in [0, 1, 2]>
gtp-enhanced-mode: <value in [disable, enable]>
host-shortcut-mode: <value in [bi-directional, host-shortcut]>
htx-gtse-quota: <value in [100Mbps, 200Mbps, 300Mbps, ...]>
intf-shaping-offload: <value in [disable, enable]>
iph-rsvd-re-cksum: <value in [disable, enable]>
ipsec-dec-subengine-mask: <value of string>
ipsec-enc-subengine-mask: <value of string>
ipsec-inbound-cache: <value in [disable, enable]>
ipsec-mtu-override: <value in [disable, enable]>
ipsec-over-vlink: <value in [disable, enable]>
isf-np-queues:
cos0: <value of string>
cos1: <value of string>
cos2: <value of string>
cos3: <value of string>
cos4: <value of string>
cos5: <value of string>
cos6: <value of string>
cos7: <value of string>
lag-out-port-select: <value in [disable, enable]>
mcast-session-accounting: <value in [disable, session-based, tpe-based]>
np6-cps-optimization-mode: <value in [disable, enable]>
per-session-accounting: <value in [enable, disable, enable-by-log, ...]>
port-cpu-map:
-
cpu-core: <value of string>
interface: <value of string>
port-npu-map:
-
interface: <value of string>
npu-group-index: <value of integer>
priority-protocol:
bfd: <value in [disable, enable]>
bgp: <value in [disable, enable]>
slbc: <value in [disable, enable]>
qos-mode: <value in [disable, priority, round-robin]>
rdp-offload: <value in [disable, enable]>
recover-np6-link: <value in [disable, enable]>
session-denied-offload: <value in [disable, enable]>
sse-backpressure: <value in [disable, enable]>
strip-clear-text-padding: <value in [disable, enable]>
strip-esp-padding: <value in [disable, enable]>
sw-eh-hash:
computation: <value in [xor16, xor8, xor4, ...]>
destination-ip-lower-16: <value in [include, exclude]>
destination-ip-upper-16: <value in [include, exclude]>
destination-port: <value in [include, exclude]>
ip-protocol: <value in [include, exclude]>
netmask-length: <value of integer>
source-ip-lower-16: <value in [include, exclude]>
source-ip-upper-16: <value in [include, exclude]>
source-port: <value in [include, exclude]>
sw-np-bandwidth: <value in [0G, 2G, 4G, ...]>
switch-np-hash: <value in [src-ip, dst-ip, src-dst-ip]>
uesp-offload: <value in [disable, enable]>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict