Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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_antivirus_profile_contentdisarm.
New in version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | ||
| antivirus_profile_contentdisarm dictionary | the top level parameters set | ||
| cover-page string |
| Enable/disable inserting a cover page into the disarmed document. | |
| detect-only string |
| Enable/disable only detect disarmable files, do not alter content. | |
| error-action string |
| Action to be taken if CDR engine encounters an unrecoverable error. | |
| office-action string |
| Enable/disable stripping of PowerPoint action events in Microsoft Office documents. | |
| office-dde string |
| Enable/disable stripping of Dynamic Data Exchange events in Microsoft Office documents. | |
| office-embed string |
| Enable/disable stripping of embedded objects in Microsoft Office documents. | |
| office-hylink string |
| Enable/disable stripping of hyperlinks in Microsoft Office documents. | |
| office-linked string |
| Enable/disable stripping of linked objects in Microsoft Office documents. | |
| office-macro string |
| Enable/disable stripping of macros in Microsoft Office documents. | |
| original-file-destination string |
| Destination to send original file if active content is removed. | |
| pdf-act-form string |
| Enable/disable stripping of actions that submit data to other targets in PDF documents. | |
| pdf-act-gotor string |
| Enable/disable stripping of links to other PDFs in PDF documents. | |
| pdf-act-java string |
| Enable/disable stripping of actions that execute JavaScript code in PDF documents. | |
| pdf-act-launch string |
| Enable/disable stripping of links to external applications in PDF documents. | |
| pdf-act-movie string |
| Enable/disable stripping of embedded movies in PDF documents. | |
| pdf-act-sound string |
| Enable/disable stripping of embedded sound files in PDF documents. | |
| pdf-embedfile string |
| Enable/disable stripping of embedded files in PDF documents. | |
| pdf-hyperlink string |
| Enable/disable stripping of hyperlinks from PDF documents. | |
| pdf-javacode string |
| Enable/disable stripping of JavaScript code in PDF documents. | |
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
| enable_log boolean |
| Enable/Disable logging for task | |
| profile string / required | the parameter (profile) in requested url | ||
| proposed_method string |
| The overridden method for the underlying Json RPC request | |
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | ||
| rc_succeeded list / elements=string | 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 | |
| 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 | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | |
Note
- 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: AV Content Disarm and Reconstruction settings.
fmgr_antivirus_profile_contentdisarm:
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>
profile: <your own value>
antivirus_profile_contentdisarm:
cover-page: <value in [disable, enable]>
detect-only: <value in [disable, enable]>
office-embed: <value in [disable, enable]>
office-hylink: <value in [disable, enable]>
office-linked: <value in [disable, enable]>
office-macro: <value in [disable, enable]>
original-file-destination: <value in [fortisandbox, quarantine, discard]>
pdf-act-form: <value in [disable, enable]>
pdf-act-gotor: <value in [disable, enable]>
pdf-act-java: <value in [disable, enable]>
pdf-act-launch: <value in [disable, enable]>
pdf-act-movie: <value in [disable, enable]>
pdf-act-sound: <value in [disable, enable]>
pdf-embedfile: <value in [disable, enable]>
pdf-hyperlink: <value in [disable, enable]>
pdf-javacode: <value in [disable, enable]>
office-action: <value in [disable, enable]>
office-dde: <value in [disable, enable]>
error-action: <value in [block, log-only, ignore]>
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_antivirus_profile_contentdisarm_module.html