Skip to content

Latest commit

 

History

History
471 lines (426 loc) · 21.6 KB

fortios_firewall_local_in_policy.rst

File metadata and controls

471 lines (426 loc) · 21.6 KB
Raw
source:fortios_firewall_local_in_policy.py
orphan:

fortios_firewall_local_in_policy -- Configure user defined IPv4 local-in policies in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • 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

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_firewall_local_in_policy v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • firewall_local_in_policy - Configure user defined IPv4 local-in policies. type: dict more...
    Supported Version Ranges
    firewall_local_in_policy v6.0.0 -> latest
    • action - Action performed on traffic matching the policy . type: str choices: accept, deny more...
      Supported Version Ranges
      action v6.0.0 -> latest
      [accept] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • comments - Comment. type: str more...
      Supported Version Ranges
      comments v6.0.0 -> latest
    • dstaddr - Destination address object from available options. type: list member_path: dstaddr:name more...
      Supported Version Ranges
      dstaddr v6.0.0 -> latest
      • name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • dstaddr_negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: enable, disable more...
      Supported Version Ranges
      dstaddr_negate v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • ha_mgmt_intf_only - Enable/disable dedicating the HA management interface only for local-in policy. type: str choices: enable, disable more...
      Supported Version Ranges
      ha_mgmt_intf_only v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • intf - Incoming interface name from available options. Source system.zone.name system.interface.name. type: str more...
      Supported Version Ranges
      intf v6.0.0 -> latest
    • policyid - User defined local in policy ID. see Notes. type: int required: true more...
      Supported Version Ranges
      policyid v6.0.0 -> latest
    • schedule - Schedule object from available options. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group .name. type: str more...
      Supported Version Ranges
      schedule v6.0.0 -> latest
    • service - Service object from available options. type: list member_path: service:name more...
      Supported Version Ranges
      service v6.0.0 -> latest
      • name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable more...
      Supported Version Ranges
      service_negate v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • srcaddr - Source address object from available options. type: list member_path: srcaddr:name more...
      Supported Version Ranges
      srcaddr v6.0.0 -> latest
      • name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • srcaddr_negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: enable, disable more...
      Supported Version Ranges
      srcaddr_negate v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • status - Enable/disable this local-in policy. type: str choices: enable, disable more...
      Supported Version Ranges
      status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
      Supported Version Ranges
      uuid v6.4.0 -> latest
    • virtual_patch - Enable/disable virtual patching. type: str choices: enable, disable more...
      Supported Version Ranges
      virtual_patch v7.2.4 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest

Notes

Note

  • We highly recommend using your own value as the policyid instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- 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)"
          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_13 (source firewall.service.custom.name firewall.service.group.name)"
          service_negate: "enable"
          srcaddr:
              -
                  name: "default_name_16 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
          srcaddr_negate: "enable"
          status: "enable"
          uuid: "<your_own_value>"
          virtual_patch: "enable"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.