fmgr_pkg_firewall_interfacepolicy – Configure IPv4 interface policies.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name
,var name
,var.name
New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> v7.2.2
, v7.2.6 -> v7.2.8
, v7.4.3 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_firewall_interfacepolicy - Configure IPv4 interface policies. type: dict
- address_type (Alias name: address-type) Address type. type: str choices: [ipv4, ipv6] more...
- application_list (Alias name: application-list) Application list name. type: str more...
- application_list_status (Alias name: application-list-status) Enable/disable application control. type: str choices: [disable, enable] more...
- av_profile (Alias name: av-profile) Antivirus profile. type: str more...
- av_profile_status (Alias name: av-profile-status) Enable/disable antivirus. type: str choices: [disable, enable] more...
- comments Comments. type: str more...
- dlp_sensor (Alias name: dlp-sensor) Dlp sensor name. type: str more...
- dlp_sensor_status (Alias name: dlp-sensor-status) Enable/disable dlp. type: str choices: [disable, enable] more...
- dsri Enable/disable dsri. type: str choices: [disable, enable] more...
- dstaddr Address object to limit traffic monitoring to network traffic sent to the specified address or range. type: list or str more...
- interface Monitored interface name from available interfaces. type: str more...
- ips_sensor (Alias name: ips-sensor) Ips sensor name. type: str more...
- ips_sensor_status (Alias name: ips-sensor-status) Enable/disable ips. type: str choices: [disable, enable] more...
- label Label. type: str more...
- logtraffic Logging type to be used in this policy (options: all | utm | disable, default: utm). type: str choices: [disable, all, utm] more...
- policyid Policy id. type: int more...
- scan_botnet_connections (Alias name: scan-botnet-connections) Enable/disable scanning for connections to botnet servers. type: str choices: [disable, block, monitor] more...
- service Service object from available options. type: list or str more...
- spamfilter_profile (Alias name: spamfilter-profile) Antispam profile. type: str more...
- spamfilter_profile_status (Alias name: spamfilter-profile-status) Enable/disable antispam. type: str choices: [disable, enable] more...
- srcaddr Address object to limit traffic monitoring to network traffic sent from the specified address or range. type: list or str more...
- status Enable/disable this policy. type: str choices: [disable, enable] more...
- webfilter_profile (Alias name: webfilter-profile) Web filter profile. type: str more...
- webfilter_profile_status (Alias name: webfilter-profile-status) Enable/disable web filtering. type: str choices: [disable, enable] more...
- emailfilter_profile (Alias name: emailfilter-profile) Email filter profile. type: str more...
- emailfilter_profile_status (Alias name: emailfilter-profile-status) Enable/disable email filter. type: str choices: [disable, enable] more...
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
- casi_profile (Alias name: casi-profile) Casi profile name. type: str more...
- casi_profile_status (Alias name: casi-profile-status) Enable/disable casi. type: str choices: [disable, enable] more...
- dlp_profile (Alias name: dlp-profile) Dlp profile name. type: str more...
- dlp_profile_status (Alias name: dlp-profile-status) Enable/disable dlp. type: str choices: [disable, enable] more...
- casb_profile (Alias name: casb-profile) Casb profile. type: list more...
- casb_profile_status (Alias name: casb-profile-status) Enable/disable casb. type: str choices: [disable, enable] more...
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
- 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.