fortinet.fortimanager.fmgr_dvm_cmd_add_devlist module – Add multiple devices to the Device Manager database.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
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_dvm_cmd_add_devlist
.
New in fortinet.fortimanager 2.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. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
The top level parameters set. |
|
A list of device objects to be added. |
|
(list) Add real and promote device. |
|
Add real and promote device. |
|
Add model device only. |
|
Available for all operations. |
|
Specify add device operations, or leave blank to add real device add_model - add a model device. promote_unreg - promote an unregistered device to be managed by FortiManager using information from database. |
|
Add model device only. |
|
Available for all operations. |
|
Add real device only. |
|
(dict or str) Add real and model device. |
|
Add real and model device. Choices:
|
|
Add model device only. |
|
Required for all operations. |
|
Add model device only. Choices:
|
|
Add model device only. Choices:
|
|
Add model device only. |
|
Add model device only. |
|
Add model device only. |
|
Name or ID of the ADOM where the command is to be executed on. |
|
create_task - Create a new task in task manager database. nonblocking - The API will return immediately in for non-blocking call. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
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: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Add multiple devices to the Device Manager database.
fortinet.fortimanager.fmgr_dvm_cmd_add_devlist:
# 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, ...]
dvm_cmd_add_devlist:
add_dev_list:
-
adm_pass: <list or string>
adm_usr: <string>
desc: <string>
device_action: <string>
faz_quota: <integer>
ip: <string>
meta_fields: <dict or string>
mgmt_mode: <value in [unreg, fmg, faz, ...]>
mr: <integer>
name: <string>
os_type: <value in [unknown, fos, fsw, ...]>
os_ver: <value in [unknown, 0.0, 1.0, ...]>
patch: <integer>
platform_str: <string>
sn: <string>
device_blueprint: <string>
authorization_template: <string>
adom: <string>
flags:
- "none"
- "create_task"
- "nonblocking"
- "log_dev"
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 |