fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_ips_custom Configure IPS custom signature. | "added in version" 2.0.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_ips_custom (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 hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure IPS custom signature. fortinet.fortimanager.fmgr_ips_custom: bypass_validation: true adom: ansible state: present ips_custom: rule-id: 1 # Required, no less than 1000; signature: "F-SBID(--name: [string]; --service: [string]; --flow: [string])" # Required; Need follow signature syntax, # check 'https://docs.fortinet.com/document/ipsengine/3.6.0/custom-ips-and-application-control-signature-syntax-guide/ # 274110/creating-ips-and-application-control-signatures' for more information; tag: ansible-ipscustom # Required
- name: Gathering fortimanager facts hosts: fortimanagers gather_facts: false connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Retrieve all the IPS custom signatures fortinet.fortimanager.fmgr_fact: facts: selector: "ips_custom" params: adom: "ansible" custom: "your_value"
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. 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 ips_custom: description: The top level parameters set. required: false suboptions: action: choices: - block - pass description: Default action type: str application: description: (list) Applications to be protected. type: raw comment: description: Comment. type: str location: description: (list) Protect client or server traffic. type: raw log: choices: - disable - enable description: Enable/disable logging. type: str log-packet: choices: - disable - enable description: Deprecated, please rename it to log_packet. Enable/disable packet logging. type: str os: description: (list) Operating system type: raw protocol: description: Protocol type: str rule-id: description: Deprecated, please rename it to rule_id. Rule-Id. type: int severity: description: Relative severity of the signature, from info to critical. type: str sig-name: description: Deprecated, please rename it to sig_name. Sig-Name. type: str signature: description: Custom signature enclosed in single quotes. type: str status: choices: - disable - enable description: Enable/disable this signature. type: str tag: description: Signature tag. required: true type: str type: dict 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 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