fmgr_dvmdb_script – Script table.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- 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.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters 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 adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- dvmdb_script - Script table. type: dict
- 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]
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: 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]>
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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict