fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy module – Configure IPv4 interface policies.

Note

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

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

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_interfacepolicy dictionary	The top level parameters set.
address-type string	Deprecated, please rename it to address_type. Address type. Choices: `"ipv4"` `"ipv6"`
application-list string	Deprecated, please rename it to application_list. Application list name.
application-list-status string	Deprecated, please rename it to application_list_status. Enable/disable application control. Choices: `"disable"` `"enable"`
av-profile string	Deprecated, please rename it to av_profile. Antivirus profile.
av-profile-status string	Deprecated, please rename it to av_profile_status. Enable/disable antivirus. Choices: `"disable"` `"enable"`
casb-profile any	(list) Deprecated, please rename it to casb_profile. CASB profile.
casb-profile-status string	Deprecated, please rename it to casb_profile_status. Enable/disable CASB. Choices: `"disable"` `"enable"`
casi-profile string	Deprecated, please rename it to casi_profile. CASI profile name.
casi-profile-status string	Deprecated, please rename it to casi_profile_status. Enable/disable CASI. Choices: `"disable"` `"enable"`
comments string	Comments.
dlp-profile string	Deprecated, please rename it to dlp_profile. DLP profile name.
dlp-profile-status string	Deprecated, please rename it to dlp_profile_status. Enable/disable DLP. Choices: `"disable"` `"enable"`
dlp-sensor string	Deprecated, please rename it to dlp_sensor. DLP sensor name.
dlp-sensor-status string	Deprecated, please rename it to dlp_sensor_status. Enable/disable DLP. Choices: `"disable"` `"enable"`
dsri string	Enable/disable DSRI. Choices: `"disable"` `"enable"`
dstaddr any	(list or str) Address object to limit traffic monitoring to network traffic sent to the specified address or range.
emailfilter-profile string	Deprecated, please rename it to emailfilter_profile. Email filter profile.
emailfilter-profile-status string	Deprecated, please rename it to emailfilter_profile_status. Enable/disable email filter. Choices: `"disable"` `"enable"`
interface string	Monitored interface name from available interfaces.
ips-sensor string	Deprecated, please rename it to ips_sensor. IPS sensor name.
ips-sensor-status string	Deprecated, please rename it to ips_sensor_status. Enable/disable IPS. Choices: `"disable"` `"enable"`
label string	Label.
logtraffic string	Logging type to be used in this policy Choices: `"disable"` `"all"` `"utm"`
policyid integer / required	Policy ID.
scan-botnet-connections string	Deprecated, please rename it to scan_botnet_connections. Enable/disable scanning for connections to Botnet servers. Choices: `"disable"` `"block"` `"monitor"`
service any	(list or str) Service object from available options.
spamfilter-profile string	Deprecated, please rename it to spamfilter_profile. Antispam profile.
spamfilter-profile-status string	Deprecated, please rename it to spamfilter_profile_status. Enable/disable antispam. Choices: `"disable"` `"enable"`
srcaddr any	(list or str) Address object to limit traffic monitoring to network traffic sent from the specified address or range.
status string	Enable/disable this policy. Choices: `"disable"` `"enable"`
uuid string	Universally Unique Identifier
webfilter-profile string	Deprecated, please rename it to webfilter_profile. Web filter profile.
webfilter-profile-status string	Deprecated, please rename it to webfilter_profile_status. Enable/disable web filtering. Choices: `"disable"` `"enable"`
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 interface policies.
      fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_interfacepolicy:
          address-type: ipv4 # <value in [ipv4, ipv6]>
          comments: "ansible-comment"
          interface: sslvpn_tun_intf
          policyid: 1
          status: enable

- 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 interface policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_interfacepolicy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            interface-policy: "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)

fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy module – Configure IPv4 interface policies.

Synopsis

Parameters

Notes

Examples

Return Values