fortinet.fortimanager.fmgr_system_npu_hpe module – Host protection engine configuration.
Note
This module is part of the fortinet.fortimanager collection (version 2.4.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_hpe.
New in fortinet.fortimanager 2.2.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. |
|
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. |
|
Deprecated, please rename it to all_protocol. Maximum packet rate of each host queue except high priority traffic |
|
Deprecated, please rename it to arp_max. Maximum ARP packet rate |
|
Deprecated, please rename it to enable_queue_shaper. Enable/Disable NPU host protection engine Choices:
|
|
Deprecated, please rename it to enable_shaper. Enable/Disable NPU Host Protection Engine Choices:
|
|
Deprecated, please rename it to esp_max. Maximum ESP packet rate |
|
Deprecated, please rename it to exception_code. Maximum exception code rate of traffic |
|
Deprecated, please rename it to fragment_with_sess. Maximum fragment with session rate of traffic |
|
Deprecated, please rename it to fragment_without_session. Maximum fragment without session rate of traffic |
|
Deprecated, please rename it to high_priority. Maximum packet rate for high priority traffic packets |
|
Deprecated, please rename it to icmp_max. Maximum ICMP packet rate |
|
Deprecated, please rename it to ip_frag_max. Maximum fragmented IP packet rate |
|
Deprecated, please rename it to ip_others_max. Maximum IP packet rate for other packets |
|
Deprecated, please rename it to l2_others_max. Maximum L2 packet rate for L2 packets that are not ARP packets |
|
Deprecated, please rename it to pri_type_max. Maximum overflow rate of priority type traffic |
|
Deprecated, please rename it to queue_shaper_max. Maximum per queue byte rate of traffic |
|
Deprecated, please rename it to sctp_max. Maximum SCTP packet rate |
|
Deprecated, please rename it to tcp_max. Maximum TCP packet rate |
|
Deprecated, please rename it to tcpfin_rst_max. Maximum TCP carries FIN or RST flags packet rate |
|
Deprecated, please rename it to tcpsyn_ack_max. Maximum TCP carries SYN and ACK flags packet rate |
|
Deprecated, please rename it to tcpsyn_max. Maximum TCP SYN packet rate |
|
Deprecated, please rename it to udp_max. Maximum UDP packet rate |
|
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: Host protection engine configuration.
fortinet.fortimanager.fmgr_system_npu_hpe:
# 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_hpe:
all_protocol: <integer>
arp_max: <integer>
enable_shaper: <value in [disable, enable]>
esp_max: <integer>
high_priority: <integer>
icmp_max: <integer>
ip_frag_max: <integer>
ip_others_max: <integer>
l2_others_max: <integer>
pri_type_max: <integer>
sctp_max: <integer>
tcp_max: <integer>
tcpfin_rst_max: <integer>
tcpsyn_ack_max: <integer>
tcpsyn_max: <integer>
udp_max: <integer>
enable_queue_shaper: <value in [disable, enable]>
exception_code: <integer>
fragment_with_sess: <integer>
fragment_without_session: <integer>
queue_shaper_max: <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 |