Fortinet black logo

CLI Reference

camera

camera

Use this command to configure FortiRecorder camera settings.

This command is only available on hardware-based FortiAnalyzer models.

camera devices

Configure camera information. The available options will vary depending on the camera model selected.

Syntax

config fortirecorder camera devices

edit <device>

set addr <string>

set address-mode wired

set alarm-post <integer>

set alarm-pre <integer>

set audio-bitrate <integer>

set audio-codec <string>

set audio-detect-sensitivity

set audio-input {default | line | mic}

set audio-input-level <integer>

set audio-output

set audio-output-echo-cancel

set audio-output-level <integer>

set audio-output-mute

set audio-samplerate <integer>

set camera-type managed

set comm-http-port <integer>

set comm-https-port <integer>

set comm-type {http | https}

set digital-input

set digital-output

set exposure-environment

set exposure-gain-max

set exposure-shutter-min {2 | 4 | 8 | 15 | 30}

set exposure-wdr-digital {on | off | 1 | 2 | 3}

set exposure-wdr-shutter {off | 1 | 2}

set fw-version

set image-digital-zoom

set image-dis

set image-dnr {on | off}

set image-dnr-level

set index

set infrared-disable-threshold <integer>

set infrared-dwell-time

set infrared-enable-threshold <integer>

set infrared-led {auto | off}

set infrared-led-intensity {auto | fixed}

set infrared-led-level

set infrared-mode {auto | off}

set light-detection

set light-disable-threshold

set light-dwell-time

set light-enable-threshold

set light-mode

set location <string>

set login-password

set mac

set model-name <model>

set move-home

set move-home-delay <integer>

set move-home-pan

set move-home-tilt

set move-home-zoom

set operator-password

set overlay-mode {off | name time-date gmt}

set pir-sensitivity

set port <integer>

set privacy-button

set profile <string>

set push-config

set ready

set status {enable | disable}

set status-led

set tamper-detect-sensitivity

set transport-http-port <integer>

set transport-https-port <integer>

set transport-tcp-port <integer>

set transport-type {http | tcp | udp}

set transport-udp-port <integer>

set unready-state

set unready-state-detail

set vendor-name

set video-aspect {sd | hd}

set video-brightness <integer>

set video-contrast <integer>

set video-orientation {normal | vertical | horizontal | rotate-90 | rotate-180 | rotate-270}

set video-saturation <integer>

set video-sharpness <integer>

set view-angle

set wired-addr <ip4|ip6>

set wired-gateway <ip4|ip6>

set wired-mode {dhcp | static}

set wired-netmask <ip4|ip6>

set wired-primary-dns <ip4|ip6>

set wired-secondary-dns <ip4|ip6>

set zoom

config motion

edit <motion>

set motion-pixel <integer>

set motion-sensitivity <integer>

set motion-top <integer>

set motion-left <integer>

set motion-bottom <integer>

set motion-right <integer>

next

end

config mask

edit <mask>

set mask-top <integer>

set mask-left <integer>

set mask-bottom <integer>

set mask-right <integer>

next

end

config ptz-presets

edit <preset>

set pan <integer>

set tilt <integer>

set zoom <integer>

next

end

next

end

Variable

Description

<device>

Enter the name of the device you need to edit.

addr <string> The camera address as configured on the camera.

address-mode wired

How that camera is reached.

alarm-post <integer>

Set the capture time after an alarm, in seconds (0 - 300, default = 30).

alarm-pre <integer>

Set the capture time before an alarm, in seconds (0 - 10, default = 10).

audio-bitrate <integer>

Set the audio bitrate (default = 64000). This option is only available for camera models that have audio capabilities.

audio-codec <string>

Set the audio codec. This option is only available for camera models that have audio capabilities.

audio-detect-sensitivity

audio-input {default | line | mic}

Set the audio input source. This option is only available for camera models that have audio input capabilities.

audio-input-level <integer>

Set the audio input level (1 - 100, default = 60). This option is only available for camera models that have audio input capabilities.

audio-output

audio-output-echo-cancel

audio-output-level <integer>

Set the audio output level (1 - 100, default = 60). This option is only available for camera models that have audio output capabilities.

audio-output-mute

audio-samplerate <integer>

Set the audio sample rate. This option is only available for camera models that have audio capabilities.

camera-type managed

The camera type.

comm-http-port <integer>

Set the command HTTP port (0 - 65535, default = 0).

comm-https-port <integer>

Set the command HTTPS port (0 - 65535, default = 0).

comm-type {http | https}

Set the command protocol (default = http).

digital-input

digital-output

exposure-environment

exposure-gain-max

exposure-shutter-min {2 | 4 | 8 | 15 | 30}

Set the minimum shutter speed.

  • 2: 1/2 seconds (default)
  • 4: 1/4 seconds
  • 8: 1/8 seconds
  • 15: 1/15 seconds
  • 30: 1/30 seconds

exposure-wdr-digital {on | off | 1 | 2 | 3}

Turn on/off exposure digital wide dynamic, or set its value (default = off). The available options depend on the camera model.

exposure-wdr-shutter {off | 1 | 2}

Set the exposure digital wide dynamic shutter speed (default = off).

fw-version

image-digital-zoom

image-dis

image-dnr {on | off}

Turn on/off image digital noise reduction (default = off).

image-dnr-level

index

infrared-disable-threshold <integer>

Set the infrared disable threshold (0 - 100, default = 15)

infrared-dwell-time

infrared-enable-threshold <integer>

Set the infrared enable threshold (0 - 100, default = 5)

infrared-led {auto | off}

Set the infrared LED status (default = auto).

infrared-led-intensity {auto | fixed}

Set the infrared LED intensity (default = auto).

infrared-led-level

infrared-mode {auto | off}

Configure infrared mode (default = auto). The available options depend on the camera model.

light-detection

light-disable-threshold

light-dwell-time

light-enable-threshold

light-mode

location <string>

Set the camera location.

login-password

mac

model-name <model>

Set the camera model name.

move-home

move-home-delay <integer>

Set the amount of time of inactivity before the camera moves to its home position, in minutes (1 - 60, default = 5).

move-home-pan

move-home-tilt

move-home-zoom

operator-password

overlay-mode {off | name time-date gmt}

Set the text overlay mode (default = name time-date gmt}.

pir-sensitivity
port <integer> Set the camera command port (0 - 65535, default = 0).

privacy-button

profile <string>

Set the camera profile.

push-config

ready

status {enable | disable}

Enable/disable the camera (default = enable).

status-led

tamper-detect-sensitivity

transport-http-port <integer>

Set the HTTP transport port (0 - 65535, default = 0).

transport-https-port <integer>

Set the HTTPS transport port (0 - 65535, default = 0).

transport-tcp-port <integer>

Set the TCP transport port (0 - 65535, default = 0).

transport-type {http | https | tcp | udp}

Set the transport type to get media from the camera. The available options will vary depending on the camera model.

transport-udp-port <integer>

Set the UDP transport port (0 - 65535, default = 0).

unready-state

unready-state-detail

vendor-name

video-aspect {sd | hd}

Set the video aspect ration. The available options will vary depending on the camera model.

video-brightness <integer>

Set the video brightness (0 - 100, default = 50).

video-contrast <integer>

Set the video contrast (0 - 100, default = 50).

video-orientation {normal | vertical | horizontal | rotate-90 | rotate-180 | rotate-270}

Set the video orientation (default = normal).

video-saturation <integer>

Set the video saturation (0 - 100, default = 50).

video-sharpness <integer>

Set the video sharpness (0 - 100, default = 50).

view-angle

wired-addr <ip4|ip6>

Set the camera IP address. This option is only available when address-mode is wired and wired-mode is static.

wired-gateway <ip4|ip6>

Set the camera gateway. This option is only available when address-mode is wired and wired-mode is static.

wired-mode {dhcp | static}

Set the IP address assignment mode (default = dhcp).

wired-netmask <ip4|ip6>

Set the camera netmask. This option is only available when address-mode is wired and wired-mode is static.

wired-primary-dns <ip4|ip6> Set the primary DNS. This option is only available when address-mode is wired and wired-mode is static.
wired-secondary-dns <ip4|ip6> Set the secondary DNS. This option is only available when address-mode is wired and wired-mode is static.

zoom

Variables for config motion subcommand:

<motion>

Enter the motion number (0 - 100).

motion-pixel <integer>

Set the pixel percentage change for motion detection (0 - 100, default = 10).

motion-sensitivity <integer>

Set the sensitivity for motion detection (0 - 100, default = 80).

motion-top <integer>

Set the top percentage of the motion detection window (0 - 100, default = 0).

motion-left <integer>

Set the left percentage of the motion detection window (0 - 100, default = 0).

motion-bottom <integer>

Set the bottom percentage of the motion detection window (0 - 100, default = 100).

motion-right <integer>

Set the right percentage of the motion detection window (0 - 100, default = 100).

Variables for config mask subcommand:

<mask> Enter the mask number (0 - 100).

mask-top <integer>

Set the top percentage of privacy mask (0 - 100, default = 0).
mask-left <integer> Set the left percentage of privacy mask (0 - 100, default = 0).

mask-bottom <integer>

Set the bottom percentage of privacy mask (0 - 100, default = 100).

mask-right <integer>

Set the right percentage of privacy mask (0 - 100, default = 100).

Variables for config ptz-presets subcommand:

<preset>

Enter the preset name.

pan <integer>

Set the pan value (default = 0).

tilt <integer>

Set the pan value (default = 0).

zoom <integer>

Set the pan value (default = 0).

camera profile

Configure camera profiles.

Syntax

config fortirecorder camera profile

edit <profile>

set continuous-retention-disposition {delete | keep}

set continuous-retention-period <integer>

set continuous-retention-period-units {days | hours | weeks | months | years}

set detection-retention-disposition {delete | keep | virtual}

set detection-retention-period <integer>

set detection-retention-period-units {days | hours | weeks | months | years}

config recording-schedule

edit <schedule>

set record-type {continuous motion-detect | none}

set store-on

set temporary-stream-for-video-clips {if-needed | no | yes}

next

end

config video-schedule

edit <schedule>

set recording-stream <string>

set viewing-stream <string>

next

end

next

end

Variable

Description

<profile>

Enter the profile name of the entry you need to edit or type a new name to create a new profile (character limit = 127).

continuous-retention-disposition {delete | keep}

Keep or delete continuous recordings (default = keep).

continuous-retention-period <integer>

The period to keep continuous recordings (0 = forever, default = 1). This option is only available when continuous-retention-disposition is delete.

continuous-retention-period-units {days | hours | weeks | months | years}

The period unit for continuous recording retention (default = months). This option is only available when continuous-retention-disposition is delete.

detection-retention-disposition {delete | keep | virtual}

Keep or delete detection recordings (default = keep).

detection-retention-period <integer>

The period to keep detection recordings (0 = forever, default = 1). This option is only available when detection-retention-disposition is delete.

detection-retention-period-units {days | hours | weeks | months | years}

The period unit for detection recording retention (default = months). This option is only available when detection-retention-disposition is delete.

Variables for config recording-schedule subcommand:

<schedule>

Select a schedule. To create a schedule use the config fortirecorder schedule command.

record-type {continuous motion-detect | none}

Set the recording type (default = continuous).

store-on

temporary-stream-for-video-clips {if-needed | no | yes}

Use a temporary stream for video clip creation (default = if-needed).

Variables for config video-schedule subcommand:

<schedule>

Select a schedule. To create a schedule use the config fortirecorder schedule command.

recording-stream <string>

Select the video profile for the recording stream.

viewing-stream <string>

Select the video profile for the viewing stream.

camera video

Configure camera video profiles.

Syntax

config fortirecorder camera video profile

edit <profile>

set audio {enable | disable}

set video-bitrate-mode {fixed | variable}

set video-codec {default | h264 | h265}

set video-fps <integer>

set video-quality {extra-high | high | normal | low | extra-low}

set video-resolution {1mp | 2mp | 3mp | 4mp | 5mp | 6mp | extra-high | half_mp | high | low | medium}

next

end

Variable

Description

audio {enable | disable}

Enable/disable audio (default = disable).

video-bitrate-mode {fixed | variable}

Set the bitrate mode (default = variable).

video-codec {default | h264 | h265}

Set the video codec (default = default).

video-fps <integer>

Set the frames per second (FPS) of the video (1 - 60, default = 30).

video-quality {extra-high | high | normal | low | extra-low}

Set the video quality (default = extra-high).

video-resolution {1mp | 2mp | 3mp | 4mp | 5mp | 6mp | extra-high | half_mp | high | low | medium}

Set the video resolution (default = medium).

camera

Use this command to configure FortiRecorder camera settings.

This command is only available on hardware-based FortiAnalyzer models.

camera devices

Configure camera information. The available options will vary depending on the camera model selected.

Syntax

config fortirecorder camera devices

edit <device>

set addr <string>

set address-mode wired

set alarm-post <integer>

set alarm-pre <integer>

set audio-bitrate <integer>

set audio-codec <string>

set audio-detect-sensitivity

set audio-input {default | line | mic}

set audio-input-level <integer>

set audio-output

set audio-output-echo-cancel

set audio-output-level <integer>

set audio-output-mute

set audio-samplerate <integer>

set camera-type managed

set comm-http-port <integer>

set comm-https-port <integer>

set comm-type {http | https}

set digital-input

set digital-output

set exposure-environment

set exposure-gain-max

set exposure-shutter-min {2 | 4 | 8 | 15 | 30}

set exposure-wdr-digital {on | off | 1 | 2 | 3}

set exposure-wdr-shutter {off | 1 | 2}

set fw-version

set image-digital-zoom

set image-dis

set image-dnr {on | off}

set image-dnr-level

set index

set infrared-disable-threshold <integer>

set infrared-dwell-time

set infrared-enable-threshold <integer>

set infrared-led {auto | off}

set infrared-led-intensity {auto | fixed}

set infrared-led-level

set infrared-mode {auto | off}

set light-detection

set light-disable-threshold

set light-dwell-time

set light-enable-threshold

set light-mode

set location <string>

set login-password

set mac

set model-name <model>

set move-home

set move-home-delay <integer>

set move-home-pan

set move-home-tilt

set move-home-zoom

set operator-password

set overlay-mode {off | name time-date gmt}

set pir-sensitivity

set port <integer>

set privacy-button

set profile <string>

set push-config

set ready

set status {enable | disable}

set status-led

set tamper-detect-sensitivity

set transport-http-port <integer>

set transport-https-port <integer>

set transport-tcp-port <integer>

set transport-type {http | tcp | udp}

set transport-udp-port <integer>

set unready-state

set unready-state-detail

set vendor-name

set video-aspect {sd | hd}

set video-brightness <integer>

set video-contrast <integer>

set video-orientation {normal | vertical | horizontal | rotate-90 | rotate-180 | rotate-270}

set video-saturation <integer>

set video-sharpness <integer>

set view-angle

set wired-addr <ip4|ip6>

set wired-gateway <ip4|ip6>

set wired-mode {dhcp | static}

set wired-netmask <ip4|ip6>

set wired-primary-dns <ip4|ip6>

set wired-secondary-dns <ip4|ip6>

set zoom

config motion

edit <motion>

set motion-pixel <integer>

set motion-sensitivity <integer>

set motion-top <integer>

set motion-left <integer>

set motion-bottom <integer>

set motion-right <integer>

next

end

config mask

edit <mask>

set mask-top <integer>

set mask-left <integer>

set mask-bottom <integer>

set mask-right <integer>

next

end

config ptz-presets

edit <preset>

set pan <integer>

set tilt <integer>

set zoom <integer>

next

end

next

end

Variable

Description

<device>

Enter the name of the device you need to edit.

addr <string> The camera address as configured on the camera.

address-mode wired

How that camera is reached.

alarm-post <integer>

Set the capture time after an alarm, in seconds (0 - 300, default = 30).

alarm-pre <integer>

Set the capture time before an alarm, in seconds (0 - 10, default = 10).

audio-bitrate <integer>

Set the audio bitrate (default = 64000). This option is only available for camera models that have audio capabilities.

audio-codec <string>

Set the audio codec. This option is only available for camera models that have audio capabilities.

audio-detect-sensitivity

audio-input {default | line | mic}

Set the audio input source. This option is only available for camera models that have audio input capabilities.

audio-input-level <integer>

Set the audio input level (1 - 100, default = 60). This option is only available for camera models that have audio input capabilities.

audio-output

audio-output-echo-cancel

audio-output-level <integer>

Set the audio output level (1 - 100, default = 60). This option is only available for camera models that have audio output capabilities.

audio-output-mute

audio-samplerate <integer>

Set the audio sample rate. This option is only available for camera models that have audio capabilities.

camera-type managed

The camera type.

comm-http-port <integer>

Set the command HTTP port (0 - 65535, default = 0).

comm-https-port <integer>

Set the command HTTPS port (0 - 65535, default = 0).

comm-type {http | https}

Set the command protocol (default = http).

digital-input

digital-output

exposure-environment

exposure-gain-max

exposure-shutter-min {2 | 4 | 8 | 15 | 30}

Set the minimum shutter speed.

  • 2: 1/2 seconds (default)
  • 4: 1/4 seconds
  • 8: 1/8 seconds
  • 15: 1/15 seconds
  • 30: 1/30 seconds

exposure-wdr-digital {on | off | 1 | 2 | 3}

Turn on/off exposure digital wide dynamic, or set its value (default = off). The available options depend on the camera model.

exposure-wdr-shutter {off | 1 | 2}

Set the exposure digital wide dynamic shutter speed (default = off).

fw-version

image-digital-zoom

image-dis

image-dnr {on | off}

Turn on/off image digital noise reduction (default = off).

image-dnr-level

index

infrared-disable-threshold <integer>

Set the infrared disable threshold (0 - 100, default = 15)

infrared-dwell-time

infrared-enable-threshold <integer>

Set the infrared enable threshold (0 - 100, default = 5)

infrared-led {auto | off}

Set the infrared LED status (default = auto).

infrared-led-intensity {auto | fixed}

Set the infrared LED intensity (default = auto).

infrared-led-level

infrared-mode {auto | off}

Configure infrared mode (default = auto). The available options depend on the camera model.

light-detection

light-disable-threshold

light-dwell-time

light-enable-threshold

light-mode

location <string>

Set the camera location.

login-password

mac

model-name <model>

Set the camera model name.

move-home

move-home-delay <integer>

Set the amount of time of inactivity before the camera moves to its home position, in minutes (1 - 60, default = 5).

move-home-pan

move-home-tilt

move-home-zoom

operator-password

overlay-mode {off | name time-date gmt}

Set the text overlay mode (default = name time-date gmt}.

pir-sensitivity
port <integer> Set the camera command port (0 - 65535, default = 0).

privacy-button

profile <string>

Set the camera profile.

push-config

ready

status {enable | disable}

Enable/disable the camera (default = enable).

status-led

tamper-detect-sensitivity

transport-http-port <integer>

Set the HTTP transport port (0 - 65535, default = 0).

transport-https-port <integer>

Set the HTTPS transport port (0 - 65535, default = 0).

transport-tcp-port <integer>

Set the TCP transport port (0 - 65535, default = 0).

transport-type {http | https | tcp | udp}

Set the transport type to get media from the camera. The available options will vary depending on the camera model.

transport-udp-port <integer>

Set the UDP transport port (0 - 65535, default = 0).

unready-state

unready-state-detail

vendor-name

video-aspect {sd | hd}

Set the video aspect ration. The available options will vary depending on the camera model.

video-brightness <integer>

Set the video brightness (0 - 100, default = 50).

video-contrast <integer>

Set the video contrast (0 - 100, default = 50).

video-orientation {normal | vertical | horizontal | rotate-90 | rotate-180 | rotate-270}

Set the video orientation (default = normal).

video-saturation <integer>

Set the video saturation (0 - 100, default = 50).

video-sharpness <integer>

Set the video sharpness (0 - 100, default = 50).

view-angle

wired-addr <ip4|ip6>

Set the camera IP address. This option is only available when address-mode is wired and wired-mode is static.

wired-gateway <ip4|ip6>

Set the camera gateway. This option is only available when address-mode is wired and wired-mode is static.

wired-mode {dhcp | static}

Set the IP address assignment mode (default = dhcp).

wired-netmask <ip4|ip6>

Set the camera netmask. This option is only available when address-mode is wired and wired-mode is static.

wired-primary-dns <ip4|ip6> Set the primary DNS. This option is only available when address-mode is wired and wired-mode is static.
wired-secondary-dns <ip4|ip6> Set the secondary DNS. This option is only available when address-mode is wired and wired-mode is static.

zoom

Variables for config motion subcommand:

<motion>

Enter the motion number (0 - 100).

motion-pixel <integer>

Set the pixel percentage change for motion detection (0 - 100, default = 10).

motion-sensitivity <integer>

Set the sensitivity for motion detection (0 - 100, default = 80).

motion-top <integer>

Set the top percentage of the motion detection window (0 - 100, default = 0).

motion-left <integer>

Set the left percentage of the motion detection window (0 - 100, default = 0).

motion-bottom <integer>

Set the bottom percentage of the motion detection window (0 - 100, default = 100).

motion-right <integer>

Set the right percentage of the motion detection window (0 - 100, default = 100).

Variables for config mask subcommand:

<mask> Enter the mask number (0 - 100).

mask-top <integer>

Set the top percentage of privacy mask (0 - 100, default = 0).
mask-left <integer> Set the left percentage of privacy mask (0 - 100, default = 0).

mask-bottom <integer>

Set the bottom percentage of privacy mask (0 - 100, default = 100).

mask-right <integer>

Set the right percentage of privacy mask (0 - 100, default = 100).

Variables for config ptz-presets subcommand:

<preset>

Enter the preset name.

pan <integer>

Set the pan value (default = 0).

tilt <integer>

Set the pan value (default = 0).

zoom <integer>

Set the pan value (default = 0).

camera profile

Configure camera profiles.

Syntax

config fortirecorder camera profile

edit <profile>

set continuous-retention-disposition {delete | keep}

set continuous-retention-period <integer>

set continuous-retention-period-units {days | hours | weeks | months | years}

set detection-retention-disposition {delete | keep | virtual}

set detection-retention-period <integer>

set detection-retention-period-units {days | hours | weeks | months | years}

config recording-schedule

edit <schedule>

set record-type {continuous motion-detect | none}

set store-on

set temporary-stream-for-video-clips {if-needed | no | yes}

next

end

config video-schedule

edit <schedule>

set recording-stream <string>

set viewing-stream <string>

next

end

next

end

Variable

Description

<profile>

Enter the profile name of the entry you need to edit or type a new name to create a new profile (character limit = 127).

continuous-retention-disposition {delete | keep}

Keep or delete continuous recordings (default = keep).

continuous-retention-period <integer>

The period to keep continuous recordings (0 = forever, default = 1). This option is only available when continuous-retention-disposition is delete.

continuous-retention-period-units {days | hours | weeks | months | years}

The period unit for continuous recording retention (default = months). This option is only available when continuous-retention-disposition is delete.

detection-retention-disposition {delete | keep | virtual}

Keep or delete detection recordings (default = keep).

detection-retention-period <integer>

The period to keep detection recordings (0 = forever, default = 1). This option is only available when detection-retention-disposition is delete.

detection-retention-period-units {days | hours | weeks | months | years}

The period unit for detection recording retention (default = months). This option is only available when detection-retention-disposition is delete.

Variables for config recording-schedule subcommand:

<schedule>

Select a schedule. To create a schedule use the config fortirecorder schedule command.

record-type {continuous motion-detect | none}

Set the recording type (default = continuous).

store-on

temporary-stream-for-video-clips {if-needed | no | yes}

Use a temporary stream for video clip creation (default = if-needed).

Variables for config video-schedule subcommand:

<schedule>

Select a schedule. To create a schedule use the config fortirecorder schedule command.

recording-stream <string>

Select the video profile for the recording stream.

viewing-stream <string>

Select the video profile for the viewing stream.

camera video

Configure camera video profiles.

Syntax

config fortirecorder camera video profile

edit <profile>

set audio {enable | disable}

set video-bitrate-mode {fixed | variable}

set video-codec {default | h264 | h265}

set video-fps <integer>

set video-quality {extra-high | high | normal | low | extra-low}

set video-resolution {1mp | 2mp | 3mp | 4mp | 5mp | 6mp | extra-high | half_mp | high | low | medium}

next

end

Variable

Description

audio {enable | disable}

Enable/disable audio (default = disable).

video-bitrate-mode {fixed | variable}

Set the bitrate mode (default = variable).

video-codec {default | h264 | h265}

Set the video codec (default = default).

video-fps <integer>

Set the frames per second (FPS) of the video (1 - 60, default = 30).

video-quality {extra-high | high | normal | low | extra-low}

Set the video quality (default = extra-high).

video-resolution {1mp | 2mp | 3mp | 4mp | 5mp | 6mp | extra-high | half_mp | high | low | medium}

Set the video resolution (default = medium).