DLI ISO32 Object Model Reference
20210317T210828Z
Event notification server object
objectnotification/
Object representing the event notification server configuration
dot_inline_dotgraph_377.png

Retrieving the value is denied if not administrative user

This object contains the following items:

sinksSinks
rulesRules
known_sink_typesSink types
sink_data_item_groupsSink data item groups

Sample CLI write command:

uom set notification ...

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

arraynotification/sinks/
Sink array
dot_inline_dotgraph_378.png

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 uom library read command:

print(uom.dump(uom.notification.sinks))

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 "[{\"test\":{\"1\":{\"value\":\"function\"},\"results\":[\"Sink handler indicates notification failure, check log for errors\"],\"arguments\":[]},\"type\":\"snmpv2ci\",\"name\":\"steven\",\"data\":{\"trap_oid\":\"1.296,,,,\",\"server\":\"timva0.u1a-us.example.com\",\"community\":\"j\"}},{\"test\":{\"1\":{\"value\":\"function\"},\"results\":[true],\"arguments\":[]},\"type\":\"webhook\",\"name\":\"paul\",\"data\":{\"content_type\":\"urlencoded\",\"recipient\":\"https://pd-ugz.example.com/jrJ\"}},{\"test\":{\"1\":{\"value\":\"function\"},\"results\":[true],\"arguments\":[]},\"type\":\"webhook\",\"name\":\"charles\",\"data\":{\"content_type\":\"json\",\"recipient\":\"https://xqdj1.dn-ne.example.com/j\"}}]" "http://192.168.0.100/restapi/notification/sinks/"

Browse more samples

Sink

objectnotification/sinks/N/
Event sink
dot_inline_dotgraph_379.png

Retrieving the value is denied if not administrative user

This object represents a value in persistent storage.

This object contains the following items:

nameName
typeType
dataData
testTest

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

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

{"test":{"1":{"value":"function"},"results":[true],"arguments":[]},"type":"snmpv2c","name":"jason","data":{"trap_oid":"1.6,,,,","server":"55zjft.rch1w.example.com","community":"H^ApFe2"}}

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 "{\"test\":{\"1\":{\"value\":\"function\"},\"results\":[true],\"arguments\":[]},\"type\":\"snmpv1\",\"name\":\"brian\",\"data\":{\"community\":\"n\",\"specific_trap_type\":\"1628\",\"generic_trap_type\":\"41875206537663\",\"enterprise_oid\":\"1.876,\",\"server\":\"5-hu.dfr76.gw3n.example.com\"}}" "http://192.168.0.100/restapi/notification/sinks/:sink_index/"

Browse more samples

See also Sink: Name

See also Sink: Type

See also Sink: Data

See also Sink: Test

Sink: Name

stringnotification/sinks/N/name/
Sink name (can be shared between sinks)
dot_inline_dotgraph_380.png

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].name="anthony"

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

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

Browse more samples

Sink: Type

stringnotification/sinks/N/type/
Sink type
dot_inline_dotgraph_381.png

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 curl read command (note that :sink_index is a URL template argument):

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

"email"

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

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

Browse more samples

Sink: Data

mapnotification/sinks/N/data/
Sink-type-specific data
dot_inline_dotgraph_382.png

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 curl data item creation 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 "\"urlencoded\"" "http://192.168.0.100/restapi/notification/sinks/:sink_index/data/content_type/"

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

uom get "notification/sinks/${sink_index}/data"

{"password":"RQ5No","port":"0","encryption":"","username":"robert","recipient":"charles@9at-.1k-fy.example.com","sender":"james@t0wy6-.hq1k16.example.com","server":"hhhe.o5moj-.example.com"}

Browse more samples

Data item

stringnotification/sinks/N/data/S/
Item of sink-type-specific data
dot_inline_dotgraph_383.png

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:

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

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

This string represents a value in persistent storage.

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

Sample JS request deletion command (note that _sink_index and _data_item are variables):

request.delete({url:"notification/sinks/"+_sink_index.toString()+"/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())

'0x293F'

Browse more samples

Sink: Test

callnotification/sinks/N/test/
Send a test notification using this sink
dot_inline_dotgraph_384.png

Performing the function call is denied if not administrative user

The call has no arguments (supply empty tuple).

The call returns the following results:

  1. Notification status: Success or Failure

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

print(uom.dump(uom.notification.sinks[_sink_index].test()))

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

Sample requests invocation (note that _sink_index is a variable):

print(requests.post('http://192.168.0.100/restapi/notification/sinks/'+str(_sink_index)+'/test/',auth=auth,headers=headers,json={}).json())

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 trueSuccessThe notification has succeeded
stringFailureThe notification has failed with the following error

Rules

arraynotification/rules/
Event processing rule list
dot_inline_dotgraph_385.png

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 requests rule creation command:

requests.post('http://192.168.0.100/restapi/notification/rules/',auth=auth,headers=headers,json={'condition': 'severity>=NOTICE', 'action': 'notify("john")'})

Sample uom library rule creation command:

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

Browse more samples

See also Rules: Rule

Rules: Rule

objectnotification/rules/N/
Event processing rule
dot_inline_dotgraph_386.png

Retrieving the value is denied if not administrative user

This object represents a value in persistent storage.

This object contains the following items:

conditionRule condition
actionRule action

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

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

{"condition":"severity>=CRITICAL","action":"notify(\"david\")"}

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

request.put({url:"notification/rules/"+_rule_index.toString()+"/",body:{"condition":"severity>=WARNING","action":"notify(\"david\")"}});

Browse more samples

Rule condition

stringnotification/rules/N/condition/
Lua expression to evaluate for events to be matched
dot_inline_dotgraph_387.png

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 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/condition/"

"severity>=WARNING"

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

print(uom.dump(uom.notification.rules[_rule_index].condition))

"severity>=EMERGENCY"

Browse more samples

Rule action

stringnotification/rules/N/action/
Lua code to evaluate for matching events
dot_inline_dotgraph_388.png

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 read command (note that _rule_index is a variable):

print(uom.dump(uom.notification.rules[_rule_index].action))

"notify(\"anthony\")"

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

uom set "notification/rules/${rule_index}/action" "\"notify(\\\"james\\\")\""

Browse more samples

Sink types

mapnotification/known_sink_types/
Known sink types
dot_inline_dotgraph_389.png

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 JS request read command:

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

<...>

Sample CLI read command:

uom get "notification/known_sink_types"

...

Browse more samples

Sink type

objectnotification/known_sink_types/S/
Type of sink
dot_inline_dotgraph_390.png

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:

nameName
data_itemsSupported data items

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

uom set "notification/known_sink_types/${sink_type}" "{\"name\":\"WebHook\",\"data_items\":{\"content_type\":{\"group\":\"msg\",\"name\":\"Content type\",\"regexp\":\"^(json|urlencoded)$\"},\"recipient\":{\"group\":\"rcpt\",\"name\":\"Recipient URL\",\"regexp\":\"^https?://.*$\"}}}"

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

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

{data_items={content_type={group="msg",name="Content type",regexp="^(json|urlencoded)$"},recipient={group="rcpt",name="Recipient URL",regexp="^https?://.*$"}},name="WebHook"}

Browse more samples

See also Sink type: Name

See also Sink type: Supported data items

Sink type: Name

stringnotification/known_sink_types/S/name/
Sink type name
dot_inline_dotgraph_391.png

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 is a variable):

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

"SNMP v3 inform"

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'

Browse more samples

Sink type: Supported data items

mapnotification/known_sink_types/S/data_items/
Properties of supported data items
dot_inline_dotgraph_392.png

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 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)});

{"trap_oid":{"group":"msg","name":"Default trap OID","regexp":"^[012](\\.[0-9]{1,}),{1,}$"},"server":{"group":"rcpt","name":"Server address","regexp":"^[0-9A-Za-z.-]{1,}$"},"community":{"regexp":"^.*$","name":"Community string","group":"msgkey"}}

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+'/data_items/',auth=auth,headers=headers).json())

Browse more samples

Data item properties

objectnotification/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:

nameName
groupData item group
regexpRegular expression

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

uom set "notification/known_sink_types/${sink_type}/data_items/${data_item_properties}" "{\"group\":\"msg\",\"name\":\"Authentication protocol\",\"regexp\":\"^(|MD5|SHA)$\"}"

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+'/',auth=auth,headers=headers).json())

{'group': 'rcpt', 'name': 'Recipient XMPP ID', 'regexp': '^..*@[0-9A-Za-z.-]{1,}$'}

Browse more samples

Name

stringnotification/known_sink_types/S/data_items/S/name/
Data item name
dot_inline_dotgraph_393.png

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+"/name/"},function(error,response,body) {console.log(body)});

"Password"

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"

"Community string"

Browse more samples

Data item group

stringnotification/known_sink_types/S/data_items/S/group/
The group of data items to which this one belongs
dot_inline_dotgraph_394.png

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 uom library read command (note that _sink_type and _data_item_properties are variables):

print(uom.dump(uom.notification.known_sink_types[_sink_type].data_items[_data_item_properties].group))

"msg"

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())

'msg'

Browse more samples

Regular expression

stringnotification/known_sink_types/S/data_items/S/regexp/
Regular expression which the data item must match
dot_inline_dotgraph_395.png

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/"

"^..*@[0-9A-Za-z.-]{1,}$"

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}/regexp"

"^[0-9A-Za-z.-]{1,}$"

Browse more samples

Sink data item groups

mapnotification/sink_data_item_groups/
Properties of groups of sink data items
dot_inline_dotgraph_396.png

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 JS request read command:

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

Sample requests read command:

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

Browse more samples

See also Sink data item groups: Sink data item group

Sink data item groups: Sink data item group

objectnotification/sink_data_item_groups/S/
Properties of a group of sink data items
dot_inline_dotgraph_397.png

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:

nameName
secretSecret
immutableImmutable
unreadableUnreadable

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

uom.notification.sink_data_item_groups[_sink_data_item_group]={immutable=false,name="Sender attribute",secret=false,unreadable=false}

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

request.put({url:"notification/sink_data_item_groups/"+_sink_data_item_group+"/",body:{"immutable":false,"unreadable":false,"name":"Recipient attribute","secret":false}});

Browse more samples

Name

stringnotification/sink_data_item_groups/S/name/
Data item group name
dot_inline_dotgraph_398.png

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_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/"

"Recipient attribute"

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+"/name/"},function(error,response,body) {console.log(body)});

"Sender key"

Browse more samples

Secret

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

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 trueSecretThe data item can contain private information
constant falseNot secretThe data item contains only public information

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

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

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
dot_inline_dotgraph_400.png

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 trueImmutableThe data item is not permitted to be changed
constant falseNot immutableThe data item can be changed

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+"/immutable/"},function(error,response,body) {console.log(body)});

false

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

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
dot_inline_dotgraph_401.png

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 trueUnreadableThe data item is not permitted to be read
constant falseNot unreadableThe data item can be read

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+'/unreadable/',auth=auth,headers=headers).json())

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/unreadable/"

false

Browse more samples