fortinet.fortimanager.fmgr_firewall_profilegroup module – Configure profile groups.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to application_list. Name of an existing Application list. |
|
Deprecated, please rename it to av_profile. Name of an existing Antivirus profile. |
|
Deprecated, please rename it to casb_profile. Name of an existing CASB profile. |
|
Deprecated, please rename it to casi_profile. CASI profile. |
|
Deprecated, please rename it to cifs_profile. Name of an existing CIFS profile. |
|
Deprecated, please rename it to diameter_filter_profile. Name of an existing Diameter filter profile. |
|
Deprecated, please rename it to dlp_profile. Name of an existing DLP profile. |
|
Deprecated, please rename it to dlp_sensor. Name of an existing DLP sensor. |
|
Deprecated, please rename it to dnsfilter_profile. Name of an existing DNS filter profile. |
|
Deprecated, please rename it to emailfilter_profile. Name of an existing email filter profile. |
|
Deprecated, please rename it to file_filter_profile. Name of an existing file-filter profile. |
|
Deprecated, please rename it to icap_profile. Name of an existing ICAP profile. |
|
Deprecated, please rename it to ips_sensor. Name of an existing IPS sensor. |
|
Deprecated, please rename it to ips_voip_filter. Name of an existing VoIP |
|
Deprecated, please rename it to mms_profile. Name of an existing MMS profile. |
|
Profile group name. |
|
Deprecated, please rename it to profile_protocol_options. Name of an existing Protocol options profile. |
|
Deprecated, please rename it to sctp_filter_profile. Name of an existing SCTP filter profile. |
|
Deprecated, please rename it to spamfilter_profile. Name of an existing Spam filter profile. |
|
Deprecated, please rename it to ssh_filter_profile. Name of an existing SSH filter profile. |
|
Deprecated, please rename it to ssl_ssh_profile. Name of an existing SSL SSH profile. |
|
Deprecated, please rename it to videofilter_profile. Name of an existing VideoFilter profile. |
|
Deprecated, please rename it to virtual_patch_profile. Name of an existing virtual-patch profile. |
|
Deprecated, please rename it to voip_profile. Name of an existing VoIP profile. |
|
Deprecated, please rename it to waf_profile. Name of an existing Web application firewall profile. |
|
Deprecated, please rename it to webfilter_profile. Name of an existing Web filter profile. |
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |