settings

The settings command branch manages the device's own operating settings: the management access, the backup, the update, the clock, the name resolution, the central authentication, the notification and the forwarding profiles. The fields here do not belong to a traffic object but directly to the device itself.

Two Types of Resource

Type	Actions	Example
A single setting	It is displayed with show and changed with update	settings ntp, settings dns, settings email
A collection	All five actions: list, show, add, update, delete	settings log-transport, settings file-transport, settings notification entry

Two resources fall outside this distinction: settings access is a single setting but it also carries the init and reset actions; settings backup and settings update, on the other hand, offer their own operation actions instead of CRUD.

Command Map

Access, Backup and Update

Command	What it manages	Actions
settings access	The management access: the HTTP, HTTPS, SSH, FTP and SNMP services, the access lists, the session durations	show · update · init · reset
settings backup	The system backups: creating, listing, restoring	list · show · create · apply
settings update	The software update: listing and applying packages, the update server	show · update · files · apply

System Settings

Command	What it manages	Actions
settings ntp	The time server, the minimum number of sources, the clock offset and the time zone	show · update
settings dns	The DNS servers the device will use in its own name resolution	show · update
settings localization	The company name, the server name and the default language	show · update
settings disk-management	The thresholds for cleaning up by itself when the disk fills up	show · update
settings email	The mail server the notification e-mails will be sent through	show · update
settings ip-intelligence	Updating the address reputation database and the external sources	show · update

Authentication and User

Command	What it manages	Actions
settings ldap	Central sign-in over a directory	show · update
settings radius	Central sign-in with RADIUS	show · update
settings tacacs	Central sign-in and accounting with TACACS	show · update
settings user-management	The users coming from the central identity being opened by themselves and the session limit	show · update

Notification and Forwarding

Command	What it manages	Actions
settings notification	The system notifications: the alert records (entry) and the recipient groups (contact)	Five actions on both
settings log-transport	Sending the system logs out	Five actions
settings file-transport	Sending the report and backup files out	Five actions

Writing on the Single Settings

On the single settings there is no identifier: update is written directly and only the fields that will change are given.

TR7 WEB-CLI · a single setting and a collection

# a single setting: no identifier

admin@TR7LBWAF01> settings ntp show

admin@TR7LBWAF01> settings ntp update --timezone <region>

 

# a collection: works with an identifier

admin@TR7LBWAF01> settings log-transport list

admin@TR7LBWAF01> settings log-transport update id <id> …

admin@TR7LBWAF01>  

Not all the irreversible operations ask for confirmation

In this branch only settings update apply shows a confirmation screen before it runs; no change is made until the confirmation word is written — the detail is in the confirmation section on the API Commands page. In contrast, settings backup apply and settings access reset run without asking for confirmation; both are irreversible operations.

Things to Know

• The settings belong to the device. No record in this branch is connected to a vService or to a traffic object.
• On the single settings there is no add and delete. The record already exists; it is only displayed and updated.
• The central identity is in three separate commands. LDAP, RADIUS and TACACS are configured separately; how the users coming from them will be opened is determined in the settings user-management command.
• The notification is in two parts. In which situation the alert will be produced is defined with the notification entry records and to whom it will go with the notification contact records.
• The forwarding profiles carry different content. The logs are sent with log-transport, and the report and backup files with file-transport.