fmgr_dvmdb_script – Script table.
Added in version 1.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- 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 more...
- desc Desc. type: str more...
- filter_build The value will be ignored in add/set/update requests if filter_ostype is not set. type: int more...
- filter_device Name or id of an existing device in the database. type: int more...
- filter_hostname The value has no effect if target is adom_database. type: str more...
- filter_ostype The value has no effect if target is adom_database. type: str choices: [unknown, fos] default: unknown more...
- 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, 6.00] default: unknown more...
- filter_platform The value will be ignored in add/set/update requests if filter_ostype is not set. type: str more...
- filter_serial The value has no effect if target is adom_database. type: str more...
- modification_time It is a read-only attribute indicating the time when the script was created or modified. type: str more...
- name Name. type: str more...
- script_schedule Script_schedule. type: list
more...
- datetime Indicates the date and time of the schedule. type: str more...
- day_of_week Day_of_week. type: str choices: [unknown, sun, mon, tue, wed, thu, fri, sat] default: sun more...
- device Name or id of an existing device in the database. type: int more...
- name Name. type: str more...
- run_on_db Indicates if the scheduled script should be executed on device database. type: str choices: [disable, enable] default: disable more...
- type Type. type: str choices: [auto, onetime, daily, weekly, monthly] more...
- target Target. type: str choices: [device_database, remote_device, adom_database] default: device_database more...
- type Type. type: str choices: [cli, tcl, cligrp] more...
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
- name: Apply a script to device
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
device_adom: "root"
script_name: "FooScript"
device_name: "CustomHostName"
device_vdom: "root"
tasks:
- name: Create a Script to later execute
fortinet.fortimanager.fmgr_dvmdb_script:
adom: "{{ device_adom }}"
state: "present"
dvmdb_script:
name: "{{ script_name }}"
desc: "A script created via Ansible"
content: |
config system global
set remoteauthtimeout 80
end
type: "cli"
- name: Run the Script
fortinet.fortimanager.fmgr_dvmdb_script_execute:
adom: "{{ device_adom }}"
dvmdb_script_execute:
adom: "{{ device_adom }}"
script: "{{ script_name }}"
scope:
- name: "{{ device_name }}"
vdom: "{{ device_vdom }}"
register: running_task
- name: Inspect the Task Status
fortinet.fortimanager.fmgr_fact:
facts:
selector: "task_task"
params:
task: "{{ running_task.meta.response_data.task }}"
register: taskinfo
until: taskinfo.meta.response_data.percent == 100
retries: 30
delay: 3
failed_when: taskinfo.meta.response_data.state == 'error'
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Script table.
fortinet.fortimanager.fmgr_dvmdb_script:
bypass_validation: false
adom: ansible
state: present
dvmdb_script:
content: "ansiblt-test"
name: "ansible-test"
target: device_database
type: cli
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the scripts in the device
fortinet.fortimanager.fmgr_fact:
facts:
selector: "dvmdb_script"
params:
adom: "ansible"
script: "your_value"
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Enable workspace mode
fortinet.fortimanager.fmgr_system_global:
system_global:
adom-status: enable
workspace-mode: normal
- name: Script table.
fortinet.fortimanager.fmgr_dvmdb_script:
bypass_validation: false
adom: root
state: present
workspace_locking_adom: "root"
dvmdb_script:
content: "ansiblt-test"
name: "fooscript000"
target: device_database
type: cli
- name: Verify script table
fortinet.fortimanager.fmgr_fact:
facts:
selector: "dvmdb_script"
params:
adom: "root"
script: "fooscript000"
register: info
failed_when: info.meta.response_code != 0
- name: Restore workspace mode
fortinet.fortimanager.fmgr_system_global:
system_global:
adom-status: enable
workspace-mode: disabled
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.