fortios_firewall_local_in_policy – Configure user defined IPv4 local-in policies in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_firewall_local_in_policy | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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...
- action - Action performed on traffic matching the policy . type: str choices: accept, deny more...
- comments - Comment. type: str more...
- dstaddr - Destination address object from available options. type: list member_path: dstaddr:name more...
- name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: true more...
- dstaddr_negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: enable, disable more...
- ha_mgmt_intf_only - Enable/disable dedicating the HA management interface only for local-in policy. type: str choices: enable, disable more...
- intf - Incoming interface name from available options. Source system.zone.name system.interface.name. type: str more...
- policyid - User defined local in policy ID. type: int required: true more...
- schedule - Schedule object from available options. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group .name. type: str more...
- service - Service object from available options. type: list member_path: service:name more...
- name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...
- service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable more...
- srcaddr - Source address object from available options. type: list member_path: srcaddr:name more...
- name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: true more...
- srcaddr_negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: enable, disable more...
- status - Enable/disable this local-in policy. type: str choices: enable, disable more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
- virtual_patch - Enable/disable virtual patching. type: str choices: enable, disable more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure user defined IPv4 local-in policies.
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: "0"
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