fmgr_dvm_cmd_discover_device – Probe a remote device and retrieve its device information and system status.¶
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.
- /dvm/cmd/discover/device
- /dvm/cmd/discover/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.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: [exec] - Probe a remote device and retrieve its device information and system status.
- data - No description for the parameter type: dict
- device
- adm_pass - No description for the parameter type: str
- adm_usr - No description for the parameter type: str
- ip - No description for the parameter 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 /DVM/CMD/DISCOVER/DEVICE
fmgr_dvm_cmd_discover_device:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [exec]>
params:
-
data:
device:
adm_pass: <value of string>
adm_usr: <value of string>
ip: <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
- device
- adm_pass - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- adm_usr - No description for the parameter type: str
- app_ver - No description for the parameter type: str
- av_ver - No description for the parameter type: str
- beta - No description for the parameter type: int
- branch_pt - No description for the parameter type: int
- build - No description for the parameter type: int
- checksum - No description for the parameter type: str
- conf_status - No description for the parameter type: str example: unknown
- conn_mode - No description for the parameter type: str example: passive
- conn_status - No description for the parameter type: str example: UNKNOWN
- db_status - No description for the parameter type: str example: unknown
- desc - No description for the parameter type: str
- dev_status - No description for the parameter type: str example: unknown
- fap_cnt - No description for the parameter type: int
- faz.full_act - No description for the parameter type: int
- faz.perm - No description for the parameter type: int
- faz.quota - No description for the parameter type: int
- faz.used - No description for the parameter type: int
- fex_cnt - No description for the parameter type: int
- flags - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- foslic_cpu - VM Meter vCPU count. type: int
- foslic_dr_site - VM Meter DR Site status. type: str example: disable
- foslic_inst_time - VM Meter first deployment time (in UNIX timestamp). type: int
- foslic_last_sync - VM Meter last synchronized time (in UNIX timestamp). type: int
- foslic_ram - VM Meter device RAM size (in MB). type: int
- foslic_type - VM Meter license type. type: str example: temporary
- foslic_utm - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- fsw_cnt - No description for the parameter type: int
- ha_group_id - No description for the parameter type: int
- ha_group_name - No description for the parameter type: str
- ha_mode - enabled - Value reserved for non-FOS HA devices. type: str example: standalone
- ha_slave - No description for the parameter type: array
- idx - No description for the parameter type: int
- name - No description for the parameter type: str
- prio - No description for the parameter type: int
- role - No description for the parameter type: str example: slave
- sn - No description for the parameter type: str
- status - No description for the parameter type: int
- hdisk_size - No description for the parameter type: int
- hostname - No description for the parameter type: str
- hw_rev_major - No description for the parameter type: int
- hw_rev_minor - No description for the parameter type: int
- ip - No description for the parameter type: str
- ips_ext - No description for the parameter type: int
- ips_ver - No description for the parameter type: str
- last_checked - No description for the parameter type: int
- last_resync - No description for the parameter type: int
- latitude - No description for the parameter type: str
- lic_flags - No description for the parameter type: int
- lic_region - No description for the parameter type: str
- location_from - No description for the parameter type: str
- logdisk_size - No description for the parameter type: int
- longitude - No description for the parameter type: str
- maxvdom - No description for the parameter type: int example: 10
- meta fields - No description for the parameter type: str
- mgmt_id - No description for the parameter type: int
- mgmt_if - No description for the parameter type: str
- mgmt_mode - No description for the parameter type: str example: unreg
- mgt_vdom - No description for the parameter type: str
- mr - No description for the parameter type: int example: -1
- name - Unique name for the device. type: str
- os_type - No description for the parameter type: str example: unknown
- os_ver - No description for the parameter type: str example: unknown
- patch - No description for the parameter type: int
- platform_str - No description for the parameter type: str
- psk - No description for the parameter type: str
- sn - Unique value for each device. type: str
- vdom - No description for the parameter type: array
- comments - No description for the parameter type: str
- name - No description for the parameter type: str
- opmode - No description for the parameter type: str example: nat
- rtm_prof_id - No description for the parameter type: int
- status - No description for the parameter type: str
- version - No description for the parameter type: int
- vm_cpu - No description for the parameter type: int
- vm_cpu_limit - No description for the parameter type: int
- vm_lic_expire - No description for the parameter type: int
- vm_mem - No description for the parameter type: int
- vm_mem_limit - No description for the parameter type: int
- vm_status - No description for the parameter type: int
- pid - When "nonblocking" flag is set, return the process ID for the command. type: int
- taskid - When "create_task" flag is set, return the ID of the task associated with the command. 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: /dvm/cmd/discover/device