fortinet.fortimanager.fmgr_dvmdb_script module – Script table.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_dvmdb_script
.
New in fortinet.fortimanager 1.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
The top level parameters set. |
|
The full content of the script result log. |
|
Desc. |
|
The value will be ignored in add/set/update requests if filter_ostype is not set. |
|
Name or id of an existing device in the database. |
|
The value has no effect if target is adom_database. |
|
The value has no effect if target is adom_database. Choices:
|
|
The value will be ignored in add/set/update requests if filter_ostype is not set. Choices:
|
|
The value will be ignored in add/set/update requests if filter_ostype is not set. |
|
The value has no effect if target is adom_database. |
|
It is a read-only attribute indicating the time when the script was created or modified. |
|
Name. |
|
Script schedule. |
|
Indicates the date and time of the schedule. onetime daily weekly monthly |
|
Day of week. Choices:
|
|
Name or id of an existing device in the database. |
|
Name. |
|
Indicates if the scheduled script should be executed on device database. Choices:
|
|
Type. Choices:
|
|
Target. Choices:
|
|
Type. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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 here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |