fmgr_dvmdb_script_execute – Run script.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [exec] the following FortiManager json-rpc urls.
- /dvmdb/adom/{adom}/script/execute
- /dvmdb/global/script/execute
- /dvmdb/script/execute
- 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.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way 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 dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- parameters for method: [exec] - Run script.
- workflow - No description for the parameter type: dict
- adom - No description for the parameter type: str
- package - No description for the parameter type: str
- scope - No description for the parameter type: array
- name - No description for the parameter type: str
- vdom - No description for the parameter type: str
- script - Script name. type: str
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
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: REQUESTING /DVMDB/SCRIPT/EXECUTE
fmgr_dvmdb_script_execute:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [exec]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
workflow:
adom: <value of string>
package: <value of string>
scope:
-
name: <value of string>
vdom: <value of string>
script: <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:
- return values for method: [exec]
- data
- No description for the parameter type: dict
- task - No description for the parameter type: str
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /dvmdb/adom/{adom}/script/execute