fmgr_pkg_firewall_policy6 – Configure IPv6 policies.¶
New in version 2.10.
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 v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_firewall_policy6 - Configure IPv6 policies. type: dict
- action - Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec, ssl-vpn]
- app-category - Application category ID list. type: str
- application - No description for the parameter type: int
- application-list - Name of an existing Application list. type: str
- auto-asic-offload - Enable/disable policy traffic ASIC offloading. type: str choices: [disable, enable]
- av-profile - Name of an existing Antivirus profile. type: str
- comments - Comment. type: str
- custom-log-fields - Log field index numbers to append custom log fields to log messages for this policy. type: str
- devices - Names of devices or device groups that can be matched by the policy. type: str
- diffserv-forward - Enable to change packets DiffServ values to the specified diffservcode-forward value. type: str choices: [disable, enable]
- diffserv-reverse - Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: [disable, enable]
- diffservcode-forward - Change packets DiffServ to this value. type: str
- diffservcode-rev - Change packets reverse (reply) DiffServ to this value. type: str
- dlp-sensor - Name of an existing DLP sensor. type: str
- dscp-match - Enable DSCP check. type: str choices: [disable, enable]
- dscp-negate - Enable negated DSCP match. type: str choices: [disable, enable]
- dscp-value - DSCP value. type: str
- dsri - Enable DSRI to ignore HTTP server responses. type: str choices: [disable, enable]
- dstaddr - Destination address and address group names. type: str
- dstaddr-negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: [disable, enable]
- dstintf - Outgoing (egress) interface. type: str
- firewall-session-dirty - How to handle sessions if the configuration of this firewall policy changes. type: str choices: [check-all, check-new]
- fixedport - Enable to prevent source NAT from changing a sessions source port. type: str choices: [disable, enable]
- global-label - Label for the policy that appears when the GUI is in Global View mode. type: str
- groups - Names of user groups that can authenticate with this policy. type: str
- icap-profile - Name of an existing ICAP profile. type: str
- inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: [disable, enable]
- ippool - Enable to use IP Pools for source NAT. type: str choices: [disable, enable]
- ips-sensor - Name of an existing IPS sensor. type: str
- label - Label for the policy that appears when the GUI is in Section View mode. type: str
- logtraffic - Enable or disable logging. type: str choices: [disable, enable, all, utm]
- logtraffic-start - Record logs when a session starts and ends. type: str choices: [disable, enable]
- mms-profile - Name of an existing MMS profile. type: str
- name - Policy name. type: str
- nat - Enable/disable source NAT. type: str choices: [disable, enable]
- natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: [disable, enable]
- natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: [disable, enable]
- np-accelation - Enable/disable UTM Network Processor acceleration. type: str choices: [disable, enable]
- outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: [disable, enable]
- per-ip-shaper - Per-IP traffic shaper. type: str
- policyid - Policy ID. type: int
- poolname - IP Pool names. type: str
- profile-group - Name of profile group. type: str
- profile-protocol-options - Name of an existing Protocol options profile. type: str
- profile-type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: [single, group]
- replacemsg-override-group - Override the default replacement message group for this policy. type: str
- rsso - Enable/disable RADIUS single sign-on (RSSO). type: str choices: [disable, enable]
- schedule - Schedule name. type: str
- send-deny-packet - Enable/disable return of deny-packet. type: str choices: [disable, enable]
- service - Service and service group names. type: str
- service-negate - When enabled service specifies what the service must NOT be. type: str choices: [disable, enable]
- session-ttl - Session TTL in seconds for sessions accepted by this policy. type: int
- spamfilter-profile - Name of an existing Spam filter profile. type: str
- srcaddr - Source address and address group names. type: str
- srcaddr-negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: [disable, enable]
- srcintf - Incoming (ingress) interface. type: str
- ssl-mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str choices: [disable, enable]
- ssl-mirror-intf - SSL mirror interface name. type: str
- ssl-ssh-profile - Name of an existing SSL SSH profile. type: str
- status - Enable or disable this policy. type: str choices: [disable, enable]
- tags - Names of object-tags applied to this policy. type: str
- tcp-mss-receiver - Receiver TCP maximum segment size (MSS). type: int
- tcp-mss-sender - Sender TCP maximum segment size (MSS). type: int
- tcp-session-without-syn - Enable/disable creation of TCP session without SYN flag. type: str choices: [all, data-only, disable]
- timeout-send-rst - Enable/disable sending RST packets when TCP sessions expire. type: str choices: [disable, enable]
- traffic-shaper - Reverse traffic shaper. type: str
- traffic-shaper-reverse - Reverse traffic shaper. type: str
- url-category - URL category ID list. type: str
- users - Names of individual users that can authenticate with this policy. type: str
- utm-status - Enable AV/web/ips protection profile. type: str choices: [disable, enable]
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
- vlan-cos-fwd - VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest type: int
- vlan-cos-rev - VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest type: int
- voip-profile - Name of an existing VoIP profile. type: str
- vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. type: str
- webfilter-profile - Name of an existing Web filter profile. type: str
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 policies.
fmgr_pkg_firewall_policy6:
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_policy6:
action: <value in [deny, accept, ipsec, ...]>
app-category: <value of string>
application: <value of integer>
application-list: <value of string>
auto-asic-offload: <value in [disable, enable]>
av-profile: <value of string>
comments: <value of string>
custom-log-fields: <value of string>
devices: <value of string>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
dlp-sensor: <value of string>
dscp-match: <value in [disable, enable]>
dscp-negate: <value in [disable, enable]>
dscp-value: <value of string>
dsri: <value in [disable, enable]>
dstaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
dstintf: <value of string>
firewall-session-dirty: <value in [check-all, check-new]>
fixedport: <value in [disable, enable]>
global-label: <value of string>
groups: <value of string>
icap-profile: <value of string>
inbound: <value in [disable, enable]>
ippool: <value in [disable, enable]>
ips-sensor: <value of string>
label: <value of string>
logtraffic: <value in [disable, enable, all, ...]>
logtraffic-start: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
nat: <value in [disable, enable]>
natinbound: <value in [disable, enable]>
natoutbound: <value in [disable, enable]>
np-accelation: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per-ip-shaper: <value of string>
policyid: <value of integer>
poolname: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
replacemsg-override-group: <value of string>
rsso: <value in [disable, enable]>
schedule: <value of string>
send-deny-packet: <value in [disable, enable]>
service: <value of string>
service-negate: <value in [disable, enable]>
session-ttl: <value of integer>
spamfilter-profile: <value of string>
srcaddr: <value of string>
srcaddr-negate: <value in [disable, enable]>
srcintf: <value of string>
ssl-mirror: <value in [disable, enable]>
ssl-mirror-intf: <value of string>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
tags: <value of string>
tcp-mss-receiver: <value of integer>
tcp-mss-sender: <value of integer>
tcp-session-without-syn: <value in [all, data-only, disable]>
timeout-send-rst: <value in [disable, enable]>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
url-category: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
vlan-cos-fwd: <value of integer>
vlan-cos-rev: <value of integer>
voip-profile: <value of string>
vpntunnel: <value of string>
webfilter-profile: <value of string>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict