object	notification/
Object representing the event notification server configuration

Retrieving the value is denied if not administrative user

This object contains the following items:

sinks	Sinks
rules	Rules
known_sink_types	Sink types
sink_data_item_groups	Sink data item groups

Sample requests write command:

requests.put('http://192.168.0.100/restapi/notification/',auth=auth,headers=headers,json=<...>)

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "..." "http://192.168.0.100/restapi/notification/"

Browse more samples

Sinks

array	notification/sinks/
Sink array

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This array represents a value in persistent storage.

This array contains Sink elements.

Sample curl sink creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"test\":{\"1\":{\"value\":\"function\"},\"results\":[\"Sink handler indicates notification failure, check log for errors\"],\"arguments\":[]},\"type\":\"xmpp\",\"name\":\"michael\",\"data\":{\"password\":\"\",\"sender\":\"ronald@31o65.example.com\",\"recipient\":\"brian@cozf1.example.com\"}}" "http://192.168.0.100/restapi/notification/sinks/"

Sample requests write command:

requests.put('http://192.168.0.100/restapi/notification/sinks/',auth=auth,headers=headers,json=[{'test': [{'value': 'function'}], 'type': 'snmpv2ci', 'name': 'william', 'data': {'trap_oid': '0.373,', 'server': 'fhk17.example.com', 'community': '8'}}])

Browse more samples

Sink

object	notification/sinks/N/
Event sink

Retrieving the value is denied if not administrative user

This object represents a value in persistent storage.

This object contains the following items:

name	Name
type	Type
data	Data
test	Test

Sample uom library write command (note that _sink_index is a variable):

uom.notification.sinks[_sink_index]={data={community="n",server="y1ck0.p684.example.com",trap_oid="1.34,,,"},name="anthony",test={{value="function"},arguments={},results={"Sink handler indicates notification failure, check log for errors"}},type="snmpv2c"}

Sample JS request deletion command (note that _sink_index is a variable):

request.delete({url:"notification/sinks/"+_sink_index.toString()+"/"});

Browse more samples

Sink: Name

string	notification/sinks/N/name/
Sink name (can be shared between sinks)

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample curl write command (note that :sink_index is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"michael\"" "http://192.168.0.100/restapi/notification/sinks/:sink_index/name/"

Sample CLI write command (note that sink_index is a variable):

uom set "notification/sinks/${sink_index}/name" "\"richard\""

Browse more samples

Sink: Type

string	notification/sinks/N/type/
Sink type

The value is subject to the following constraints: sink types[the value]

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample uom library write command (note that _sink_index is a variable):

uom.notification.sinks[_sink_index].type="xmpp"

Sample JS request write command (note that _sink_index is a variable):

request.put({url:"notification/sinks/"+_sink_index.toString()+"/type/",body:"snmpv2c"});

Browse more samples

Sink: Data

map	notification/sinks/N/data/
Sink-type-specific data

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This map represents a value in persistent storage.

This map contains Data item elements.

Sample uom library data item creation command (note that _sink_index is a variable):

uom.insert(uom.notification.sinks[_sink_index].data,"recipient","james@x65m.example.com")

Sample JS request write command (note that _sink_index is a variable):

request.put({url:"notification/sinks/"+_sink_index.toString()+"/data/",body:{"password":"","port":"860","encryption":"smtps","username":"brian","recipient":"robert@ienono.example.com","sender":"brian@-cwr.example.com","server":"15dza.duxdcc.-q3j.example.com"}});

Browse more samples

Data item

string	notification/sinks/N/data/S/
Item of sink-type-specific data

The value is subject to the following constraints: the value matches sink types[type].data_items[index of the value].regexp

Retrieving the value is denied if any of the following is true:

not administrative user
all of the following is true:
- index of the value is not equal to ""
- sink data item groups[sink types[type].data_items[index of the value].group].unreadable

Changing the value is denied if any of the following is true:

not administrative user
all of the following is true:
- index of the value is not equal to ""
- sink data item groups[sink types[type].data_items[index of the value].group].immutable

Using the string as a field for indexing into the grandparent collection is denied if any of the following is true:

not administrative user
all of the following is true:
- index of the value is not equal to ""
- sink data item groups[sink types[type].data_items[index of the value].group].secret

This string represents a value in persistent storage.

This string should be displayed in a secure manner if all of the following is true:

index of the value is not equal to ""
sink data item groups[sink types[type].data_items[index of the value].group].secret

Sample curl deletion command (note that :sink_index and :data_item are URL template arguments):

curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json" "http://192.168.0.100/restapi/notification/sinks/:sink_index/data/:data_item/"

Sample requests read command (note that _sink_index and _data_item are variables):

print(requests.get('http://192.168.0.100/restapi/notification/sinks/'+str(_sink_index)+'/data/'+_data_item+'/',auth=auth,headers=headers).json())

⇒

'urlencoded'

Browse more samples

Sink: Test

call	notification/sinks/N/test/
Send a test notification using this sink

Performing the function call is denied if not administrative user

The call has no arguments (supply empty tuple).

The call returns the following results:

Notification status: Success or Failure

Sample curl invocation (note that :sink_index is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[]" "http://192.168.0.100/restapi/notification/sinks/:sink_index/test/"

⇒

"Sink handler indicates notification failure, check log for errors"

Sample JS request invocation (note that _sink_index is a variable):

request.post({url:"notification/sinks/"+_sink_index.toString()+"/test/",body:[]});

⇒

true

Browse more samples

Notification status

sum (variant)	notification/sinks/N/test/results: 1/
Notification success or failure message

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant true	Success	The notification has succeeded
string	Failure	The notification has failed with the following error

Rules

array	notification/rules/
Event processing rule list

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This array represents a value in persistent storage.

This array contains Rule elements.

Sample uom library rule creation command:

uom.insert(uom.notification.rules,6,{action="notify(\"daniel\")",condition="severity>=ERROR"})

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/notification/rules/',auth=auth,headers=headers).json())

⇒

Browse more samples

Rules: Rule

object	notification/rules/N/
Event processing rule

Retrieving the value is denied if not administrative user

This object represents a value in persistent storage.

This object contains the following items:

condition	Rule condition
action	Rule action

Sample CLI write command (note that rule_index is a variable):

uom set "notification/rules/${rule_index}" "{\"condition\":\"severity>=EMERGENCY\",\"action\":\"notify(\\\"robert\\\")\"}"

Sample CLI deletion command (note that rule_index is a variable):

uom remove "notification/rules/${rule_index}"

Browse more samples

Rule condition

string	notification/rules/N/condition/
Lua expression to evaluate for events to be matched

The value contains Lua source (has native MIME type text/x-lua).

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample CLI write command (note that rule_index is a variable):

uom set "notification/rules/${rule_index}/condition" "\"severity>=ALERT\""

Sample JS request read command (note that _rule_index is a variable):

request.get({url:"notification/rules/"+_rule_index.toString()+"/condition/"},function(error,response,body) {console.log(body)});

⇒

"severity>=WARNING"

Browse more samples

Rule action

string	notification/rules/N/action/
Lua code to evaluate for matching events

The value contains Lua source (has native MIME type text/x-lua).

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample uom library write command (note that _rule_index is a variable):

uom.notification.rules[_rule_index].action="notify(\"john\")"

Sample curl read command (note that :rule_index is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/notification/rules/:rule_index/action/"

⇒

"notify(\"anthony\")"

Browse more samples

Sink types

map	notification/known_sink_types/
Known sink types

Retrieving the value is denied if not administrative user

This map is composite, i.e. is modified as a whole.

This map does not support direct modification.

This map contains Sink type elements.

Creating elements in this collection is not supported.

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/notification/known_sink_types/"

⇒

...

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/notification/known_sink_types/',auth=auth,headers=headers).json())

⇒

<...>

Browse more samples

Sink type

object	notification/known_sink_types/S/
Type of sink

Retrieving the value is denied if not administrative user

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

name	Name
data_items	Supported data items

Sample JS request read command (note that _sink_type is a variable):

request.get({url:"notification/known_sink_types/"+_sink_type+"/"},function(error,response,body) {console.log(body)});

⇒

Sample curl write command (note that :sink_type is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"name\":\"SNMP v1 trap\",\"data_items\":{\"community\":{\"group\":\"msgkey\",\"name\":\"Community string\",\"regexp\":\"^.*$\"},\"specific_trap_type\":{\"group\":\"msg\",\"name\":\"Default specific trap type\",\"regexp\":\"^[0-9][0-9]*$\"},\"generic_trap_type\":{\"group\":\"msg\",\"name\":\"Default generic trap type\",\"regexp\":\"^[0-9][0-9]*$\"},\"enterprise_oid\":{\"group\":\"msg\",\"name\":\"Enterprise OID\",\"regexp\":\"^[012](\\\\.[0-9]{1,}),{1,}$\"},\"server\":{\"group\":\"rcpt\",\"name\":\"Server address\",\"regexp\":\"^[0-9A-Za-z.-]{1,}$\"}}}" "http://192.168.0.100/restapi/notification/known_sink_types/:sink_type/"

Browse more samples

Sink type: Name

string	notification/known_sink_types/S/name/
Sink type name

Retrieving the value is denied if not administrative user

This string is a part of a composite value which is modified as a whole.

This string does not support direct modification.

Sample requests read command (note that _sink_type is a variable):

print(requests.get('http://192.168.0.100/restapi/notification/known_sink_types/'+_sink_type+'/name/',auth=auth,headers=headers).json())

⇒

'SNMP v3 trap'

Sample uom library read command (note that _sink_type is a variable):

print(uom.dump(uom.notification.known_sink_types[_sink_type].name))

⇒

"WebHook"

Browse more samples

Sink type: Supported data items

map	notification/known_sink_types/S/data_items/
Properties of supported data items

Retrieving the value is denied if not administrative user

This map is a part of a composite value which is modified as a whole.

This map does not support direct modification.

This map contains Data item properties elements.

Creating elements in this collection is not supported.

Sample CLI read command (note that sink_type is a variable):

uom get "notification/known_sink_types/${sink_type}/data_items"

⇒

Sample JS request read command (note that _sink_type is a variable):

request.get({url:"notification/known_sink_types/"+_sink_type+"/data_items/"},function(error,response,body) {console.log(body)});

⇒

Browse more samples

Data item properties

object	notification/known_sink_types/S/data_items/S/
Properties of data item

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

name	Name
group	Data item group
regexp	Regular expression

Sample CLI read command (note that sink_type and data_item_properties are variables):

uom get "notification/known_sink_types/${sink_type}/data_items/${data_item_properties}"

⇒

{"group":"msg","name":"Context engine ID","regexp":"^(|0x([0-9A-Fa-f][0-,9A-Fa-f]){1,})$"}

Sample curl read command (note that :sink_type and :data_item_properties are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/notification/known_sink_types/:sink_type/data_items/:data_item_properties/"

⇒

{"group":"rcpt","name":"Recipient URL","regexp":"^https?://.*$"}

Browse more samples

Name

string	notification/known_sink_types/S/data_items/S/name/
Data item name

Retrieving the value is denied if not administrative user

This string is a part of a composite value which is modified as a whole.

This string does not support direct modification.

Sample CLI read command (note that sink_type and data_item_properties are variables):

uom get "notification/known_sink_types/${sink_type}/data_items/${data_item_properties}/name"

⇒

"Server address"

Sample JS request read command (note that _sink_type and _data_item_properties are variables):

request.get({url:"notification/known_sink_types/"+_sink_type+"/data_items/"+_data_item_properties+"/name/"},function(error,response,body) {console.log(body)});

⇒

"Authentication passphrase"

Browse more samples

Data item group

string	notification/known_sink_types/S/data_items/S/group/
The group of data items to which this one belongs

The value is subject to the following constraints: sink data item groups[the value]

Retrieving the value is denied if not administrative user

This string is a part of a composite value which is modified as a whole.

This string does not support direct modification.

Sample JS request read command (note that _sink_type and _data_item_properties are variables):

request.get({url:"notification/known_sink_types/"+_sink_type+"/data_items/"+_data_item_properties+"/group/"},function(error,response,body) {console.log(body)});

⇒

"sndrkey"

Sample requests read command (note that _sink_type and _data_item_properties are variables):

print(requests.get('http://192.168.0.100/restapi/notification/known_sink_types/'+_sink_type+'/data_items/'+_data_item_properties+'/group/',auth=auth,headers=headers).json())

⇒

'rcpt'

Browse more samples

Regular expression

string	notification/known_sink_types/S/data_items/S/regexp/
Regular expression which the data item must match

Retrieving the value is denied if not administrative user

This string is a part of a composite value which is modified as a whole.

This string does not support direct modification.

Sample curl read command (note that :sink_type and :data_item_properties are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/notification/known_sink_types/:sink_type/data_items/:data_item_properties/regexp/"

⇒

"^.*$"

Sample requests read command (note that _sink_type and _data_item_properties are variables):

print(requests.get('http://192.168.0.100/restapi/notification/known_sink_types/'+_sink_type+'/data_items/'+_data_item_properties+'/regexp/',auth=auth,headers=headers).json())

⇒

'^(|DES|AES)$'

Browse more samples

Sink data item groups

map	notification/sink_data_item_groups/
Properties of groups of sink data items

Retrieving the value is denied if not administrative user

This map is composite, i.e. is modified as a whole.

This map does not support direct modification.

This map can change as if by itself or indirectly because of other actions.

Changes to this map cannot be tracked.

This map contains Sink data item group elements.

Creating elements in this collection is not supported.

Sample CLI read command:

uom get "notification/sink_data_item_groups"

⇒

Sample JS request read command:

request.get({url:"notification/sink_data_item_groups/"},function(error,response,body) {console.log(body)});

⇒

Browse more samples

Sink data item groups: Sink data item group

object	notification/sink_data_item_groups/S/
Properties of a group of sink data items

Retrieving the value is denied if not administrative user

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

name	Name
secret	Secret
immutable	Immutable
unreadable	Unreadable

Sample JS request read command (note that _sink_data_item_group is a variable):

request.get({url:"notification/sink_data_item_groups/"+_sink_data_item_group+"/"},function(error,response,body) {console.log(body)});

⇒

{"immutable":false,"unreadable":false,"name":"Recipient key","secret":true}

Sample CLI read command (note that sink_data_item_group is a variable):

uom get "notification/sink_data_item_groups/${sink_data_item_group}"

⇒

{"immutable":false,"unreadable":false,"name":"Message key","secret":true}

Browse more samples

Name

string	notification/sink_data_item_groups/S/name/
Data item group name

Retrieving the value is denied if not administrative user

This string is a part of a composite value which is modified as a whole.

This string does not support direct modification.

Sample uom library read command (note that _sink_data_item_group is a variable):

print(uom.dump(uom.notification.sink_data_item_groups[_sink_data_item_group].name))

⇒

"Sender key"

Sample curl read command (note that :sink_data_item_group is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/notification/sink_data_item_groups/:sink_data_item_group/name/"

⇒

"Sender attribute"

Browse more samples

Secret

sum (boolean)	notification/sink_data_item_groups/S/secret/
Flag indicating whether the data item can contain private information

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant true	Secret	The data item can contain private information
constant false	Not secret	The data item contains only public information

Sample requests read command (note that _sink_data_item_group is a variable):

print(requests.get('http://192.168.0.100/restapi/notification/sink_data_item_groups/'+_sink_data_item_group+'/secret/',auth=auth,headers=headers).json())

⇒

True

Sample CLI read command (note that sink_data_item_group is a variable):

uom get "notification/sink_data_item_groups/${sink_data_item_group}/secret"

⇒

true

Browse more samples

Immutable

sum (boolean)	notification/sink_data_item_groups/S/immutable/
Flag indicating whether the data item is not permitted to be changed

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant true	Immutable	The data item is not permitted to be changed
constant false	Not immutable	The data item can be changed

Sample uom library read command (note that _sink_data_item_group is a variable):

print(uom.dump(uom.notification.sink_data_item_groups[_sink_data_item_group].immutable))

⇒

false

Sample curl read command (note that :sink_data_item_group is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/notification/sink_data_item_groups/:sink_data_item_group/immutable/"

⇒

false

Browse more samples

Unreadable

sum (boolean)	notification/sink_data_item_groups/S/unreadable/
Flag indicating whether the data item is not permitted to be read

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant true	Unreadable	The data item is not permitted to be read
constant false	Not unreadable	The data item can be read

Sample curl read command (note that :sink_data_item_group is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/notification/sink_data_item_groups/:sink_data_item_group/unreadable/"

⇒

false

Sample CLI read command (note that sink_data_item_group is a variable):

uom get "notification/sink_data_item_groups/${sink_data_item_group}/unreadable"

⇒

false

Browse more samples