fortinet.fortimanager.fmgr_ips_custom – Configure IPS custom signature.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr ips custom module


fortinet.fortimanager.fmgr_ips_custom – Configure IPS custom signature.

Note

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

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

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


New in version 2.10: of fortinet.fortimanager


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 Choices/Defaults Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

  • no

  • yes

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

ips_custom

dictionary

the top level parameters set

action

string

  • block
  • pass

Default action (pass or block) for this signature.

application

string

no description

comment

string

Comment.

location

string

no description

log

string

  • disable
  • enable

Enable/disable logging.

log-packet

string

  • disable
  • enable

Enable/disable packet logging.

os

string

no description

protocol

string

Protocol(s) that the signature scans. Blank for all protocols.

rule-id

integer

no description

severity

string

Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.

sig-name

string

no description

signature

string

Custom signature enclosed in single quotes.

status

string

  • disable
  • enable

Enable/disable this signature.

tag

string

Signature tag.

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

  • present
  • absent

the directive to create, update or delete an object

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

Default:

300

the maximum time in seconds to wait for other user to release the workspace lock



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

- 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: Configure IPS custom signature.
     fmgr_ips_custom:
        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>
        state: <value in [present, absent]>
        ips_custom:
           action: <value in [block, pass]>
           application: <value of string>
           comment: <value of string>
           location: <value of string>
           log: <value in [disable, enable]>
           log-packet: <value in [disable, enable]>
           os: <value of string>
           protocol: <value of string>
           rule-id: <value of integer>
           severity: <value of string>
           sig-name: <value of string>
           signature: <value of string>
           status: <value in [disable, enable]>
           tag: <value of string>

Return Values

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

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_ips_custom_module.html