fmgr_system_npu_hpe – Host protection engine configuration.
Added in version 2.2.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: v6.4.7 -> v6.4.14, v7.0.1 -> 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
- system_npu_hpe - Host protection engine configuration. type: dict
- all_protocol (Alias name: all-protocol) Maximum packet rate of each host queue except high priority traffic(1k - 32m pps, default = 400k pps), set 0 to disable. type: int more...
- arp_max (Alias name: arp-max) Maximum arp packet rate (1k - 32m pps, default = 5k pps). type: int more...
- enable_shaper (Alias name: enable-shaper) Enable/disable npu host protection engine (hpe) for packet type shaper. type: str choices: [disable, enable] more...
- esp_max (Alias name: esp-max) Maximum esp packet rate (1k - 32m pps, default = 5k pps). type: int more...
- high_priority (Alias name: high-priority) Maximum packet rate for high priority traffic packets (1k - 32m pps, default = 400k pps). type: int more...
- icmp_max (Alias name: icmp-max) Maximum icmp packet rate (1k - 32m pps, default = 5k pps). type: int more...
- ip_frag_max (Alias name: ip-frag-max) Maximum fragmented ip packet rate (1k - 32m pps, default = 5k pps). type: int more...
- ip_others_max (Alias name: ip-others-max) Maximum ip packet rate for other packets (packet types that cannot be set with other options) (1k - 32g pps, default = 5k pps). type: int more...
- l2_others_max (Alias name: l2-others-max) Maximum l2 packet rate for l2 packets that are not arp packets (1k - 32m pps, default = 5k pps). type: int more...
- pri_type_max (Alias name: pri-type-max) Maximum overflow rate of priority type traffic(1k - 32m pps, default = 40k pps). type: int more...
- sctp_max (Alias name: sctp-max) Maximum sctp packet rate (1k - 32m pps, default = 5k pps). type: int more...
- tcp_max (Alias name: tcp-max) Maximum tcp packet rate (1k - 32m pps, default = 40k pps). type: int more...
- tcpfin_rst_max (Alias name: tcpfin-rst-max) Maximum tcp carries fin or rst flags packet rate (1k - 32m pps, default = 40k pps). type: int more...
- tcpsyn_ack_max (Alias name: tcpsyn-ack-max) Maximum tcp carries syn and ack flags packet rate (1k - 32m pps, default = 40k pps). type: int more...
- tcpsyn_max (Alias name: tcpsyn-max) Maximum tcp syn packet rate (1k - 40m pps, default = 32k pps). type: int more...
- udp_max (Alias name: udp-max) Maximum udp packet rate (1k - 32m pps, default = 40k pps). type: int more...
- enable_queue_shaper (Alias name: enable-queue-shaper) Enable/disable npu host protection engine (hpe) queue shaper. type: str choices: [disable, enable] more...
- exception_code (Alias name: exception-code) Maximum exception code rate of traffic(1k - 32m pps, default = 1m pps). type: int more...
- fragment_with_sess (Alias name: fragment-with-sess) Maximum fragment with session rate of traffic(1k - 32m pps, default = 1m pps). type: int more...
- fragment_without_session (Alias name: fragment-without-session) Maximum fragment without session rate of traffic(1k - 32m pps, default = 1m pps). type: int more...
- queue_shaper_max (Alias name: queue-shaper-max) Maximum per queue byte rate of traffic(1k - 32m pps, default = 1m pps). 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: 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: 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.