fortinet.fortimanager.fmgr_dvm_cmd_add_device (1.0.5) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==1.0.5

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 1.0.5

Description

This module is able to configure a FortiManager device by allowing the user to [ exec ] the following apis.

/dvm/cmd/add/device

/dvm/cmd/add/device

Examples include all parameters and values need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - 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: REQUESTING /DVM/CMD/ADD/DEVICE
      fmgr_dvm_cmd_add_device:
         loose_validation: False
         workspace_locking_adom: <value in [global, custom adom]>
         workspace_locking_timeout: 300
         method: <value in [exec]>
         params:
            -
               data:
                  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 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>
                  flags:
                    - <value in [none, create_task, nonblocking, ...]>
                  groups:
                    -
                        name: <value of string>
                        vdom: <value of string>

Inputs

    
method:
    choices:
    - exec
    description:
    - The method in request
    required: true
    type: str

params:
    description:
    - The parameters for each method
    - See full parameters list in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
    required: false
    type: list

url_params:
    description:
    - The parameters for each API request URL
    - Also see full URL parameters in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
    required: false
    type: dict

loose_validation:
    description:
    - Do parameter validation in a loose way
    required: false
    type: bool

workspace_locking_adom:
    description:
    - the adom name to lock in case FortiManager running in workspace mode
    - it can be global or any other custom adom names
    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

data:
  description: The payload returned in the request
  returned: always
  type: dict
status:
  description: The status of api request
  returned: always
  type: dict
url:
  description: The full url requested
  returned: always
  sample: /sys/login/user
  type: str