fmgr_pkg_firewall_interfacepolicy6 – Configure IPv6 interface 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_interfacepolicy6 - Configure IPv6 interface policies. type: dict
- address-type - No description for the parameter type: str choices: [ipv4, ipv6]
- application-list - Application list name. type: str
- application-list-status - Enable/disable application control. type: str choices: [disable, enable]
- av-profile - Antivirus profile. type: str
- av-profile-status - Enable/disable antivirus. type: str choices: [disable, enable]
- comments - Comments. type: str
- dlp-sensor - DLP sensor name. type: str
- dlp-sensor-status - Enable/disable DLP. type: str choices: [disable, enable]
- dsri - Enable/disable DSRI. type: str choices: [disable, enable]
- dstaddr6 - IPv6 address object to limit traffic monitoring to network traffic sent to the specified address or range. type: str
- interface - Monitored interface name from available interfaces. type: str
- ips-sensor - IPS sensor name. type: str
- ips-sensor-status - Enable/disable IPS. type: str choices: [disable, enable]
- label - Label. type: str
- logtraffic - Logging type to be used in this policy (Options: all | utm | disable, Default: utm). type: str choices: [disable, all, utm]
- policyid - Policy ID. type: int
- scan-botnet-connections - Enable/disable scanning for connections to Botnet servers. type: str choices: [disable, block, monitor]
- service6 - Service name. type: str
- spamfilter-profile - Antispam profile. type: str
- spamfilter-profile-status - Enable/disable antispam. type: str choices: [disable, enable]
- srcaddr6 - IPv6 address object to limit traffic monitoring to network traffic sent from the specified address or range. type: str
- status - Enable/disable this policy. type: str choices: [disable, enable]
- webfilter-profile - Web filter profile. type: str
- webfilter-profile-status - Enable/disable web filtering. type: str choices: [disable, enable]
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: 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