fortinet.fortimanager.fmgr_firewall_profilegroup module – Configure profile groups.

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_firewall_profilegroup.

New in fortinet.fortimanager 1.0.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

firewall_profilegroup

dictionary

The top level parameters set.

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.

casi_profile

aliases: casi-profile

string

CASI profile.

cifs_profile

aliases: cifs-profile

string

Name of an existing CIFS profile.

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.

emailfilter_profile

aliases: emailfilter-profile

string

Name of an existing email filter profile.

file_filter_profile

aliases: file-filter-profile

string

Name of an existing file-filter profile.

icap_profile

aliases: icap-profile

string

Name of an existing ICAP profile.

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

mms_profile

aliases: mms-profile

string

Name of an existing MMS profile.

name

string / required

Profile group name.

profile_protocol_options

aliases: profile-protocol-options

string

Name of an existing Protocol options profile.

sctp_filter_profile

aliases: sctp-filter-profile

string

Name of an existing SCTP filter profile.

spamfilter_profile

aliases: spamfilter-profile

string

Name of an existing Spam filter profile.

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.

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.

waf_profile

aliases: waf-profile

string

Name of an existing Web application firewall profile.

webfilter_profile

aliases: webfilter-profile

string

Name of an existing Web filter profile.

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure profile groups.
      fortinet.fortimanager.fmgr_firewall_profilegroup:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_profilegroup:
          application-list: "default" # need a valid profile name
          name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the profile groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_profilegroup"
          params:
            adom: "ansible"
            profile-group: "your_value"

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)