fmgr_dvmdb_script – Script table.¶

New in version 2.10.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiManager device by allowing the user to [add, get, set, update] the following FortiManager json-rpc urls.
/dvmdb/adom/{adom}/script
/dvmdb/global/script
/dvmdb/script
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v6.0.0

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.10.0

Parameters ¶

loose_validation - Do parameter validation in a loose way type: bool required: false default: false
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom dom
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
url_params - parameters in url path type: dict required: true

adom - the domain prefix type: str choices: none, global, custom dom

parameters for method: [add, set, update] - Script table.

data - No description for the parameter type: array
- content - The full content of the script result log. type: str
- desc - No description for the parameter type: str
- filter_build - The value will be ignored in add/set/update requests if filter_ostype is not set. type: int
- filter_device - Name or id of an existing device in the database. type: int
- filter_hostname - The value has no effect if target is "adom_database". type: str
- filter_ostype - The value has no effect if target is "adom_database". type: str choices: [unknown, fos] default: unknown
- filter_osver - The value will be ignored in add/set/update requests if filter_ostype is not set. type: str choices: [unknown, 4.00, 5.00] default: unknown
- filter_platform - The value will be ignored in add/set/update requests if filter_ostype is not set. type: str
- filter_serial - The value has no effect if target is "adom_database". type: str
- modification_time - It is a read-only attribute indicating the time when the script was created or modified. type: str
- name - No description for the parameter type: str
- script_schedule - No description for the parameter type: array
  - datetime - Indicates the date and time of the schedule. type: str
  - day_of_week - No description for the parameter type: str choices: [unknown, sun, mon, tue, wed, thu, fri, sat] default: sun
  - device - Name or id of an existing device in the database. type: int
  - name - No description for the parameter type: str
  - run_on_db - Indicates if the scheduled script should be executed on device database. type: str choices: [disable, enable] default: disable
  - type - No description for the parameter type: str choices: [auto, onetime, daily, weekly, monthly]
- target - No description for the parameter type: str choices: [device_database, remote_device, adom_database] default: device_database
- type - No description for the parameter type: str choices: [cli, tcl, cligrp]

parameters for method: [get] - Script table.

expand member - Fetch all or selected attributes of object members. type: str
fields - No description for the parameter type: array
- {no-name} - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str choices: [content, desc, filter_build, filter_device, filter_hostname, filter_ostype, filter_osver, filter_platform, filter_serial, modification_time, name, target, type]
filter - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
loadsub - Enable or disable the return of any sub-objects. type: int
option - Set fetch option for the request. type: str choices: [count, object member, syntax]
range - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
sortings - No description for the parameter type: array
- {attr_name} - No description for the parameter type: int choices: [1, -1]

Notes ¶

Note

The module may supports multiple method, every method has different parameters definition
One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
The module may include domain dependent urls, the domain can be specified in url_params as adom
To run in workspace mode, the paremeter workspace_locking_adom must be included in the task

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: REQUESTING /DVMDB/SCRIPT
     fmgr_dvmdb_script:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
        params:
           -
              data:
                -
                    content: <value of string>
                    desc: <value of string>
                    filter_build: <value of integer>
                    filter_device: <value of integer>
                    filter_hostname: <value of string>
                    filter_ostype: <value in [unknown, fos]>
                    filter_osver: <value in [unknown, 4.00, 5.00]>
                    filter_platform: <value of string>
                    filter_serial: <value of string>
                    modification_time: <value of string>
                    name: <value of string>
                    script_schedule:
                      -
                          datetime: <value of string>
                          day_of_week: <value in [unknown, sun, mon, ...]>
                          device: <value of integer>
                          name: <value of string>
                          run_on_db: <value in [disable, enable]>
                          type: <value in [auto, onetime, daily, ...]>
                    target: <value in [device_database, remote_device, adom_database]>
                    type: <value in [cli, tcl, cligrp]>

   - name: REQUESTING /DVMDB/SCRIPT
     fmgr_dvmdb_script:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        url_params:
           adom: <value in [none, global, custom dom]>
        params:
           -
              expand member: <value of string>
              fields:
                -
                   - <value in [content, desc, filter_build, ...]>
              filter:
                - <value of string>
              loadsub: <value of integer>
              option: <value in [count, object member, syntax]>
              range:
                - <value of integer>
              sortings:
                -
                    varidic.attr_name: <value in [1, -1]>

Return Values ¶

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

return values for method: [add, set, update]

status - No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
url - No description for the parameter type: str example: /dvmdb/adom/{adom}/script

return values for method: [get]

data - No description for the parameter type: array
- content - The full content of the script result log. type: str
- desc - No description for the parameter type: str
- filter_build - The value will be ignored in add/set/update requests if filter_ostype is not set. type: int
- filter_device - Name or id of an existing device in the database. type: int
- filter_hostname - The value has no effect if target is "adom_database". type: str
- filter_ostype - The value has no effect if target is "adom_database". type: str example: unknown
- filter_osver - The value will be ignored in add/set/update requests if filter_ostype is not set. type: str example: unknown
- filter_platform - The value will be ignored in add/set/update requests if filter_ostype is not set. type: str
- filter_serial - The value has no effect if target is "adom_database". type: str
- modification_time - It is a read-only attribute indicating the time when the script was created or modified. type: str
- name - No description for the parameter type: str
- script_schedule - No description for the parameter type: array
  - datetime - Indicates the date and time of the schedule. type: str
  - day_of_week - No description for the parameter type: str example: sun
  - device - Name or id of an existing device in the database. type: int
  - name - No description for the parameter type: str
  - run_on_db - Indicates if the scheduled script should be executed on device database. type: str example: disable
  - type - No description for the parameter type: str
- target - No description for the parameter type: str example: device_database
- type - No description for the parameter type: str
status - No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
url - No description for the parameter type: str example: /dvmdb/adom/{adom}/script

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Frank Shen (@fshen01)
Link Zheng (@zhengl)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.