fortinet.fortios.fortios_ips_custom (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and custom category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure IPS custom signature.
  fortinet.fortios.fortios_ips_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ips_custom:
          action: "pass"
          application: "<your_own_value>"
          comment: "Comment."
          location: "<your_own_value>"
          log: "disable"
          log_packet: "disable"
          os: "<your_own_value>"
          protocol: "<your_own_value>"
          rule_id: "0"
          severity: "<your_own_value>"
          sig_name: "<your_own_value>"
          signature: "<your_own_value>"
          status: "disable"
          tag: "<your_own_value>"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

ips_custom:
    default: null
    description:
    - Configure IPS custom signature.
    suboptions:
      action:
        choices:
        - pass
        - block
        description:
        - Default action (pass or block) for this signature.
        type: str
      application:
        description:
        - Applications to be protected. Blank for all applications.
        elements: str
        type: list
      comment:
        description:
        - Comment.
        type: str
      location:
        description:
        - Protect client or server traffic.
        elements: str
        type: list
      log:
        choices:
        - disable
        - enable
        description:
        - Enable/disable logging.
        type: str
      log_packet:
        choices:
        - disable
        - enable
        description:
        - Enable/disable packet logging.
        type: str
      os:
        description:
        - Operating system(s) that the signature protects. Blank for all operating systems.
        elements: str
        type: list
      protocol:
        description:
        - Protocol(s) that the signature scans. Blank for all protocols.
        type: str
      rule_id:
        description:
        - Signature ID.
        type: int
      severity:
        description:
        - Relative severity of the signature, from info to critical. Log messages generated
          by the signature include the severity.
        type: str
      sig_name:
        description:
        - Signature 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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str