faz_dvmdb_device – Device table, most attributes are read-only and can only be changed internally.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiAnalyzer device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiAnalyzer Version Compatibility¶
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| dvmdb_device | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
- 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
- adom - The parameter in requested url type: str required: true
- device - The parameter in requested url type: str required: true
- dvmdb_device - Device table, most attributes are read-only and can only be changed internally. type: dict
- adm_pass - No description for the parameter type: str more...
- adm_usr - No description for the parameter type: str more...
- app_ver - No description for the parameter type: str more...
- av_ver - No description for the parameter type: str more...
- beta - No description for the parameter type: int more...
- branch_pt - No description for the parameter type: int more...
- build - No description for the parameter type: int more...
- checksum - No description for the parameter type: str more...
- conf_status - No description for the parameter type: str choices: [unknown, insync, outofsync] default: unknown more...
- conn_mode - No description for the parameter type: str choices: [active, passive] default: passive more...
- conn_status - No description for the parameter type: str choices: [UNKNOWN, up, down] default: UNKNOWN more...
- db_status - No description for the parameter type: str choices: [unknown, nomod, mod] default: unknown more...
- desc - No description for the parameter type: str more...
- dev_status - No description for the parameter type: str choices: [none, unknown, checkedin, inprogress, installed, aborted, sched, retry, canceled, pending, retrieved, changed_conf, sync_fail, timeout, rev_revert, auto_updated] default: unknown more...
- fap_cnt - No description for the parameter type: int more...
- faz.full_act - No description for the parameter type: int more...
- faz.perm - No description for the parameter type: int more...
- faz.quota - No description for the parameter type: int more...
- faz.used - No description for the parameter type: int more...
- fex_cnt - No description for the parameter type: int more...
- flags - No description for the parameter type: array choices: [has_hdd, vdom_enabled, discover, reload, interim_build, offline_mode, is_model, fips_mode, linked_to_model, ip-conflict, faz-autosync] more...
- foslic_cpu - VM Meter vCPU count. type: int more...
- foslic_dr_site - VM Meter DR Site status. type: str choices: [disable, enable] default: disable more...
- foslic_inst_time - VM Meter first deployment time (in UNIX timestamp). type: int more...
- foslic_last_sync - VM Meter last synchronized time (in UNIX timestamp). type: int more...
- foslic_ram - VM Meter device RAM size (in MB). type: int more...
- foslic_type - VM Meter license type. type: str choices: [temporary, trial, regular, trial_expired] default: temporary more...
- foslic_utm - No description for the parameter type: array choices: [fw, av, ips, app, url, utm, fwb] more...
- fsw_cnt - No description for the parameter type: int more...
- ha_group_id - No description for the parameter type: int more...
- ha_group_name - No description for the parameter type: str more...
- ha_mode - enabled - Value reserved for non-FOS HA devices. type: str choices: [standalone, AP, AA, ELBC, DUAL, enabled, unknown, fmg-enabled, autoscale] default: standalone more...
- hdisk_size - No description for the parameter type: int more...
- hostname - No description for the parameter type: str more...
- hw_rev_major - No description for the parameter type: int more...
- hw_rev_minor - No description for the parameter type: int more...
- ip - No description for the parameter type: str more...
- ips_ext - No description for the parameter type: int more...
- ips_ver - No description for the parameter type: str more...
- last_checked - No description for the parameter type: int more...
- last_resync - No description for the parameter type: int more...
- latitude - No description for the parameter type: str more...
- lic_flags - No description for the parameter type: int more...
- lic_region - No description for the parameter type: str more...
- location_from - No description for the parameter type: str more...
- logdisk_size - No description for the parameter type: int more...
- longitude - No description for the parameter type: str more...
- maxvdom - No description for the parameter type: int default: 10 more...
- meta fields - No description for the parameter type: dict more...
- mgmt_id - No description for the parameter type: int more...
- mgmt_if - No description for the parameter type: str more...
- mgmt_mode - No description for the parameter type: str choices: [unreg, fmg, faz, fmgfaz] default: unreg more...
- mgt_vdom - No description for the parameter type: str more...
- module_sn - No description for the parameter type: str more...
- mr - No description for the parameter type: int default: -1 more...
- name - Unique name for the device. type: str more...
- os_type - No description for the parameter type: str choices: [unknown, fos, fsw, foc, fml, faz, fwb, fch, fct, log, fmg, fsa, fdd, fac, fpx, fna, fdc, fsr, fad, ffw, fap, fxt, fts, fai, fwc] default: unknown more...
- os_ver - No description for the parameter type: str choices: [unknown, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0] default: unknown more...
- patch - No description for the parameter type: int more...
- platform_str - No description for the parameter type: str more...
- prefer_img_ver - No description for the parameter type: str more...
- psk - No description for the parameter type: str more...
- sn - Unique value for each device. type: str more...
- vdom - No description for the parameter type: array
more...
- comments - No description for the parameter type: str more...
- name - No description for the parameter type: str more...
- opmode - No description for the parameter type: str choices: [nat, transparent] default: nat more...
- rtm_prof_id - No description for the parameter type: int more...
- status - No description for the parameter type: str more...
- vpn_id - No description for the parameter type: int more...
- meta fields - No description for the parameter type: dict more...
- vdom_type - No description for the parameter type: str choices: [traffic, admin] default: traffic more...
- version - No description for the parameter type: int more...
- vm_cpu - No description for the parameter type: int more...
- vm_cpu_limit - No description for the parameter type: int more...
- vm_lic_expire - No description for the parameter type: int more...
- vm_mem - No description for the parameter type: int more...
- vm_mem_limit - No description for the parameter type: int more...
- vm_status - No description for the parameter type: int more...
- prio - No description for the parameter type: int more...
- role - No description for the parameter type: str choices: [master, ha-slave, autoscale-slave] default: master more...
- hyperscale - No description for the parameter type: int more...
- nsxt_service_name - No description for the parameter type: str more...
- private_key - No description for the parameter type: str more...
- private_key_status - No description for the parameter type: int more...
Notes¶
Note
- 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¶
- collections:
- fortinet.fortianalyzer
connection: httpapi
hosts: fortianalyzer-inventory
tasks:
- faz_dvmdb_device:
adom: root
device: foodevice
dvmdb_device:
desc: device modified via module faz_dvmdb_device
name: Device table, most attributes are read-only and can only be changed internally.
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
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