Fortinet white logo
Fortinet white logo

CLI Reference

config report layout

config report layout

Note

This command is available for model(s): FortiGate 1000D, FortiGate 101E, FortiGate 101F, FortiGate 1101E, FortiGate 1500DT, FortiGate 1500D, FortiGate 1801F, FortiGate 2000E, FortiGate 201E, FortiGate 201F, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3301E, FortiGate 3401E, FortiGate 3501F, FortiGate 3601E, FortiGate 3700D, FortiGate 3800D, FortiGate 401E, FortiGate 401F, FortiGate 4201F, FortiGate 4401F, FortiGate 5001E1, FortiGate 501E, FortiGate 601E, FortiGate 601F, FortiGate 61E, FortiGate 61F, FortiGate 71F, FortiGate 800D, FortiGate 81E-POE, FortiGate 81E, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 91E, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiWiFi 61E, FortiWiFi 61F, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

It is not available for: FortiGate 100EF, FortiGate 100E, FortiGate 100F, FortiGate 1100E, FortiGate 140E-POE, FortiGate 140E, FortiGate 1800F, FortiGate 200E, FortiGate 200F, FortiGate 2200E, FortiGate 300E, FortiGate 3300E, FortiGate 3400E, FortiGate 3500F, FortiGate 3600E, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4400F, FortiGate 5001E, FortiGate 500E, FortiGate 600E, FortiGate 600F, FortiGate 60E DSLJ, FortiGate 60E DSL, FortiGate 60E-POE, FortiGate 60E, FortiGate 60F, FortiGate 70F, FortiGate 80E-POE, FortiGate 80E, FortiGate 80F Bypass, FortiGate 80F-POE, FortiGate 80F, FortiGate 90E, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 60E DSLJ, FortiWiFi 60E DSL, FortiWiFi 60E, FortiWiFi 60F, FortiWiFi 80F 2R.

Report layout configuration.

config report layout
    Description: Report layout configuration.
    edit <name>
        config body-item
            Description: Configure report body item.
            edit <id>
                set description {string}
                set type [text|image|...]
                set style {string}
                set top-n {integer}
                config parameters
                    Description: Parameters.
                    edit <id>
                        set name {string}
                        set value {string}
                    next
                end
                set text-component [text|heading1|...]
                set content {string}
                set img-src {string}
                set chart {string}
                set chart-options {option1}, {option2}, ...
                set misc-component [hline|page-break|...]
                set title {string}
            next
        end
        set cutoff-option [run-time|custom]
        set cutoff-time {user}
        set day [sunday|monday|...]
        set description {string}
        set email-recipients {string}
        set email-send [enable|disable]
        set format {option1}, {option2}, ...
        set max-pdf-report {integer}
        set options {option1}, {option2}, ...
        config page
            Description: Configure report page.
            set paper [a4|letter]
            set column-break-before {option1}, {option2}, ...
            set page-break-before {option1}, {option2}, ...
            set options {option1}, {option2}, ...
            config header
                Description: Configure report page header.
                set style {string}
                config header-item
                    Description: Configure report header item.
                    edit <id>
                        set description {string}
                        set type [text|image]
                        set style {string}
                        set content {string}
                        set img-src {string}
                    next
                end
            end
            config footer
                Description: Configure report page footer.
                set style {string}
                config footer-item
                    Description: Configure report footer item.
                    edit <id>
                        set description {string}
                        set type [text|image]
                        set style {string}
                        set content {string}
                        set img-src {string}
                    next
                end
            end
        end
        set schedule-type [demand|daily|...]
        set style-theme {string}
        set subtitle {string}
        set time {user}
        set title {string}
    next
end

config report layout

Parameter

Description

Type

Size

Default

cutoff-option

Cutoff-option is either run-time or custom.

option

-

run-time

Option

Description

run-time

Run time.

custom

Custom.

cutoff-time

Custom cutoff time to generate report (format = hh:mm).

user

Not Specified

day

Schedule days of week to generate report.

option

-

sunday

Option

Description

sunday

Sunday.

monday

Monday.

tuesday

Tuesday.

wednesday

Wednesday.

thursday

Thursday.

friday

Friday.

saturday

Saturday.

description

Description.

string

Maximum length: 127

email-recipients

Email recipients for generated reports.

string

Maximum length: 511

email-send

Enable/disable sending emails after reports are generated.

option

-

disable

Option

Description

enable

Enable sending emails after generating reports.

disable

Disable sending emails after generating reports.

format

Report format.

option

-

pdf

Option

Description

pdf

PDF.

max-pdf-report

Maximum number of PDF reports to keep at one time (oldest report is overwritten).

integer

Minimum value: 1 Maximum value: 365

31

name

Report layout name.

string

Maximum length: 35

options

Report layout options.

option

-

include-table-of-content auto-numbering-heading view-chart-as-heading

Option

Description

include-table-of-content

Include table of content in the report.

auto-numbering-heading

Prepend heading with auto numbering.

view-chart-as-heading

Auto add heading for each chart.

show-html-navbar-before-heading

Show HTML navigation bar before each heading.

dummy-option

Use this option if you need none of the above options.

schedule-type

Report schedule type.

option

-

daily

Option

Description

demand

Run on demand.

daily

Schedule daily.

weekly

Schedule weekly.

style-theme

Report style theme.

string

Maximum length: 35

subtitle

Report subtitle.

string

Maximum length: 127

time

Schedule time to generate report (format = hh:mm).

user

Not Specified

title

Report title.

string

Maximum length: 127

config body-item

Parameter

Description

Type

Size

Default

id

Report item ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

description

Description.

string

Maximum length: 63

type

Report item type.

option

-

text

Option

Description

text

Text.

image

Image.

chart

Chart.

misc

Miscellaneous.

style

Report item style.

string

Maximum length: 71

top-n

Value of top.

integer

Minimum value: 0 Maximum value: 4294967295

0

text-component

Report item text component.

option

-

text

Option

Description

text

Normal text.

heading1

Heading 1.

heading2

Heading 2.

heading3

Heading 3.

content

Report item text content.

string

Maximum length: 511

img-src

Report item image file name.

string

Maximum length: 127

chart

Report item chart name.

string

Maximum length: 71

chart-options

Report chart options.

option

-

include-no-data hide-title show-caption

Option

Description

include-no-data

Include chart with no data.

hide-title

Hide chart title.

show-caption

Show chart caption.

misc-component

Report item miscellaneous component.

option

-

hline

Option

Description

hline

Horizontal line.

page-break

Page break.

column-break

Column break.

section-start

Section start.

title

Report section title.

string

Maximum length: 511

config parameters

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

name

Field name that match field of parameters defined in dataset.

string

Maximum length: 127

value

Value to replace corresponding field of parameters defined in dataset.

string

Maximum length: 1023

config page

Parameter

Description

Type

Size

Default

paper

Report page paper.

option

-

a4

Option

Description

a4

A4 paper.

letter

Letter paper.

column-break-before

Report page auto column break before heading.

option

-

Option

Description

heading1

Column break before heading 1.

heading2

Column break before heading 2.

heading3

Column break before heading 3.

page-break-before

Report page auto page break before heading.

option

-

Option

Description

heading1

Page break before heading 1.

heading2

Page break before heading 2.

heading3

Page break before heading 3.

options

Report page options.

option

-

Option

Description

header-on-first-page

Show header on first page.

footer-on-first-page

Show footer on first page.

config header

Parameter

Description

Type

Size

Default

style

Report header style.

string

Maximum length: 71

config header-item

Parameter

Description

Type

Size

Default

id

Report item ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

description

Description.

string

Maximum length: 63

type

Report item type.

option

-

text

Option

Description

text

Text.

image

Image.

style

Report item style.

string

Maximum length: 71

content

Report item text content.

string

Maximum length: 511

img-src

Report item image file name.

string

Maximum length: 127

config footer

Parameter

Description

Type

Size

Default

style

Report footer style.

string

Maximum length: 71

config footer-item

Parameter

Description

Type

Size

Default

id

Report item ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

description

Description.

string

Maximum length: 63

type

Report item type.

option

-

text

Option

Description

text

Text.

image

Image.

style

Report item style.

string

Maximum length: 71

content

Report item text content.

string

Maximum length: 511

img-src

Report item image file name.

string

Maximum length: 127

config report layout

config report layout

Note

This command is available for model(s): FortiGate 1000D, FortiGate 101E, FortiGate 101F, FortiGate 1101E, FortiGate 1500DT, FortiGate 1500D, FortiGate 1801F, FortiGate 2000E, FortiGate 201E, FortiGate 201F, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3301E, FortiGate 3401E, FortiGate 3501F, FortiGate 3601E, FortiGate 3700D, FortiGate 3800D, FortiGate 401E, FortiGate 401F, FortiGate 4201F, FortiGate 4401F, FortiGate 5001E1, FortiGate 501E, FortiGate 601E, FortiGate 601F, FortiGate 61E, FortiGate 61F, FortiGate 71F, FortiGate 800D, FortiGate 81E-POE, FortiGate 81E, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 91E, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiWiFi 61E, FortiWiFi 61F, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

It is not available for: FortiGate 100EF, FortiGate 100E, FortiGate 100F, FortiGate 1100E, FortiGate 140E-POE, FortiGate 140E, FortiGate 1800F, FortiGate 200E, FortiGate 200F, FortiGate 2200E, FortiGate 300E, FortiGate 3300E, FortiGate 3400E, FortiGate 3500F, FortiGate 3600E, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4400F, FortiGate 5001E, FortiGate 500E, FortiGate 600E, FortiGate 600F, FortiGate 60E DSLJ, FortiGate 60E DSL, FortiGate 60E-POE, FortiGate 60E, FortiGate 60F, FortiGate 70F, FortiGate 80E-POE, FortiGate 80E, FortiGate 80F Bypass, FortiGate 80F-POE, FortiGate 80F, FortiGate 90E, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 60E DSLJ, FortiWiFi 60E DSL, FortiWiFi 60E, FortiWiFi 60F, FortiWiFi 80F 2R.

Report layout configuration.

config report layout
    Description: Report layout configuration.
    edit <name>
        config body-item
            Description: Configure report body item.
            edit <id>
                set description {string}
                set type [text|image|...]
                set style {string}
                set top-n {integer}
                config parameters
                    Description: Parameters.
                    edit <id>
                        set name {string}
                        set value {string}
                    next
                end
                set text-component [text|heading1|...]
                set content {string}
                set img-src {string}
                set chart {string}
                set chart-options {option1}, {option2}, ...
                set misc-component [hline|page-break|...]
                set title {string}
            next
        end
        set cutoff-option [run-time|custom]
        set cutoff-time {user}
        set day [sunday|monday|...]
        set description {string}
        set email-recipients {string}
        set email-send [enable|disable]
        set format {option1}, {option2}, ...
        set max-pdf-report {integer}
        set options {option1}, {option2}, ...
        config page
            Description: Configure report page.
            set paper [a4|letter]
            set column-break-before {option1}, {option2}, ...
            set page-break-before {option1}, {option2}, ...
            set options {option1}, {option2}, ...
            config header
                Description: Configure report page header.
                set style {string}
                config header-item
                    Description: Configure report header item.
                    edit <id>
                        set description {string}
                        set type [text|image]
                        set style {string}
                        set content {string}
                        set img-src {string}
                    next
                end
            end
            config footer
                Description: Configure report page footer.
                set style {string}
                config footer-item
                    Description: Configure report footer item.
                    edit <id>
                        set description {string}
                        set type [text|image]
                        set style {string}
                        set content {string}
                        set img-src {string}
                    next
                end
            end
        end
        set schedule-type [demand|daily|...]
        set style-theme {string}
        set subtitle {string}
        set time {user}
        set title {string}
    next
end

config report layout

Parameter

Description

Type

Size

Default

cutoff-option

Cutoff-option is either run-time or custom.

option

-

run-time

Option

Description

run-time

Run time.

custom

Custom.

cutoff-time

Custom cutoff time to generate report (format = hh:mm).

user

Not Specified

day

Schedule days of week to generate report.

option

-

sunday

Option

Description

sunday

Sunday.

monday

Monday.

tuesday

Tuesday.

wednesday

Wednesday.

thursday

Thursday.

friday

Friday.

saturday

Saturday.

description

Description.

string

Maximum length: 127

email-recipients

Email recipients for generated reports.

string

Maximum length: 511

email-send

Enable/disable sending emails after reports are generated.

option

-

disable

Option

Description

enable

Enable sending emails after generating reports.

disable

Disable sending emails after generating reports.

format

Report format.

option

-

pdf

Option

Description

pdf

PDF.

max-pdf-report

Maximum number of PDF reports to keep at one time (oldest report is overwritten).

integer

Minimum value: 1 Maximum value: 365

31

name

Report layout name.

string

Maximum length: 35

options

Report layout options.

option

-

include-table-of-content auto-numbering-heading view-chart-as-heading

Option

Description

include-table-of-content

Include table of content in the report.

auto-numbering-heading

Prepend heading with auto numbering.

view-chart-as-heading

Auto add heading for each chart.

show-html-navbar-before-heading

Show HTML navigation bar before each heading.

dummy-option

Use this option if you need none of the above options.

schedule-type

Report schedule type.

option

-

daily

Option

Description

demand

Run on demand.

daily

Schedule daily.

weekly

Schedule weekly.

style-theme

Report style theme.

string

Maximum length: 35

subtitle

Report subtitle.

string

Maximum length: 127

time

Schedule time to generate report (format = hh:mm).

user

Not Specified

title

Report title.

string

Maximum length: 127

config body-item

Parameter

Description

Type

Size

Default

id

Report item ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

description

Description.

string

Maximum length: 63

type

Report item type.

option

-

text

Option

Description

text

Text.

image

Image.

chart

Chart.

misc

Miscellaneous.

style

Report item style.

string

Maximum length: 71

top-n

Value of top.

integer

Minimum value: 0 Maximum value: 4294967295

0

text-component

Report item text component.

option

-

text

Option

Description

text

Normal text.

heading1

Heading 1.

heading2

Heading 2.

heading3

Heading 3.

content

Report item text content.

string

Maximum length: 511

img-src

Report item image file name.

string

Maximum length: 127

chart

Report item chart name.

string

Maximum length: 71

chart-options

Report chart options.

option

-

include-no-data hide-title show-caption

Option

Description

include-no-data

Include chart with no data.

hide-title

Hide chart title.

show-caption

Show chart caption.

misc-component

Report item miscellaneous component.

option

-

hline

Option

Description

hline

Horizontal line.

page-break

Page break.

column-break

Column break.

section-start

Section start.

title

Report section title.

string

Maximum length: 511

config parameters

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

name

Field name that match field of parameters defined in dataset.

string

Maximum length: 127

value

Value to replace corresponding field of parameters defined in dataset.

string

Maximum length: 1023

config page

Parameter

Description

Type

Size

Default

paper

Report page paper.

option

-

a4

Option

Description

a4

A4 paper.

letter

Letter paper.

column-break-before

Report page auto column break before heading.

option

-

Option

Description

heading1

Column break before heading 1.

heading2

Column break before heading 2.

heading3

Column break before heading 3.

page-break-before

Report page auto page break before heading.

option

-

Option

Description

heading1

Page break before heading 1.

heading2

Page break before heading 2.

heading3

Page break before heading 3.

options

Report page options.

option

-

Option

Description

header-on-first-page

Show header on first page.

footer-on-first-page

Show footer on first page.

config header

Parameter

Description

Type

Size

Default

style

Report header style.

string

Maximum length: 71

config header-item

Parameter

Description

Type

Size

Default

id

Report item ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

description

Description.

string

Maximum length: 63

type

Report item type.

option

-

text

Option

Description

text

Text.

image

Image.

style

Report item style.

string

Maximum length: 71

content

Report item text content.

string

Maximum length: 511

img-src

Report item image file name.

string

Maximum length: 127

config footer

Parameter

Description

Type

Size

Default

style

Report footer style.

string

Maximum length: 71

config footer-item

Parameter

Description

Type

Size

Default

id

Report item ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

description

Description.

string

Maximum length: 63

type

Report item type.

option

-

text

Option

Description

text

Text.

image

Image.

style

Report item style.

string

Maximum length: 71

content

Report item text content.

string

Maximum length: 511

img-src

Report item image file name.

string

Maximum length: 127