Fortinet black logo

Cookbook

Dashboard CLI

Copy Link
Copy Doc ID 5ede200c-a21f-11eb-b70b-00505692583a:517570
Download PDF

Dashboard CLI

Dashboards and widgets can be managed using the CLI. The options available when creating a widget will vary depending on the widget type.

To create a dashboard:

config system admin

edit <admin name>

config gui-dashboard

edit <dashboard number>

set name <name>

set vdom <vdom>

set layout-type {responsive | fixed}

set permanent {enable | disable}

next

end

next

end

To add a widget to a dashboard:

config system admin

edit <admin name>

config gui-dashboard

edit <dashboard number>

config widget

edit <widget number>

set type <widget type>

set x-pos <0 - 1000>

set y-pos <0 - 1000>

set width <1 - 50>

set height <1 - 50>

...

next

end

next

end

next

end

The widget type can be one of the following:

CLI type

GUI name

sysinfo System Information
licinfo License Information
vminfo Virtual machine information
forticloud FortiGate Cloud Licenses
cpu-usage CPU Usage
memory-usage Memory Usage
disk-usage Disk Usage
log-rate Session Rate
sessions Sessions
session-rate Session Rate
tr-history Traffic History
analytics FortiGuard Analytics
usb-modem USB Modem
admins Administrators
security-fabric Security Fabric
security-fabric-ranking Security Fabric Ranking
ha-status HA Status
vulnerability-summary Vulnerability Summary
host-scan-summary Host Scan Summary
fortiview FortiView
botnet-activity Botnet Activity
fabric-device Fabric Device

Dashboard CLI

Dashboards and widgets can be managed using the CLI. The options available when creating a widget will vary depending on the widget type.

To create a dashboard:

config system admin

edit <admin name>

config gui-dashboard

edit <dashboard number>

set name <name>

set vdom <vdom>

set layout-type {responsive | fixed}

set permanent {enable | disable}

next

end

next

end

To add a widget to a dashboard:

config system admin

edit <admin name>

config gui-dashboard

edit <dashboard number>

config widget

edit <widget number>

set type <widget type>

set x-pos <0 - 1000>

set y-pos <0 - 1000>

set width <1 - 50>

set height <1 - 50>

...

next

end

next

end

next

end

The widget type can be one of the following:

CLI type

GUI name

sysinfo System Information
licinfo License Information
vminfo Virtual machine information
forticloud FortiGate Cloud Licenses
cpu-usage CPU Usage
memory-usage Memory Usage
disk-usage Disk Usage
log-rate Session Rate
sessions Sessions
session-rate Session Rate
tr-history Traffic History
analytics FortiGuard Analytics
usb-modem USB Modem
admins Administrators
security-fabric Security Fabric
security-fabric-ranking Security Fabric Ranking
ha-status HA Status
vulnerability-summary Vulnerability Summary
host-scan-summary Host Scan Summary
fortiview FortiView
botnet-activity Botnet Activity
fabric-device Fabric Device