fmgr_task_task – Read-only table containing the 10000 most recent tasks of the system.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [get] the following FortiManager json-rpc urls.
- /task/task
- 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
- parameters for method: [get] - Read-only table containing the 10000 most recent tasks of the system. This table can be used for tracking non-blocking tasks initiated by the Device Manager Command and Security Console modules.
- fields - No description for the parameter type: array
- {no-name} - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [adom, end_tm, flags, id, num_done, num_err, num_lines, num_warn, percent, pid, src, start_tm, state, title, tot_percent, user]
- {no-name} - No description for the parameter type: array
- filter - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- loadsub - Enable or disable the return of any sub-objects. type: int
- option - Set fetch option for the request. type: str choices: [count, syntax]
- range - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- sortings - No description for the parameter type: array
- {attr_name} - No description for the parameter type: int choices: [1, -1]
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 /TASK/TASK
fmgr_task_task:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
params:
-
fields:
-
- <value in [adom, end_tm, flags, ...]>
filter:
- <value of string>
loadsub: <value of integer>
option: <value in [count, syntax]>
range:
- <value of integer>
sortings:
-
varidic.attr_name: <value in [1, -1]>
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: [get]
- data
- No description for the parameter type: array
- adom - No description for the parameter type: int example: 0
- end_tm - No description for the parameter type: int example: 0
- flags - No description for the parameter type: int example: 0
- history - No description for the parameter type: array
- detail - No description for the parameter type: str
- name - No description for the parameter type: str
- percent - No description for the parameter type: int example: 0
- vdom - No description for the parameter type: str
- id - No description for the parameter type: int
- line - No description for the parameter type: array
- detail - No description for the parameter type: str
- err - No description for the parameter type: int example: 0
- ip - No description for the parameter type: str
- name - No description for the parameter type: str
- oid - No description for the parameter type: int example: 0
- percent - No description for the parameter type: int example: 0
- state - No description for the parameter type: str example: pending
- vdom - No description for the parameter type: str
- num_done - No description for the parameter type: int example: 0
- num_err - No description for the parameter type: int example: 0
- num_lines - No description for the parameter type: int example: 0
- num_warn - No description for the parameter type: int example: 0
- percent - No description for the parameter type: int example: 0
- pid - No description for the parameter type: int example: 0
- src - No description for the parameter type: str example: device manager
- start_tm - No description for the parameter type: int example: 0
- state - No description for the parameter type: str example: pending
- title - No description for the parameter type: str
- tot_percent - No description for the parameter type: int example: 0
- user - 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: /task/task