FortiManager
FortiManager supports network operations use cases for centralized management, best practices compliance, and workflow automation to provide better protection against breaches.
smkml
Staff
Staff
Article Id 334459
Description

 

This article describes the functions of the CLI script on FortiManager and how to use them in each use case. There are three options to run a script on FortiManager, as per below:

 

  • Device Database.
  • Policy Package or ADOM Database.
  • Remote FortiGate Directly (via CLI).

 

FMG Script details.png

Scope

 

FortiManager.

 

Solution

 

FMG Script Flow.png

 

  1. Device Database
  • Create a script that runs on the Device Database.

 

Device Database scripts.png

  • Run the script by selecting the Script -> Run Script -> Select a device to run a Script -> Run Now -> OK.

 

device database run script.gif

  • Make sure the script is running without error.
  • After running the script, the changes will reflected on the Device Database configuration. (The config status will show 'Modified'.)
  • It will be necessary to install (Install Device Settings (only)) the changes to reflect on the FortiGate.

 

Install device database.gif

  1. Policy Package or ADOM Database:
  • Create a script that runs on a Policy Package or the ADOM Database.

 

ADOM database scripts.png

  • Run the script by selecting the Script -> Run Script -> Select a policy package -> Run Now.

 

adom database run script.gif

  • Make sure the script running without error.
  • After running the script, the changes will reflected on the Policy Package configuration. (The Policy Package Status will show 'Modified'.)
  • Install (Install Policy Package & Device Settings) the changes to reflect on the FortiGate.

 

install adom database.gif

  1. Remote FortiGate Directly (via the CLI):
  • Create a script that runs on the remote FortiGate Directly (via the CLI).

fgt cli scripts.png

  • Run the script by selecting the Script -> Run Script -> Select a policy package -> Run Now.
  • Make sure the script running without error.
  • Since the script is installed directly on the FortiGate it will automatically perform a Retrieve back to FortiManager, and the expected output on Config Status is "Synchronize" and the Policy Package will be 'Unknown'.

 

fgt cli revision history.png

Note:

To get an output for the commands 'get' and 'show', use this option to run a script from FortiManager. Select the 'Lens' icon after successfully running the script to check on the output.

 

view script executing history.png

fgt cli script get.png

Related documents: