Steampunk Ansible Documentation - drmofu.fortimanager.fmgr_dvm_cmd_add_devlist (2.2.2) - module - Add multiple devices to the Device Manager database.

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

 - 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 multiple devices to the Device Manager database.
      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: <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 string>
                  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>
                  device blueprint: <value of string>
            adom: <value of string>
            flags:
              - none
              - create_task
              - nonblocking
              - log_dev

Inputs

rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list

enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool

access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str

rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list

bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool

dvm_cmd_add_devlist:
description: the top level parameters set
required: false
suboptions:
add-dev-list:
description: description
elements: dict
suboptions:
adm_pass:
description: description
type: str
adm_usr:
description: add real and promote device.
type: str
desc:
description: available for all operations.
type: str
device action:
description:
- 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.
type: str
device blueprint:
description: add model device only.
type: str
faz.quota:
description: available for all operations.
type: int
ip:
description: add real device only.
type: str
meta fields:
description: add real and model device.
type: str
mgmt_mode:
choices:
- unreg
- fmg
- faz
- fmgfaz
description: add real and model device.
type: str
mr:
description: add model device only.
type: int
name:
description: required for all operations.
type: str
os_type:
choices:
- unknown
- fos
- fsw
- foc
- fml
- faz
- fwb
- fch
- fct
- log
- fmg
- fsa
- fdd
- fac
- fpx
- fna
description: add model device only.
type: str
os_ver:
choices:
- unknown
- '0.0'
- '1.0'
- '2.0'
- '3.0'
- '4.0'
- '5.0'
- '6.0'
- '7.0'
- '8.0'
description: add model device only.
type: str
patch:
description: add model device only.
type: int
platform_str:
description: add model device only.
type: str
sn:
description: add model device only.
type: str
type: list
adom:
description: Name or ID of the ADOM where the command is to be executed on.
type: str
flags:
choices:
- none
- create_task
- nonblocking
- log_dev
description: description
elements: str
type: list
type: dict

workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str

forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str

workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list