Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.0.6
Download PDF
Copy Link

report chart

Use the following command to configure a chart or widget.

You can edit the settings of existing widgets or you can add new widgets. To add a new widget you need to have a dataset for it as well as a title. You can also configure the widget to be a graph in various formats or a table and you can also optionally configure details about the appearance of the graph or table.

config report chart
    edit {name}
    # Report chart widget configuration.
        set name {string}   Chart Widget Name size[71]
        set policy {integer}   Used by monitor policy. range[0-4294967295]
        set type {graph | table}   Chart type.
                graph  Graph.
                table  Table.
        set period {last24h | last7d}   Time period.
                last24h  Last 24 hours.
                last7d   Last 7 days.
        config drill-down-charts
            edit {id}
            # Drill down charts.
                set id {integer}   Drill down chart ID. range[0-4294967295]
                set chart-name {string}   Drill down chart name. size[71]
                set status {enable | disable}   Enable/disable this drill down chart.
            next
        set comments {string}   Comment. size[127]
        set dataset {string}   Bind dataset to chart. size[71]
        set category {option}   Category.
                misc           Miscellaneous.
                traffic        Traffic.
                event          Event.
                virus          Virus.
                webfilter      Webfilter.
                attack         Attack.
                spam           Spam.
                dlp            Data leak prevention.
                app-ctrl       Application control.
                vulnerability  Vulnerability.
        set favorite {no | yes}   Favorite.
                no   Not a favorite chart.
                yes  Favorite chart.
        set graph-type {option}   Graph type.
                none  None.
                bar   Bar Chart.
                pie   Pie Chart.
                line  Line Chart.
                flow  flow Chart.
        set style {auto | manual}   Style.
                auto    Auto.
                manual  Manual.
        set dimension {2D | 3D}   Dimension.
                2D  2D graphic.
                3D  3D graphic.
        config x-series
            set databind {string}   X-series value expression. size[127]
            set caption {string}   X-series caption. size[35]
            set caption-font-size {integer}   X-series caption font size. range[5-20]
            set font-size {integer}   X-series label font size. range[5-20]
            set label-angle {45-degree | vertical | horizontal}   X-series label angle.
                    45-degree   45-degree.
                    vertical    Vertical.
                    horizontal  Horizontal.
            set is-category {yes | no}   X-series represent category or not.
                    yes  X-series is category.
                    no   X-series is not category.
            set scale-unit {option}   Scale unit.
                    minute  Minute.
                    hour    Hour.
                    day     Day.
                    month   Month.
                    year    Year.
            set scale-step {integer}   Scale step. range[1-65535]
            set scale-direction {decrease | increase}   Scale increase or decrease.
                    decrease  Decrease.
                    increase  Increase.
            set scale-format {option}   Date/time format.
                    YYYY-MM-DD-HH-MM  YYYY/MM/DD HH:MM
                    YYYY-MM-DD HH     YYYY/MM/DD HH
                    YYYY-MM-DD        YYYY/MM/DD
                    YYYY-MM           YYYY/MM
                    YYYY              YYYY
                    HH-MM             HH:MM
                    MM-DD             MM:DD
            set unit {string}   X-series unit. size[35]
        config y-series
            set databind {string}   Y-series value expression. size[127]
            set caption {string}   Y-series caption. size[35]
            set caption-font-size {integer}   Y-series caption font size. range[5-20]
            set font-size {integer}   Y-series label font size. range[5-20]
            set label-angle {45-degree | vertical | horizontal}   Y-series label angle.
                    45-degree   45-degree.
                    vertical    Vertical.
                    horizontal  Horizontal.
            set group {string}   Y-series group option. size[127]
            set unit {string}   Y-series unit. size[35]
            set extra-y {enable | disable}   Allow another Y-series value
            set extra-databind {string}   Extra Y-series value. size[127]
            set y-legend {string}   First Y-series legend type/name. size[35]
            set extra-y-legend {string}   Extra Y-series legend type/name. size[35]
        config category-series
            set databind {string}   Category series value expression. size[127]
            set font-size {integer}   Font size of category-series title. range[5-20]
        config value-series
            set databind {string}   Value series value expression. size[127]
        set title {string}   Chart title. size[63]
        set title-font-size {integer}   Font size of chart title. range[0-4294967295]
        set background {string}   Chart background. size[11]
        set color-palette {string}   Color palette (system will pick color automatically by default). size[11]
        set legend {enable | disable}   Enable/Disable Legend area.
        set legend-font-size {integer}   Font size of legend area. range[0-4294967295]
        config column
            edit {id}
            # Table column definition.
                set id {integer}   ID. range[0-4294967295]
                set header-value {string}   Display name of table header. size[127]
                set detail-value {string}   Detail value of column. size[127]
                set footer-value {string}   Footer value of column. size[127]
                set detail-unit {string}   Detail unit of column. size[35]
                set footer-unit {string}   Footer unit of column. size[35]
                config mapping
                    edit {id}
                    # Show detail in certain display value for certain condition.
                        set id {integer}   id range[0-4294967295]
                        set op {option}   Comparision operater.
                                none           None.
                                greater        Greater than.
                                greater-equal  Greater than or equal to.
                                less           Less than.
                                less-equal     Less than or equal to.
                                equal          Equal to.
                                between        Between value 1 and value 2.
                        set value-type {integer | string}   Value type.
                                integer  Integer.
                                string   String.
                        set value1 {string}   Value 1. size[127]
                        set value2 {string}   Value 2. size[127]
                        set displayname {string}   Display name. size[127]
                    next
            next
    next
end

report chart

Use the following command to configure a chart or widget.

You can edit the settings of existing widgets or you can add new widgets. To add a new widget you need to have a dataset for it as well as a title. You can also configure the widget to be a graph in various formats or a table and you can also optionally configure details about the appearance of the graph or table.

config report chart
    edit {name}
    # Report chart widget configuration.
        set name {string}   Chart Widget Name size[71]
        set policy {integer}   Used by monitor policy. range[0-4294967295]
        set type {graph | table}   Chart type.
                graph  Graph.
                table  Table.
        set period {last24h | last7d}   Time period.
                last24h  Last 24 hours.
                last7d   Last 7 days.
        config drill-down-charts
            edit {id}
            # Drill down charts.
                set id {integer}   Drill down chart ID. range[0-4294967295]
                set chart-name {string}   Drill down chart name. size[71]
                set status {enable | disable}   Enable/disable this drill down chart.
            next
        set comments {string}   Comment. size[127]
        set dataset {string}   Bind dataset to chart. size[71]
        set category {option}   Category.
                misc           Miscellaneous.
                traffic        Traffic.
                event          Event.
                virus          Virus.
                webfilter      Webfilter.
                attack         Attack.
                spam           Spam.
                dlp            Data leak prevention.
                app-ctrl       Application control.
                vulnerability  Vulnerability.
        set favorite {no | yes}   Favorite.
                no   Not a favorite chart.
                yes  Favorite chart.
        set graph-type {option}   Graph type.
                none  None.
                bar   Bar Chart.
                pie   Pie Chart.
                line  Line Chart.
                flow  flow Chart.
        set style {auto | manual}   Style.
                auto    Auto.
                manual  Manual.
        set dimension {2D | 3D}   Dimension.
                2D  2D graphic.
                3D  3D graphic.
        config x-series
            set databind {string}   X-series value expression. size[127]
            set caption {string}   X-series caption. size[35]
            set caption-font-size {integer}   X-series caption font size. range[5-20]
            set font-size {integer}   X-series label font size. range[5-20]
            set label-angle {45-degree | vertical | horizontal}   X-series label angle.
                    45-degree   45-degree.
                    vertical    Vertical.
                    horizontal  Horizontal.
            set is-category {yes | no}   X-series represent category or not.
                    yes  X-series is category.
                    no   X-series is not category.
            set scale-unit {option}   Scale unit.
                    minute  Minute.
                    hour    Hour.
                    day     Day.
                    month   Month.
                    year    Year.
            set scale-step {integer}   Scale step. range[1-65535]
            set scale-direction {decrease | increase}   Scale increase or decrease.
                    decrease  Decrease.
                    increase  Increase.
            set scale-format {option}   Date/time format.
                    YYYY-MM-DD-HH-MM  YYYY/MM/DD HH:MM
                    YYYY-MM-DD HH     YYYY/MM/DD HH
                    YYYY-MM-DD        YYYY/MM/DD
                    YYYY-MM           YYYY/MM
                    YYYY              YYYY
                    HH-MM             HH:MM
                    MM-DD             MM:DD
            set unit {string}   X-series unit. size[35]
        config y-series
            set databind {string}   Y-series value expression. size[127]
            set caption {string}   Y-series caption. size[35]
            set caption-font-size {integer}   Y-series caption font size. range[5-20]
            set font-size {integer}   Y-series label font size. range[5-20]
            set label-angle {45-degree | vertical | horizontal}   Y-series label angle.
                    45-degree   45-degree.
                    vertical    Vertical.
                    horizontal  Horizontal.
            set group {string}   Y-series group option. size[127]
            set unit {string}   Y-series unit. size[35]
            set extra-y {enable | disable}   Allow another Y-series value
            set extra-databind {string}   Extra Y-series value. size[127]
            set y-legend {string}   First Y-series legend type/name. size[35]
            set extra-y-legend {string}   Extra Y-series legend type/name. size[35]
        config category-series
            set databind {string}   Category series value expression. size[127]
            set font-size {integer}   Font size of category-series title. range[5-20]
        config value-series
            set databind {string}   Value series value expression. size[127]
        set title {string}   Chart title. size[63]
        set title-font-size {integer}   Font size of chart title. range[0-4294967295]
        set background {string}   Chart background. size[11]
        set color-palette {string}   Color palette (system will pick color automatically by default). size[11]
        set legend {enable | disable}   Enable/Disable Legend area.
        set legend-font-size {integer}   Font size of legend area. range[0-4294967295]
        config column
            edit {id}
            # Table column definition.
                set id {integer}   ID. range[0-4294967295]
                set header-value {string}   Display name of table header. size[127]
                set detail-value {string}   Detail value of column. size[127]
                set footer-value {string}   Footer value of column. size[127]
                set detail-unit {string}   Detail unit of column. size[35]
                set footer-unit {string}   Footer unit of column. size[35]
                config mapping
                    edit {id}
                    # Show detail in certain display value for certain condition.
                        set id {integer}   id range[0-4294967295]
                        set op {option}   Comparision operater.
                                none           None.
                                greater        Greater than.
                                greater-equal  Greater than or equal to.
                                less           Less than.
                                less-equal     Less than or equal to.
                                equal          Equal to.
                                between        Between value 1 and value 2.
                        set value-type {integer | string}   Value type.
                                integer  Integer.
                                string   String.
                        set value1 {string}   Value 1. size[127]
                        set value2 {string}   Value 2. size[127]
                        set displayname {string}   Display name. size[127]
                    next
            next
    next
end