fmgr_pm_config_pblock_firewall_consolidated_policy – Configure consolidated IPv4/IPv6 policies.
Added in version 2.2.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.nameNew 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 v6.x and 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: v7.0.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
- pblock - The parameter in requested url type: str required: true
- pm_config_pblock_firewall_consolidated_policy - Configure consolidated IPv4/IPv6 policies. type: dict
- _policy_block Assigned policy block. type: int more...
- action Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec] more...
- app_category (Alias name: app-category) type: list more...
- app_group (Alias name: app-group) type: list more...
- application type: list more...
- application_list (Alias name: application-list) Name of an existing application list. type: str more...
- auto_asic_offload (Alias name: auto-asic-offload) Enable/disable policy traffic asic offloading. type: str choices: [disable, enable] more...
- av_profile (Alias name: av-profile) Name of an existing antivirus profile. type: str more...
- captive_portal_exempt (Alias name: captive-portal-exempt) Enable exemption of some users from the captive portal. type: str choices: [disable, enable] more...
- cifs_profile (Alias name: cifs-profile) Name of an existing cifs profile. type: str more...
- comments Comment. type: str more...
- diffserv_forward (Alias name: diffserv-forward) Enable to change packets diffserv values to the specified diffservcode-forward value. type: str choices: [disable, enable] more...
- diffserv_reverse (Alias name: diffserv-reverse) Enable to change packets reverse (reply) diffserv values to the specified diffservcode-rev value. type: str choices: [disable, enable] more...
- diffservcode_forward (Alias name: diffservcode-forward) Change packets diffserv to this value. type: str more...
- diffservcode_rev (Alias name: diffservcode-rev) Change packets reverse (reply) diffserv to this value. type: str more...
- dlp_sensor (Alias name: dlp-sensor) Name of an existing dlp sensor. type: str more...
- dnsfilter_profile (Alias name: dnsfilter-profile) Name of an existing dns filter profile. type: str more...
- dstaddr_negate (Alias name: dstaddr-negate) When enabled dstaddr specifies what the destination address must not be. type: str choices: [disable, enable] more...
- dstaddr4 type: list more...
- dstaddr6 type: list more...
- dstintf type: list more...
- emailfilter_profile (Alias name: emailfilter-profile) Name of an existing email filter profile. type: str more...
- fixedport Enable to prevent source nat from changing a sessions source port. type: str choices: [disable, enable] more...
- fsso_groups (Alias name: fsso-groups) type: list more...
- global_label (Alias name: global-label) Label for the policy that appears when the gui is in global view mode. type: str more...
- groups type: list more...
- http_policy_redirect (Alias name: http-policy-redirect) Redirect http(s) traffic to matching transparent web proxy policy. type: str choices: [disable, enable] more...
- icap_profile (Alias name: icap-profile) Name of an existing icap profile. type: str more...
- inbound Policy-based ipsec vpn: only traffic from the remote network can initiate a vpn. type: str choices: [disable, enable] more...
- inspection_mode (Alias name: inspection-mode) Policy inspection mode (flow/proxy). type: str choices: [proxy, flow] more...
- internet_service (Alias name: internet-service) Enable/disable use of internet services for this policy. type: str choices: [disable, enable] more...
- internet_service_custom (Alias name: internet-service-custom) type: list more...
- internet_service_custom_group (Alias name: internet-service-custom-group) type: list more...
- internet_service_group (Alias name: internet-service-group) type: list more...
- internet_service_id (Alias name: internet-service-id) type: list more...
- internet_service_negate (Alias name: internet-service-negate) When enabled internet-service specifies what the service must not be. type: str choices: [disable, enable] more...
- internet_service_src (Alias name: internet-service-src) Enable/disable use of internet services in source for this policy. type: str choices: [disable, enable] more...
- internet_service_src_custom (Alias name: internet-service-src-custom) type: list more...
- internet_service_src_custom_group (Alias name: internet-service-src-custom-group) type: list more...
- internet_service_src_group (Alias name: internet-service-src-group) type: list more...
- internet_service_src_id (Alias name: internet-service-src-id) type: list more...
- internet_service_src_negate (Alias name: internet-service-src-negate) When enabled internet-service-src specifies what the service must not be. type: str choices: [disable, enable] more...
- ippool Enable to use ip pools for source nat. type: str choices: [disable, enable] more...
- ips_sensor (Alias name: ips-sensor) Name of an existing ips sensor. type: str more...
- logtraffic Enable or disable logging. type: str choices: [disable, all, utm] more...
- logtraffic_start (Alias name: logtraffic-start) Record logs when a session starts. type: str choices: [disable, enable] more...
- mms_profile (Alias name: mms-profile) Name of an existing mms profile. type: str more...
- name Policy name. type: str more...
- nat Enable/disable source nat. type: str choices: [disable, enable] more...
- outbound Policy-based ipsec vpn: only traffic from the internal network can initiate a vpn. type: str choices: [disable, enable] more...
- per_ip_shaper (Alias name: per-ip-shaper) Per-ip traffic shaper. type: str more...
- policyid Policy id (0 - 4294967294). type: int more...
- poolname4 type: list more...
- poolname6 type: list more...
- profile_group (Alias name: profile-group) Name of profile group. type: str more...
- profile_protocol_options (Alias name: profile-protocol-options) Name of an existing protocol options profile. type: str more...
- profile_type (Alias name: 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...
- service type: list more...
- service_negate (Alias name: service-negate) When enabled service specifies what the service must not be. type: str choices: [disable, enable] more...
- session_ttl (Alias name: session-ttl) Ttl in seconds for sessions accepted by this policy (0 means use the system default session ttl). type: int more...
- srcaddr_negate (Alias name: srcaddr-negate) When enabled srcaddr specifies what the source address must not be. type: str choices: [disable, enable] more...
- srcaddr4 type: list more...
- srcaddr6 type: list more...
- srcintf type: list more...
- ssh_filter_profile (Alias name: ssh-filter-profile) Name of an existing ssh filter profile. type: str more...
- ssh_policy_redirect (Alias name: ssh-policy-redirect) Redirect ssh traffic to matching transparent proxy policy. type: str choices: [disable, enable] more...
- ssl_ssh_profile (Alias name: 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...
- tcp_mss_receiver (Alias name: tcp-mss-receiver) Receiver tcp maximum segment size (mss). type: int more...
- tcp_mss_sender (Alias name: tcp-mss-sender) Sender tcp maximum segment size (mss). type: int more...
- traffic_shaper (Alias name: traffic-shaper) Traffic shaper. type: str more...
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) Reverse traffic shaper. type: str more...
- url_category (Alias name: url-category) type: list more...
- users type: list more...
- utm_status (Alias name: utm-status) Enable to add one or more security profiles (av, ips, etc. type: str choices: [disable, enable] more...
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
- voip_profile (Alias name: voip-profile) Name of an existing voip profile. type: str more...
- vpntunnel Policy-based ipsec vpn: name of the ipsec vpn phase 1. type: str more...
- waf_profile (Alias name: waf-profile) Name of an existing web application firewall profile. type: str more...
- wanopt Enable/disable wan optimization. type: str choices: [disable, enable] more...
- wanopt_detection (Alias name: wanopt-detection) Wan optimization auto-detection mode. type: str choices: [active, passive, off] more...
- wanopt_passive_opt (Alias name: wanopt-passive-opt) Wan optimization passive mode options. type: str choices: [default, transparent, non-transparent] more...
- wanopt_peer (Alias name: wanopt-peer) Wan optimization peer. type: str more...
- wanopt_profile (Alias name: wanopt-profile) Wan optimization profile. type: str more...
- webcache Enable/disable web cache. type: str choices: [disable, enable] more...
- webcache_https (Alias name: webcache-https) Enable/disable web cache for https. type: str choices: [disable, enable] more...
- webfilter_profile (Alias name: webfilter-profile) Name of an existing web filter profile. type: str more...
- webproxy_forward_server (Alias name: webproxy-forward-server) Webproxy forward server name. type: str more...
- webproxy_profile (Alias name: webproxy-profile) Webproxy profile name. 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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure consolidated IPv4/IPv6 policies.
fortinet.fortimanager.fmgr_pm_config_pblock_firewall_consolidated_policy:
# 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: present # <value in [present, absent]>
pm_config_pblock_firewall_consolidated_policy:
_policy_block: <integer>
action: <value in [deny, accept, ipsec]>
app_category: <list or string>
app_group: <list or string>
application: <list or integer>
application_list: <string>
auto_asic_offload: <value in [disable, enable]>
av_profile: <string>
captive_portal_exempt: <value in [disable, enable]>
cifs_profile: <string>
comments: <string>
diffserv_forward: <value in [disable, enable]>
diffserv_reverse: <value in [disable, enable]>
diffservcode_forward: <string>
diffservcode_rev: <string>
dlp_sensor: <string>
dnsfilter_profile: <string>
dstaddr_negate: <value in [disable, enable]>
dstaddr4: <list or string>
dstaddr6: <list or string>
dstintf: <list or string>
emailfilter_profile: <string>
fixedport: <value in [disable, enable]>
fsso_groups: <list or string>
global_label: <string>
groups: <list or string>
http_policy_redirect: <value in [disable, enable]>
icap_profile: <string>
inbound: <value in [disable, enable]>
inspection_mode: <value in [proxy, flow]>
internet_service: <value in [disable, enable]>
internet_service_custom: <list or string>
internet_service_custom_group: <list or string>
internet_service_group: <list or string>
internet_service_id: <list or string>
internet_service_negate: <value in [disable, enable]>
internet_service_src: <value in [disable, enable]>
internet_service_src_custom: <list or string>
internet_service_src_custom_group: <list or string>
internet_service_src_group: <list or string>
internet_service_src_id: <list or string>
internet_service_src_negate: <value in [disable, enable]>
ippool: <value in [disable, enable]>
ips_sensor: <string>
logtraffic: <value in [disable, all, utm]>
logtraffic_start: <value in [disable, enable]>
mms_profile: <string>
name: <string>
nat: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per_ip_shaper: <string>
policyid: <integer>
poolname4: <list or string>
poolname6: <list or string>
profile_group: <string>
profile_protocol_options: <string>
profile_type: <value in [single, group]>
schedule: <string>
service: <list or string>
service_negate: <value in [disable, enable]>
session_ttl: <integer>
srcaddr_negate: <value in [disable, enable]>
srcaddr4: <list or string>
srcaddr6: <list or string>
srcintf: <list or string>
ssh_filter_profile: <string>
ssh_policy_redirect: <value in [disable, enable]>
ssl_ssh_profile: <string>
status: <value in [disable, enable]>
tcp_mss_receiver: <integer>
tcp_mss_sender: <integer>
traffic_shaper: <string>
traffic_shaper_reverse: <string>
url_category: <list or string>
users: <list or string>
utm_status: <value in [disable, enable]>
uuid: <string>
voip_profile: <string>
vpntunnel: <string>
waf_profile: <string>
wanopt: <value in [disable, enable]>
wanopt_detection: <value in [active, passive, off]>
wanopt_passive_opt: <value in [default, transparent, non-transparent]>
wanopt_peer: <string>
wanopt_profile: <string>
webcache: <value in [disable, enable]>
webcache_https: <value in [disable, enable]>
webfilter_profile: <string>
webproxy_forward_server: <string>
webproxy_profile: <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:
- 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.