fmgr_firewall_profilegroup – Configure profile groups.¶
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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- firewall_profilegroup - Configure profile groups. type: dict
- application-list - Name of an existing Application list. type: str
- av-profile - Name of an existing Antivirus profile. type: str
- dlp-sensor - Name of an existing DLP sensor. type: str
- dnsfilter-profile - Name of an existing DNS filter profile. type: str
- icap-profile - Name of an existing ICAP profile. type: str
- ips-sensor - Name of an existing IPS sensor. type: str
- mms-profile - Name of an existing MMS profile. type: str
- name - Profile group name. type: str
- profile-protocol-options - Name of an existing Protocol options profile. type: str
- spamfilter-profile - Name of an existing Spam filter profile. type: str
- ssh-filter-profile - Name of an existing SSH filter profile. type: str
- ssl-ssh-profile - Name of an existing SSL SSH profile. type: str
- voip-profile - Name of an existing VoIP profile. type: str
- waf-profile - Name of an existing Web application firewall profile. type: str
- webfilter-profile - Name of an existing Web filter profile. type: str
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: Configure profile groups.
fmgr_firewall_profilegroup:
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>
state: <value in [present, absent]>
firewall_profilegroup:
application-list: <value of string>
av-profile: <value of string>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
icap-profile: <value of string>
ips-sensor: <value of string>
mms-profile: <value of string>
name: <value of string>
profile-protocol-options: <value of string>
spamfilter-profile: <value of string>
ssh-filter-profile: <value of string>
ssl-ssh-profile: <value of string>
voip-profile: <value of string>
waf-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