Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.2.1
Copy Link

Configure SSO admin users.

  config system sso-admin
      Description: Configure SSO admin users.
      edit <name>
          set accprofile {string}
          config gui-dashboard
              Description: GUI dashboards.
              edit <id>
                  set name {string}
                  set vdom {string}
                  set layout-type [responsive|fixed]
                  set permanent [disable|enable]
                  set columns {integer}
                  config widget
                      Description: Dashboard widgets.
                      edit <id>
                          set type [sysinfo|licinfo|...]
                          set x-pos {integer}
                          set y-pos {integer}
                          set width {integer}
                          set height {integer}
                          set interface {string}
                          set region [default|custom]
                          set industry [default|custom]
                          set fabric-device {string}
                          set fabric-device-widget-name {string}
                          set fabric-device-widget-visualization-type {string}
                          set title {string}
                          set fortiview-type {string}
                          set fortiview-sort-by {string}
                          set fortiview-timeframe {string}
                          set fortiview-visualization {string}
                          set fortiview-device {string}
                          config fortiview-filters
                              Description: FortiView filters.
                              edit <id>
                                  set key {string}
                                  set value {string}
                              next
                          end
                      next
                  end
              next
          end
          set vdom <name1>, <name2>, ...
          set gui-global-menu-favorites <id1>, <id2>, ...
          set gui-vdom-menu-favorites <id1>, <id2>, ...
          set gui-new-feature-acknowledge <id1>, <id2>, ...
      next
  end

config system sso-admin

Parameter Name Description Type Size
accprofile SSO admin user access profile. string Maximum length: 35
vdom <name> Virtual domain(s) that the administrator can access.
Virtual domain name.
string Maximum length: 79
gui-global-menu-favorites <id> Favorite GUI menu IDs for the global VDOM.
Select menu ID.
string Maximum length: 79
gui-vdom-menu-favorites <id> Favorite GUI menu IDs for VDOMs.
Select menu ID.
string Maximum length: 79
gui-new-feature-acknowledge <id> Acknowledgement of new features.
Select menu ID.
string Maximum length: 79

config gui-dashboard

Parameter Name Description Type Size
name Dashboard name. string Maximum length: 35
vdom Virtual domain. string Maximum length: 31
layout-type Layout type.
responsive: Responsive.
fixed: Fixed grid.
option -
permanent Permanent dashboard (can't be removed via the GUI).
disable: Dashboard is not permanent.
enable: Dashboard is permanent (can't be removed).
option -
columns Number of columns. integer Minimum value: 5 Maximum value: 20

config widget

Parameter Name Description Type Size
type Widget type.
sysinfo: System Information.
licinfo: License Information.
forticloud: FortiCloud 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.
option -
x-pos X position. integer Minimum value: 0 Maximum value: 1000
y-pos Y position. integer Minimum value: 0 Maximum value: 1000
width Width. integer Minimum value: 1 Maximum value: 50
height Height. integer Minimum value: 1 Maximum value: 50
interface Interface to monitor. string Maximum length: 15
region Security Audit Rating region.
default: All regions.
custom: FortiGate region.
option -
industry Security Audit Rating industry.
default: All industries.
custom: FortiCare industry.
option -
fabric-device Fabric device to monitor. string Maximum length: 127
fabric-device-widget-name Fabric device widget name. string Maximum length: 127
fabric-device-widget-visualization-type Visualization type for fabric device widget. string Maximum length: 35
title Widget title. string Maximum length: 127
fortiview-type FortiView type. string Maximum length: 35
fortiview-sort-by FortiView sort by. string Maximum length: 35
fortiview-timeframe FortiView timeframe. string Maximum length: 35
fortiview-visualization FortiView visualization. string Maximum length: 35
fortiview-device FortiView device. string Maximum length: 35
config fortiview-filters
Parameter Name Description Type Size
key Filter key. string Maximum length: 127
value Filter value. string Maximum length: 127

Configure SSO admin users.

  config system sso-admin
      Description: Configure SSO admin users.
      edit <name>
          set accprofile {string}
          config gui-dashboard
              Description: GUI dashboards.
              edit <id>
                  set name {string}
                  set vdom {string}
                  set layout-type [responsive|fixed]
                  set permanent [disable|enable]
                  set columns {integer}
                  config widget
                      Description: Dashboard widgets.
                      edit <id>
                          set type [sysinfo|licinfo|...]
                          set x-pos {integer}
                          set y-pos {integer}
                          set width {integer}
                          set height {integer}
                          set interface {string}
                          set region [default|custom]
                          set industry [default|custom]
                          set fabric-device {string}
                          set fabric-device-widget-name {string}
                          set fabric-device-widget-visualization-type {string}
                          set title {string}
                          set fortiview-type {string}
                          set fortiview-sort-by {string}
                          set fortiview-timeframe {string}
                          set fortiview-visualization {string}
                          set fortiview-device {string}
                          config fortiview-filters
                              Description: FortiView filters.
                              edit <id>
                                  set key {string}
                                  set value {string}
                              next
                          end
                      next
                  end
              next
          end
          set vdom <name1>, <name2>, ...
          set gui-global-menu-favorites <id1>, <id2>, ...
          set gui-vdom-menu-favorites <id1>, <id2>, ...
          set gui-new-feature-acknowledge <id1>, <id2>, ...
      next
  end

config system sso-admin

Parameter Name Description Type Size
accprofile SSO admin user access profile. string Maximum length: 35
vdom <name> Virtual domain(s) that the administrator can access.
Virtual domain name.
string Maximum length: 79
gui-global-menu-favorites <id> Favorite GUI menu IDs for the global VDOM.
Select menu ID.
string Maximum length: 79
gui-vdom-menu-favorites <id> Favorite GUI menu IDs for VDOMs.
Select menu ID.
string Maximum length: 79
gui-new-feature-acknowledge <id> Acknowledgement of new features.
Select menu ID.
string Maximum length: 79

config gui-dashboard

Parameter Name Description Type Size
name Dashboard name. string Maximum length: 35
vdom Virtual domain. string Maximum length: 31
layout-type Layout type.
responsive: Responsive.
fixed: Fixed grid.
option -
permanent Permanent dashboard (can't be removed via the GUI).
disable: Dashboard is not permanent.
enable: Dashboard is permanent (can't be removed).
option -
columns Number of columns. integer Minimum value: 5 Maximum value: 20

config widget

Parameter Name Description Type Size
type Widget type.
sysinfo: System Information.
licinfo: License Information.
forticloud: FortiCloud 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.
option -
x-pos X position. integer Minimum value: 0 Maximum value: 1000
y-pos Y position. integer Minimum value: 0 Maximum value: 1000
width Width. integer Minimum value: 1 Maximum value: 50
height Height. integer Minimum value: 1 Maximum value: 50
interface Interface to monitor. string Maximum length: 15
region Security Audit Rating region.
default: All regions.
custom: FortiGate region.
option -
industry Security Audit Rating industry.
default: All industries.
custom: FortiCare industry.
option -
fabric-device Fabric device to monitor. string Maximum length: 127
fabric-device-widget-name Fabric device widget name. string Maximum length: 127
fabric-device-widget-visualization-type Visualization type for fabric device widget. string Maximum length: 35
title Widget title. string Maximum length: 127
fortiview-type FortiView type. string Maximum length: 35
fortiview-sort-by FortiView sort by. string Maximum length: 35
fortiview-timeframe FortiView timeframe. string Maximum length: 35
fortiview-visualization FortiView visualization. string Maximum length: 35
fortiview-device FortiView device. string Maximum length: 35
config fortiview-filters
Parameter Name Description Type Size
key Filter key. string Maximum length: 127
value Filter value. string Maximum length: 127