Jump to:navigation, search
Wiki






































Syntax of the CLI command system

Last adaptation to the version: 14.0.0(11.2024)

New:
  • New Traceroute parameters: source_addr and source
  • Extensive completion of commands
  • Layout adjustment
notempty
This article refers to a Beta version
Access: UTM-IP:Port or UTM-URL:Port
Port as configured at Network / Appliance Settings / Webserver
Default-Port: 11115
i.e.: https://utm.ttt-point.de:11115
Default: https://192.168.175.1:11115
Extras CLI


System

Command Parameters Description Example

system date

system date get

system date get
Display the current system time system date get

system date set

system date set
Change system time and date system date set date "2013-10-21 15:48:52"
date New date (“YYYY-MM-DD hh:mm:ss”)

system info

system info
Displays system information system info

system supportinfo

system supportinfo
system supportinfo

system specs

system specs
system specs

system features

system features
Shows whether the system features http-proxy-Statistics, wifi and umts are enabled or disabled system features

system register

system register
Registers a new license on the UTM
After executing the command, the license key, which can be copied from the .pem file, must be copied into the CLI. Then, press STRG + D to exit.
system register Return

Insert license Return
Ctrl + D

system reboot

system reboot
Reboots the system system reboot

system poweroff

system poweroff

system poweroff
Shutting down the system system poweroff

system restrictions

system restrictions get

system restrictions get
system restrictions get

system restrictions update

system restrictions update
system restrictions update

system config

system config load

system config load
Loads a configuration system config load name "configname"
name Name of a configuration

system config load_dryrun

system config load_dryrun
system config load_dryrun name "configname"
name Name of a configuration

system config save

system config save
Saves a configuration system config save name "configname"
name Name of a configuration

system config new

system config new
Creates a new configuration system config new name "new_config"
name Name of the new configuration

system config clone

system config clone
Clones/copies a configuration system config clone name "configname" new_name "new_config"
name Name of a configuration
new_name Name of the cloned configuration

system config delete

system config delete
Deletes a configuration system config delete name "configname"
name Name of a configuration

system config set

system config set
Changes the boot configuration system config set name "configname"
name Name of a configuration

system config setup

system config setup
  • Don't use, internal command
  • system config get

    system config get
    Listing of the existing configurations system config get

    system config export

    system config export
    Exports a configuration in form of a download key
    After screen output copy this key into a text file
    system config export name "configname"
    name Name of a configuration

    system config import

    system config import
    Funktioniert derzeit in der CLI nicht, bitte über das Webinterface importieren

    system config factorysettings

    system config factorysettings
    Sets a configuration to factory setting system config factorysettings

    system config report

    system config report
    Generates a system report in pdf format
    Saved at /var/www/admin/private
    system config report

    system config otpexport

    system config otpexport
    Generates a list of OTP Secrets in pdf format
    Saved under /var/www/admin/private
    system config otpexport

    system config xmlreport

    system config xmlreport
    Output of the current configuration in XML format system config xmlreport

    system config synchronize

    system config synchronize
    Synchronizes the configurations between the devices operating in the cluster system config synchronize

    system config synchronize_dryrun

    system config synchronize_dryrun
    system config synchronize_dryrun

    system update

    system update system

    system update system
    Update System Settings system update system

    system update interface

    system update interface
    Updates network interfaces system update interface

    system update rule

    system update rule
    Updates rules system update rule

    system update route

    system update route
    Updates routes system update route

    system update qos

    system update qos
    Update QoS system update qos

    system update tif

    system update tif
    Updated Threat Intelligence Filter system update tif

    system lsrrd

    system lsrrd
    Listing of the RRD files system lsrrd

    system rrd refresh

    system rrd refresh

    system rrd refresh
    system rrd refresh

    system contentfilter

    system contentfilter categorize

    system contentfilter categorize
    Output of the category of a url for the content filter system contentfilter categorize url www.clamav.com
    url

    system contentfilter get

    system contentfilter get
    Listing ID/Names of the categories system contentfilter get

    system ssh pubkey

    system ssh pubkey new

    system ssh pubkey new
    Adds a new SSH key system ssh pubkey new key "AAAAB3NzaC1yc2EAAAABIwAAA..."
    key Value of the key

    system ssh pubkey get

    system ssh pubkey get
    Outputs all current public SSH keys system ssh pubkey get

    system ssh pubkey delete

    system ssh pubkey delete
    Deletes the SSH key system ssh pubkey delete id "8"
    id Id of a SSH key

    system ssh pubkey enable

    system ssh pubkey enable
    Disables an SSH key system ssh pubkey enable id "8"
    id Id of a SSH key

    system ssh pubkey disable

    system ssh pubkey disable
    Activates an SSH key system ssh pubkey disable id "8"
    id Id of a SSH key

    system generate

    system generate sshdkeys

    system generate sshdkeys
    Creates new keys for SSH connections to the appliance system generate sshdkeys

    system generate webservercert

    system generate webservercert
    Generates new UTM web server certificates system generate webservercert

    system generate dhparams

    system generate dhparams
    Generates new Diffie-Hellman parameter files system generate dhparams

    system ciphers

    system ciphers
    Lists the encryptions of a cipher list system ciphers value "MEDIUM"

    system predictable_interface_names

    system predictable_interface_names
    Enables/disables predictable interface names system predictable_interface_names value "enable"
    value Enable/Disable

    system interface

    system interface info

    system interface info
    system interface info

    system rule_engine

    system rule_engine get

    system rule_engine get
    system rule_engine get

    system rule_engine set

    system rule_engine set
    system rule_engine set value "iptables"
    value

    system remote

    system remote sync status

    system remote sync status
    Transferring the status to the remote terminal system remote sync status

    system remote sync virus_pattern

    system remote sync virus_pattern
    Transferring the virus pattern to the remote terminal system remote sync virus_pattern

    system remote sync ipdeny

    system remote sync ipdeny
    Transferring the ipdeny list to the remote terminal system remote sync ipdeny

    system remote upgrade cur

    system remote upgrade cur
    Transfers the installed firmware to the remote terminal system remote upgrade cur

    system remote upgrade new

    system remote upgrade new
    Transfers the firmware in the folder 'new' to the remote terminal system remote upgrade new

    system remote upgrade status

    system remote upgrade status
    Status of ongoing synchronizations system remote upgrade status

    system remote upgrade abort

    system remote upgrade abort
    Canceling ongoing synchronizations system remote upgrade abort

    system remote get new

    system remote get new
    Displays the firmware versions of the remote terminal
    The error message connection error appears if the remote terminal is not reachable.
    system remote get new

    system remote get old

    system remote get old
    Displays the former firmware versions of the remote station system remote get old

    system remote get cur

    system remote get cur
    system remote get cur

    system cloudbackup

    system cloudbackup get

    system cloudbackup get
    Listed available backups system cloudbackup get

    system cloudbackup store

    system cloudbackup store
    Saves a backup of the active configuration system cloudbackup store

    system cloudbackup set

    system cloudbackup set
    setting a password system cloudbackup set password "geheim"
    password Password for the backup

    system cloudbackup delete

    system cloudbackup delete
    Deletes a backup in the cloud system cloudbackup delete id "5264f921f3819be23e000001"
    id Id of a backup

    system cloudbackup restore

    system cloudbackup restore
    Restore a backup system cloudbackup restore id "5264f921f3819be23e000001" ctime "1382349089" password "geheim"
    id Id of a backup
    ctime
    password Password for the backup

    system cloudbackup password status get

    system cloudbackup password status get
    Indicates whether a cloud backup password has been set. (Does not display the password) system cloudbackup password status get

    system tools

    system tools ping

    system tools ping
    Sends ICMP ECHO_REQUEST to Network Hosts system tools ping host "8.8.8.8"
    or
    system tools ping family "4" source "192.168.175.1" resolve "on" count "10" host "www.securepoint.de"
    family Specifies whether IPv4 ("4") or IPv6 ("6") is used
    source Source address
    resolve
    count Number of performances
    host destination address

    system tools traceroute

    system tools traceroute
    Measures delays of network packets on their way to the target host system tools traceroute host "8.8.8.8"
    or
    system tools traceroute family "4" source "LAN2" resolve "on" count "10" host "www.securepoint.de"
    family Specifies whether IPv4 ("4") or IPv6 ("6") is used
    source
    Source interface
    source_addr
    Source address
    resolve
    count Number of performances
    host destination address

    system tools route

    system tools route
    Output of the Routing Table system tools route family "4"
    family Specifies whether IPv4 ("4") or IPv6 ("6") is used

    system tools host

    system tools host
    Running DNS lookups system tools host type "A" server "8.8.8.8" host "www.securepoint.de"
    type DNS Type
    server DNS Server
    host Domain

    system tools wake

    system tools wake
    Sends Wake-on-Lan Magic Packets to a MAC address (More information)
    Letters in hexadecimal numbers must be entered in uppercase
    system tools wake host 00:1A:2B:3C:4E:5F@eth1
    host MAC address of the target device in the format MAC@interface

    system upgrade

    system upgrade finalize

    system upgrade finalize
    Finish a previous update or rollback system upgrade finalize

    system upgrade hint

    system upgrade hint
    Get a hint for the next upgrade action system upgrade hint

    system upgrade updatehint

    system upgrade updatehint
    system upgrade updatehint

    system upgrade info

    system upgrade info
    Lists the installed firmware versions system upgrade info

    system upgrade update

    system upgrade update
    Download an update (if available) system upgrade update

    system upgrade forceupdate

    system upgrade forceupdate
    Loads an update and removes remnants of previous updates system upgrade forceupdate

    system upgrade updatelatest

    system upgrade updatelatest
    Download the latest update and remove old updates system upgrade updatelatest

    system upgrade updatelatestcheck

    system upgrade updatelatestcheck
    Check whether the limit for update requests has been reached system upgrade updatelatestcheck

    system upgrade dryrun

    system upgrade dryrun
    Reboots the system into the updated firmware image system upgrade dryrun

    system upgrade rollback

    system upgrade rollback
    Reboots the system to the previous firmware image system upgrade rollback

    system upgrade confirm/decline privacy

    system upgrade confirm/decline privacy
    Accept/Reject the privacy policy system upgrade confirm privacy
    or
    system upgrade decline privacy

    system upgrade confirm/decline eula

    system upgrade confirm/decline eula
    Accept/Reject the license agreement system upgrade confirm eula
    or
    system upgrade decline eula

    system upgrade privacy/eula get

    system upgrade privacy/eula get
    Provides the privacy policy or license agreement system upgrade privacy get version "cur" lang "de"
    or
    system upgrade eula get version "cur" lang "de"
    version Version ("new", "cur", "old")
    lang Language ("de", "en")

    system sysctl

    system sysctl get

    system sysctl get
    Lists all sysctl variables system sysctl get

    system sysctl new

    system sysctl new
    Set a new sysctl variable system sysctl new name "net.ipv4.neigh.default.gc_thresh1" value "512"
    name Name of the variable
    value Value of the variable

    system sysctl set

    system sysctl set
    Changes the value of a sysctl variable system sysctl set name "net.ipv4.neigh.default.gc_thresh1" value "128"
    name Name of the variable
    value Value of the variable

    system sysctl delete

    system sysctl delete
    Deletes a sysctl variable of the Linux kernel system sysctl delete name "net.ipv4.neigh.default.gc_thresh1"
    name Name of the variable

    system sysctl update

    system sysctl update
    Update the sysctl variables system sysctl update
    It happens frequently that VoIP providers specify session timeout for UDP packets. This value is set to 30 seconds in the factory default setting and is therefore too little for many providers.

    To ensure that a change still exists after an update or a restart, a variable must be added here that contains the desired value.
    In our example, we set the Session Timeout value for UDP packets to a value of 300 seconds.
    system sysctl new name net.netfilter.nf_conntrack_udp_timeout value 300
    To ensure that this change is accepted and also saved in the configuration, the following commands must be issued:
    system update system
    system config save

    system activedirectory

    system activedirectory join

    system activedirectory join
    Connects the UTM to the Active Directory system activedirectory join password "geheim"
    password Password of the Active Directory

    system activedirectory testjoin

    system activedirectory testjoin
    Checks the AD account of the UTM system activedirectory testjoin

    system activedirectory leave

    system activedirectory leave
    Release connection to Active Directory system activedirectory leave password "geheim"
    password Password of the Active Directory

    system activedirectory lsgroups

    system activedirectory lsgroups
    List of Active Directory groups ( Only groups to which at least one user is assigned are displayed) system activedirectory lsgroups