fmgr_pm_config_pblock_firewall_securitypolicy – Configure NGFW IPv4/IPv6 application 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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- pblock - The parameter in requested url type: str required: true
- pm_config_pblock_firewall_securitypolicy - no description type: dict
- _policy_block - Assigned policy block. type: int more...
- action - Policy action (accept/deny). type: str choices: [deny, accept] more...
- app-category - No description for the parameter type: str more...
- app-group - No description for the parameter type: str more...
- application - No description for the parameter type: int more...
- application-list - Name of an existing Application list. type: str more...
- av-profile - Name of an existing Antivirus profile. type: str more...
- cifs-profile - Name of an existing CIFS profile. type: str more...
- comments - Comment. type: str more...
- dlp-profile - Name of an existing DLP profile. type: str more...
- dnsfilter-profile - Name of an existing DNS filter profile. type: str more...
- dstaddr - No description for the parameter type: str more...
- dstaddr-negate - When enabled dstaddr/dstaddr6 specifies what the destination address must NOT be. type: str choices: [disable, enable] more...
- dstaddr6 - No description for the parameter type: str more...
- dstintf - No description for the parameter type: str more...
- emailfilter-profile - Name of an existing email filter profile. type: str more...
- enforce-default-app-port - Enable/disable default application port enforcement for allowed applications. type: str choices: [disable, enable] more...
- file-filter-profile - Name of an existing file-filter profile. type: str more...
- fsso-groups - No description for the parameter type: str more...
- global-label - Label for the policy that appears when the GUI is in Global View mode. type: str more...
- groups - No description for the parameter type: str more...
- icap-profile - Name of an existing ICAP profile. type: str more...
- internet-service - Enable/disable use of Internet Services for this policy. type: str choices: [disable, enable] more...
- internet-service-custom - No description for the parameter type: str more...
- internet-service-custom-group - No description for the parameter type: str more...
- internet-service-group - No description for the parameter type: str more...
- internet-service-name - No description for the parameter type: str more...
- internet-service-negate - When enabled internet-service specifies what the service must NOT be. type: str choices: [disable, enable] more...
- internet-service-src - Enable/disable use of Internet Services in source for this policy. type: str choices: [disable, enable] more...
- internet-service-src-custom - No description for the parameter type: str more...
- internet-service-src-custom-group - No description for the parameter type: str more...
- internet-service-src-group - No description for the parameter type: str more...
- internet-service-src-name - No description for the parameter type: str more...
- internet-service-src-negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: [disable, enable] more...
- ips-sensor - Name of an existing IPS sensor. type: str more...
- learning-mode - Enable to allow everything, but log all of the meaningful data for security information gathering. type: str choices: [disable, enable] more...
- logtraffic - Enable or disable logging. type: str choices: [disable, all, utm] more...
- name - Policy name. type: str more...
- nat46 - Enable/disable NAT46. type: str choices: [disable, enable] more...
- nat64 - Enable/disable NAT64. type: str choices: [disable, enable] more...
- policyid - Policy ID. type: int more...
- profile-group - Name of profile group. type: str more...
- profile-protocol-options - Name of an existing Protocol options profile. type: str more...
- profile-type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: [single, group] more...
- schedule - Schedule name. type: str more...
- sctp-filter-profile - Name of an existing SCTP filter profile. type: str more...
- send-deny-packet - Enable to send a reply when a session is denied or blocked by a firewall policy. type: str choices: [disable, enable] more...
- service - No description for the parameter type: str more...
- service-negate - When enabled service specifies what the service must NOT be. type: str choices: [disable, enable] more...
- srcaddr - No description for the parameter type: str more...
- srcaddr-negate - When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. type: str choices: [disable, enable] more...
- srcaddr6 - No description for the parameter type: str more...
- srcintf - No description for the parameter type: str more...
- ssh-filter-profile - Name of an existing SSH filter profile. type: str more...
- ssl-ssh-profile - Name of an existing SSL SSH profile. type: str more...
- status - Enable or disable this policy. type: str choices: [disable, enable] more...
- url-category - No description for the parameter type: str more...
- users - No description for the parameter type: str more...
- utm-status - Enable security profiles. type: str choices: [disable, enable] more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
- videofilter-profile - Name of an existing VideoFilter profile. type: str more...
- voip-profile - Name of an existing VoIP profile. type: str more...
- webfilter-profile - Name of an existing Web filter profile. type: str 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¶
- 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: no description
fmgr_pm_config_pblock_firewall_securitypolicy:
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>
pblock: <your own value>
state: <value in [present, absent]>
pm_config_pblock_firewall_securitypolicy:
_policy_block: <value of integer>
action: <value in [deny, accept]>
app-category: <value of string>
app-group: <value of string>
application: <value of integer>
application-list: <value of string>
av-profile: <value of string>
cifs-profile: <value of string>
comments: <value of string>
dlp-profile: <value of string>
dnsfilter-profile: <value of string>
dstaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
dstaddr6: <value of string>
dstintf: <value of string>
emailfilter-profile: <value of string>
enforce-default-app-port: <value in [disable, enable]>
file-filter-profile: <value of string>
fsso-groups: <value of string>
global-label: <value of string>
groups: <value of string>
icap-profile: <value of string>
internet-service: <value in [disable, enable]>
internet-service-custom: <value of string>
internet-service-custom-group: <value of string>
internet-service-group: <value of string>
internet-service-name: <value of string>
internet-service-negate: <value in [disable, enable]>
internet-service-src: <value in [disable, enable]>
internet-service-src-custom: <value of string>
internet-service-src-custom-group: <value of string>
internet-service-src-group: <value of string>
internet-service-src-name: <value of string>
internet-service-src-negate: <value in [disable, enable]>
ips-sensor: <value of string>
learning-mode: <value in [disable, enable]>
logtraffic: <value in [disable, all, utm]>
name: <value of string>
nat46: <value in [disable, enable]>
nat64: <value in [disable, enable]>
policyid: <value of integer>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
schedule: <value of string>
sctp-filter-profile: <value of string>
send-deny-packet: <value in [disable, enable]>
service: <value of string>
service-negate: <value in [disable, enable]>
srcaddr: <value of string>
srcaddr-negate: <value in [disable, enable]>
srcaddr6: <value of string>
srcintf: <value of string>
ssh-filter-profile: <value of string>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
url-category: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
videofilter-profile: <value of string>
voip-profile: <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