fortinet.fortimanager.fmgr_pkg_firewall_securitypolicy module – Configure NGFW IPv4/IPv6 application policies.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_securitypolicy.

New in fortinet.fortimanager 2.1.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

pkg

string / required

The parameter (pkg) in requested url.

pkg_firewall_securitypolicy

dictionary

The top level parameters set.

_policy_block

integer

Assigned policy block.

action

string

Policy action

Choices:

  • "deny"

  • "accept"

app_category

aliases: app-category

any

(list or str) Application category ID list.

app_group

aliases: app-group

any

(list or str) Application group names.

application

any

(list) Application ID list.

application_list

aliases: application-list

string

Name of an existing Application list.

av_profile

aliases: av-profile

string

Name of an existing Antivirus profile.

casb_profile

aliases: casb-profile

string

Name of an existing CASB profile.

cifs_profile

aliases: cifs-profile

string

Name of an existing CIFS profile.

comments

string

Comment.

diameter_filter_profile

aliases: diameter-filter-profile

string

Name of an existing Diameter filter profile.

dlp_profile

aliases: dlp-profile

string

Name of an existing DLP profile.

dlp_sensor

aliases: dlp-sensor

string

Name of an existing DLP sensor.

dnsfilter_profile

aliases: dnsfilter-profile

string

Name of an existing DNS filter profile.

dstaddr

any

(list or str) Destination IPv4 address name and address group names.

dstaddr4

any

(list or str) Destination IPv4 address name and address group names.

dstaddr6

any

(list or str) Destination IPv6 address name and address group names.

dstaddr6_negate

aliases: dstaddr6-negate

string

When enabled dstaddr6 specifies what the destination address must NOT be.

Choices:

  • "disable"

  • "enable"

dstaddr_negate

aliases: dstaddr-negate

string

When enabled dstaddr/dstaddr6 specifies what the destination address must NOT be.

Choices:

  • "disable"

  • "enable"

dstintf

any

(list or str) Outgoing

emailfilter_profile

aliases: emailfilter-profile

string

Name of an existing email filter profile.

enforce_default_app_port

aliases: enforce-default-app-port

string

Enable/disable default application port enforcement for allowed applications.

Choices:

  • "disable"

  • "enable"

file_filter_profile

aliases: file-filter-profile

string

Name of an existing file-filter profile.

fsso_groups

aliases: fsso-groups

any

(list or str) Names of FSSO groups.

global_label

aliases: global-label

string

Label for the policy that appears when the GUI is in Global View mode.

groups

any

(list or str) Names of user groups that can authenticate with this policy.

icap_profile

aliases: icap-profile

string

Name of an existing ICAP profile.

internet_service

aliases: internet-service

string

Enable/disable use of Internet Services for this policy.

Choices:

  • "disable"

  • "enable"

internet_service6

aliases: internet-service6

string

Enable/disable use of IPv6 Internet Services for this policy.

Choices:

  • "disable"

  • "enable"

internet_service6_custom

aliases: internet-service6-custom

any

(list) Custom IPv6 Internet Service name.

internet_service6_custom_group

aliases: internet-service6-custom-group

any

(list) Custom IPv6 Internet Service group name.

internet_service6_group

aliases: internet-service6-group

any

(list) Internet Service group name.

internet_service6_name

aliases: internet-service6-name

any

(list) IPv6 Internet Service name.

internet_service6_negate

aliases: internet-service6-negate

string

When enabled internet-service6 specifies what the service must NOT be.

Choices:

  • "disable"

  • "enable"

internet_service6_src

aliases: internet-service6-src

string

Enable/disable use of IPv6 Internet Services in source for this policy.

Choices:

  • "disable"

  • "enable"

internet_service6_src_custom

aliases: internet-service6-src-custom

any

(list) Custom IPv6 Internet Service source name.

internet_service6_src_custom_group

aliases: internet-service6-src-custom-group

any

(list) Custom Internet Service6 source group name.

internet_service6_src_group

aliases: internet-service6-src-group

any

(list) Internet Service6 source group name.

internet_service6_src_name

aliases: internet-service6-src-name

any

(list) IPv6 Internet Service source name.

internet_service6_src_negate

aliases: internet-service6-src-negate

string

When enabled internet-service6-src specifies what the service must NOT be.

Choices:

  • "disable"

  • "enable"

internet_service_custom

aliases: internet-service-custom

any

(list or str) Custom Internet Service name.

internet_service_custom_group

aliases: internet-service-custom-group

any

(list or str) Custom Internet Service group name.

internet_service_group

aliases: internet-service-group

any

(list or str) Internet Service group name.

internet_service_id

aliases: internet-service-id

any

(list or str) Internet Service ID.

internet_service_name

aliases: internet-service-name

any

(list or str) Internet Service name.

internet_service_negate

aliases: internet-service-negate

string

When enabled internet-service specifies what the service must NOT be.

Choices:

  • "disable"

  • "enable"

internet_service_src

aliases: internet-service-src

string

Enable/disable use of Internet Services in source for this policy.

Choices:

  • "disable"

  • "enable"

internet_service_src_custom

aliases: internet-service-src-custom

any

(list or str) Custom Internet Service source name.

internet_service_src_custom_group

aliases: internet-service-src-custom-group

any

(list or str) Custom Internet Service source group name.

internet_service_src_group

aliases: internet-service-src-group

any

(list or str) Internet Service source group name.

internet_service_src_id

aliases: internet-service-src-id

any

(list or str) Internet Service source ID.

internet_service_src_name

aliases: internet-service-src-name

any

(list or str) Internet Service source name.

internet_service_src_negate

aliases: internet-service-src-negate

string

When enabled internet-service-src specifies what the service must NOT be.

Choices:

  • "disable"

  • "enable"

ips_sensor

aliases: ips-sensor

string

Name of an existing IPS sensor.

ips_voip_filter

aliases: ips-voip-filter

string

Name of an existing VoIP

learning_mode

aliases: learning-mode

string

Enable to allow everything, but log all of the meaningful data for security information gathering.

Choices:

  • "disable"

  • "enable"

logtraffic

string

Enable or disable logging.

Choices:

  • "disable"

  • "all"

  • "utm"

logtraffic_start

aliases: logtraffic-start

string

Record logs when a session starts.

Choices:

  • "disable"

  • "enable"

mms_profile

aliases: mms-profile

string

Name of an existing MMS profile.

name

string

Policy name.

nat46

string

Enable/disable NAT46.

Choices:

  • "disable"

  • "enable"

nat64

string

Enable/disable NAT64.

Choices:

  • "disable"

  • "enable"

policyid

integer / required

Policy ID.

profile_group

aliases: profile-group

string

Name of profile group.

profile_protocol_options

aliases: profile-protocol-options

string

Name of an existing Protocol options profile.

profile_type

aliases: profile-type

string

Determine whether the firewall policy allows security profile groups or single profiles only.

Choices:

  • "single"

  • "group"

schedule

string

Schedule name.

sctp_filter_profile

aliases: sctp-filter-profile

string

Name of an existing SCTP filter profile.

send_deny_packet

aliases: send-deny-packet

string

Enable to send a reply when a session is denied or blocked by a firewall policy.

Choices:

  • "disable"

  • "enable"

service

any

(list or str) Service and service group names.

service_negate

aliases: service-negate

string

When enabled service specifies what the service must NOT be.

Choices:

  • "disable"

  • "enable"

srcaddr

any

(list or str) Source IPv4 address name and address group names.

srcaddr4

any

(list or str) Source IPv4 address name and address group names.

srcaddr6

any

(list or str) Source IPv6 address name and address group names.

srcaddr6_negate

aliases: srcaddr6-negate

string

When enabled srcaddr6 specifies what the source address must NOT be.

Choices:

  • "disable"

  • "enable"

srcaddr_negate

aliases: srcaddr-negate

string

When enabled srcaddr/srcaddr6 specifies what the source address must NOT be.

Choices:

  • "disable"

  • "enable"

srcintf

any

(list or str) Incoming

ssh_filter_profile

aliases: ssh-filter-profile

string

Name of an existing SSH filter profile.

ssl_ssh_profile

aliases: ssl-ssh-profile

string

Name of an existing SSL SSH profile.

status

string

Enable or disable this policy.

Choices:

  • "disable"

  • "enable"

url_category

aliases: url-category

any

(list or str) URL category ID list.

users

any

(list or str) Names of individual users that can authenticate with this policy.

utm_status

aliases: utm-status

string

Enable security profiles.

Choices:

  • "disable"

  • "enable"

uuid

string

Universally Unique Identifier

videofilter_profile

aliases: videofilter-profile

string

Name of an existing VideoFilter profile.

virtual_patch_profile

aliases: virtual-patch-profile

string

Name of an existing virtual-patch profile.

voip_profile

aliases: voip-profile

string

Name of an existing VoIP profile.

webfilter_profile

aliases: webfilter-profile

string

Name of an existing Web filter profile.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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 NGFW IPv4/IPv6 application policies.
      fortinet.fortimanager.fmgr_pkg_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>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_securitypolicy:
          action: <value in [deny, accept]>
          app_category: <list or string>
          app_group: <list or string>
          application: <list or integer>
          application_list: <string>
          av_profile: <string>
          cifs_profile: <string>
          comments: <string>
          dlp_sensor: <string>
          dnsfilter_profile: <string>
          dstaddr4: <list or string>
          dstaddr6: <list or string>
          dstintf: <list or string>
          emailfilter_profile: <string>
          enforce_default_app_port: <value in [disable, enable]>
          groups: <list or string>
          icap_profile: <string>
          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]>
          ips_sensor: <string>
          logtraffic: <value in [disable, all, utm]>
          logtraffic_start: <value in [disable, enable]>
          mms_profile: <string>
          name: <string>
          policyid: <integer>
          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]>
          srcaddr4: <list or string>
          srcaddr6: <list or string>
          srcintf: <list or string>
          ssh_filter_profile: <string>
          ssl_ssh_profile: <string>
          status: <value in [disable, enable]>
          url_category: <list or string>
          users: <list or string>
          utm_status: <value in [disable, enable]>
          uuid: <string>
          voip_profile: <string>
          webfilter_profile: <string>
          fsso_groups: <list or string>
          global_label: <string>
          send_deny_packet: <value in [disable, enable]>
          dstaddr: <list or string>
          internet_service_name: <list or string>
          internet_service_src_name: <list or string>
          srcaddr: <list or string>
          dstaddr_negate: <value in [disable, enable]>
          file_filter_profile: <string>
          srcaddr_negate: <value in [disable, enable]>
          learning_mode: <value in [disable, enable]>
          videofilter_profile: <string>
          _policy_block: <integer>
          dlp_profile: <string>
          nat46: <value in [disable, enable]>
          nat64: <value in [disable, enable]>
          sctp_filter_profile: <string>
          internet_service6: <value in [disable, enable]>
          internet_service6_custom: <list or string>
          internet_service6_custom_group: <list or string>
          internet_service6_group: <list or string>
          internet_service6_name: <list or string>
          internet_service6_negate: <value in [disable, enable]>
          internet_service6_src: <value in [disable, enable]>
          internet_service6_src_custom: <list or string>
          internet_service6_src_custom_group: <list or string>
          internet_service6_src_group: <list or string>
          internet_service6_src_name: <list or string>
          internet_service6_src_negate: <value in [disable, enable]>
          casb_profile: <string>
          diameter_filter_profile: <string>
          dstaddr6_negate: <value in [disable, enable]>
          ips_voip_filter: <string>
          srcaddr6_negate: <value in [disable, enable]>
          virtual_patch_profile: <string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)