Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

config report layout

Note

This command is available for reference model(s) FortiGate 3000D, FortiGate 501E, FortiGate VM64, FortiWiFi 61F. It is not available for FortiGate 140E-POE.

Report layout configuration.

config report layout

Description: Report layout configuration.

edit <name>

set title {string}

set subtitle {string}

set description {string}

set style-theme {string}

set options {option1}, {option2}, ...

set format {option1}, {option2}, ...

set schedule-type [demand|daily|...]

set day [sunday|monday|...]

set time {user}

set cutoff-option [run-time|custom]

set cutoff-time {user}

set email-send [enable|disable]

set email-recipients {string}

set max-pdf-report {integer}

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

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

next

end

config report layout

Parameter

Description

Type

Size

Default

title

Report title.

string

Maximum length: 127

subtitle

Report subtitle.

string

Maximum length: 127

description

Description.

string

Maximum length: 127

style-theme

Report style theme.

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.

format

Report format.

option

-

pdf

 

Option

Description

pdf

PDF.

schedule-type

Report schedule type.

option

-

daily

 

Option

Description

demand

Run on demand.

daily

Schedule daily.

weekly

Schedule weekly.

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.

time

Schedule time to generate report [hh:mm].

user

Not Specified

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 [hh:mm].

user

Not Specified

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.

email-recipients

Email recipients for generated reports.

string

Maximum length: 511

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

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

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

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 body-item

Parameter

Description

Type

Size

Default

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

Number of entries in PDF report.

integer

Minimum value: 0 Maximum value: 1000

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

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 report layout

Note

This command is available for reference model(s) FortiGate 3000D, FortiGate 501E, FortiGate VM64, FortiWiFi 61F. It is not available for FortiGate 140E-POE.

Report layout configuration.

config report layout

Description: Report layout configuration.

edit <name>

set title {string}

set subtitle {string}

set description {string}

set style-theme {string}

set options {option1}, {option2}, ...

set format {option1}, {option2}, ...

set schedule-type [demand|daily|...]

set day [sunday|monday|...]

set time {user}

set cutoff-option [run-time|custom]

set cutoff-time {user}

set email-send [enable|disable]

set email-recipients {string}

set max-pdf-report {integer}

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

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

next

end

config report layout

Parameter

Description

Type

Size

Default

title

Report title.

string

Maximum length: 127

subtitle

Report subtitle.

string

Maximum length: 127

description

Description.

string

Maximum length: 127

style-theme

Report style theme.

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.

format

Report format.

option

-

pdf

 

Option

Description

pdf

PDF.

schedule-type

Report schedule type.

option

-

daily

 

Option

Description

demand

Run on demand.

daily

Schedule daily.

weekly

Schedule weekly.

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.

time

Schedule time to generate report [hh:mm].

user

Not Specified

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 [hh:mm].

user

Not Specified

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.

email-recipients

Email recipients for generated reports.

string

Maximum length: 511

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

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

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

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 body-item

Parameter

Description

Type

Size

Default

description

Description.

string

Maximum length: 63

type

Report item type.

option

-