Fortinet white logo
Fortinet white logo

CLI Reference

config telemetry-controller profile

config telemetry-controller profile

Note

This command is available for model(s): FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, FortiGate 120G, FortiGate 121G, FortiGate 1800F, FortiGate 1801F, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 200G, FortiGate 201E, FortiGate 201F, FortiGate 201G, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 3000F, FortiGate 3001F, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3200F, FortiGate 3201F, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F, FortiGate 3501F, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3700F, FortiGate 3701F, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 401E, FortiGate 401F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 5001E1, FortiGate 5001E, FortiGate 500E, FortiGate 501E, FortiGate 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 70F, FortiGate 70G-POE, FortiGate 70G, FortiGate 71F, FortiGate 71G-POE, FortiGate 71G, FortiGate 800D, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F-POE, FortiGate 80F, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 900G, FortiGate 901G, FortiGate 90G, FortiGate 91G, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiGateRugged 70G 5G Dual, FortiWiFi 70G, FortiWiFi 80F 2R 3G4G DSL, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G DSL, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

It is not available for: FortiGate 40F 3G4G, FortiGate 40F, FortiGate 50G 5G, FortiGate 50G DSL, FortiGate 50G SFP-POE, FortiGate 50G SFP, FortiGate 50G, FortiGate 51G 5G, FortiGate 51G SFP-POE, FortiGate 51G, FortiGate 60F, FortiGate 61F, FortiGate-VM64 Aliyun, FortiGate-VM64 AWS, FortiGate-VM64 Azure, FortiGate-VM64 GCP, FortiGate-VM64 OPC, FortiGate-VM64, FortiGateRugged 50G 5G, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 50G 5G, FortiWiFi 50G DSL, FortiWiFi 50G SFP, FortiWiFi 50G, FortiWiFi 51G, FortiWiFi 60F, FortiWiFi 61F.

Configure FortiTelemetry profiles.

config telemetry-controller profile
    Description: Configure FortiTelemetry profiles.
    edit <name>
        config application
            Description: Configure applications.
            edit <id>
                set app-name {string}
                set interval {integer}
                set monitor [enable|disable]
                config sla
                    Description: Service level agreement (SLA).
                    set app-throughput-threshold {integer}
                    set atdt-threshold {integer}
                    set dns-time-threshold {integer}
                    set experience-score-threshold {integer}
                    set failure-rate-threshold {integer}
                    set jitter-threshold {integer}
                    set latency-threshold {integer}
                    set packet-loss-threshold {integer}
                    set sla-factor {option1}, {option2}, ...
                    set tcp-rtt-threshold {integer}
                    set tls-time-threshold {integer}
                    set ttfb-threshold {integer}
                end
            next
        end
        set comment {var-string}
    next
end

config telemetry-controller profile

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

name

Name of the profile.

string

Maximum length: 35

config application

Parameter

Description

Type

Size

Default

app-name

Application name.

string

Maximum length: 79

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

interval

Time in milliseconds to check the application (1000 - 86,400 * 1000, default = 300 * 1000 ms).

integer

Minimum value: 1000 Maximum value: 86400000

300000

monitor

Enable/disable monitoring of the application.

option

-

enable

Option

Description

enable

Enable monitoring of the application.

disable

Disable monitoring of the application.

config sla

Parameter

Description

Type

Size

Default

app-throughput-threshold

Threshold of application throughput in megabytes (0 - 10,000, default = 2 MB).

integer

Minimum value: 0 Maximum value: 10000

2

atdt-threshold

Threshold of application total downloading time in milliseconds (0 - 10,000,000, default = 3,000 ms).

integer

Minimum value: 0 Maximum value: 10000000

3000

dns-time-threshold

Threshold of 95th percentile of DNS resolution time in milliseconds (0 - 10,000,000, default = 100 ms).

integer

Minimum value: 0 Maximum value: 10000000

100

experience-score-threshold

Threshold of experience score (0 - 10, default = 6).

integer

Minimum value: 0 Maximum value: 10

6

failure-rate-threshold

Threshold of failure rate (0 - 100, default = 5 percentage).

integer

Minimum value: 0 Maximum value: 100

5

jitter-threshold

Threshold of jitter in milliseconds (0 - 10,000,000, default = 50 ms).

integer

Minimum value: 0 Maximum value: 10000000

50

latency-threshold

Threshold of latency in milliseconds (0 - 10,000,000, default = 100 ms).

integer

Minimum value: 0 Maximum value: 10000000

100

packet-loss-threshold

Threshold of packet loss (0 - 100, default = 5 percentage).

integer

Minimum value: 0 Maximum value: 100

5

sla-factor

Criteria on which metric to SLA threshold list.

option

-

Option

Description

experience-score

Select SLA target based on experience score.

failure-rate

Select SLA target based on failure rate.

latency

Select SLA target based on latency.

jitter

Select SLA target based on jitter.

packet-loss

Select SLA target based on packet loss.

ttfb

Select SLA target based on time to first byte.

atdt

Select SLA target based on application total downloading time.

tcp-rtt

Select SLA target based on TCP round-trip time.

dns-time

Select SLA target based on DNS resolution time.

tls-time

Select SLA target based on TLS handshake time.

app-throughput

Select SLA target based on application throughput.

tcp-rtt-threshold

Threshold of TCP round-trip time in milliseconds (0 - 10,000,000, default = 100 ms).

integer

Minimum value: 0 Maximum value: 10000000

100

tls-time-threshold

Threshold of 95th percentile of TLS handshake time in milliseconds (0 - 10,000,000, default = 200 ms).

integer

Minimum value: 0 Maximum value: 10000000

200

ttfb-threshold

Threshold of time to first byte in milliseconds (0 - 10,000,000, default = 200 ms).

integer

Minimum value: 0 Maximum value: 10000000

200

config telemetry-controller profile

config telemetry-controller profile

Note

This command is available for model(s): FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, FortiGate 120G, FortiGate 121G, FortiGate 1800F, FortiGate 1801F, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 200G, FortiGate 201E, FortiGate 201F, FortiGate 201G, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 3000F, FortiGate 3001F, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3200F, FortiGate 3201F, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F, FortiGate 3501F, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3700F, FortiGate 3701F, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 401E, FortiGate 401F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 5001E1, FortiGate 5001E, FortiGate 500E, FortiGate 501E, FortiGate 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 70F, FortiGate 70G-POE, FortiGate 70G, FortiGate 71F, FortiGate 71G-POE, FortiGate 71G, FortiGate 800D, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F-POE, FortiGate 80F, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 900G, FortiGate 901G, FortiGate 90G, FortiGate 91G, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiGateRugged 70G 5G Dual, FortiWiFi 70G, FortiWiFi 80F 2R 3G4G DSL, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G DSL, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

It is not available for: FortiGate 40F 3G4G, FortiGate 40F, FortiGate 50G 5G, FortiGate 50G DSL, FortiGate 50G SFP-POE, FortiGate 50G SFP, FortiGate 50G, FortiGate 51G 5G, FortiGate 51G SFP-POE, FortiGate 51G, FortiGate 60F, FortiGate 61F, FortiGate-VM64 Aliyun, FortiGate-VM64 AWS, FortiGate-VM64 Azure, FortiGate-VM64 GCP, FortiGate-VM64 OPC, FortiGate-VM64, FortiGateRugged 50G 5G, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 50G 5G, FortiWiFi 50G DSL, FortiWiFi 50G SFP, FortiWiFi 50G, FortiWiFi 51G, FortiWiFi 60F, FortiWiFi 61F.

Configure FortiTelemetry profiles.

config telemetry-controller profile
    Description: Configure FortiTelemetry profiles.
    edit <name>
        config application
            Description: Configure applications.
            edit <id>
                set app-name {string}
                set interval {integer}
                set monitor [enable|disable]
                config sla
                    Description: Service level agreement (SLA).
                    set app-throughput-threshold {integer}
                    set atdt-threshold {integer}
                    set dns-time-threshold {integer}
                    set experience-score-threshold {integer}
                    set failure-rate-threshold {integer}
                    set jitter-threshold {integer}
                    set latency-threshold {integer}
                    set packet-loss-threshold {integer}
                    set sla-factor {option1}, {option2}, ...
                    set tcp-rtt-threshold {integer}
                    set tls-time-threshold {integer}
                    set ttfb-threshold {integer}
                end
            next
        end
        set comment {var-string}
    next
end

config telemetry-controller profile

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

name

Name of the profile.

string

Maximum length: 35

config application

Parameter

Description

Type

Size

Default

app-name

Application name.

string

Maximum length: 79

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

interval

Time in milliseconds to check the application (1000 - 86,400 * 1000, default = 300 * 1000 ms).

integer

Minimum value: 1000 Maximum value: 86400000

300000

monitor

Enable/disable monitoring of the application.

option

-

enable

Option

Description

enable

Enable monitoring of the application.

disable

Disable monitoring of the application.

config sla

Parameter

Description

Type

Size

Default

app-throughput-threshold

Threshold of application throughput in megabytes (0 - 10,000, default = 2 MB).

integer

Minimum value: 0 Maximum value: 10000

2

atdt-threshold

Threshold of application total downloading time in milliseconds (0 - 10,000,000, default = 3,000 ms).

integer

Minimum value: 0 Maximum value: 10000000

3000

dns-time-threshold

Threshold of 95th percentile of DNS resolution time in milliseconds (0 - 10,000,000, default = 100 ms).

integer

Minimum value: 0 Maximum value: 10000000

100

experience-score-threshold

Threshold of experience score (0 - 10, default = 6).

integer

Minimum value: 0 Maximum value: 10

6

failure-rate-threshold

Threshold of failure rate (0 - 100, default = 5 percentage).

integer

Minimum value: 0 Maximum value: 100

5

jitter-threshold

Threshold of jitter in milliseconds (0 - 10,000,000, default = 50 ms).

integer

Minimum value: 0 Maximum value: 10000000

50

latency-threshold

Threshold of latency in milliseconds (0 - 10,000,000, default = 100 ms).

integer

Minimum value: 0 Maximum value: 10000000

100

packet-loss-threshold

Threshold of packet loss (0 - 100, default = 5 percentage).

integer

Minimum value: 0 Maximum value: 100

5

sla-factor

Criteria on which metric to SLA threshold list.

option

-

Option

Description

experience-score

Select SLA target based on experience score.

failure-rate

Select SLA target based on failure rate.

latency

Select SLA target based on latency.

jitter

Select SLA target based on jitter.

packet-loss

Select SLA target based on packet loss.

ttfb

Select SLA target based on time to first byte.

atdt

Select SLA target based on application total downloading time.

tcp-rtt

Select SLA target based on TCP round-trip time.

dns-time

Select SLA target based on DNS resolution time.

tls-time

Select SLA target based on TLS handshake time.

app-throughput

Select SLA target based on application throughput.

tcp-rtt-threshold

Threshold of TCP round-trip time in milliseconds (0 - 10,000,000, default = 100 ms).

integer

Minimum value: 0 Maximum value: 10000000

100

tls-time-threshold

Threshold of 95th percentile of TLS handshake time in milliseconds (0 - 10,000,000, default = 200 ms).

integer

Minimum value: 0 Maximum value: 10000000

200

ttfb-threshold

Threshold of time to first byte in milliseconds (0 - 10,000,000, default = 200 ms).

integer

Minimum value: 0 Maximum value: 10000000

200