Fortinet white logo
Fortinet white logo

CLI Reference

config system mqtt-broker

config system mqtt-broker

This command is available for model(s): FortiGateRugged 50G 5G, FortiGateRugged 60F 3G4G, FortiGateRugged 60F Gen2, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiGateRugged 70G 5G Dual, FortiGateRugged 70G.

It is not available for: FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F Gen2, 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 3000F, FortiGate 3001F, FortiGate 300E, FortiGate 301E, FortiGate 30G, FortiGate 31G, FortiGate 3200F, FortiGate 3201F Gen2, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F Gen2, FortiGate 3501F Gen2, FortiGate 3600E, FortiGate 3601E, FortiGate 3700F, FortiGate 3701F, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 401E, FortiGate 401F, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F Gen2, FortiGate 4400F, FortiGate 4401F Gen2, FortiGate 4800F, FortiGate 4801F, FortiGate 500E, FortiGate 501E, 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 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 60F, FortiGate 61F, FortiGate 70F, FortiGate 70G-POE, FortiGate 70G, FortiGate 71F, FortiGate 71G-POE, FortiGate 71G, FortiGate 800D, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F Gen2, FortiGate 80F-POE, FortiGate 81F Gen2, FortiGate 81F-POE, FortiGate 900D, FortiGate 900G, FortiGate 901G, FortiGate 90G Gen2, FortiGate 90G, FortiGate 91G Gen2, FortiGate 91G, FortiGate-VM64 Aliyun, FortiGate-VM64 AWS, FortiGate-VM64 Azure, FortiGate-VM64 GCP, FortiGate-VM64 OPC, FortiGate-VM64, FortiWiFi 30G, FortiWiFi 31G, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 50G 5G, FortiWiFi 50G DSL, FortiWiFi 50G SFP, FortiWiFi 50G, FortiWiFi 51G, FortiWiFi 60F, FortiWiFi 61F, FortiWiFi 70G-POE, FortiWiFi 70G, FortiWiFi 71G, 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.

Configure Message Queuing Telemetry Transport (MQTT) broker for this FortiGate unit.

config system mqtt-broker
    Description: Configure Message Queuing Telemetry Transport (MQTT) broker for this FortiGate unit.
    set anonymous-publish [enable|disable]
    set anonymous-subscribe [enable|disable]
    set authentication [global|client|...]
    set max-clients {integer}
    set max-keepalive {integer}
    set max-queued-messages {integer}
    set password {password}
    set status [enable|disable]
    set tls-authentication [enable|disable]
    set tls-ca {string}
    set tls-certificate {string}
    config topic-list
        Description: Configure topic.
        edit <id>
            set topic {string}
        next
    end
    set username {string}
end

config system mqtt-broker

Parameter

Description

Type

Size

Default

anonymous-publish

Allow anonymous publishing (applicable only when authentication is disabled).

option

-

disable

Option

Description

enable

Enable MQTT broker.

disable

Disable MQTT broker.

anonymous-subscribe

Allow anonymous subscription (applicable only when authentication is disabled).

option

-

disable

Option

Description

enable

Enable MQTT broker.

disable

Disable MQTT broker.

authentication

Enable/disable authentication (default = disabled).

option

-

disable

Option

Description

global

Global authentication.

client

Client authentication.

disable

No authentication.

max-clients

Configure the maximum number of concurrent clients (1 - 10000, default = 1000).

integer

Minimum value: 1 Maximum value: 10000

1000

max-keepalive

Maximum allowed keepalive time in seconds (30 - 65535, default = 3600). Clients specifying a keepalive value exceeding this limit will be disconnected.

integer

Minimum value: 30 Maximum value: 65535

3600

max-queued-messages

Configure the maximum queued message count (0 - 65535, default = 1000). Configure zero for no maximum.

integer

Minimum value: 0 Maximum value: 65535

1000

password

Password to use when global authentication is enabled.

password

Not Specified

status

Enable/disable MQTT broker (default = disabled).

option

-

disable

Option

Description

enable

Enable MQTT broker.

disable

Disable MQTT broker.

tls-authentication

Enable/disable TLS authentication (default = disabled).

option

-

disable

Option

Description

enable

Enable MQTT broker.

disable

Disable MQTT broker.

tls-ca

TLS CA certificate for verifying clients.

string

Maximum length: 79

tls-certificate

TLS certificate for MQTT broker server.

string

Maximum length: 35

username

Username to use when global authentication is enabled.

string

Maximum length: 63

config topic-list

Parameter

Description

Type

Size

Default

id

Unique integer ID of the entry.

integer

Minimum value: 0 Maximum value: 4294967295

0

topic

Topic name.

string

Maximum length: 1024

config system mqtt-broker

config system mqtt-broker

This command is available for model(s): FortiGateRugged 50G 5G, FortiGateRugged 60F 3G4G, FortiGateRugged 60F Gen2, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiGateRugged 70G 5G Dual, FortiGateRugged 70G.

It is not available for: FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F Gen2, 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 3000F, FortiGate 3001F, FortiGate 300E, FortiGate 301E, FortiGate 30G, FortiGate 31G, FortiGate 3200F, FortiGate 3201F Gen2, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F Gen2, FortiGate 3501F Gen2, FortiGate 3600E, FortiGate 3601E, FortiGate 3700F, FortiGate 3701F, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 401E, FortiGate 401F, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F Gen2, FortiGate 4400F, FortiGate 4401F Gen2, FortiGate 4800F, FortiGate 4801F, FortiGate 500E, FortiGate 501E, 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 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 60F, FortiGate 61F, FortiGate 70F, FortiGate 70G-POE, FortiGate 70G, FortiGate 71F, FortiGate 71G-POE, FortiGate 71G, FortiGate 800D, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F Gen2, FortiGate 80F-POE, FortiGate 81F Gen2, FortiGate 81F-POE, FortiGate 900D, FortiGate 900G, FortiGate 901G, FortiGate 90G Gen2, FortiGate 90G, FortiGate 91G Gen2, FortiGate 91G, FortiGate-VM64 Aliyun, FortiGate-VM64 AWS, FortiGate-VM64 Azure, FortiGate-VM64 GCP, FortiGate-VM64 OPC, FortiGate-VM64, FortiWiFi 30G, FortiWiFi 31G, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 50G 5G, FortiWiFi 50G DSL, FortiWiFi 50G SFP, FortiWiFi 50G, FortiWiFi 51G, FortiWiFi 60F, FortiWiFi 61F, FortiWiFi 70G-POE, FortiWiFi 70G, FortiWiFi 71G, 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.

Configure Message Queuing Telemetry Transport (MQTT) broker for this FortiGate unit.

config system mqtt-broker
    Description: Configure Message Queuing Telemetry Transport (MQTT) broker for this FortiGate unit.
    set anonymous-publish [enable|disable]
    set anonymous-subscribe [enable|disable]
    set authentication [global|client|...]
    set max-clients {integer}
    set max-keepalive {integer}
    set max-queued-messages {integer}
    set password {password}
    set status [enable|disable]
    set tls-authentication [enable|disable]
    set tls-ca {string}
    set tls-certificate {string}
    config topic-list
        Description: Configure topic.
        edit <id>
            set topic {string}
        next
    end
    set username {string}
end

config system mqtt-broker

Parameter

Description

Type

Size

Default

anonymous-publish

Allow anonymous publishing (applicable only when authentication is disabled).

option

-

disable

Option

Description

enable

Enable MQTT broker.

disable

Disable MQTT broker.

anonymous-subscribe

Allow anonymous subscription (applicable only when authentication is disabled).

option

-

disable

Option

Description

enable

Enable MQTT broker.

disable

Disable MQTT broker.

authentication

Enable/disable authentication (default = disabled).

option

-

disable

Option

Description

global

Global authentication.

client

Client authentication.

disable

No authentication.

max-clients

Configure the maximum number of concurrent clients (1 - 10000, default = 1000).

integer

Minimum value: 1 Maximum value: 10000

1000

max-keepalive

Maximum allowed keepalive time in seconds (30 - 65535, default = 3600). Clients specifying a keepalive value exceeding this limit will be disconnected.

integer

Minimum value: 30 Maximum value: 65535

3600

max-queued-messages

Configure the maximum queued message count (0 - 65535, default = 1000). Configure zero for no maximum.

integer

Minimum value: 0 Maximum value: 65535

1000

password

Password to use when global authentication is enabled.

password

Not Specified

status

Enable/disable MQTT broker (default = disabled).

option

-

disable

Option

Description

enable

Enable MQTT broker.

disable

Disable MQTT broker.

tls-authentication

Enable/disable TLS authentication (default = disabled).

option

-

disable

Option

Description

enable

Enable MQTT broker.

disable

Disable MQTT broker.

tls-ca

TLS CA certificate for verifying clients.

string

Maximum length: 79

tls-certificate

TLS certificate for MQTT broker server.

string

Maximum length: 35

username

Username to use when global authentication is enabled.

string

Maximum length: 63

config topic-list

Parameter

Description

Type

Size

Default

id

Unique integer ID of the entry.

integer

Minimum value: 0 Maximum value: 4294967295

0

topic

Topic name.

string

Maximum length: 1024