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_dvmdb_script.
New in version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | |||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
| dvmdb_script dictionary | the top level parameters set | |||
| content string | The full content of the script result log. | |||
| desc string | no description | |||
| filter_build integer | The value will be ignored in add/set/update requests if filter_ostype is not set. It has no effect if target is "adom_database". | |||
| filter_device integer | Name or id of an existing device in the database. It has no effect if target is "adom_database". | |||
| filter_hostname string | The value has no effect if target is "adom_database". | |||
| filter_ostype string |
| The value has no effect if target is "adom_database". | ||
| filter_osver string |
| The value will be ignored in add/set/update requests if filter_ostype is not set. It has no effect if target is "adom_database". | ||
| filter_platform string | The value will be ignored in add/set/update requests if filter_ostype is not set. It has no effect if target is "adom_database". | |||
| filter_serial string | The value has no effect if target is "adom_database". | |||
| modification_time string | It is a read-only attribute indicating the time when the script was created or modified. The value will be ignored in add/set/... | |||
| name string | no description | |||
| script_schedule list / elements=string | no description | |||
| datetime string | Indicates the date and time of the schedule. It should follow the following format for each scheduling type: onetime: "YYYY-MM-DD hh:mm:ss" daily: "hh:mm" weekly: "hh:mm" monthly: "DD hh:mm" | |||
| day_of_week string |
| no description | ||
| device integer | Name or id of an existing device in the database. | |||
| name string | no description | |||
| run_on_db string |
| Indicates if the scheduled script should be executed on device database. It should always be disable for tcl scripts. | ||
| type string |
| no description | ||
| target string |
| no description | ||
| type 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 | |||
| state string / required |
| the directive to create, update or delete an object | ||
| 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 | ||
Note
- 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: Script table.
fmgr_dvmdb_script:
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, ...]
adom: <your own value>
state: <value in [present, absent]>
dvmdb_script:
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]>
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. |
© 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_dvmdb_script_module.html