fortinet.fortimanager.fmgr_dvmdb_device module – Device table, most attributes are read-only and can only be changed internally.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_dvmdb_device
.
New in fortinet.fortimanager 1.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
The parameter (device) in requested url. |
|
The top level parameters set. |
|
(list) Adm pass. |
|
Adm usr. |
|
App ver. |
|
Av ver. |
|
Beta. |
|
Branch pt. |
|
Build. |
|
Checksum. |
|
Cluster worker. |
|
Conf status. Choices:
|
|
Conn mode. Choices:
|
|
Conn status. Choices:
|
|
Db status. Choices:
|
|
Desc. |
|
Dev status. Choices:
|
|
Eip. |
|
Fap cnt. |
|
Faz. |
|
Faz. |
|
Faz. |
|
Faz. |
|
Fex cnt. |
|
First tunnel up. |
|
Flags. Choices:
|
|
VM Meter vCPU count. |
|
VM Meter DR Site status. Choices:
|
|
VM Meter first deployment time |
|
VM Meter last synchronized time |
|
VM Meter device RAM size |
|
VM Meter license type. Choices:
|
|
VM Meter services fw - Firewall av - Anti-virus ips - IPS app - App control url - Web filter utm - Full UTM fwb - FortiWeb Choices:
|
|
Fsw cnt. |
|
Ha group id. |
|
Ha group name. |
|
Enabled - Value reserved for non-FOS HA devices. Choices:
|
|
Ha slave. |
|
Conf status. |
|
Idx. |
|
Name. |
|
Prio. |
|
Role. Choices:
|
|
Sn. |
|
Status. |
|
Ha upgrade mode. |
|
Ha. |
|
Hdisk size. |
|
Hostname. |
|
Hw generation. |
|
Hw rev major. |
|
Hw rev minor. |
|
Hyperscale. |
|
Ip. |
|
Ips ext. |
|
Ips ver. |
|
Last checked. |
|
Last resync. |
|
Latitude. |
|
Lic flags. |
|
Lic region. |
|
Location from. |
|
Logdisk size. |
|
Longitude. |
|
Maxvdom. |
|
Default metafields |
|
Mgmt id. |
|
Mgmt if. |
|
Mgmt mode. Choices:
|
|
Mgmt uuid. |
|
Mgt vdom. |
|
Module sn. |
|
Mr. |
|
Unique name for the device. |
|
Nsxt service name. |
|
Os type. Choices:
|
|
Os ver. Choices:
|
|
Patch. |
|
Platform str. |
|
Prefer img ver. |
|
Prio. |
|
Private key. |
|
Private key status. |
|
Psk. |
|
Relver info. |
|
Role. Choices:
|
|
Unique value for each device. |
|
Vdom. |
|
Comments. |
|
Meta fields. |
|
Name. |
|
Opmode. Choices:
|
|
Rtm prof id. |
|
Status. |
|
Vdom type. Choices:
|
|
Vpn id. |
|
Version. |
|
Vm cpu. |
|
Vm cpu limit. |
|
Vm lic expire. |
|
Vm lic overdue since. |
|
Vm mem. |
|
Vm mem limit. |
|
Vm payg status. |
|
(int or str) Vm status. |
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
- name: Delete first FOS devices from FMG In a specific adom
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
device_adom: "root"
tasks:
- name: Fetch all devices
fortinet.fortimanager.fmgr_fact:
facts:
selector: "dvmdb_device"
params:
adom: "{{ device_adom }}"
device: "your_value"
register: alldevices
- name: No name
when: alldevices.meta.response_data != []
ansible.builtin.debug:
msg:
- "We are going to delete device: {{ alldevices.meta.response_data[0].name }}"
- "IP of the device is: {{ alldevices.meta.response_data[0].ip }}"
- name: Create The Task To Delete The Device
when: alldevices.meta.response_data != [] and False
fortinet.fortimanager.fmgr_dvm_cmd_del_device:
dvm_cmd_del_device:
device: "{{ alldevices.meta.response_data[0].name }}"
adom: "{{ device_adom }}"
flags:
- "create_task"
- "nonblocking"
register: uninstalling_task
- name: Poll the task
when: alldevices.meta.response_data != [] and False
fortinet.fortimanager.fmgr_fact:
facts:
selector: "task_task"
params:
task: "{{ uninstalling_task.meta.response_data.taskid }}"
register: taskinfo
until: taskinfo.meta.response_data.percent == 100
retries: 30
delay: 5
failed_when: taskinfo.meta.response_data.state == 'error'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |