Jump to:navigation, search
Wiki







































Syntax for the CLI command Extc

Last adaptation to the version: 14.0.1(01.2025)

New:
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


General commands

Command Parameter Description Example

extc cleanup

extc cleanup overview
extc cleanup overview notempty
New as of v14.0.1
Displays all invalid variables from multiple Extc applications/variables extc cleanup overview [ { application "l2tpd" } { application "spauthd" } { variables [ "INTERFACES" "TIMEOUT" ] } ]
  • All brackets and spaces are necessary for the command to work correctly.
  • application Specific application
    variables List of variable names
    extc cleanup execute
    extc cleanup execute notempty
    New as of v14.0.1
    Removes invalid entries, then lists changed variables with new (valid) values extc cleanup execute [ { application "l2tpd" } { application "spauthd" } { variables [ "INTERFACES" "TIMEOUT" ] } ]
  • All brackets and spaces are necessary for the command to work correctly.
  • application Specific application
    variables List of variable names

    extc valuelist

    extc valuelist get_with_state
    extc valuelist get_with_state notempty
    New as of v14.0.1
    Reading several Extc applications/variables including information about the status (valid / invalid) extc valuelist get_with_state [ { application "l2tpd" } { application "spauthd" } { variables [ "INTERFACES" "TIMEOUT" ] } ]
  • All brackets and spaces are necessary for the command to work correctly.
  • application Specific application
    variables List of variable names
    extc valuelist set
    extc valuelist set
    Setting the values of several variables extc valuelist set [ { application "dhcprelay4" values [ { variable "INTERFACES" value [ "LAN1" ] } { variable "SERVER" value [ "192.168.42.121" ] } ] } { application "dhcprelay6" values [ { variable "INTERFACES" value [ "LAN2" "LAN3" ] } ] } ]
  • All brackets and spaces are necessary for the command to work correctly.
  • application Specific application
    values List of value assignments to specific variables
    variable Certain variable
    value New value of the variable
    extc valuelist default
    extc valuelist default
    Reading the default values of several Extc applications/variables extc valuelist default [ { application "l2tpd" } { application "spauthd" } { variables [ "INTERFACES" "TIMEOUT" ] } ]
  • All brackets and spaces are necessary for the command to work correctly.
  • application Specific application
    variables List of variable names
    extc valuelist get
    extc valuelist get
    Reading several Extc applications/variables extc valuelist get [ { application "l2tpd" } { application "spauthd" } { variables [ "INTERFACES" "TIMEOUT" ] } ]
  • All brackets and spaces are necessary for the command to work correctly.
  • application Specific application
    variables List of variable names

    extc template

    extc template edit
    extc template edit
    Editor for editing a template extc template edit template "/etc/mailfilter_template_urlfilter"
    template File path of the template on the UTM
    extc template set
    extc template set
    Setting the content of a template extc template set template "/etc/mailfilter_template_urlfilter" content "test"
    template File path of the template on the UTM
    content New content of the template
    extc template getdiff
    extc template getdiff
    Output of a complete template and the changes compared to the default value extc template getdiff template "/etc/mailfilter_template_urlfilter"
    template File path of the template on the UTM
    extc template get
    extc template get
    Output of a complete template extc template get template "/etc/mailfilter_template_urlfilter"
    template File path of the template on the UTM

    extc runtimevar

    extc runtimevar delete
    extc runtimevar delete
    Deleting a runtime variable extc runtimevar delete variable "PROVIDER_DNS"
    variable Certain variable
    extc runtimevar set
    extc runtimevar set
    Setting the value of a runtime variable extc runtimevar set variable "PROVIDER_DNS" value "192.168.1.253"
    variable Certain variable
    value Value of the new variable
    extc runtimevar get
    extc runtimevar get
    Output of all runtime variables extc runtimevar get

    extc global

    extc global defaults
    extc global defaults
    List all global variables with their default values extc global defaults
    extc global reset
    extc global reset
    Resets the content of a global variable to the factory setting extc global reset variable "GLOB_ADMIN_EMAIL"
    variable Certain variable
    extc global get
    extc global get
    List all global variables extc global get
    extc global set
    extc global set
    Setting the value of a global variable extc global set { variable GLOB_BLOCK_ADDRESSES value [ 203.113.0.113 203.113.0.203 ] } notempty
    New variable GLOB_BLOCK_ADDRESSES
    The variable ‘'GLOB_BLOCK_ADDRESSES’' enables IP addresses to be blocked globally in all networks of the UTM. Multiple entries are separated by a space.
    variable Certain variable
    value New value of the variable
    extc global new
    extc global new
    Creating a new global variable extc global new variable "GLOB_NEW_VARIABLE" value "1234567890"
    variable Certain variable
    value Value of the new variable

    extc delete

    extc delete
    Removing a variable extc delete variable "new_variable" application "http_proxy"
    variable Certain variable
    application Specific application

    extc new

    extc new
    Creating a new variable extc new variable "new_variable" application "http_proxy" value "test"
    variable Name of the new variable
    application Application of the variable
    value Value of the new variable

    extc application

    extc application get
    extc application get
    List all applications extc application get

    extc variable

    extc variable get
    extc variable get
    Reading the variables of an application extc variable get application "http_proxy"
    application Specific application

    extc value

    extc value default
    extc value default
    Output of the variables with the values of the factory setting Alle Anwendungen: extc value default
    Bestimmte Anwendung: extc value default application "webserver"
    application (optional) Specific application
    extc value reset
    extc value reset
    Resets the content of a variable to the factory setting extc value reset application "cvpn" variable "RDP2VNC_PORT"
    application Specific application
    variable Certain variable
    extc value set
    extc value set
    Setting the value of a variable extc value set application "http_proxy" variable "VIRUSSCAN_ENGINE" value "csamd"
    application Specific application
    variable Certain variable
    value New value of the variable
    extc value get
    extc value get
    Reading the value of one or more variables extc value get application "http_proxy" variable "VIRUSSCAN_ENGINE"
    application Specific application
    variable Certain variable

    Application examples

    Command Description

    Block IP addresses globally

    Block IP addresses globally
    extc global set { variable GLOB_BLOCK_ADDRESSES value [ 203.113.0.113 203.113.0.203 ] } To block IP addresses globally, they must first be added to the variable ‘'GLOB_BLOCK_ADDRESSES’'. An array of IP addresses (separated by spaces) can be transferred using the ‘'value’' parameter.
    extc global get This command can be used to check the current value of the variable.
    rule implied rule set implied_group 17 implied_rule 0 active 1
    rule implied rule set implied_group 17 implied_rule 1 active 1
    The implicit rules that activate the blocking of IP addresses from the list must also be activated.