fortinet.fortios.fortios_firewall_local_in_policy module – Configure user defined IPv4 local-in policies in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.6).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_local_in_policy.
New in fortinet.fortios 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.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure user defined IPv4 local-in policies. |
|
Action performed on traffic matching the policy . Choices:
|
|
Comment. |
|
Destination address object from available options. |
|
Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. |
|
When enabled dstaddr specifies what the destination address must NOT be. Choices:
|
|
Enable/disable dedicating the HA management interface only for local-in policy. Choices:
|
|
Incoming interface name from available options. Source system.zone.name system.interface.name. |
|
Incoming interface name from available options. Use the parameter intf if the fortiOS firmware version <= 7.4.1 |
|
Address name. Source system.zone.name system.interface.name. |
|
User defined local in policy ID. see <a href=’#notes’>Notes</a>. |
|
Schedule object from available options. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group .name. |
|
Service object from available options. |
|
Service name. Source firewall.service.custom.name firewall.service.group.name. |
|
When enabled service specifies what the service must NOT be. Choices:
|
|
Source address object from available options. |
|
Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. |
|
When enabled srcaddr specifies what the source address must NOT be. Choices:
|
|
Enable/disable this local-in policy. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Enable/disable virtual patching. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
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)"
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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |