/ home / fortinet / fortinet.fortimanager / 1.0.5 / module / fmgr_dvmdb_script_obj

fortinet.fortimanager.fmgr_dvmdb_script_obj (1.0.5) — module

Script table.

| "added in version" 2.10 of fortinet.fortimanager"

Authors: Frank Shen (@fshen01), Link Zheng (@zhengl)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==1.0.5

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 1.0.5

Description

This module is able to configure a FortiManager device by allowing the user to [ delete get set update add ] the following apis.

/dvmdb/adom/{adom}/script/{script}

/dvmdb/global/script/{script}

/dvmdb/script/{script}

Examples include all parameters and values need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

 - 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: REQUESTING /DVMDB/SCRIPT/{SCRIPT}
      fmgr_dvmdb_script_obj:
         loose_validation: False
         workspace_locking_adom: <value in [global, custom adom]>
         workspace_locking_timeout: 300
         method: <value in [delete]>
         url_params:
            adom: <value in [none, global, custom dom]>
            script: <value of string>
         params:
            -
               data:
                 -
                     name: <value of string>
                     vdom: <value of string>

    - name: REQUESTING /DVMDB/SCRIPT/{SCRIPT}
      fmgr_dvmdb_script_obj:
         loose_validation: False
         workspace_locking_adom: <value in [global, custom adom]>
         workspace_locking_timeout: 300
         method: <value in [get]>
         url_params:
            adom: <value in [none, global, custom dom]>
            script: <value of string>
         params:
            -
               option: <value in [object member, chksum]>

    - name: REQUESTING /DVMDB/SCRIPT/{SCRIPT}
      fmgr_dvmdb_script_obj:
         loose_validation: False
         workspace_locking_adom: <value in [global, custom adom]>
         workspace_locking_timeout: 300
         method: <value in [set, update]>
         url_params:
            adom: <value in [none, global, custom dom]>
            script: <value of string>
         params:
            -
               data:
                  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]>

    - name: REQUESTING /DVMDB/SCRIPT/{SCRIPT}
      fmgr_dvmdb_script_obj:
         loose_validation: False
         workspace_locking_adom: <value in [global, custom adom]>
         workspace_locking_timeout: 300
         method: <value in [set, update]>
         url_params:
            adom: <value in [none, global, custom dom]>
            script: <value of string>
         params:
            -
               data:
                 -
                     name: <value of string>
                     vdom: <value of string>

    - name: REQUESTING /DVMDB/SCRIPT/{SCRIPT}
      fmgr_dvmdb_script_obj:
         loose_validation: False
         workspace_locking_adom: <value in [global, custom adom]>
         workspace_locking_timeout: 300
         method: <value in [add]>
         url_params:
            adom: <value in [none, global, custom dom]>
            script: <value of string>
         params:
            -
               data:
                 -
                     name: <value of string>
                     vdom: <value of string>

Inputs

    
method:
    choices:
    - delete
    - get
    - set
    - update
    - add
    description:
    - The method in request
    required: true
    type: str

params:
    description:
    - The parameters for each method
    - See full parameters list in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
    required: false
    type: list

url_params:
    description:
    - The parameters for each API request URL
    - Also see full URL parameters in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
    required: false
    type: dict

loose_validation:
    description:
    - Do parameter validation in a loose way
    required: false
    type: bool

workspace_locking_adom:
    description:
    - the adom name to lock in case FortiManager running in workspace mode
    - it can be global or any other custom adom names
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description:
    - the maximum time in seconds to wait for other user to release the workspace lock
    required: false
    type: int

Outputs

data:
  description: The payload returned in the request
  returned: always
  type: dict
status:
  description: The status of api request
  returned: always
  type: dict
url:
  description: The full url requested
  returned: always
  sample: /sys/login/user
  type: str