fmgr_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 FortiManager 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.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters 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 adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- 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. Refer to Device Manager Command module for API to add, d... type: dict
- adm_pass - 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 choices: [unknown, insync, outofsync] default: unknown
- conn_mode - No description for the parameter type: str choices: [active, passive] default: passive
- conn_status - No description for the parameter type: str choices: [UNKNOWN, up, down] default: UNKNOWN
- db_status - No description for the parameter type: str choices: [unknown, nomod, mod] default: unknown
- desc - No description for the parameter type: str
- 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
- 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 choices: [has_hdd, vdom_enabled, discover, reload, interim_build, offline_mode, is_model, fips_mode, linked_to_model, ip-conflict, faz-autosync]
- foslic_cpu - VM Meter vCPU count. type: int
- foslic_dr_site - VM Meter DR Site status. type: str choices: [disable, enable] default: 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 choices: [temporary, trial, regular, trial_expired] default: temporary
- foslic_utm - No description for the parameter type: array choices: [fw, av, ips, app, url, utm, fwb]
- 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 choices: [standalone, AP, AA, ELBC, DUAL, enabled, unknown] default: standalone
- 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 default: 10
- meta fields - No description for the parameter type: dict
- 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 choices: [unreg, fmg, faz, fmgfaz] default: unreg
- mgt_vdom - No description for the parameter type: str
- mr - No description for the parameter type: int default: -1
- name - Unique name for the device. type: str
- 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] default: unknown
- 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] default: 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 choices: [nat, transparent] default: 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
Notes¶
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- 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¶
- 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: Device table, most attributes are read-only and can only be changed internally. Refer to Device Manager Command module for API to add, d...
fmgr_dvmdb_device:
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>
device: <your own value>
dvmdb_device:
adm_pass: <value of string>
adm_usr: <value of string>
app_ver: <value of string>
av_ver: <value of string>
beta: <value of integer>
branch_pt: <value of integer>
build: <value of integer>
checksum: <value of string>
conf_status: <value in [unknown, insync, outofsync]>
conn_mode: <value in [active, passive]>
conn_status: <value in [UNKNOWN, up, down]>
db_status: <value in [unknown, nomod, mod]>
desc: <value of string>
dev_status: <value in [none, unknown, checkedin, ...]>
fap_cnt: <value of integer>
faz.full_act: <value of integer>
faz.perm: <value of integer>
faz.quota: <value of integer>
faz.used: <value of integer>
fex_cnt: <value of integer>
flags:
- has_hdd
- vdom_enabled
- discover
- reload
- interim_build
- offline_mode
- is_model
- fips_mode
- linked_to_model
- ip-conflict
- faz-autosync
foslic_cpu: <value of integer>
foslic_dr_site: <value in [disable, enable]>
foslic_inst_time: <value of integer>
foslic_last_sync: <value of integer>
foslic_ram: <value of integer>
foslic_type: <value in [temporary, trial, regular, ...]>
foslic_utm:
- fw
- av
- ips
- app
- url
- utm
- fwb
fsw_cnt: <value of integer>
ha_group_id: <value of integer>
ha_group_name: <value of string>
ha_mode: <value in [standalone, AP, AA, ...]>
hdisk_size: <value of integer>
hostname: <value of string>
hw_rev_major: <value of integer>
hw_rev_minor: <value of integer>
ip: <value of string>
ips_ext: <value of integer>
ips_ver: <value of string>
last_checked: <value of integer>
last_resync: <value of integer>
latitude: <value of string>
lic_flags: <value of integer>
lic_region: <value of string>
location_from: <value of string>
logdisk_size: <value of integer>
longitude: <value of string>
maxvdom: <value of integer>
meta fields: <value of dict>
mgmt_id: <value of integer>
mgmt_if: <value of string>
mgmt_mode: <value in [unreg, fmg, faz, ...]>
mgt_vdom: <value of string>
mr: <value of integer>
name: <value of string>
os_type: <value in [unknown, fos, fsw, ...]>
os_ver: <value in [unknown, 0.0, 1.0, ...]>
patch: <value of integer>
platform_str: <value of string>
psk: <value of string>
sn: <value of string>
vdom:
-
comments: <value of string>
name: <value of string>
opmode: <value in [nat, transparent]>
rtm_prof_id: <value of integer>
status: <value of string>
version: <value of integer>
vm_cpu: <value of integer>
vm_cpu_limit: <value of integer>
vm_lic_expire: <value of integer>
vm_mem: <value of integer>
vm_mem_limit: <value of integer>
vm_status: <value of integer>
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