fortinet.fortimanager.fmgr_ips_sensor_obj – Configure IPS sensor.

Note

This plugin is part of the fortinet.fortimanager collection (version 1.0.5).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_ips_sensor_obj.

New in version 2.10: of fortinet.fortimanager

Synopsis

• This module is able to configure a FortiManager device by allowing the user to [ clone delete get set update ] the following apis.

• /pm/config/adom/{adom}/obj/ips/sensor/{sensor}

• /pm/config/global/obj/ips/sensor/{sensor}

• Examples include all parameters and values need to be adjusted to data sources before usage.

Parameters

Parameter	Choices/Defaults	Comments
loose_validation boolean	Choices: no yes	Do parameter validation in a loose way
method string / required	Choices: clone delete get set update	The method in request
params list / elements=string		The parameters for each method See full parameters list in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params dictionary		The parameters for each API request URL Also see full URL parameters in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom string		the adom name to lock in case FortiManager running in workspace mode it can be global or any other custom adom names
workspace_locking_timeout integer	Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

• There are only three top-level parameters where ‘method’ is always required while other two ‘params’ and ‘url_params’ can be optional

• Due to the complexity of fortimanager api schema, the validation is done out of Ansible native parameter validation procedure.

• The syntax of OPTIONS doen not comply with the standard Ansible argument specification, but with the structure of fortimanager API schema, we need a trivial transformation when we are filling the ansible playbook

Examples

- 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: REQUESTING /PM/CONFIG/OBJ/IPS/SENSOR/{SENSOR}
     fmgr_ips_sensor_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [clone, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           sensor: <value of string>
        params:
           -
              data:
                 block-malicious-url: <value in [disable, enable]>
                 comment: <value of string>
                 entries:
                   -
                       action: <value in [pass, block, reset, ...]>
                       application:
                         - <value of string>
                       exempt-ip:
                         -
                             dst-ip: <value of string>
                             id: <value of integer>
                             src-ip: <value of string>
                       id: <value of integer>
                       location:
                         - <value of string>
                       log: <value in [disable, enable]>
                       log-attack-context: <value in [disable, enable]>
                       log-packet: <value in [disable, enable]>
                       os:
                         - <value of string>
                       protocol:
                         - <value of string>
                       quarantine: <value in [none, attacker, both, ...]>
                       quarantine-expiry: <value of string>
                       quarantine-log: <value in [disable, enable]>
                       rate-count: <value of integer>
                       rate-duration: <value of integer>
                       rate-mode: <value in [periodical, continuous]>
                       rate-track: <value in [none, src-ip, dest-ip, ...]>
                       rule: <value of string>
                       severity:
                         - <value of string>
                       status: <value in [disable, enable, default]>
                 extended-log: <value in [disable, enable]>
                 filter:
                   -
                       action: <value in [pass, block, default, ...]>
                       application:
                         - <value of string>
                       location:
                         - <value of string>
                       log: <value in [disable, enable, default]>
                       log-packet: <value in [disable, enable, default]>
                       name: <value of string>
                       os:
                         - <value of string>
                       protocol:
                         - <value of string>
                       quarantine: <value in [none, attacker, both, ...]>
                       quarantine-expiry: <value of integer>
                       quarantine-log: <value in [disable, enable]>
                       severity:
                         - <value of string>
                       status: <value in [disable, enable, default]>
                 name: <value of string>
                 override:
                   -
                       action: <value in [pass, block, reset]>
                       exempt-ip:
                         -
                             dst-ip: <value of string>
                             id: <value of integer>
                             src-ip: <value of string>
                       log: <value in [disable, enable]>
                       log-packet: <value in [disable, enable]>
                       quarantine: <value in [none, attacker, both, ...]>
                       quarantine-expiry: <value of integer>
                       quarantine-log: <value in [disable, enable]>
                       rule-id: <value of integer>
                       status: <value in [disable, enable]>
                 replacemsg-group: <value of string>

   - name: REQUESTING /PM/CONFIG/OBJ/IPS/SENSOR/{SENSOR}
     fmgr_ips_sensor_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        url_params:
           adom: <value in [none, global, custom dom]>
           sensor: <value of string>
        params:
           -
              option: <value in [object member, chksum, datasrc]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
data dictionary	always	The payload returned in the request
status dictionary	always	The status of api request
url string	always	The full url requested Sample: /sys/login/user

Authors

• Frank Shen (@fshen01)

• Link Zheng (@zhengl)