fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_npu_hpe Host protection engine configuration. | "added in version" 2.2.0 of fortinet.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 communityfortinet.fortimanager.fmgr_system_npu_hpe (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- 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>
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 type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list system_npu_hpe: description: The top level parameters set. required: false suboptions: all-protocol: description: Deprecated, please rename it to all_protocol. Maximum packet rate of each host queue except high priority traffic type: int arp-max: description: Deprecated, please rename it to arp_max. Maximum ARP packet rate type: int enable-queue-shaper: choices: - disable - enable description: Deprecated, please rename it to enable_queue_shaper. Enable/Disable NPU host protection engine type: str enable-shaper: choices: - disable - enable description: Deprecated, please rename it to enable_shaper. Enable/Disable NPU Host Protection Engine type: str esp-max: description: Deprecated, please rename it to esp_max. Maximum ESP packet rate type: int exception-code: description: Deprecated, please rename it to exception_code. Maximum exception code rate of traffic type: int fragment-with-sess: description: Deprecated, please rename it to fragment_with_sess. Maximum fragment with session rate of traffic type: int fragment-without-session: description: Deprecated, please rename it to fragment_without_session. Maximum fragment without session rate of traffic type: int high-priority: description: Deprecated, please rename it to high_priority. Maximum packet rate for high priority traffic packets type: int icmp-max: description: Deprecated, please rename it to icmp_max. Maximum ICMP packet rate type: int ip-frag-max: description: Deprecated, please rename it to ip_frag_max. Maximum fragmented IP packet rate type: int ip-others-max: description: Deprecated, please rename it to ip_others_max. Maximum IP packet rate for other packets type: int l2-others-max: description: Deprecated, please rename it to l2_others_max. Maximum L2 packet rate for L2 packets that are not ARP packets type: int pri-type-max: description: Deprecated, please rename it to pri_type_max. Maximum overflow rate of priority type traffic type: int queue-shaper-max: description: Deprecated, please rename it to queue_shaper_max. Maximum per queue byte rate of traffic type: int sctp-max: description: Deprecated, please rename it to sctp_max. Maximum SCTP packet rate type: int tcp-max: description: Deprecated, please rename it to tcp_max. Maximum TCP packet rate type: int tcpfin-rst-max: description: Deprecated, please rename it to tcpfin_rst_max. Maximum TCP carries FIN or RST flags packet rate type: int tcpsyn-ack-max: description: Deprecated, please rename it to tcpsyn_ack_max. Maximum TCP carries SYN and ACK flags packet rate type: int tcpsyn-max: description: Deprecated, please rename it to tcpsyn_max. Maximum TCP SYN packet rate type: int udp-max: description: Deprecated, please rename it to udp_max. Maximum UDP packet rate type: int type: dict proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. 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. 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. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. 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