fortinet.fortios.fortios_firewall_local_in_policy6 module – Configure user defined IPv6 local-in policies in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.9).

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_policy6.

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_policy6 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

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

firewall_local_in_policy6

dictionary

Configure user defined IPv6 local-in policies.

action

string

Action performed on traffic matching the policy .

Choices:

  • "accept"

  • "deny"

comments

string

Comment.

dstaddr

list / elements=dictionary

Destination address object from available options.

name

string / required

Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name.

dstaddr_negate

string

When enabled dstaddr specifies what the destination address must NOT be.

Choices:

  • "enable"

  • "disable"

internet_service6_src

string

Enable/disable use of IPv6 Internet Services in source for this local-in policy.If enabled, source address is not used.

Choices:

  • "enable"

  • "disable"

internet_service6_src_custom

list / elements=dictionary

Custom IPv6 Internet Service source name.

name

string / required

Custom Internet Service name. Source firewall.internet-service-custom.name.

internet_service6_src_custom_group

list / elements=dictionary

Custom Internet Service6 source group name.

name

string / required

Custom Internet Service6 group name. Source firewall.internet-service-custom-group.name.

internet_service6_src_group

list / elements=dictionary

Internet Service6 source group name.

name

string / required

Internet Service group name. Source firewall.internet-service-group.name.

internet_service6_src_name

list / elements=dictionary

IPv6 Internet Service source name.

name

string / required

Internet Service name. Source firewall.internet-service-name.name.

internet_service6_src_negate

string

When enabled internet-service6-src specifies what the service must NOT be.

Choices:

  • "enable"

  • "disable"

intf

string

Incoming interface name from available options. Source system.zone.name system.interface.name.

intf_dict

list / elements=dictionary

Incoming interface name from available options.

name

string / required

Address name. Source system.zone.name system.interface.name.

logtraffic

string

Enable/disable local-in traffic logging.

Choices:

  • "enable"

  • "disable"

policyid

integer / required

User defined local in policy ID. see <a href=’#notes’>Notes</a>.

schedule

string

Schedule object from available options. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group .name.

service

list / elements=dictionary

Service object from available options. Separate names with a space.

name

string / required

Service name. Source firewall.service.custom.name firewall.service.group.name.

service_negate

string

When enabled service specifies what the service must NOT be.

Choices:

  • "enable"

  • "disable"

srcaddr

list / elements=dictionary

Source address object from available options.

name

string / required

Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name.

srcaddr_negate

string

When enabled srcaddr specifies what the source address must NOT be.

Choices:

  • "enable"

  • "disable"

status

string

Enable/disable this local-in policy.

Choices:

  • "enable"

  • "disable"

uuid

string

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

virtual_patch

string

Enable/disable the virtual patching feature.

Choices:

  • "enable"

  • "disable"

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"

  • "absent"

vdom

string

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: "root"

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

  • The module supports check_mode.

Examples

- name: Configure user defined IPv6 local-in policies.
  fortinet.fortios.fortios_firewall_local_in_policy6:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_local_in_policy6:
          action: "accept"
          comments: "<your_own_value>"
          dstaddr:
              -
                  name: "default_name_6 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
          dstaddr_negate: "enable"
          internet_service6_src: "enable"
          internet_service6_src_custom:
              -
                  name: "default_name_10 (source firewall.internet-service-custom.name)"
          internet_service6_src_custom_group:
              -
                  name: "default_name_12 (source firewall.internet-service-custom-group.name)"
          internet_service6_src_group:
              -
                  name: "default_name_14 (source firewall.internet-service-group.name)"
          internet_service6_src_name:
              -
                  name: "default_name_16 (source firewall.internet-service-name.name)"
          internet_service6_src_negate: "enable"
          intf: "<your_own_value> (source system.zone.name system.interface.name)"
          intf_dict:
              -
                  name: "default_name_20 (source system.zone.name system.interface.name)"
          logtraffic: "enable"
          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_25 (source firewall.service.custom.name firewall.service.group.name)"
          service_negate: "enable"
          srcaddr:
              -
                  name: "default_name_28 (source firewall.address6.name firewall.addrgrp6.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

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)