settings notification

The settings notification command manages the system notifications of the device. It has two sub-resources:

Sub-resource	What it defines
entry	In which situation the alert will be produced and by which ways it will be delivered
contact	Who the alert will go to — the recipient groups

On both of them there are five actions: list, show, add, update, delete.

Command Summary

TR7 WEB-CLI · settings notification

# Tab after the command

admin@TR7LBWAF01> settings notification

contact entry

 

admin@TR7LBWAF01> settings notification entry

add delete list show update

 

admin@TR7LBWAF01> settings notification entry list

admin@TR7LBWAF01> settings notification entry add name <name> type cpu …

admin@TR7LBWAF01> settings notification contact list

admin@TR7LBWAF01> settings notification contact show <id>

admin@TR7LBWAF01> settings notification contact add name <name> contactSelection manual …

admin@TR7LBWAF01> settings notification contact update id <id> …

admin@TR7LBWAF01> settings notification contact delete <id>

admin@TR7LBWAF01>  

entry — The Alert Records

The Required Fields

In the add command the CLI asks for the required fields one by one in the order below and does not show the next one until one is written. The fields are written with the field name and the value together. The field in the third order changes according to the selected type; on the types that are not in the list there is no third required field.

Order	Field	Status	Value
1	name	Required	A name specific to the record; the same name cannot be used in two records
2	type	Required	One of the fifteen values below; the type-dependent fields are listed after this selection
3	cpuLimit	Conditionally required	Only type cpu; a percentage between 0 and 95
3	memLimit	Conditionally required	Only type mem; a percentage between 0 and 95
3	diskLimit	Conditionally required	Only type disk; a percentage between 0 and 95
3	bwLimit	Conditionally required	Only type bw; 0 or a larger number
3	ipRepStaleDays	Conditionally required	Only type ipRep; a number of days (the default is 45)
3 · 4	ntpOffsetLimit.val · ntpOffsetLimit.unit	Conditionally required	Only type ntp; a number and a unit (s · m · h). Even if there is a -- on the line, they are written without a prefix and before the -- fields

When a -- field is added to the line, the cpuLimit, memLimit, diskLimit, bwLimit and ipRepStaleDays fields switch to the -- prefixed writing; ntpOffsetLimit.val and ntpOffsetLimit.unit, on the other hand, are without a prefix in every case. Tab shows the correct writing at every step.

In the update command the record to be edited is selected with id <id>; in the show and delete commands the identifier is written without the field name (settings notification entry delete <id>).

The Notification Types

Value	Its name in the interface	The fields opened on that type
cpu	CPU usage	--cpuLimit
mem	Memory usage	--memLimit
disk	Disk	--diskLimit
bw	Bandwidth	--bwLimit
zoneStatus	vDevice status	--v-device
interfaceState	Interface status	--v-device · --namespace · --interface
ipStatus	IP status	--v-device · --namespace · --interface · --ipId
vrrp	VIP status	--v-device · --namespace · --interface · --ipId
tr7InterfaceGw	GW health status	--v-device · --namespace · --interface
tr7InterfaceClusterIpConn	VIP connection status	--v-device · --namespace · --interface
tr7Ip	TR7 IP state	--v-device · --namespace · --interface · --ipId
clusterConn	Cluster connection	No type-specific field
ipRep	IP Intelligence & Reputation Data	--ipRepStaleDays
ntp	NTP synchronization	ntpOffsetLimit.val · ntpOffsetLimit.unit
userLog	User action	No type-specific field

The Threshold Fields

Field	What it does	What is written after it
--cpuLimit	Determines which percentage the processor usage exceeding will produce an alert	A number between 0 and 95. Only while type cpu
--memLimit	Determines which percentage the memory usage exceeding will produce an alert	A number between 0 and 95. Only while type mem
--diskLimit	Determines which percentage the disk occupancy exceeding will produce an alert	A number between 0 and 95. Only while type disk
--bwLimit	Determines which value the bandwidth exceeding will produce an alert	0 or a larger number. Only while type bw
--ipRepStaleDays	Determines how many days old the address reputation database being will produce an alert	1 or a larger integer (the default is 45). Only while type ipRep
ntpOffsetLimit.val	Determines how much the clock drifting from its source will produce an alert	A number (the default is 5). It is required while type ntp and it is written without a prefix
ntpOffsetLimit.unit	Selects the unit of that offset	s (the default) · m · h; the total duration cannot be smaller than 1 second or larger than 24 hours

The Scope Fields

On the network-related types, which object the alert will monitor is narrowed down with these fields. All three of them can be left empty: when they are left empty, the scope is not narrowed down.

Field	What it does	What is written after it
--v-device	Selects on which vDevice the alert will be monitored	A vDevice; the default is the device the command runs on
--namespace	Selects which routing table the alert will be limited to	A routing table. When it is left empty, all the tables are monitored
--interface	Selects which interface the alert will be limited to	An interface; it is filtered according to the selected routing table. When it is left empty, all the interfaces are monitored
--ipId	Selects which address the alert will be limited to	An address; it is filtered according to the selected interface. When it is left empty, all the addresses are monitored

The Delivery Fields

Field	What it does	What is written after it
--actions.N	Selects by which ways the alert will be delivered	sendEmail — Send e-mail · sendSms — Send sms · snmpTrap — SNMP trap · notifyUi — Notify UI. By default sendEmail and notifyUi are selected
--contactGroups.N	Selects which recipient groups the alert will be sent to	The group records defined with the contact sub-command; each of them with its own index

contact — The Recipient Groups

The Required Fields

Order	Field	Status	Value
1	name	Required	A name specific to the group; the same name cannot be used in two groups
2	contactSelection	Required	byUserType — By user type · byUser — By user · manual — the addresses are written manually

The Recipient Fields

Field	What it does	What is written after it
--userTypes.N	Determines which user roles will enter the group on the byUserType selection	The role values: superAdmin · readOnly · cloudClient · monitor · networkManager · networkUser · trafficManager · trafficUser
--users.N	Determines which users will enter the group on the byUser selection	User names; each of them with its own index
--manualEmailAddresses.N	Determines the e-mail addresses to be added to the group manually	An e-mail address; every address with its own index
--manualPhoneNumbers.N	Determines the telephone numbers to be added to the group manually	A telephone number; every number with its own index

The recipient fields are not offered as active in this version

The condition of these four fields in the schema, instead of comparing the contactSelection value, looks for fields named byUserType, byUser and manual; since there are no such fields, the condition is not met on any selection and the fields are not offered as active in the Tab list. The recipient groups can be edited from the management interface.

Examples

TR7 WEB-CLI · the alert records

# an e-mail and an interface notification when the processor exceeds 80 percent

admin@TR7LBWAF01> settings notification entry add name cpu-alert type cpu \

--cpuLimit 80 --actions.0 sendEmail --actions.1 notifyUi --contactGroups.0 <group>

 

# alert if the clock drifts more than 30 seconds

admin@TR7LBWAF01> settings notification entry add name clock-offset type ntp \

ntpOffsetLimit.val 30 ntpOffsetLimit.unit s

 

# the status of a certain interface should be monitored

admin@TR7LBWAF01> settings notification entry add name uplink-status type interfaceState \

--v-device <device> --namespace 1 --interface <interface> --actions.0 snmpTrap

 

# changing and deleting

admin@TR7LBWAF01> settings notification entry update id <id> --cpuLimit 90

admin@TR7LBWAF01> settings notification entry delete <id>

admin@TR7LBWAF01>  

Things to Know

• The alert and the recipient are separate records. In which situation the alert will be produced is defined with the entry records and who it will go to with the contact records; the two are connected with --contactGroups.N.
• The name is asked first, then the type. In the entry add command the CLI asks for the name and type fields in order, and then, on the threshold types, for the threshold field of that type. In the contact add command the order is name, contactSelection.
• The required fields do not take --. The fields in the order tables are written with the field name and the value side by side; the optional fields are in the --field value format. When a -- field is added to the line, the conditionally required threshold fields are also written with the -- prefix. The detail is on the API Commands page.
• The resource thresholds cannot exceed 95 percent. The upper limit of the --cpuLimit, --memLimit and --diskLimit fields is 95.
• The scope fields can be left empty. When --namespace, --interface and --ipId are not given, the alert covers all the objects of that type.
• The e-mail sending depends on the mail server. In order for the sendEmail action to work, the settings email setting must have been made.
• The SNMP notification depends on the access setting. The SNMP configuration related to the snmpTrap action is in the settings access command.
• The address reputation threshold should not be selected shorter than the update frequency. If the --ipRepStaleDays value is shorter than the online update interval in the settings ip-intelligence command, an alert is produced between two updates.