fortinet.fortios.fortios_firewall_local_in_policy (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 firewall feature and local_in_policy 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 user defined IPv4 local-in policies.
  fortinet.fortios.fortios_firewall_local_in_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_local_in_policy:
          action: "accept"
          comments: "<your_own_value>"
          dstaddr:
              -
                  name: "default_name_6 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
          dstaddr_negate: "enable"
          ha_mgmt_intf_only: "enable"
          intf: "<your_own_value> (source system.zone.name system.interface.name)"
          intf_dict:
              -
                  name: "default_name_11 (source system.zone.name system.interface.name)"
          policyid: "<you_own_value>"
          schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
          service:
              -
                  name: "default_name_15 (source firewall.service.custom.name firewall.service.group.name)"
          service_negate: "enable"
          srcaddr:
              -
                  name: "default_name_18 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
          srcaddr_negate: "enable"
          status: "enable"
          uuid: "<your_own_value>"
          virtual_patch: "enable"

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

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

firewall_local_in_policy:
    default: null
    description:
    - Configure user defined IPv4 local-in policies.
    suboptions:
      action:
        choices:
        - accept
        - deny
        description:
        - Action performed on traffic matching the policy .
        type: str
      comments:
        description:
        - Comment.
        type: str
      dstaddr:
        description:
        - Destination address object from available options.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name.
            required: true
            type: str
        type: list
      dstaddr_negate:
        choices:
        - enable
        - disable
        description:
        - When enabled dstaddr specifies what the destination address must NOT be.
        type: str
      ha_mgmt_intf_only:
        choices:
        - enable
        - disable
        description:
        - Enable/disable dedicating the HA management interface only for local-in policy.
        type: str
      intf:
        description:
        - Incoming interface name from available options. Source system.zone.name system.interface.name.
        type: str
      intf_dict:
        description:
        - Incoming interface name from available options. Use the parameter intf if the
          fortiOS firmware version <= 7.4.1
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source system.zone.name system.interface.name.
            required: true
            type: str
        type: list
      policyid:
        description:
        - User defined local in policy ID. see <a href='#notes'>Notes</a>.
        required: true
        type: int
      schedule:
        description:
        - Schedule object from available options. Source firewall.schedule.onetime.name
          firewall.schedule.recurring.name firewall.schedule.group .name.
        type: str
      service:
        description:
        - Service object from available options.
        elements: dict
        suboptions:
          name:
            description:
            - Service name. Source firewall.service.custom.name firewall.service.group.name.
            required: true
            type: str
        type: list
      service_negate:
        choices:
        - enable
        - disable
        description:
        - When enabled service specifies what the service must NOT be.
        type: str
      srcaddr:
        description:
        - Source address object from available options.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name.
            required: true
            type: str
        type: list
      srcaddr_negate:
        choices:
        - enable
        - disable
        description:
        - When enabled srcaddr specifies what the source address must NOT be.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this local-in policy.
        type: str
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
        type: str
      virtual_patch:
        choices:
        - enable
        - disable
        description:
        - Enable/disable virtual patching.
        type: str
    type: dict

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