fortinet.fortimanager.fmgr_pkg_firewall_policy46 module – Configure IPv4 to IPv6 policies.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

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

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

New in fortinet.fortimanager 2.0.0

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

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

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

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

pkg

string / required

The parameter (pkg) in requested url.

pkg_firewall_policy46

dictionary

The top level parameters set.

action

string

Accept or deny traffic matching the policy.

Choices:

  • "deny"

  • "accept"

cgn_log_server_grp

aliases: cgn-log-server-grp

string

NP log server group name

comments

string

Comment.

dstaddr

any

(list or str) Destination address objects.

dstintf

string

Destination interface name.

fixedport

string

Enable/disable fixed port for this policy.

Choices:

  • "disable"

  • "enable"

ippool

string

Enable/disable use of IP Pools for source NAT.

Choices:

  • "disable"

  • "enable"

logtraffic

string

Enable/disable traffic logging for this policy.

Choices:

  • "disable"

  • "enable"

logtraffic_start

aliases: logtraffic-start

string

Record logs when a session starts and ends.

Choices:

  • "disable"

  • "enable"

name

string

Policy name.

per_ip_shaper

aliases: per-ip-shaper

string

Per IP traffic shaper.

permit_any_host

aliases: permit-any-host

string

Enable/disable allowing any host.

Choices:

  • "disable"

  • "enable"

policy_offload

aliases: policy-offload

string

Enable/disable hardware session setup for CGNAT.

Choices:

  • "disable"

  • "enable"

policyid

integer / required

Policy ID.

poolname

any

(list or str) IP Pool names.

schedule

string

Schedule name.

service

any

(list or str) Service name.

srcaddr

any

(list or str) Source address objects.

srcintf

string

Source interface name.

status

string

Enable/disable this policy.

Choices:

  • "disable"

  • "enable"

tags

string

Applied object tags.

tcp_mss_receiver

aliases: tcp-mss-receiver

integer

TCP Maximum Segment Size value of receiver

tcp_mss_sender

aliases: tcp-mss-sender

integer

TCP Maximum Segment Size value of sender

traffic_shaper

aliases: traffic-shaper

string

Traffic shaper.

traffic_shaper_reverse

aliases: traffic-shaper-reverse

string

Reverse traffic shaper.

uuid

string

Universally Unique Identifier

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

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

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

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 to IPv6 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_policy46:
        bypass_validation: true
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_policy46:
          action: accept # <value in [deny, accept]>
          comments: ansible-comment
          dstaddr: ansible-test-vip46
          dstintf: any
          policyid: 1
          schedule: always
          service: ALL
          srcaddr: all
          srcintf: any
          status: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPv4 to IPv6 policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_policy46"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            policy46: "your_value"

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)