fortinet.fortimanager.fmgr_dvm_cmd_add_device – Add a device to the Device Manager database.
fortinet.fortimanager.fmgr_dvm_cmd_add_device – Add a device to the Device Manager database.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_dvm_cmd_add_device
.
New in version 2.10: of fortinet.fortimanager
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 | Choices/Defaults | Comments | ||
---|---|---|---|---|
bypass_validation boolean |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
dvm_cmd_add_device dictionary |
the top level parameters set | |||
adom string |
Name or ID of the ADOM where the command is to be executed on. | |||
device dictionary |
no description | |||
adm_pass string |
no description | |||
adm_usr string |
add real and promote device. | |||
desc string |
available for all operations. | |||
device action string |
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. | |||
faz.quota integer |
available for all operations. | |||
ip string |
add real device only. Add device will probe with this IP using the log in credential specified. | |||
meta fields dictionary |
no description | |||
mgmt_mode string |
|
add real and model device. | ||
mr integer |
add model device only. | |||
name string |
required for all operations. Unique name for the device. | |||
os_type string |
|
add model device only. | ||
os_ver string |
|
os version | ||
patch integer |
add model device only. | |||
platform_str string |
add model device only. Required for determine the platform for VM platforms. | |||
sn string |
add model device only. This attribute will be used to determine the device platform, except for VM platforms, w... | |||
flags list / elements=string |
|
no description | ||
groups list / elements=string |
no description | |||
name string |
no description | |||
vdom string |
no description | |||
rc_failed list / elements=string |
the rc codes list with which the conditions to fail will be overriden | |||
rc_succeeded list / elements=string |
the rc codes list with which the conditions to succeed will be overriden | |||
workspace_locking_adom string |
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | |||
workspace_locking_timeout integer |
Default: 300 |
the maximum time in seconds to wait for other user to release the workspace lock |
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: Add a device to the Device Manager database.
fmgr_dvm_cmd_add_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, ...]
dvm_cmd_add_device:
adom: <value of string>
device:
adm_pass: <value of string>
adm_usr: <value of string>
desc: <value of string>
device action: <value of string>
faz.quota: <value of integer>
ip: <value of string>
meta fields: <value of dict>
mgmt_mode: <value in [unreg, fmg, faz, ...]>
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>
sn: <value of string>
flags:
- none
- create_task
- nonblocking
- log_dev
groups:
-
name: <value of string>
vdom: <value of string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
request_url string |
always |
The full url requested
Sample: /sys/login/user |
response_code integer |
always |
The status of api request
|
response_message string |
always |
The descriptive message of the api response
Sample: OK. |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_dvm_cmd_add_device_module.html