fortinet.fortimanager.fmgr_dvmdb_script – Script table.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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 version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
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
Desc.
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
    Choices:
  • unknown ←
  • fos
The value has no effect if target is "adom_database".
filter_osver
string
    Choices:
  • unknown ←
  • 4.00
  • 5.00
  • 6.00
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
Name.
script_schedule
list / elements=string
Script_Schedule.
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
    Choices:
  • unknown
  • sun ←
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat
Day_Of_Week.
device
integer
Name or id of an existing device in the database.
name
string
Name.
run_on_db
string
    Choices:
  • disable ←
  • enable
Indicates if the scheduled script should be executed on device database. It should always be disable for tcl scripts.
type
string
    Choices:
  • auto
  • onetime
  • daily
  • weekly
  • monthly
Type.
target
string
    Choices:
  • device_database ←
  • remote_device
  • adom_database
Target.
type
string
    Choices:
  • cli
  • tcl
  • cligrp
Type.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • present
  • absent
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

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: fortimanager01
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  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
      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
      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
      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'

- hosts: fortimanager00
  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
        adom: ansible
        state: present
        dvmdb_script:
           content: 'ansiblt-test'
           name: 'ansible-test'
           target: device_database
           type: cli
- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the scripts in the device
     fmgr_fact:
       facts:
           selector: 'dvmdb_script'
           params:
               adom: 'ansible'
               script: ''
- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: enable workspace mode
     fmgr_system_global:
        system_global:
             adom-status: enable
             workspace-mode: normal

   - name: Script table.
     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
     fmgr_fact:
        facts:
           selector: 'dvmdb_script'
           params:
               adom: 'root'
               script: 'fooscript000'
     register: info
     failed_when: info.meta.response_code != 0

   - name: restore workspace mode
     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 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.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)