Try SpotterConfigure NPU attributes.
| "added in version" 2.1.6 of drmofu.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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: Configure NPU attributes.
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]>
tcp-fin-only: <value in [allow, drop, trap-to-host]>
ipv4-optsecurity: <value in [allow, drop, trap-to-host]>
ipv6-optralert: <value in [allow, drop, trap-to-host]>
tcp-syn-fin: <value in [allow, drop, trap-to-host]>
ipv4-proto-err: <value in [allow, drop, trap-to-host]>
ipv6-saddr-err: <value in [allow, drop, trap-to-host]>
icmp-frag: <value in [allow, drop, trap-to-host]>
ipv4-optssrr: <value in [allow, drop, trap-to-host]>
ipv6-opthomeaddr: <value in [allow, drop, trap-to-host]>
udp-land: <value in [allow, drop, trap-to-host]>
ipv6-optinvld: <value in [allow, drop, trap-to-host]>
tcp-fin-noack: <value in [allow, drop, trap-to-host]>
ipv6-proto-err: <value in [allow, drop, trap-to-host]>
tcp-land: <value in [allow, drop, trap-to-host]>
ipv4-unknopt: <value in [allow, drop, trap-to-host]>
ipv4-optstream: <value in [allow, drop, trap-to-host]>
ipv6-optjumbo: <value in [allow, drop, trap-to-host]>
icmp-land: <value in [allow, drop, trap-to-host]>
tcp-winnuke: <value in [allow, drop, trap-to-host]>
ipv6-daddr-err: <value in [allow, drop, trap-to-host]>
ipv4-land: <value in [allow, drop, trap-to-host]>
ipv6-opttunnel: <value in [allow, drop, trap-to-host]>
tcp-no-flag: <value in [allow, drop, trap-to-host]>
ipv6-land: <value in [allow, drop, trap-to-host]>
ipv4-optlsrr: <value in [allow, drop, trap-to-host]>
ipv4-opttimestamp: <value in [allow, drop, trap-to-host]>
ipv4-optrr: <value in [allow, drop, trap-to-host]>
ipv6-optnsap: <value in [allow, drop, trap-to-host]>
ipv6-unknopt: <value in [allow, drop, trap-to-host]>
tcp-syn-data: <value in [allow, drop, trap-to-host]>
ipv6-optendpid: <value in [allow, drop, trap-to-host]>
gtpu-plen-err: <value in [drop, trap-to-host]>
vxlan-minlen-err: <value in [drop, trap-to-host]>
capwap-minlen-err: <value in [drop, trap-to-host]>
gre-csum-err: <value in [drop, trap-to-host]>
nvgre-minlen-err: <value in [drop, trap-to-host]>
sctp-l4len-err: <value in [drop, trap-to-host]>
tcp-hlenvsl4len-err: <value in [drop, trap-to-host]>
sctp-crc-err: <value in [drop, trap-to-host]>
sctp-clen-err: <value in [drop, trap-to-host]>
uesp-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]>
np-queues:
ethernet-type:
-
name: <value of string>
queue: <value of integer>
type: <value of integer>
weight: <value of integer>
ip-protocol:
-
name: <value of string>
protocol: <value of integer>
queue: <value of integer>
weight: <value of integer>
ip-service:
-
dport: <value of integer>
name: <value of string>
protocol: <value of integer>
queue: <value of integer>
sport: <value of integer>
weight: <value of integer>
profile:
-
cos0: <value in [queue0, queue1, queue2, ...]>
cos1: <value in [queue0, queue1, queue2, ...]>
cos2: <value in [queue0, queue1, queue2, ...]>
cos3: <value in [queue0, queue1, queue2, ...]>
cos4: <value in [queue0, queue1, queue2, ...]>
cos5: <value in [queue0, queue1, queue2, ...]>
cos6: <value in [queue0, queue1, queue2, ...]>
cos7: <value in [queue0, queue1, queue2, ...]>
dscp0: <value in [queue0, queue1, queue2, ...]>
dscp1: <value in [queue0, queue1, queue2, ...]>
dscp10: <value in [queue0, queue1, queue2, ...]>
dscp11: <value in [queue0, queue1, queue2, ...]>
dscp12: <value in [queue0, queue1, queue2, ...]>
dscp13: <value in [queue0, queue1, queue2, ...]>
dscp14: <value in [queue0, queue1, queue2, ...]>
dscp15: <value in [queue0, queue1, queue2, ...]>
dscp16: <value in [queue0, queue1, queue2, ...]>
dscp17: <value in [queue0, queue1, queue2, ...]>
dscp18: <value in [queue0, queue1, queue2, ...]>
dscp19: <value in [queue0, queue1, queue2, ...]>
dscp2: <value in [queue0, queue1, queue2, ...]>
dscp20: <value in [queue0, queue1, queue2, ...]>
dscp21: <value in [queue0, queue1, queue2, ...]>
dscp22: <value in [queue0, queue1, queue2, ...]>
dscp23: <value in [queue0, queue1, queue2, ...]>
dscp24: <value in [queue0, queue1, queue2, ...]>
dscp25: <value in [queue0, queue1, queue2, ...]>
dscp26: <value in [queue0, queue1, queue2, ...]>
dscp27: <value in [queue0, queue1, queue2, ...]>
dscp28: <value in [queue0, queue1, queue2, ...]>
dscp29: <value in [queue0, queue1, queue2, ...]>
dscp3: <value in [queue0, queue1, queue2, ...]>
dscp30: <value in [queue0, queue1, queue2, ...]>
dscp31: <value in [queue0, queue1, queue2, ...]>
dscp32: <value in [queue0, queue1, queue2, ...]>
dscp33: <value in [queue0, queue1, queue2, ...]>
dscp34: <value in [queue0, queue1, queue2, ...]>
dscp35: <value in [queue0, queue1, queue2, ...]>
dscp36: <value in [queue0, queue1, queue2, ...]>
dscp37: <value in [queue0, queue1, queue2, ...]>
dscp38: <value in [queue0, queue1, queue2, ...]>
dscp39: <value in [queue0, queue1, queue2, ...]>
dscp4: <value in [queue0, queue1, queue2, ...]>
dscp40: <value in [queue0, queue1, queue2, ...]>
dscp41: <value in [queue0, queue1, queue2, ...]>
dscp42: <value in [queue0, queue1, queue2, ...]>
dscp43: <value in [queue0, queue1, queue2, ...]>
dscp44: <value in [queue0, queue1, queue2, ...]>
dscp45: <value in [queue0, queue1, queue2, ...]>
dscp46: <value in [queue0, queue1, queue2, ...]>
dscp47: <value in [queue0, queue1, queue2, ...]>
dscp48: <value in [queue0, queue1, queue2, ...]>
dscp49: <value in [queue0, queue1, queue2, ...]>
dscp5: <value in [queue0, queue1, queue2, ...]>
dscp50: <value in [queue0, queue1, queue2, ...]>
dscp51: <value in [queue0, queue1, queue2, ...]>
dscp52: <value in [queue0, queue1, queue2, ...]>
dscp53: <value in [queue0, queue1, queue2, ...]>
dscp54: <value in [queue0, queue1, queue2, ...]>
dscp55: <value in [queue0, queue1, queue2, ...]>
dscp56: <value in [queue0, queue1, queue2, ...]>
dscp57: <value in [queue0, queue1, queue2, ...]>
dscp58: <value in [queue0, queue1, queue2, ...]>
dscp59: <value in [queue0, queue1, queue2, ...]>
dscp6: <value in [queue0, queue1, queue2, ...]>
dscp60: <value in [queue0, queue1, queue2, ...]>
dscp61: <value in [queue0, queue1, queue2, ...]>
dscp62: <value in [queue0, queue1, queue2, ...]>
dscp63: <value in [queue0, queue1, queue2, ...]>
dscp7: <value in [queue0, queue1, queue2, ...]>
dscp8: <value in [queue0, queue1, queue2, ...]>
dscp9: <value in [queue0, queue1, queue2, ...]>
id: <value of integer>
type: <value in [cos, dscp]>
weight: <value of integer>
scheduler:
-
mode: <value in [none, priority, round-robin]>
name: <value of string>
udp-timeout-profile:
-
id: <value of integer>
udp-idle: <value of integer>
qtm-buf-mode: <value in [6ch, 4ch]>
default-qos-type: <value in [policing, shaping, policing-enhanced]>
tcp-rst-timeout: <value of integer>
ipsec-local-uesp-port: <value of integer>
htab-dedi-queue-nr: <value of integer>
double-level-mcast-offload: <value in [disable, enable]>
dse-timeout: <value of integer>
ippool-overload-low: <value of integer>
pba-eim: <value in [disallow, allow]>
policy-offload-level: <value in [disable, dos-offload, full-offload]>
max-session-timeout: <value of integer>
port-path-option:
ports-using-npu: <value of string>
vlan-lookup-cache: <value in [disable, enable]>
dos-options:
npu-dos-meter-mode: <value in [local, global]>
npu-dos-synproxy-mode: <value in [synack2ack, pass-synack]>
npu-dos-tpe-mode: <value in [disable, enable]>
hash-tbl-spread: <value in [disable, enable]>
tcp-timeout-profile:
-
close-wait: <value of integer>
fin-wait: <value of integer>
id: <value of integer>
syn-sent: <value of integer>
syn-wait: <value of integer>
tcp-idle: <value of integer>
time-wait: <value of integer>
ip-reassembly:
max-timeout: <value of integer>
min-timeout: <value of integer>
status: <value in [disable, enable]>
gtp-support: <value in [disable, enable]>
htx-icmp-csum-chk: <value in [pass, drop]>
hpe:
all-protocol: <value of integer>
arp-max: <value of integer>
enable-shaper: <value in [disable, enable]>
esp-max: <value of integer>
high-priority: <value of integer>
icmp-max: <value of integer>
ip-frag-max: <value of integer>
ip-others-max: <value of integer>
l2-others-max: <value of integer>
pri-type-max: <value of integer>
sctp-max: <value of integer>
tcp-max: <value of integer>
tcpfin-rst-max: <value of integer>
tcpsyn-ack-max: <value of integer>
tcpsyn-max: <value of integer>
udp-max: <value of integer>
dsw-dts-profile:
-
action: <value in [wait, drop, drop_tmr_0, ...]>
min-limit: <value of integer>
profile-id: <value of integer>
step: <value of integer>
hash-config: <value in [5-tuple, src-ip, src-dst-ip]>
ipsec-ob-np-sel: <value in [RR, rr, Packet, ...]>
napi-break-interval: <value of integer>
background-sse-scan:
scan: <value in [disable, enable]>
stats-update-interval: <value of integer>
udp-keepalive-interval: <value of integer>
inbound-dscp-copy-port: <value of string>
session-acct-interval: <value of integer>
htab-msg-queue: <value in [idle, data, dedicated]>
dsw-queue-dts-profile:
-
iport: <value in [EIF0, eif0, EIF1, ...]>
name: <value of string>
oport: <value in [EIF0, eif0, EIF1, ...]>
profile-id: <value of integer>
queue-select: <value of integer>
hw-ha-scan-interval: <value of integer>
ippool-overload-high: <value of integer>
nat46-force-ipv4-packet-forwarding: <value in [disable, enable]>
prp-port-out: <value of string>
isf-np-rx-tr-distr: <value in [port-flow, round-robin, randomized]>
mcast-session-counting6: <value in [disable, enable, session-based, ...]>
prp-port-in: <value of string>
rps-mode: <value in [disable, enable]>
per-policy-accounting: <value in [disable, enable]>
mcast-session-counting: <value in [disable, enable, session-based, ...]>
inbound-dscp-copy: <value in [disable, enable]>
ipsec-host-dfclr: <value in [disable, enable]>
process-icmp-by-host: <value in [disable, enable]>
dedicated-tx-npu: <value in [disable, enable]>
ull-port-mode: <value in [10G, 25G]>
sse-ha-scan:
gap: <value of integer>
max-session-cnt: <value of integer>
min-duration: <value of integer>
hash-ipv6-sel: <value of integer>
ip-fragment-offload: <value in [disable, enable]>
ple-non-syn-tcp-action: <value in [forward, drop]>
npu-group-effective-scope: <value of integer>
prp-session-clear-mode: <value in [blocking, non-blocking, do-not-clear]>
shaping-stats: <value in [disable, enable]>
sw-tr-hash:
draco15: <value in [disable, enable]>
tcp-udp-port: <value in [include, exclude]>
adom:
description: the parameter (adom) in requested url
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
system_npu:
description: the top level parameters set
required: false
suboptions:
background-sse-scan:
description: no description
required: false
suboptions:
scan:
choices:
- disable
- enable
description: Enable/disable background SSE scan by driver thread
type: str
stats-update-interval:
description: Stats update interval
type: int
udp-keepalive-interval:
description: UDP keepalive interval
type: int
type: dict
capwap-offload:
choices:
- disable
- enable
description: Enable/disable offloading managed FortiAP and FortiLink CAPWAP sessions.
type: str
dedicated-management-affinity:
description: Affinity setting for management deamons
type: str
dedicated-management-cpu:
choices:
- disable
- enable
description: Enable to dedicate one CPU for GUI and CLI connections when NPs are
busy.
type: str
dedicated-tx-npu:
choices:
- disable
- enable
description: Enable/disable dedication of 3rd NPU for slow path TX.
type: str
default-qos-type:
choices:
- policing
- shaping
- policing-enhanced
description: Set default QoS type.
type: str
dos-options:
description: no description
required: false
suboptions:
npu-dos-meter-mode:
choices:
- local
- global
description: Set DoS meter NPU offloading mode.
type: str
npu-dos-synproxy-mode:
choices:
- synack2ack
- pass-synack
description: Set NPU DoS SYNPROXY mode.
type: str
npu-dos-tpe-mode:
choices:
- disable
- enable
description: Enable/disable insertion of DoS meter ID to session table.
type: str
type: dict
double-level-mcast-offload:
choices:
- disable
- enable
description: Enable double level mcast offload.
type: str
dse-timeout:
description: DSE timeout in seconds
type: int
dsw-dts-profile:
description: description
elements: dict
suboptions:
action:
choices:
- wait
- drop
- drop_tmr_0
- drop_tmr_1
- enque
- enque_0
- enque_1
description: Set NPU DSW DTS profile action.
type: str
min-limit:
description: Set NPU DSW DTS profile min-limt.
type: int
profile-id:
description: Set NPU DSW DTS profile profile id.
type: int
step:
description: Set NPU DSW DTS profile step.
type: int
type: list
dsw-queue-dts-profile:
description: description
elements: dict
suboptions:
iport:
choices:
- EIF0
- eif0
- EIF1
- eif1
- EIF2
- eif2
- EIF3
- eif3
- EIF4
- eif4
- EIF5
- eif5
- EIF6
- eif6
- EIF7
- eif7
- HTX0
- htx0
- HTX1
- htx1
- SSE0
- sse0
- SSE1
- sse1
- SSE2
- sse2
- SSE3
- sse3
- RLT
- rlt
- DFR
- dfr
- IPSECI
- ipseci
- IPSECO
- ipseco
- IPTI
- ipti
- IPTO
- ipto
- VEP0
- vep0
- VEP2
- vep2
- VEP4
- vep4
- VEP6
- vep6
- IVS
- ivs
- L2TI1
- l2ti1
- L2TO
- l2to
- L2TI0
- l2ti0
- PLE
- ple
- SPATH
- spath
- QTM
- qtm
description: Set NPU DSW DTS in port.
type: str
name:
description: Name.
type: str
oport:
choices:
- EIF0
- eif0
- EIF1
- eif1
- EIF2
- eif2
- EIF3
- eif3
- EIF4
- eif4
- EIF5
- eif5
- EIF6
- eif6
- EIF7
- eif7
- HRX
- hrx
- SSE0
- sse0
- SSE1
- sse1
- SSE2
- sse2
- SSE3
- sse3
- RLT
- rlt
- DFR
- dfr
- IPSECI
- ipseci
- IPSECO
- ipseco
- IPTI
- ipti
- IPTO
- ipto
- VEP0
- vep0
- VEP2
- vep2
- VEP4
- vep4
- VEP6
- vep6
- IVS
- ivs
- L2TI1
- l2ti1
- L2TO
- l2to
- L2TI0
- l2ti0
- PLE
- ple
- SYNK
- sync
- NSS
- nss
- TSK
- tsk
- QTM
- qtm
- l2tO
description: Set NPU DSW DTS out port.
type: str
profile-id:
description: Set NPU DSW DTS profile ID.
type: int
queue-select:
description: Set NPU DSW DTS queue ID select
type: int
type: list
fastpath:
choices:
- disable
- enable
description: Enable/disable NP6 offloading
type: str
fp-anomaly:
description: no description
required: false
suboptions:
capwap-minlen-err:
choices:
- drop
- trap-to-host
description: no description
type: str
esp-minlen-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 ESP short packet anomalies.
type: str
gre-csum-err:
choices:
- drop
- trap-to-host
description: no description
type: str
gtpu-plen-err:
choices:
- drop
- trap-to-host
description: no description
type: str
icmp-csum-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 ICMP packet checksum anomalies.
type: str
icmp-frag:
choices:
- allow
- drop
- trap-to-host
description: Layer 3 fragmented packets that could be part of layer 4 ICMP
anomalies.
type: str
icmp-land:
choices:
- allow
- drop
- trap-to-host
description: ICMP land anomalies.
type: str
icmp-minlen-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 ICMP short packet anomalies.
type: str
ipv4-csum-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 packet checksum anomalies.
type: str
ipv4-ihl-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 header length anomalies.
type: str
ipv4-land:
choices:
- allow
- drop
- trap-to-host
description: Land anomalies.
type: str
ipv4-len-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 packet length anomalies.
type: str
ipv4-opt-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 option parsing anomalies.
type: str
ipv4-optlsrr:
choices:
- allow
- drop
- trap-to-host
description: Loose source record route option anomalies.
type: str
ipv4-optrr:
choices:
- allow
- drop
- trap-to-host
description: Record route option anomalies.
type: str
ipv4-optsecurity:
choices:
- allow
- drop
- trap-to-host
description: Security option anomalies.
type: str
ipv4-optssrr:
choices:
- allow
- drop
- trap-to-host
description: Strict source record route option anomalies.
type: str
ipv4-optstream:
choices:
- allow
- drop
- trap-to-host
description: Stream option anomalies.
type: str
ipv4-opttimestamp:
choices:
- allow
- drop
- trap-to-host
description: Timestamp option anomalies.
type: str
ipv4-proto-err:
choices:
- allow
- drop
- trap-to-host
description: Invalid layer 4 protocol anomalies.
type: str
ipv4-ttlzero-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 TTL field zero anomalies.
type: str
ipv4-unknopt:
choices:
- allow
- drop
- trap-to-host
description: Unknown option anomalies.
type: str
ipv4-ver-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 header version anomalies.
type: str
ipv6-daddr-err:
choices:
- allow
- drop
- trap-to-host
description: Destination address as unspecified or loopback address anomalies.
type: str
ipv6-exthdr-len-err:
choices:
- drop
- trap-to-host
description: Invalid IPv6 packet chain extension header total length anomalies.
type: str
ipv6-exthdr-order-err:
choices:
- drop
- trap-to-host
description: Invalid IPv6 packet extension header ordering anomalies.
type: str
ipv6-ihl-err:
choices:
- drop
- trap-to-host
description: Invalid IPv6 packet length anomalies.
type: str
ipv6-land:
choices:
- allow
- drop
- trap-to-host
description: Land anomalies.
type: str
ipv6-optendpid:
choices:
- allow
- drop
- trap-to-host
description: End point identification anomalies.
type: str
ipv6-opthomeaddr:
choices:
- allow
- drop
- trap-to-host
description: Home address option anomalies.
type: str
ipv6-optinvld:
choices:
- allow
- drop
- trap-to-host
description: Invalid option anomalies.
type: str
ipv6-optjumbo:
choices:
- allow
- drop
- trap-to-host
description: Jumbo options anomalies.
type: str
ipv6-optnsap:
choices:
- allow
- drop
- trap-to-host
description: Network service access point address option anomalies.
type: str
ipv6-optralert:
choices:
- allow
- drop
- trap-to-host
description: Router alert option anomalies.
type: str
ipv6-opttunnel:
choices:
- allow
- drop
- trap-to-host
description: Tunnel encapsulation limit option anomalies.
type: str
ipv6-plen-zero:
choices:
- drop
- trap-to-host
description: Invalid IPv6 packet payload length zero anomalies.
type: str
ipv6-proto-err:
choices:
- allow
- drop
- trap-to-host
description: Layer 4 invalid protocol anomalies.
type: str
ipv6-saddr-err:
choices:
- allow
- drop
- trap-to-host
description: Source address as multicast anomalies.
type: str
ipv6-unknopt:
choices:
- allow
- drop
- trap-to-host
description: Unknown option anomalies.
type: str
ipv6-ver-err:
choices:
- drop
- trap-to-host
description: Invalid IPv6 packet version anomalies.
type: str
nvgre-minlen-err:
choices:
- drop
- trap-to-host
description: no description
type: str
sctp-clen-err:
choices:
- drop
- trap-to-host
description: no description
type: str
sctp-crc-err:
choices:
- drop
- trap-to-host
description: no description
type: str
sctp-l4len-err:
choices:
- drop
- trap-to-host
description: no description
type: str
tcp-csum-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 TCP packet checksum anomalies.
type: str
tcp-fin-noack:
choices:
- allow
- drop
- trap-to-host
description: TCP SYN flood with FIN flag set without ACK setting anomalies.
type: str
tcp-fin-only:
choices:
- allow
- drop
- trap-to-host
description: TCP SYN flood with only FIN flag set anomalies.
type: str
tcp-hlen-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 TCP header length anomalies.
type: str
tcp-hlenvsl4len-err:
choices:
- drop
- trap-to-host
description: no description
type: str
tcp-land:
choices:
- allow
- drop
- trap-to-host
description: TCP land anomalies.
type: str
tcp-no-flag:
choices:
- allow
- drop
- trap-to-host
description: TCP SYN flood with no flag set anomalies.
type: str
tcp-plen-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 TCP packet length anomalies.
type: str
tcp-syn-data:
choices:
- allow
- drop
- trap-to-host
description: TCP SYN flood packets with data anomalies.
type: str
tcp-syn-fin:
choices:
- allow
- drop
- trap-to-host
description: TCP SYN flood SYN/FIN flag set anomalies.
type: str
tcp-winnuke:
choices:
- allow
- drop
- trap-to-host
description: TCP WinNuke anomalies.
type: str
udp-csum-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 UDP packet checksum anomalies.
type: str
udp-hlen-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 UDP packet header length anomalies.
type: str
udp-land:
choices:
- allow
- drop
- trap-to-host
description: UDP land anomalies.
type: str
udp-len-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 UDP packet length anomalies.
type: str
udp-plen-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 UDP packet minimum length anomalies.
type: str
udplite-cover-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 UDP-Lite packet coverage anomalies.
type: str
udplite-csum-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 UDP-Lite packet checksum anomalies.
type: str
uesp-minlen-err:
choices:
- drop
- trap-to-host
description: no description
type: str
unknproto-minlen-err:
choices:
- drop
- trap-to-host
description: Invalid IPv4 L4 unknown protocol short packet anomalies.
type: str
vxlan-minlen-err:
choices:
- drop
- trap-to-host
description: no description
type: str
type: dict
gtp-enhanced-cpu-range:
choices:
- '0'
- '1'
- '2'
description: GTP enhanced CPU range option.
type: str
gtp-enhanced-mode:
choices:
- disable
- enable
description: Enable/disable GTP enhanced mode.
type: str
gtp-support:
choices:
- disable
- enable
description: Enable/Disable NP7 GTP support
type: str
hash-config:
choices:
- 5-tuple
- src-ip
- src-dst-ip
description: Configure NPU trunk hash.
type: str
hash-ipv6-sel:
description: Select which 4bytes of the IPv6 address are used for traffic hash
type: int
hash-tbl-spread:
choices:
- disable
- enable
description: Enable/disable hash table entry spread
type: str
host-shortcut-mode:
choices:
- bi-directional
- host-shortcut
description: Set np6 host shortcut mode.
type: str
hpe:
description: no description
required: false
suboptions:
all-protocol:
description: Maximum packet rate of each host queue except high priority traffic
type: int
arp-max:
description: Maximum ARP packet rate
type: int
enable-shaper:
choices:
- disable
- enable
description: Enable/Disable NPU Host Protection Engine
type: str
esp-max:
description: Maximum ESP packet rate
type: int
high-priority:
description: Maximum packet rate for high priority traffic packets
type: int
icmp-max:
description: Maximum ICMP packet rate
type: int
ip-frag-max:
description: Maximum fragmented IP packet rate
type: int
ip-others-max:
description: Maximum IP packet rate for other packets
type: int
l2-others-max:
description: Maximum L2 packet rate for L2 packets that are not ARP packets
type: int
pri-type-max:
description: Maximum overflow rate of priority type traffic
type: int
sctp-max:
description: Maximum SCTP packet rate
type: int
tcp-max:
description: Maximum TCP packet rate
type: int
tcpfin-rst-max:
description: Maximum TCP carries FIN or RST flags packet rate
type: int
tcpsyn-ack-max:
description: Maximum TCP carries SYN and ACK flags packet rate
type: int
tcpsyn-max:
description: Maximum TCP SYN packet rate
type: int
udp-max:
description: Maximum UDP packet rate
type: int
type: dict
htab-dedi-queue-nr:
description: Set the number of dedicate queue for hash table messages.
type: int
htab-msg-queue:
choices:
- idle
- data
- dedicated
description: Set hash table message queue mode.
type: str
htx-gtse-quota:
choices:
- 100Mbps
- 200Mbps
- 300Mbps
- 400Mbps
- 500Mbps
- 600Mbps
- 700Mbps
- 800Mbps
- 900Mbps
- 1Gbps
- 2Gbps
- 4Gbps
- 8Gbps
- 10Gbps
description: Configure HTX GTSE quota.
type: str
htx-icmp-csum-chk:
choices:
- pass
- drop
description: Set HTX icmp csum checking mode.
type: str
hw-ha-scan-interval:
description: HW HA periodical scan interval in seconds
type: int
inbound-dscp-copy:
choices:
- disable
- enable
description: Enable/disable copying the DSCP field from outer IP header to inner
IP Header.
type: str
inbound-dscp-copy-port:
description: description
type: str
intf-shaping-offload:
choices:
- disable
- enable
description: Enable/disable NPU offload when doing interface-based traffic shaping
according to the egress-shaping-profile.
type: str
ip-fragment-offload:
choices:
- disable
- enable
description: Enable/disable NP7 NPU IP fragment offload.
type: str
ip-reassembly:
description: no description
required: false
suboptions:
max-timeout:
description: Maximum timeout value for IP reassembly
type: int
min-timeout:
description: Minimum timeout value for IP reassembly
type: int
status:
choices:
- disable
- enable
description: Set IP reassembly processing status.
type: str
type: dict
iph-rsvd-re-cksum:
choices:
- disable
- enable
description: Enable/disable IP checksum re-calculation for packets with iph.
type: str
ippool-overload-high:
description: High threshold for overload ippool port reuse
type: int
ippool-overload-low:
description: Low threshold for overload ippool port reuse
type: int
ipsec-dec-subengine-mask:
description: IPsec decryption subengine mask
type: str
ipsec-enc-subengine-mask:
description: IPsec encryption subengine mask
type: str
ipsec-host-dfclr:
choices:
- disable
- enable
description: Enable/disable DF clearing of NP4lite host IPsec offload.
type: str
ipsec-inbound-cache:
choices:
- disable
- enable
description: Enable/disable IPsec inbound cache for anti-replay.
type: str
ipsec-local-uesp-port:
description: no description
type: int
ipsec-mtu-override:
choices:
- disable
- enable
description: Enable/disable NP6 IPsec MTU override.
type: str
ipsec-ob-np-sel:
choices:
- RR
- rr
- Packet
- Hash
description: IPsec NP selection for OB SA offloading.
type: str
ipsec-over-vlink:
choices:
- disable
- enable
description: Enable/disable IPSEC over vlink.
type: str
isf-np-queues:
description: no description
required: false
suboptions:
cos0:
description: CoS profile name for CoS 0.
type: str
cos1:
description: CoS profile name for CoS 1.
type: str
cos2:
description: CoS profile name for CoS 2.
type: str
cos3:
description: CoS profile name for CoS 3.
type: str
cos4:
description: CoS profile name for CoS 4.
type: str
cos5:
description: CoS profile name for CoS 5.
type: str
cos6:
description: CoS profile name for CoS 6.
type: str
cos7:
description: CoS profile name for CoS 7.
type: str
type: dict
isf-np-rx-tr-distr:
choices:
- port-flow
- round-robin
- randomized
description: Select ISF NP Rx trunk distribution
type: str
lag-out-port-select:
choices:
- disable
- enable
description: Enable/disable LAG outgoing port selection based on incoming traffic
port.
type: str
max-session-timeout:
description: Maximum time interval for refreshing NPU-offloaded sessions
type: int
mcast-session-accounting:
choices:
- disable
- session-based
- tpe-based
description: Enable/disable traffic accounting for each multicast session through
TAE counter.
type: str
mcast-session-counting:
choices:
- disable
- enable
- session-based
- tpe-based
description: no description
type: str
mcast-session-counting6:
choices:
- disable
- enable
- session-based
- tpe-based
description: Enable/disable traffic accounting for each multicast session6 through
TAE counter.
type: str
napi-break-interval:
description: NAPI break interval
type: int
nat46-force-ipv4-packet-forwarding:
choices:
- disable
- enable
description: Enable/disable mandatory IPv4 packet forwarding in nat46.
type: str
np-queues:
description: no description
required: false
suboptions:
ethernet-type:
description: description
elements: dict
suboptions:
name:
description: Ethernet Type Name.
type: str
queue:
description: Queue Number.
type: int
type:
description: Ethernet Type.
type: int
weight:
description: Class Weight.
type: int
type: list
ip-protocol:
description: description
elements: dict
suboptions:
name:
description: IP Protocol Name.
type: str
protocol:
description: IP Protocol.
type: int
queue:
description: Queue Number.
type: int
weight:
description: Class Weight.
type: int
type: list
ip-service:
description: description
elements: dict
suboptions:
dport:
description: Destination port.
type: int
name:
description: IP service name.
type: str
protocol:
description: IP protocol.
type: int
queue:
description: Queue number.
type: int
sport:
description: Source port.
type: int
weight:
description: Class weight.
type: int
type: list
profile:
description: description
elements: dict
suboptions:
cos0:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of CoS 0.
type: str
cos1:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of CoS 1.
type: str
cos2:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of CoS 2.
type: str
cos3:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of CoS 3.
type: str
cos4:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of CoS 4.
type: str
cos5:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of CoS 5.
type: str
cos6:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of CoS 6.
type: str
cos7:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of CoS 7.
type: str
dscp0:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 0.
type: str
dscp1:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 1.
type: str
dscp10:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 10.
type: str
dscp11:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 11.
type: str
dscp12:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 12.
type: str
dscp13:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 13.
type: str
dscp14:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 14.
type: str
dscp15:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 15.
type: str
dscp16:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 16.
type: str
dscp17:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 17.
type: str
dscp18:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 18.
type: str
dscp19:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 19.
type: str
dscp2:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 2.
type: str
dscp20:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 20.
type: str
dscp21:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 21.
type: str
dscp22:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 22.
type: str
dscp23:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 23.
type: str
dscp24:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 24.
type: str
dscp25:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 25.
type: str
dscp26:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 26.
type: str
dscp27:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 27.
type: str
dscp28:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 28.
type: str
dscp29:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 29.
type: str
dscp3:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 3.
type: str
dscp30:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 30.
type: str
dscp31:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 31.
type: str
dscp32:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 32.
type: str
dscp33:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 33.
type: str
dscp34:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 34.
type: str
dscp35:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 35.
type: str
dscp36:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 36.
type: str
dscp37:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 37.
type: str
dscp38:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 38.
type: str
dscp39:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 39.
type: str
dscp4:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 4.
type: str
dscp40:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 40.
type: str
dscp41:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 41.
type: str
dscp42:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 42.
type: str
dscp43:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 43.
type: str
dscp44:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 44.
type: str
dscp45:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 45.
type: str
dscp46:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 46.
type: str
dscp47:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 47.
type: str
dscp48:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 48.
type: str
dscp49:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 49.
type: str
dscp5:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 5.
type: str
dscp50:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 50.
type: str
dscp51:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 51.
type: str
dscp52:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 52.
type: str
dscp53:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 53.
type: str
dscp54:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 54.
type: str
dscp55:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 55.
type: str
dscp56:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 56.
type: str
dscp57:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 57.
type: str
dscp58:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 58.
type: str
dscp59:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 59.
type: str
dscp6:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 6.
type: str
dscp60:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 60.
type: str
dscp61:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 61.
type: str
dscp62:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 62.
type: str
dscp63:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 63.
type: str
dscp7:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 7.
type: str
dscp8:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 8.
type: str
dscp9:
choices:
- queue0
- queue1
- queue2
- queue3
- queue4
- queue5
- queue6
- queue7
description: Queue number of DSCP 9.
type: str
id:
description: Profile ID.
type: int
type:
choices:
- cos
- dscp
description: Profile type.
type: str
weight:
description: Class weight.
type: int
type: list
scheduler:
description: description
elements: dict
suboptions:
mode:
choices:
- none
- priority
- round-robin
description: Scheduler mode.
type: str
name:
description: Scheduler name.
type: str
type: list
type: dict
np6-cps-optimization-mode:
choices:
- disable
- enable
description: Enable/disable NP6 connection per second
type: str
npu-group-effective-scope:
description: npu-group-effective-scope defines under which npu-group cmds such
as list/purge will be excecuted.
type: int
pba-eim:
choices:
- disallow
- allow
description: Configure option for PBA
type: str
per-policy-accounting:
choices:
- disable
- enable
description: Set per-policy accounting.
type: str
per-session-accounting:
choices:
- enable
- disable
- enable-by-log
- all-enable
- traffic-log-only
description: Enable/disable per-session accounting.
type: str
ple-non-syn-tcp-action:
choices:
- forward
- drop
description: Configure action for the PLE to take on TCP packets that have the
SYN field unset.
type: str
policy-offload-level:
choices:
- disable
- dos-offload
- full-offload
description: Configure firewall policy offload level
type: str
port-cpu-map:
description: description
elements: dict
suboptions:
cpu-core:
description: The CPU core to map to an interface.
type: str
interface:
description: The interface to map to a CPU core.
type: str
type: list
port-npu-map:
description: description
elements: dict
suboptions:
interface:
description: Set npu interface port to NPU group map.
type: str
npu-group-index:
description: Mapping NPU group index.
type: int
type: list
port-path-option:
description: no description
required: false
suboptions:
ports-using-npu:
description: description
type: str
type: dict
priority-protocol:
description: no description
required: false
suboptions:
bfd:
choices:
- disable
- enable
description: Enable/disable NPU BFD priority protocol.
type: str
bgp:
choices:
- disable
- enable
description: Enable/disable NPU BGP priority protocol.
type: str
slbc:
choices:
- disable
- enable
description: Enable/disable NPU SLBC priority protocol.
type: str
type: dict
process-icmp-by-host:
choices:
- disable
- enable
description: Enable/disable process ICMP by host when received from IPsec tunnel
and payload size
type: str
prp-port-in:
description: description
type: str
prp-port-out:
description: description
type: str
prp-session-clear-mode:
choices:
- blocking
- non-blocking
- do-not-clear
description: PRP session clear mode for excluded ip sessions.
type: str
qos-mode:
choices:
- disable
- priority
- round-robin
description: QoS mode on switch and NP.
type: str
qtm-buf-mode:
choices:
- 6ch
- 4ch
description: QTM channel configuration for packet buffer.
type: str
rdp-offload:
choices:
- disable
- enable
description: Enable/disable rdp offload.
type: str
recover-np6-link:
choices:
- disable
- enable
description: Enable/disable internal link failure check and recovery after boot
up.
type: str
rps-mode:
choices:
- disable
- enable
description: Enable/disable receive packet steering
type: str
session-acct-interval:
description: Session accounting update interval
type: int
session-denied-offload:
choices:
- disable
- enable
description: Enable/disable offloading of denied sessions.
type: str
shaping-stats:
choices:
- disable
- enable
description: Enable/disable NP7 traffic shaping statistics
type: str
sse-backpressure:
choices:
- disable
- enable
description: Enable/disable sse backpressure.
type: str
sse-ha-scan:
description: no description
required: false
suboptions:
gap:
description: Scanning message gap
type: int
max-session-cnt:
description: If the session count
type: int
min-duration:
description: Scanning filter for minimum duration of the session.
type: int
type: dict
strip-clear-text-padding:
choices:
- disable
- enable
description: Enable/disable stripping clear text padding.
type: str
strip-esp-padding:
choices:
- disable
- enable
description: Enable/disable stripping ESP padding.
type: str
sw-eh-hash:
description: no description
required: false
suboptions:
computation:
choices:
- xor16
- xor8
- xor4
- crc16
description: Set hashing computation.
type: str
destination-ip-lower-16:
choices:
- include
- exclude
description: Include/exclude destination IP address lower 16 bits.
type: str
destination-ip-upper-16:
choices:
- include
- exclude
description: Include/exclude destination IP address upper 16 bits.
type: str
destination-port:
choices:
- include
- exclude
description: Include/exclude destination port if TCP/UDP.
type: str
ip-protocol:
choices:
- include
- exclude
description: Include/exclude IP protocol.
type: str
netmask-length:
description: Network mask length.
type: int
source-ip-lower-16:
choices:
- include
- exclude
description: Include/exclude source IP address lower 16 bits.
type: str
source-ip-upper-16:
choices:
- include
- exclude
description: Include/exclude source IP address upper 16 bits.
type: str
source-port:
choices:
- include
- exclude
description: Include/exclude source port if TCP/UDP.
type: str
type: dict
sw-np-bandwidth:
choices:
- 0G
- 2G
- 4G
- 5G
- 6G
- 7G
- 8G
- 9G
description: Bandwidth from switch to NP.
type: str
sw-tr-hash:
description: no description
required: false
suboptions:
draco15:
choices:
- disable
- enable
description: Enable/disable DRACO15 hashing.
type: str
tcp-udp-port:
choices:
- include
- exclude
description: Include/exclude TCP/UDP source and destination port for unicast
trunk traffic.
type: str
type: dict
switch-np-hash:
choices:
- src-ip
- dst-ip
- src-dst-ip
description: Switch-NP trunk port selection Criteria.
type: str
tcp-rst-timeout:
description: TCP RST timeout in seconds
type: int
tcp-timeout-profile:
description: description
elements: dict
suboptions:
close-wait:
description: Set close-wait timeout
type: int
fin-wait:
description: Set fin-wait timeout
type: int
id:
description: Timeout profile ID
type: int
syn-sent:
description: Set syn-sent timeout
type: int
syn-wait:
description: Set syn-wait timeout
type: int
tcp-idle:
description: Set TCP establish timeout
type: int
time-wait:
description: Set time-wait timeout
type: int
type: list
udp-timeout-profile:
description: description
elements: dict
suboptions:
id:
description: Timeout profile ID
type: int
udp-idle:
description: Set UDP idle timeout
type: int
type: list
uesp-offload:
choices:
- disable
- enable
description: Enable/disable UDP-encapsulated ESP offload
type: str
ull-port-mode:
choices:
- 10G
- 25G
description: Set ULL ports speed to 10G/25G
type: str
vlan-lookup-cache:
choices:
- disable
- enable
description: Enable/disable vlan lookup cache
type: str
type: dict
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list