Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

sql-report

Use these commands to import and display language translation and font files, and run a SQL report schedule once against the FortiAnalyzer system.

Syntax

execute sql-report delete-font <font-name>

execute sql-report delete-lang <language-name>

execute sql-report delete-template adom-installed <adom> <language> [title]

execute sql-report delete-template device-default <dev-type> <language> [title]

execute sql-report export-lang <language-name> <service> <ip> <argument 1> <argument 2> <argument 3>

execute sql-report export-template adom-installed <adom> <service> <ip> <user> <password> <file name> [language] [title]

execute sql-report export-template device-default <dev-type> <service> <ip> <user> <password> <file name> [language] [title]

execute sql-report hcache-build <adom> <schedule-name> <start-time> <end-time>

execute sql-report hcache-check <adom> <schedule-name> <start-time> <end-time>

execute sql-report import-font <service> <ip> <argument 1> <argument 2> <argument 3>

execute sql-report import-lang <language-name> <service> <ip> <argument 1> <argument 2> <argument 3>

execute sql-report import-template <devtype> <service> <ip> <user> <password> <file name>

execute sql-report install-template <adom> <language> <service> <ip> <user> <password> <file name>

execute sql-report list <adom> [days-range] [layout-name]

execute sql-report list-fonts

execute sql-report list-lang [language]

execute sql-report list-schedule <adom> [sched-only | autocache-only | detail] [detail]

execute sql-report list-template adom-installed <adom> [language]

execute sql-report list-template device-default <dev-type> [language]

execute sql-report run <adom> <schedule-name> <start-time> <end-time>

execute sql-report view <data-type> <adom> <report-name>

Variable

Description

delete-font

Delete one font.

delete-lang

Delete one language translation file.

delete-template

Delete templates.

  • adom-installed - Delete report templates installed in ADOM.
  • device-default - Delete device type default report templates.

export-lang

Export a user-defined language translation file.

export-template

Export report templates.

  • adom-installed - Export ADOM report templates to file.
  • device-default - Export device type default report templates to file.

hcache-build

Build report hcache.

hcache-check

Check report hcache.

import-font

Import one font.

import-lang

Import a user-defined language translation file.

import-template

Import per device type template from a configuration file.

install-template

Install specific language templates to an ADOM.

list

List recent generated reports.

list-fonts

List all imported fonts.

list-lang

Display all supported language translation files.

list-schedule

List report schedule and autocache information.

list-template

List templates.

  • adom-installed - Display report templates installed in ADOM.
  • device-default - Display device type default report templates.

run

Run a report once.

view

View report data.

<adom>

Specify the ADOM name.

<font-name>

The name of a font.

<dev-type>

Enter the device type abbreviation:

  • FGT - FortiGate
  • FMG - FortiManager
  • FCT - FortiClient
  • FML - FortiMail
  • FWB - FortiWeb
  • FCH - FortiCache
  • FAZ - FortiAnalyzer
  • FSA - FortiSandbox
  • FDD - FortiDDoS
  • FAC - FortiAuthenticator
  • FPX - FortiProxy

<language-name>

Enter the language name to import, export, or delete a language translation file, or select one of the following options:

  • English
  • French
  • Japanese
  • Korean
  • Portuguese
  • Simplified_Chinese
  • Spanish
  • Traditional_Chinese

<service>

Enter the transfer protocol: ftp, sftp, scp, or tftp.

TFTP is not available for all commands.

<ip>

Enter the server IP address.

<argument 1>

For FTP, SFTP, or SCP, type a user name. For TFTP, enter a file name.

<argument 2>

For FTP, SFTP, or SCP, type a password or ‘-’. For TFTP, press <enter>.

<argument 3>

Enter a file name and press <enter>.

<user>

Enter a user name for the remote server.

<password>

Enter the password, or -, for the remote server user.

<file name>

Enter the name of the file.

<data-type>

The data type to view. Must be report-data.

<report-name>

The name of the report to view.

<schedule-name>

Select one of the available report schedule names.

<start-time>

The start date and time of the report schedule, in the format: "HH:MM yyyy/mm/dd"

<end-time>

The enddate and time of the report schedule, in the format: "HH:MM yyyy/mm/dd"

[days-range]

The recent n days to list reports, from 1 to 99.

[layout-name]

One of the available SQL report layout names.

[language]

Enter the language abbreviation:

  • en - English
  • de - German
  • es - Spanish
  • fr - French
  • it - Italian
  • ja - Japanese
  • ko - Korean
  • pt - Portuguese
  • ru - Russian
  • zh - Simplified Chinese
  • zh_Hant - Traditional Chinese

[title]

Title of a specific report template.

sql-report

Use these commands to import and display language translation and font files, and run a SQL report schedule once against the FortiAnalyzer system.

Syntax

execute sql-report delete-font <font-name>

execute sql-report delete-lang <language-name>

execute sql-report delete-template adom-installed <adom> <language> [title]

execute sql-report delete-template device-default <dev-type> <language> [title]

execute sql-report export-lang <language-name> <service> <ip> <argument 1> <argument 2> <argument 3>

execute sql-report export-template adom-installed <adom> <service> <ip> <user> <password> <file name> [language] [title]

execute sql-report export-template device-default <dev-type> <service> <ip> <user> <password> <file name> [language] [title]

execute sql-report hcache-build <adom> <schedule-name> <start-time> <end-time>

execute sql-report hcache-check <adom> <schedule-name> <start-time> <end-time>

execute sql-report import-font <service> <ip> <argument 1> <argument 2> <argument 3>

execute sql-report import-lang <language-name> <service> <ip> <argument 1> <argument 2> <argument 3>

execute sql-report import-template <devtype> <service> <ip> <user> <password> <file name>

execute sql-report install-template <adom> <language> <service> <ip> <user> <password> <file name>

execute sql-report list <adom> [days-range] [layout-name]

execute sql-report list-fonts

execute sql-report list-lang [language]

execute sql-report list-schedule <adom> [sched-only | autocache-only | detail] [detail]

execute sql-report list-template adom-installed <adom> [language]

execute sql-report list-template device-default <dev-type> [language]

execute sql-report run <adom> <schedule-name> <start-time> <end-time>

execute sql-report view <data-type> <adom> <report-name>

Variable

Description

delete-font

Delete one font.

delete-lang

Delete one language translation file.

delete-template

Delete templates.

  • adom-installed - Delete report templates installed in ADOM.
  • device-default - Delete device type default report templates.

export-lang

Export a user-defined language translation file.

export-template

Export report templates.

  • adom-installed - Export ADOM report templates to file.
  • device-default - Export device type default report templates to file.

hcache-build

Build report hcache.

hcache-check

Check report hcache.

import-font

Import one font.

import-lang

Import a user-defined language translation file.

import-template

Import per device type template from a configuration file.

install-template

Install specific language templates to an ADOM.

list

List recent generated reports.

list-fonts

List all imported fonts.

list-lang

Display all supported language translation files.

list-schedule

List report schedule and autocache information.

list-template

List templates.

  • adom-installed - Display report templates installed in ADOM.
  • device-default - Display device type default report templates.

run

Run a report once.

view

View report data.

<adom>

Specify the ADOM name.

<font-name>

The name of a font.

<dev-type>

Enter the device type abbreviation:

  • FGT - FortiGate
  • FMG - FortiManager
  • FCT - FortiClient
  • FML - FortiMail
  • FWB - FortiWeb
  • FCH - FortiCache
  • FAZ - FortiAnalyzer
  • FSA - FortiSandbox
  • FDD - FortiDDoS
  • FAC - FortiAuthenticator
  • FPX - FortiProxy

<language-name>

Enter the language name to import, export, or delete a language translation file, or select one of the following options:

  • English
  • French
  • Japanese
  • Korean
  • Portuguese
  • Simplified_Chinese
  • Spanish
  • Traditional_Chinese

<service>

Enter the transfer protocol: ftp, sftp, scp, or tftp.

TFTP is not available for all commands.

<ip>

Enter the server IP address.

<argument 1>

For FTP, SFTP, or SCP, type a user name. For TFTP, enter a file name.

<argument 2>

For FTP, SFTP, or SCP, type a password or ‘-’. For TFTP, press <enter>.

<argument 3>

Enter a file name and press <enter>.

<user>

Enter a user name for the remote server.

<password>

Enter the password, or -, for the remote server user.

<file name>

Enter the name of the file.

<data-type>

The data type to view. Must be report-data.

<report-name>

The name of the report to view.

<schedule-name>

Select one of the available report schedule names.

<start-time>

The start date and time of the report schedule, in the format: "HH:MM yyyy/mm/dd"

<end-time>

The enddate and time of the report schedule, in the format: "HH:MM yyyy/mm/dd"

[days-range]

The recent n days to list reports, from 1 to 99.

[layout-name]

One of the available SQL report layout names.

[language]

Enter the language abbreviation:

  • en - English
  • de - German
  • es - Spanish
  • fr - French
  • it - Italian
  • ja - Japanese
  • ko - Korean
  • pt - Portuguese
  • ru - Russian
  • zh - Simplified Chinese
  • zh_Hant - Traditional Chinese

[title]

Title of a specific report template.