fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy6 – Configure IPv6 interface policies.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr pkg firewall interfacepolicy6 module


fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy6 – Configure IPv6 interface policies.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy6.


New in version 2.10: of fortinet.fortimanager


Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

  • no

  • yes

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

pkg

string / required

the parameter (pkg) in requested url

pkg_firewall_interfacepolicy6

dictionary

the top level parameters set

address-type

string

  • ipv4
  • ipv6

no description

application-list

string

Application list name.

application-list-status

string

  • disable
  • enable

Enable/disable application control.

av-profile

string

Antivirus profile.

av-profile-status

string

  • disable
  • enable

Enable/disable antivirus.

comments

string

Comments.

dlp-sensor

string

DLP sensor name.

dlp-sensor-status

string

  • disable
  • enable

Enable/disable DLP.

dsri

string

  • disable
  • enable

Enable/disable DSRI.

dstaddr6

string

IPv6 address object to limit traffic monitoring to network traffic sent to the specified address or range.

interface

string

Monitored interface name from available interfaces.

ips-sensor

string

IPS sensor name.

ips-sensor-status

string

  • disable
  • enable

Enable/disable IPS.

label

string

Label.

logtraffic

string

  • disable
  • all
  • utm

Logging type to be used in this policy (Options: all | utm | disable, Default: utm).

policyid

integer

Policy ID.

scan-botnet-connections

string

  • disable
  • block
  • monitor

Enable/disable scanning for connections to Botnet servers.

service6

string

Service name.

spamfilter-profile

string

Antispam profile.

spamfilter-profile-status

string

  • disable
  • enable

Enable/disable antispam.

srcaddr6

string

IPv6 address object to limit traffic monitoring to network traffic sent from the specified address or range.

status

string

  • disable
  • enable

Enable/disable this policy.

webfilter-profile

string

Web filter profile.

webfilter-profile-status

string

  • disable
  • enable

Enable/disable web filtering.

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

  • present
  • absent

the directive to create, update or delete an object

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

Default:

300

the maximum time in seconds to wait for other user to release the workspace lock



Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state present directive.
  • To delete an object, use state absent directive.
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded


Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv6 interface policies.
     fmgr_pkg_firewall_interfacepolicy6:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        pkg: <your own value>
        state: <value in [present, absent]>
        pkg_firewall_interfacepolicy6:
           address-type: <value in [ipv4, ipv6]>
           application-list: <value of string>
           application-list-status: <value in [disable, enable]>
           av-profile: <value of string>
           av-profile-status: <value in [disable, enable]>
           comments: <value of string>
           dlp-sensor: <value of string>
           dlp-sensor-status: <value in [disable, enable]>
           dsri: <value in [disable, enable]>
           dstaddr6: <value of string>
           interface: <value of string>
           ips-sensor: <value of string>
           ips-sensor-status: <value in [disable, enable]>
           label: <value of string>
           logtraffic: <value in [disable, all, utm]>
           policyid: <value of integer>
           scan-botnet-connections: <value in [disable, block, monitor]>
           service6: <value of string>
           spamfilter-profile: <value of string>
           spamfilter-profile-status: <value in [disable, enable]>
           srcaddr6: <value of string>
           status: <value in [disable, enable]>
           webfilter-profile: <value of string>
           webfilter-profile-status: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_pkg_firewall_interfacepolicy6_module.html