Fortinet black logo

Administration Guide

CLI for management extensions

CLI for management extensions

You can use the CLI console to enable, disable, update, debug, and check the management extension.

To enable management extensions:
  1. Enable the production registry:

    FAZ-VM64 # config system docker

    (docker)# set status

    enable Enable production registry.

  2. Enable the management application.

    (docker)# set

    fortisoar Enable/disable container.

    fsmcollector Enable/disable container.

Caution

FortiAnalyzer supports FortiSIEM MEA and FortiSOAR MEA. Although you can use the CLI to enable additional management extension applications, they are not supported by FortiAnalyzer. Enabled, unsupported management extension applications are hidden from the FortiAnalyzer GUI, but still consume valuable resources. Be sure to only enable FortiSIEM MEA and/or FortiSOAR MEA on FortiAnalyzer when using the CLI.

To disable management extensions:

config system docker

(docker)# get

(docker)# set {fsmcollector | fortisoar} disable

To debug management extensions:

diagnose debug application docker

To clean up or check management extensions:

diagnose docker {cleanup|status}

To limit CPU and RAM resources for management extensions:

config system docker

(docker)# set cpu <integer> #Set the maximum % of CPU usage (10 - 50, default = 50).

(docker)# set mem <integer> #Set the maximum % of RAM usage (10 - 50, default = 50).

  • The CLI commands allow you to set the resource limit globally for all management extension applications.
  • If management extension applications reach the limit of allocated FortiAnalyzer resource, a warning appears in the Alert Message Console widget.

See also Checking for new versions and upgrading.

CLI for management extensions

You can use the CLI console to enable, disable, update, debug, and check the management extension.

To enable management extensions:
  1. Enable the production registry:

    FAZ-VM64 # config system docker

    (docker)# set status

    enable Enable production registry.

  2. Enable the management application.

    (docker)# set

    fortisoar Enable/disable container.

    fsmcollector Enable/disable container.

Caution

FortiAnalyzer supports FortiSIEM MEA and FortiSOAR MEA. Although you can use the CLI to enable additional management extension applications, they are not supported by FortiAnalyzer. Enabled, unsupported management extension applications are hidden from the FortiAnalyzer GUI, but still consume valuable resources. Be sure to only enable FortiSIEM MEA and/or FortiSOAR MEA on FortiAnalyzer when using the CLI.

To disable management extensions:

config system docker

(docker)# get

(docker)# set {fsmcollector | fortisoar} disable

To debug management extensions:

diagnose debug application docker

To clean up or check management extensions:

diagnose docker {cleanup|status}

To limit CPU and RAM resources for management extensions:

config system docker

(docker)# set cpu <integer> #Set the maximum % of CPU usage (10 - 50, default = 50).

(docker)# set mem <integer> #Set the maximum % of RAM usage (10 - 50, default = 50).

  • The CLI commands allow you to set the resource limit globally for all management extension applications.
  • If management extension applications reach the limit of allocated FortiAnalyzer resource, a warning appears in the Alert Message Console widget.

See also Checking for new versions and upgrading.