Skip to content
Smarter by Design.Simpler for Business

settings update ​

The settings update command manages the software update of the device: it lists the packages waiting in the drop directory, applies the selected package and keeps the update server setting.

Applying an update cannot be undone

When apply runs, the target area is synchronized with the content of the package; a wrong package can break the service. The operation continues until it finishes and can take minutes. For this reason the command asks for confirmation before it runs.

Command Summary ​

TR7 WEB-CLI · settings update
# Tab after the command
admin@TR7LBWAF01> settings update
apply files show update
 
admin@TR7LBWAF01> settings update show # show the server setting
admin@TR7LBWAF01> settings update files # the waiting packages
admin@TR7LBWAF01> settings update apply <package> # apply the package
admin@TR7LBWAF01> settings update update … # change the server setting
admin@TR7LBWAF01>  

files — Listing the Waiting Packages ​

In the update drop directory (the folder of the FTP update user) it lists the waiting .tr7 packages, with the newest at the top. The scope and version information is read from the package name; the standard name format is <package>_v<version>_<date>.tr7.

FieldWhat it doesWhat is written after it
--infoWrites what the command will do without running itIt does not take a value; it is written on its own

apply — Applying the Package ​

OrderFieldStatusValue
1filenameRequiredThe package that will be applied. The field name is not written, the package name is written directly after the word apply; Tab lists the waiting ones
FieldWhat it doesWhat is written after it
--scopeDetermines which area the package will be applied totr7_server · tr7_healthcheck · ip_db · waf_rules · pool_services · zone_services. When it is left empty, the scope in the package name is used
--versionDetermines the version that will be appliedA version number. When it is left empty, the version in the package name is used
TR7 WEB-CLI · the application confirmation screen
admin@TR7LBWAF01> settings update apply <package>
⚠  The update package will be applied to this device
    The target area is synchronized with the content of the package — a wrong package can break the service. The operation continues until it finishes, it can take minutes.
Type "yes" to confirm: yes
admin@TR7LBWAF01>  

update — The Update Server ​

FieldWhat it doesWhat is written after it
--updateServerAddressDetermines the address of the server the update packages will be taken fromA server address
--releaseSelects which distribution channel will be followedA channel value (the default is Stable)

Examples ​

TR7 WEB-CLI · the update flow
# 1) see the waiting packages
admin@TR7LBWAF01> settings update files
 
# 2) apply the package; the scope and the version are read from the package name
admin@TR7LBWAF01> settings update apply <package>
 
# if the scope needs to be given manually
admin@TR7LBWAF01> settings update apply <package> --scope waf_rules --version <version>
 
# the update server setting
admin@TR7LBWAF01> settings update update --updateServerAddress <address> --release Stable
admin@TR7LBWAF01>  

Things to Know ​

  • The packages are read from the drop directory. The files output gives the packages waiting in the folder of the FTP update user — the .tr7 files — with the newest at the top.
  • The scope and the version are derived from the package name. When --scope and --version are left empty, the values are read from the <package>_v<version>_<date>.tr7 name.
  • The application asks for confirmation. No change is made until the confirmation word is written.
  • The operation is not interrupted halfway. After the application starts, it continues until it finishes; this duration can take minutes.
  • A wrong package can break the service. Before applying, it must be made sure that the package is for the right device and the right scope.